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

title	PwsGetClientList Request

PwsGetClientListRq
PwsGetClientListRq
- Common Input Elements
- RequestId: Int32
- SessionTicket: String
- ClientIdentity: PwsClientRef
- IncludeInactiveFlag: Boolean
- MaxRowsToReturn: Int32
- QueryString: String (255)
- LastUpdatedSinceTimestamp: dateTimeDateTime

Request Elements

no

Element	Data Type	Required?	Default	Description	Common Input	Common Input Elements	yes	PwsClientRef	PwsClientRef [1]	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 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.
IncludeInactiveFlag	Boolean	noNo	falseValid	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
MaxRowsToReturn	Int32	no	infinite	Maximum No		The maximum number of clients to be returned. This value is disregarded if a client is specified in ClientIdentity.	100
QueryString	String (255)	no	Find all clients matching specified string in client name or client number	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
LastUpdatedSinceTimestamp	DateTime	No		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

language	xml
title	Example 01 - Client is not specified
collapse	true

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/"    <PwsGetClientList>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>
            <req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
            <req:MaxRowsToReturn>100</req:MaxRowsToReturn>
    <ClientIdentity>        <req:QueryString>Parent</req:QueryString>
       <!--ClientId>?</ClientId-->     <req:LastUpdatedSinceTimestamp>2018-01-01</req:LastUpdatedSinceTimestamp>
         </pws:serviceRequest>
      </pws:PwsGetClientList>
   <!--ClientNumber>?</ClientNumber-->
   /soapenv:Body>
</soapenv:Envelope>

Code Block

language	xml
title	Example 02 - Client is specified
collapse	true

<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>
           <!--ClientUid>?</ClientUid--><pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</ClientIdentity>req:SessionTicket>
            <IncludeInactiveFlag>true</IncludeInactiveFlag><req:ClientIdentity>
               <!--MaxRowsToReturn>?</MaxRowsToReturn--><com:ClientNumber>C000121</com:ClientNumber>
            <!--QueryString>?</QueryString-->/req:ClientIdentity>
            <!--LastUpdatedSinceTimestamp>?</LastUpdatedSinceTimestamp--><req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
         </pws:serviceRequest>
      </pws:PwsGetClientList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

Panel

title	PwsClientRs

PwsGetClientListRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- Clients: PwsClientSummary[]

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	RequestStatus	Click here for more information	Ok
ServerTimestampUtc	DateTime	Click here for more informaton	2018-01-17T19:52:55.4411759Z
Clients	PwsClientSummary[]	The client summary record(s) retrieved by the service

Response Usage Example(s)

Code Block

language	xml
title	Example 02 - Client is specified01
collapse	true

 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetClientListResponse  <PwsGetClientList>xmlns="http://projectorpsa.com/PwsProjectorServices/">
          <serviceRequest><PwsGetClientListResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages  <RequestId>1</RequestId>xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId <SessionTicket>AcjOqKSXoUYG3qLkrxKQYw==</SessionTicket>xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <ClientIdentity>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
              <!--ClientId>?</ClientId--<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"/>
               <ClientNumber>Projector PSA</ClientNumber>   <b:ClientNumber>C000121</b:ClientNumber>
                <!--ClientUid>?</ClientUid-->  <b:ClientUid>1152921504606998462</b:ClientUid>
                  <b:ClientName>Parent Inc.</b:ClientName>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:ParentClientIdentity i:nil="true"/>
               </ClientIdentity>/b:PwsClientSummary>
               <b:PwsClientSummary>
                  <b:ClientId i:nil="true"/>
                  <b:ClientNumber>C000123</b:ClientNumber>
                  <IncludeInactiveFlag>true</IncludeInactiveFlag><b:ClientUid>1152921504606998464</b:ClientUid>
                  <!--MaxRowsToReturn>?</MaxRowsToReturn--><b:ClientName>Child Inc.</b:ClientName>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:ParentClientIdentity>
                     <b:ClientId i:nil="true"/>
               <!--QueryString>?</QueryString-->      <b:ClientNumber>C000121</b:ClientNumber>
                     <b:ClientUid>1152921504606998462</b:ClientUid>
                  </b:ParentClientIdentity>
               </b:PwsClientSummary>
            <!--LastUpdatedSinceTimestamp>?</LastUpdatedSinceTimestamp-->a:Clients>
         </serviceRequest>PwsGetClientListResult>
      </PwsGetClientList>

Response Format

Panel

title	PwsClientRs

PwsGetClientListRs
- Common Output Elements
- Clients: PwsClientSummary [0..infinity]
- ParentClientIdentity: /wiki/spaces/QA/pages/11796518

Response Elements

...

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
104	RowCountExceeded	Row count limit exceeded
10100	MaxRowsToReturnOutOfRange	Invalid value specified for MaxRowsToReturn
50045	ViewPermissionDenied	Permission denied
57629	ClientNotFound	Specified client not found
57633	UnexpectedErrorRetrievingClientList	Unexpected error retrieving client list

Version	Old Version 12	New Version Current
Changes made by	Bettina Borces	Bettina Borces
Saved on	Dec 26, 2017	Apr 04, 2018

Versions Compared

Key

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

Response Format

Response Elements

PwsGetClientList - Common Errors and Warnings

Page Comparison

Versions Compared

Key

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

Response Format

Response Elements

PwsGetClientList - Common Errors and Warnings