Overview

This web service retrieves one or a list of locations (PwsLocationSummary) based on specified search criteria.

Request Format

PwsGetLocations Request

PwsGetLocations
- serviceRequest: PwsGetLocationsRq
  - RequestId: Int32
  - SessionTicket: String
  - IncludeInactiveFlag: Boolean
  - ListType: String (1)
  - LocationIdentity: PwsLocationRef
  - MaximumRows: Int32
  - SearchString: String (255)

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.	ARNkL4C1bp7KLtsSXQW6/g==
IncludeInactiveFlag	Boolean	No	false	If set to 'true', both inactive and active locations will be returned in the response. Otherwise, only active locations are returned. Locations explicitly marked inactive, as well as locations that are not active for the specified list type (see ListType parameter) are considered to be inactive.	false
ListType	String (1)	Yes		The type of locations to retrieve: C: enabled for cost T: enabled for time	T
LocationIdentity	PwsLocationRef	No		A set of unique key fields of a location. Specify a value here to retrieve a specific location. Click here for more information.
MaximumRows	Int32	No		If not set, the complete list of locations that fit 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.

Request Usage Example(s)

Example 01 - without location identity

<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>

Example 02 - with location identity

<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:LocationIdentity>
               <com:LocationName>London</com:LocationName>
            </tim:LocationIdentity>
            <tim:MaximumRows>10</tim:MaximumRows>
         </pws:serviceRequest>
      </pws:PwsGetLocations>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetLocations Response

PwsGetLocationsResponse
- PwsGetLocationsResult: PwsGetLocationsRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Locations: PwsLocationSummary[]

Response Elements

Element	Data Type	Description	Sample Data
Messages	PwsMessage[]	The web service response status and message. Click here for 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	PwsLocationSummary[]	The set of basic information about a location. Click here for more information.

Response Usage Example(s)

Example 01 - without location identity

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetLocationsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetLocationsResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-07T18:49:19.6612047Z</ServerTimestampUtc>
            <a:Locations xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsLocationSummary>
                  <b:LocationId i:nil="true"/>
                  <b:LocationName>Boston</b:LocationName>
                  <b:LocationUid>1152921504606852816</b:LocationUid>
                  <b:CurrencyIdentity>
                     <b:CurrencyCode>USD</b:CurrencyCode>
                     <b:CurrencyId i:nil="true"/>
                     <b:CurrencyUid>1152921504606849879</b:CurrencyUid>
                  </b:CurrencyIdentity>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:MileageUom>M</b:MileageUom>
                  <b:OpsCurrencyIdentity>
                     <b:OpsCurrencyCode>USD</b:OpsCurrencyCode>
                     <b:OpsCurrencyId i:nil="true"/>
                  </b:OpsCurrencyIdentity>
                  <b:EnabledForCostcardsFlag>true</b:EnabledForCostcardsFlag>
                  <b:EnabledForProjectsFlag>true</b:EnabledForProjectsFlag>
                  <b:EnabledForResourcesFlag>true</b:EnabledForResourcesFlag>
                  <b:EnabledForTimecardsFlag>true</b:EnabledForTimecardsFlag>
               </b:PwsLocationSummary>
               <b:PwsLocationSummary>
                  <b:LocationId i:nil="true"/>
                  <b:LocationName>Location using LAK</b:LocationName>
                  <b:LocationUid>1152921504606855808</b:LocationUid>
                  <b:CurrencyIdentity>
                     <b:CurrencyCode>LAK</b:CurrencyCode>
                     <b:CurrencyId i:nil="true"/>
                     <b:CurrencyUid>1152921504606851801</b:CurrencyUid>
                  </b:CurrencyIdentity>
                  <b:InactiveFlag>true</b:InactiveFlag>
                  <b:MileageUom>M</b:MileageUom>
                  <b:OpsCurrencyIdentity>
                     <b:OpsCurrencyCode>LAK</b:OpsCurrencyCode>
                     <b:OpsCurrencyId i:nil="true"/>
                  </b:OpsCurrencyIdentity>
                  <b:EnabledForCostcardsFlag>true</b:EnabledForCostcardsFlag>
                  <b:EnabledForProjectsFlag>true</b:EnabledForProjectsFlag>
                  <b:EnabledForResourcesFlag>true</b:EnabledForResourcesFlag>
                  <b:EnabledForTimecardsFlag>true</b:EnabledForTimecardsFlag>
               </b:PwsLocationSummary>
               <b:PwsLocationSummary>
                  <b:LocationId i:nil="true"/>
                  <b:LocationName>Location using Won</b:LocationName>
                  <b:LocationUid>1152921504606855807</b:LocationUid>
                  <b:CurrencyIdentity>
                     <b:CurrencyCode>KRW</b:CurrencyCode>
                     <b:CurrencyId i:nil="true"/>
                     <b:CurrencyUid>1152921504606851800</b:CurrencyUid>
                  </b:CurrencyIdentity>
                  <b:InactiveFlag>true</b:InactiveFlag>
                  <b:MileageUom>M</b:MileageUom>
                  <b:OpsCurrencyIdentity>
                     <b:OpsCurrencyCode>KRW</b:OpsCurrencyCode>
                     <b:OpsCurrencyId i:nil="true"/>
                  </b:OpsCurrencyIdentity>
                  <b:EnabledForCostcardsFlag>true</b:EnabledForCostcardsFlag>
                  <b:EnabledForProjectsFlag>true</b:EnabledForProjectsFlag>
                  <b:EnabledForResourcesFlag>true</b:EnabledForResourcesFlag>
                  <b:EnabledForTimecardsFlag>true</b:EnabledForTimecardsFlag>
               </b:PwsLocationSummary>
               <b:PwsLocationSummary>
                  <b:LocationId i:nil="true"/>
                  <b:LocationName>London</b:LocationName>
                  <b:LocationUid>1152921504606850976</b:LocationUid>
                  <b:CurrencyIdentity>
                     <b:CurrencyCode>GBP</b:CurrencyCode>
                     <b:CurrencyId i:nil="true"/>
                     <b:CurrencyUid>1152921504606849882</b:CurrencyUid>
                  </b:CurrencyIdentity>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:MileageUom>M</b:MileageUom>
                  <b:OpsCurrencyIdentity>
                     <b:OpsCurrencyCode>GBP</b:OpsCurrencyCode>
                     <b:OpsCurrencyId i:nil="true"/>
                  </b:OpsCurrencyIdentity>
                  <b:EnabledForCostcardsFlag>true</b:EnabledForCostcardsFlag>
                  <b:EnabledForProjectsFlag>true</b:EnabledForProjectsFlag>
                  <b:EnabledForResourcesFlag>false</b:EnabledForResourcesFlag>
                  <b:EnabledForTimecardsFlag>true</b:EnabledForTimecardsFlag>
               </b:PwsLocationSummary>
            </a:Locations>
         </PwsGetLocationsResult>
      </PwsGetLocationsResponse>
   </s:Body>
</s:Envelope>

Example 02 - with location identity

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetLocationsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetLocationsResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-13T15:39:07.5601224Z</ServerTimestampUtc>
            <a:Locations xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsLocationSummary>
                  <b:LocationId i:nil="true"/>
                  <b:LocationName>London</b:LocationName>
                  <b:LocationUid>1152921504606850976</b:LocationUid>
                  <b:CurrencyIdentity>
                     <b:CurrencyCode>GBP</b:CurrencyCode>
                     <b:CurrencyId i:nil="true"/>
                     <b:CurrencyUid>1152921504606849882</b:CurrencyUid>
                  </b:CurrencyIdentity>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:MileageUom>M</b:MileageUom>
                  <b:OpsCurrencyIdentity>
                     <b:OpsCurrencyCode>GBP</b:OpsCurrencyCode>
                     <b:OpsCurrencyId i:nil="true"/>
                  </b:OpsCurrencyIdentity>
                  <b:EnabledForCostcardsFlag>true</b:EnabledForCostcardsFlag>
                  <b:EnabledForProjectsFlag>true</b:EnabledForProjectsFlag>
                  <b:EnabledForResourcesFlag>false</b:EnabledForResourcesFlag>
                  <b:EnabledForTimecardsFlag>true</b:EnabledForTimecardsFlag>
               </b:PwsLocationSummary>
            </a:Locations>
         </PwsGetLocationsResult>
      </PwsGetLocationsResponse>
   </s:Body>
</s:Envelope>

Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
57541	LocationNotFound	Specified location does not exist.
64223	InvalidValueForListType	The specified value for ListType is invalid. Valid values are T for time or C for cost.