Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This web service retrieves a list of client summary records (PwsClientSummary), based on specified search criteria. You can specify which client or clients to retrieve either by specifying a set of search criteria, or by specifying a specific client (PwsClientRef). The web service returns a list of clients (PwsClientSummary).


Info
titleRate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm.  When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate.  Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly.  For more information please visit: Projector Rate Limiting Behavior.

Request Format


Panel
titlePwsGetClientList Request


Request Elements


no
ElementData TypeRequired?DefaultDescriptionCommon InputCommon InputyesPwsClientRefPwsClientRef [1]Sample Data
RequestIdInt32No
Click here for more information
1
SessionTicketString (50)Yes
Click here for more information
AavFwbZgVb9V4tr3R7BbzQ==
ClientIdentityPwsClientRefNo
For this service, the caller may specify a client identity to retrieve a specific client summary. If a client identity is not specified all clients fitting the other specified criteria will be returned.
IncludeInactiveFlagBooleannoNofalseValid 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 in ClientIdentity.
true/false
MaxRowsToReturnInt32noinfiniteMaximum No
The maximum number of clients to be returned. This value is disregarded if a client is specified in ClientIdentity.
100
QueryStringString (255)noFind all clients matching specified string in client name or client numberNo
A search string to narrow down the results. A client will be included in the results if the search string matches the client number or client name, or if it is a child to a client that is matched based upon the criteria. This value is disregarded if a client is specified in ClientIdentity.
Parent
LastUpdatedSinceTimestampDateTimeNo
Only clients that have been updated on or after the specified date/time will be retrieved. This value is disregarded if a client is specified in ClientIdentity.
2018-01-01

Request Usage Example(s)


Code Block
languagexml
titleExample 01 - Client Id is not specified
collapsetrue
<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>
      <PwsGetClientList><pws:PwsGetClientList>
         <serviceRequest><pws:serviceRequest>
            <RequestId>1<<req:RequestId>1</req:RequestId>
            <SessionTicket>AcjOqKSXoUYG3qLkrxKQYw<req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
            <req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
            <req:MaxRowsToReturn>100</req:MaxRowsToReturn>
            <req:QueryString>Parent</req:QueryString>
            <!<req:LastUpdatedSinceTimestamp>2018--ClientIdentity>01-01</req:LastUpdatedSinceTimestamp>
         </pws:serviceRequest>
      <ClientId>?</ClientId> </pws:PwsGetClientList>
   </soapenv:Body>
</soapenv:Envelope>


Code Block
languagexml
titleExample 02 - Client is specified
collapsetrue
<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>
      <ClientNumber>?</ClientNumber>      <req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
            <req:ClientIdentity>
               <ClientUid>?</ClientUid><com:ClientNumber>C000121</com:ClientNumber>
            </ClientIdentity-->req:ClientIdentity>
            <req:IncludeInactiveFlag>true<IncludeInactiveFlag>false</req:IncludeInactiveFlag>
         </pws:serviceRequest>
      <!--req:MaxRowsToReturn>?</MaxRowsToReturn-->/pws:PwsGetClientList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


Panel
titlePwsClientRs


Response Elements


ElementData TypeDescriptionSample Data
MessagesPwsMessage[]

The web service response status and message. Click here for more information


ResponseIdInt32Click here for more information
1
StatusRequestStatusClick here for more information
Ok
ServerTimestampUtcDateTimeClick here for more informaton
2018-01-17T19:52:55.4411759Z
ClientsPwsClientSummary[]The client summary record(s) retrieved by the service

Response Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
 <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/"/>
             <!--req:QueryString>?</QueryString--><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"/>
               <!--req:LastUpdatedSinceTimestamp>?</LastUpdatedSinceTimestamp-->/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>
            </serviceRequest>
 a:Clients>
         </PwsGetClientListResult>
      </PwsGetClientListResponse>
    </PwsGetClientList></s:Body>
</s:Envelope>

PwsGetClientList - Common Errors and Warnings

ErrorNumberErrorCodeErrorText
104RowCountExceededRow count limit exceeded
10100MaxRowsToReturnOutOfRangeInvalid value specified for MaxRowsToReturn
50045ViewPermissionDeniedPermission denied
57629ClientNotFoundSpecified client not found
57633UnexpectedErrorRetrievingClientListUnexpected error retrieving client list