Overview

This web service retrieves a list of client summary records (PwsClientSummary), based on specified search criteria (PwsClientRef).

Request Format

PwsGetClientList Request

PwsGetClientListRq
- RequestId: Int32
- SessionTicket: String (50)
- ClientIdentity: PwsClientRef
- IncludeInactiveFlag: Boolean
- MaxRowsToReturn: Int32
- QueryString: String (50)
- LastUpdatedSinceTimestamp: DateTime

Request Elements

Element	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32	No		Click here for more information	1
SessionTicket	String (50)	Yes		Click here for more information	AavFwbZgVb9V4tr3R7BbzQ==
ClientIdentity	PwsClientRef	No		For this service, the caller may specify up to 1 client identity. If a client identity is not specified all clients fitting the criteria will be returned. Click here for more information.
IncludeInactiveFlag	Boolean	No	false	Valid values for this field include "true" or "false". If set to true, inactive clients will be included in the response. This flag is disregarded if a client is specified.	true/false
MaxRowsToReturn	Int32	No		The maximum number of clients to be returned. This flag is disregarded if a client is specified.	100
QueryString	String (50)	No		The clients that are returned will contain the value in this field. This flag is disregarded if a client is specified.	Parent
LastUpdatedSinceTimestamp	DateTime	No		Only clients that have been updated on or after the specified date/time will be retrieved. This flag is disregarded if a client is specified.	2018-01-01

Request Usage Example(s)

Example 01 - Client is not specified

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetClientList>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
            <req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
            <req:MaxRowsToReturn>100</req:MaxRowsToReturn>
            <req:QueryString>Parent</req:QueryString>
            <req:LastUpdatedSinceTimestamp>2018-01-01</req:LastUpdatedSinceTimestamp>
         </pws:serviceRequest>
      </pws:PwsGetClientList>
   </soapenv:Body>
</soapenv:Envelope>

Example 02 - Client is specified

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetClientList>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
            <req:ClientIdentity>
               <com:ClientNumber>C000121</com:ClientNumber>
            </req:ClientIdentity>
            <req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
         </pws:serviceRequest>
      </pws:PwsGetClientList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsClientRs

PwsGetClientListRs
- Messages: PwsMessage
- ResponseId: Int32
- Status: String
- ServerTimestampUtc: DateTime
- Clients: PwsClientSummary [0..infinity]
- ParentClientIdentity: PwsClientRef

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	1
Status	String	Click here for more information	Ok
ServerTimestampUtc	DateTime	Click here for more informaton	2018-01-17T19:52:55.4411759Z
Clients	PwsClientSummary [0..infinity]	The client summary record(s) retrieved by the service. Click here for more information.
ParentClientIdentity	PwsClientRef	The identity of this client's parent, if any. Circular relationships are not permitted (a client cannot be it's own parent, nor can a client's parent refer back to the client as it's parent, and so forth.). Click here for more information.

Response Usage Example(s)

Example 01

 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetClientListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetClientListResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" 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/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-17T19:52:55.4411759Z</ServerTimestampUtc>
            <a:Clients xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsClientSummary>
                  <b:ClientId i:nil="true"/>
                  <b:ClientNumber>C000121</b:ClientNumber>
                  <b:ClientUid>1152921504606998462</b:ClientUid>
                  <b:ClientName>Parent Inc.</b:ClientName>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:ParentClientIdentity i:nil="true"/>
               </b:PwsClientSummary>
               <b:PwsClientSummary>
                  <b:ClientId i:nil="true"/>
                  <b:ClientNumber>C000123</b:ClientNumber>
                  <b:ClientUid>1152921504606998464</b:ClientUid>
                  <b:ClientName>Child Inc.</b:ClientName>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:ParentClientIdentity>
                     <b:ClientId i:nil="true"/>
                     <b:ClientNumber>C000121</b:ClientNumber>
                     <b:ClientUid>1152921504606998462</b:ClientUid>
                  </b:ParentClientIdentity>
               </b:PwsClientSummary>
            </a:Clients>
         </PwsGetClientListResult>
      </PwsGetClientListResponse>
   </s:Body>
</s:Envelope>

PwsGetClientList - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
RowCountExceeded	104	Row count limit exceeded
MaxRowsToReturnOutOfRange	10100	Invalid value specified for MaxRowsToReturn
ViewPermissionDenied	50045	Permission denied
ClientNotFound	57629	Specified client not found
UnexpectedErrorRetrievingClientList	57633	Unexpected error retrieving client list