Overview
This web service retrieves a list of client element records (PwsClientDetail), based upon a list of unique client identifiers (PwsClientRef).
Request Format
PwsGetLocations Request
- PwsGetLocations
- serviceRequest: PwsGetLocationsRq
- RequestId: Int32
- SessionTicket: String
- IncludeInactiveFlag: Boolean
- ListType: String
- LocationIdentity: PwsLocationRef
- MaximumRows: Int32
- SearchString: String
- serviceRequest: PwsGetLocationsRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | Click here for more information. | |||
SessionTicket | String | Click here for more information. | |||
IncludeInactiveFlag | Boolean | ||||
ListType | String | The type of the location list: C: cost T: time | |||
LocationIdentity | |||||
MaximumRows | Int32 | ||||
SearchString | String |
Request Usage Example(s)
Response Format
PwsGetLocations Response
- 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. |