...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | ||
SessionTicket | String | Yes | Click here for more information. | ARNkL4C1bp7KLtsSXQW6/g== | |
IncludeInactiveFlag | Boolean | No | false | If set to 'true', both inactive and active locations will be returned in the response. | false |
ListType | String (1) | Yes | The type of the a location list: C: enabled for cost T: enabled for time | T | |
LocationIdentity | No | A set of unique key fields of a location. Click here for more information. | |||
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. |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:tim="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsGetLocations>
<pws:serviceRequest>
<req:SessionTicket>ARNkL4C1bp7KLtsSXQW6/g==</req:SessionTicket>
<tim:IncludeInactiveFlag>true</tim:IncludeInactiveFlag>
<tim:ListType>T</tim:ListType>
<tim:MaximumRows>10</tim:MaximumRows>
<tim:SearchString>on</tim:SearchString>
</pws:serviceRequest>
</pws:PwsGetLocations>
</soapenv:Body>
</soapenv:Envelope>
|
| Code Block |
|---|
...
| |||||
| Panel | |||||
|---|---|---|---|---|---|
| |||||
| |||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:tim="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsGetLocations>
<pws:serviceRequest>
<req:SessionTicket>ARNkL4C1bp7KLtsSXQW6/g==</req:SessionTicket>
<tim:IncludeInactiveFlag>true</tim:IncludeInactiveFlag>
<tim:ListType>T</tim:ListType>
<tim:MaximumRows>10</tim:MaximumRows>
<tim:SearchString>on</tim:SearchString>
</pws:serviceRequest>
</pws:PwsGetLocations>
</soapenv:Body>
</soapenv:Envelope>
|
Response Format
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click herefor more information | ||
ResponseId | Int32 | Click here for more information. | 0 |
Status | RequestStatus | Click here for more information | Ok |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-07T18:49:19.6612047Z |
Locations | The set of basic information of a location. Click here for more information. |
Response Usage Example(s)
...