Versions Compared

Version Old Version 41 New Version Current
Changes made by

Bettina Borces

Bettina Borces

Saved on

Key

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

...

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

Request Format


Panel
titlePwsGetClientList Request

...

ElementData TypeRequired?DefaultDescriptionSample Data
RequestIdInt32No
Click here for more information
1
SessionTicketString (50)YesPwsClientRef
PwsClientRef [1]Click here for more information
AavFwbZgVb9V4tr3R7BbzQ==
ClientIdentityPwsClientRefNo
For this service, the caller may specify up to 1 client identitya 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.
IncludeInactiveFlagBooleanNofalseValid 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
MaxRowsToReturnInt32Noinfinite
Maximum The maximum number of clients to be returnedQueryStringStringNoFind all clients matching specified string in client name or client numberLastUpdatedSinceTimestampDateTimeNoOnly clients that . This value is disregarded if a client is specified in ClientIdentity.
100
QueryStringString (255)No
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 is not specified
collapsetrue
      <PwsGetClientList>
         <serviceRequest>
            <RequestId>1</RequestId>
            <SessionTicket>AcjOqKSXoUYG3qLkrxKQYw==</SessionTicket>
            <ClientIdentity>
   <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>
 <!--ClientId>?</ClientId-->                <!--ClientNumber>?</ClientNumber--><req:RequestId>1</req:RequestId>
               <!--ClientUid>?</ClientUid--><req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
            </ClientIdentity><req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
            <IncludeInactiveFlag>true</IncludeInactiveFlag><req:MaxRowsToReturn>100</req:MaxRowsToReturn>
            <!--MaxRowsToReturn>?</MaxRowsToReturn--><req:QueryString>Parent</req:QueryString>
            <!<req:LastUpdatedSinceTimestamp>2018-01-QueryString>?</QueryString-->01</req:LastUpdatedSinceTimestamp>
            <!--LastUpdatedSinceTimestamp>?</LastUpdatedSinceTimestamp-->/pws:serviceRequest>
         </serviceRequest>pws:PwsGetClientList>
     </soapenv:Body>
</PwsGetClientList>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/"    <PwsGetClientList>xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetClientList>
  <serviceRequest>       <pws:serviceRequest>
            <RequestId>1<<req:RequestId>1</req:RequestId>
            <SessionTicket>AcjOqKSXoUYG3qLkrxKQYw<req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
            <ClientIdentity><req:ClientIdentity>
               <!--ClientId>?</ClientId--><com:ClientNumber>C000121</com:ClientNumber>
               <ClientNumber>Projector PSA</ClientNumber></req:ClientIdentity>
               <!--ClientUid>?</ClientUid-->
  <req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
         </ClientIdentity>pws:serviceRequest>
      </pws:PwsGetClientList>
     <IncludeInactiveFlag>true</IncludeInactiveFlag>
            <!--MaxRowsToReturn>?</MaxRowsToReturn-->
            <!--QueryString>?</QueryString-->
            <!--LastUpdatedSinceTimestamp>?</LastUpdatedSinceTimestamp-->
         </serviceRequest>
      </PwsGetClientList>

Response Format

Panel
titlePwsClientRs

Response Elements

...

Response Usage Example(s)

Code Block
languagexml
titleExample 01 - Client is not specified
collapsetrue
      <PwsGetClientListResponse>
         <PwsGetClientListResult>
            <Messages>
               <PwsMessage>
                  <AdditionalErrorText i:nil="true"/>
                  <ErrorCode i:nil="true"/>
                  <ErrorNumber i:nil="true"/>
                  <ErrorText i:nil="true"/>
                  <Type i:nil="true"/>
                  <ReferenceId1 i:nil="true"/>
                  <ReferenceId2 i:nil="true"/>
               </PwsMessage>
            </Messages>
            <ResponseId>1</ResponseId>
            <Status>Ok</Status>
            <ServerTimestampUtc>2017-12-27T18:23:22.3881313Z</ServerTimestampUtc>
            <Clients>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>Air Acme<ClientNumber>
                  <ClientUid>1152921504606949187<ClientUid>
                  <ClientName>Air Canada<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity>
                     <ClientId i:nil="true"/>
                     <ClientNumber>Constellation Acme<ClientNumber>
                     <ClientUid>1152921504606956489<ClientUid>
                  </ParentClientIdentity>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>River<ClientNumber>
                  <ClientUid>1152921504606971723<ClientUid>
                  <ClientName>River<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>FR123<ClientNumber>
                  <ClientUid>1152921504606973698<ClientUid>
                  <ClientName>Fruits and Chocolates<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>RI123<ClientNumber>
                  <ClientUid>1152921504606949188<ClientUid>
                  <ClientName>Realty Inc.<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>D545<ClientNumber>
                  <ClientUid>1152921504606968450<ClientUid>
                  <ClientName>Dogs Dogs Dogs<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>C000109<ClientNumber>
                  <ClientUid>1152921504606971245<ClientUid>
                  <ClientName>Sound Shack<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>C000110<ClientNumber>
                  <ClientUid>1152921504606973604<ClientUid>
                  <ClientName>Platinum Service<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>C000112<ClientNumber>
                  <ClientUid>1152921504606980895<ClientUid>
                  <ClientName>Temperate Destinations<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>C000113<ClientNumber>
                  <ClientUid>1152921504606987273<ClientUid>
                  <ClientName>R17-B14<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>C000114<ClientNumber>
                  <ClientUid>1152921504606987286<ClientUid>
                  <ClientName>R17-B17<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>C000115<ClientNumber>
                  <ClientUid>1152921504606989357<ClientUid>
                  <ClientName>S-Miles Corporation<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>C000116<ClientNumber>
                  <ClientUid>1152921504606989620<ClientUid>
                  <ClientName>Cat World<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>C000118<ClientNumber>
                  <ClientUid>1152921504606989807<ClientUid>
                  <ClientName>Acme 100<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>C000119<ClientNumber>
                  <ClientUid>1152921504606989815<ClientUid>
                  <ClientName>Hedgehog Gardening<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>C001000<ClientNumber>
                  <ClientUid>1152921504606989813<ClientUid>
                  <ClientName>Acme 1000-01<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity>
                     <ClientId i:nil="true"/>
                     <ClientNumber>C000118<ClientNumber>
                     <ClientUid>1152921504606989807<ClientUid>
                  </ParentClientIdentity>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>C001001<ClientNumber>
                  <ClientUid>1152921504606989814<ClientUid>
                  <ClientName>Acme 1000-02<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>CL0009<ClientNumber>
                  <ClientUid>1152921504606984049<ClientUid>
                  <ClientName>Target<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>CL0010<ClientNumber>
                  <ClientUid>1152921504606984050<ClientUid>
                  <ClientName>W6 Airlines<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>Projector PSA<ClientNumber>
                  <ClientUid>1152921504606961482<ClientUid>
                  <ClientName>Projector PSA<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>revcorp-bb<ClientNumber>
                  <ClientUid>1152921504606944619<ClientUid>
                  <ClientName>revcorp-bb<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>C736718<ClientNumber>
                  <ClientUid>1152921504606967386<ClientUid>
                  <ClientName>Concrete Research and Development<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>12938028212<ClientNumber>
                  <ClientUid>1152921504606960351<ClientUid>
                  <ClientName>Constellations Inc.<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>12938028213<ClientNumber>
                  <ClientUid>1152921504606966758<ClientUid>
                  <ClientName>Orion Inc.<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity>
                     <ClientId i:nil="true"/>
                     <ClientNumber>12938028212<ClientNumber>
                     <ClientUid>1152921504606960351<ClientUid>
                  </ParentClientIdentity>
               </PwsClientSummary>
               <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>12938028214<ClientNumber>
                  <ClientUid>1152921504606966759<ClientUid>
                  <ClientName>Milky Way Inc.<ClientName>
                  <InactiveFlag>false<InactiveFlag>
                  <ParentClientIdentity>
                     <ClientId i:nil="true"/>
           </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/">
         <ClientNumber>12938028212<ClientNumber>
                     <ClientUid>1152921504606960351<ClientUid>
 <PwsGetClientListResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages    </ParentClientIdentity>
xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId  </PwsClientSummary>xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status </Clients>
         </PwsGetClientListResult>
      </PwsGetClientListResponse>
Code Block
languagexml
titleExample 02 - Client is specified
collapsetrue
xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
         <PwsGetClientListResponse>   <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-17T19:52:55.4411759Z</ServerTimestampUtc>
     <PwsGetClientListResult>       <a:Clients xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
    <Messages>           <b:PwsClientSummary>
    <PwsMessage>                   <AdditionalErrorText <b:ClientId i:nil="true"/>
                  <ErrorCode i:nil="true"/><b:ClientNumber>C000121</b:ClientNumber>
                  <ErrorNumber i:nil="true"/><b:ClientUid>1152921504606998462</b:ClientUid>
                  <ErrorText i:nil="true"/><b:ClientName>Parent Inc.</b:ClientName>
                  <Type i:nil="true"/><b:InactiveFlag>false</b:InactiveFlag>
                  <ReferenceId1<b:ParentClientIdentity i:nil="true"/>
               </b:PwsClientSummary>
     <ReferenceId2 i:nil="true"/>         <b:PwsClientSummary>
      </PwsMessage>             </Messages>
<b:ClientId i:nil="true"/>
           <ResponseId>1</ResponseId>       <b:ClientNumber>C000123</b:ClientNumber>
     <Status>Ok</Status>             <ServerTimestampUtc>2017-12-27T18:23:22.3881313Z</ServerTimestampUtc><b:ClientUid>1152921504606998464</b:ClientUid>
              <Clients>    <b:ClientName>Child Inc.</b:ClientName>
          <PwsClientSummary>        <b:InactiveFlag>false</b:InactiveFlag>
          <ClientId i:nil="true"/>       <b:ParentClientIdentity>
           <ClientNumber>Projector PSA</ClientNumber>         <b:ClientId i:nil="true"/>
        <ClientUid>1152921504606961482</ClientUid>             <b:ClientNumber>C000121</b:ClientNumber>
     <ClientName>Projector PSA</ClientName>                   <InactiveFlag>false</InactiveFlag><b:ClientUid>1152921504606998462</b:ClientUid>
                  <ParentClientIdentity i:nil="true"/></b:ParentClientIdentity>
               </b:PwsClientSummary>
            </a:Clients>
         </PwsGetClientListResult>
      </PwsGetClientListResponse>
   </s:Body>
</s:Envelope>

PwsGetClientList - Common Errors and Warnings

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