CanadaPostLocationDetail Type
Indicates the address details and other specifics of a Canada Post location.
Remarks
This type contains the results of a search made with the FindLocations method. The fields contained by this type are listed below.
Fields
|
Area String |
The name of the general location or area of a Post Office. This is used to distinguish among various Post Office locations that have similar names. This is populated when FindLocations is called. |
|
Bilingual Boolean |
Indicates whether the post office provides services in both English and French. |
|
City String |
Name of the city that the current location is in. |
|
Distance String |
The distance between the location and the address or coordinates specified in the search. |
|
GeographicCoordinates String |
Specifies the geographic coordinates of the CandaPost location. The latitude and longitude will be specified in decimal format and separated by a comma. For example: "35.912366,-78.939459" |
|
HoursCount Integer |
The number of hour information sets. Hours information is only returned if IncludeHours is set to True before calling FindLocations. |
|
HoursDayOfWeek Integer |
The day of the week for which the HoursOfOperation are being specified. This is populated when NormalHoursIndex is set. Values range from 1 to 7. Day 1 is Sunday and Day 7 is Saturday. Hours information is only returned if IncludeHours is set to True before calling FindLocations. |
|
HoursIndex Integer |
This field specifies the current hours information set. Valid values are from 0 to HoursCount - 1. Hours information is only returned if IncludeHours is set to True before calling FindLocations. |
|
HoursOfOperation String |
This contains the time range for the hours, specified by HoursIndex, that the current location is open. The format will be a 24 hour time format "HH:mm-HH:mm". For instance "09:00-16:00". If the location closes during the middle of the day so that it opens and closes twice in one day the sets will be separated by a comma. For instance "09:00-16:00,19:00-23:00" means the location is open from 9 a.m. to 4 p.m. and open again from 7 p.m. to 11 p.m. Hours information is only returned if IncludeHours is set to True before calling FindLocations. |
|
Name String |
The name of the business at this Canada Post location. This is populated when FindLocations is called. |
|
OfficeId String |
The internal Canada Post assigned unique identification number for the Post Office. Note: leading zeros are significant and should be included. |
|
PostalCode String |
The postal code for the current location. This is populated after a call to FindLocations. |
|
Province String |
Province or state code of the current location. This is populated after a call to FindLocations. |
|
StreetAddress String |
Street number and name of this Canada Post location. This is populated after a call to FindLocations. |