Overview
This web service retrieves a list of client element records (PwsClientDetail), based upon a list of unique client identifiers (PwsClientRef).
Request Format
- PwsGetLocations
- serviceRequest: PwsGetLocationsRq
- RequestId: Int32
- SessionTicket: String
- IncludeInactiveFlag: Boolean
- ListType: String (1)
- LocationIdentity: PwsLocationRef
- MaximumRows: Int32
- SearchString: String (255)
- serviceRequest: PwsGetLocationsRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | ||
SessionTicket | String | Yes | Click here for more information. | ||
IncludeInactiveFlag | Boolean | No | false | false | |
ListType | String (1) | Yes | The type of the location list: C: cost T: time | T | |
LocationIdentity | No | ||||
MaximumRows | Int32 | No | If not set, the complete list of locations that fits the search criteria will be returned in the response. | 10 | |
SearchString | String (255) | No | A search string to narrow down the results. A location will be included in the results if the search string matches the location name. This value is disregarded if a location is specified in LocationIdentity. |
Request Usage Example(s)
Response Format
- PwsGetLocationsResponse
- PwsGetLocationsResult: PwsGetLocationsRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- Locations: PwsLocationSummar
- PwsGetLocationsResult: PwsGetLocationsRs
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | |||
ResponseId | Int32 | Click here for more information. | |
Status | RequestStatus | Click here for more information | Ok |
ServerTimestampUtc | DateTime | Click here for more information. | |
Locations |
Response Usage Example(s)
Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 64223 | InvalidValueForListType | The specified value for ListType is invalid. Valid values are T for time or C for cost. |