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
- RequestId: Int32
- SessionTicket: String
- ClientIdentity: PwsClientRef
- IncludeInactiveFlag: Boolean
- MaxRowsToReturn: Int32
- QueryString: String (255)
- LastUpdatedSinceTimestamp: dateTime

This request also includes the Common Input Elements

Request Elements

- DateTime

Request Elements

Valid values for this field include "true" or "false". If set to true

Element	Data Type	Required?	Default	Description	PwsClientRef	PwsClientRef [1]	no	IncludeInactiveFlag	Boolean	no	false	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	No	false	If set to 'true', inactive clients will be included in the response. MaxRowsToReturn 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

Usage Example(s)

...

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

...

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/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetClientList>
         <pws:serviceRequest>
 <!--ClientId>?</ClientId-->           <req:RequestId>1</req:RequestId>
     <!--ClientNumber>?</ClientNumber-->       <req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
        <!--ClientUid>?</ClientUid-->    <req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
        </ClientIdentity>    <req:MaxRowsToReturn>100</req:MaxRowsToReturn>
            <IncludeInactiveFlag>true</IncludeInactiveFlag><req:QueryString>Parent</req:QueryString>
            <!<req:LastUpdatedSinceTimestamp>2018-01-MaxRowsToReturn>?</MaxRowsToReturn-->
  01</req:LastUpdatedSinceTimestamp>
         <!--QueryString>?</QueryString-->pws:serviceRequest>
       </pws:PwsGetClientList>
    <!--LastUpdatedSinceTimestamp>?</LastUpdatedSinceTimestamp-->
         </serviceRequest>
      </PwsGetClientList></soapenv:Body>
</soapenv:Envelope>

Code Block

language	xml
title	Example 02 - Client is specified
collapse	true

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

Response Format

Panel

title	PwsClientRs

PwsGetClientListRs
- ClientsMessages: PwsClientSummary PwsMessage[0..infinity]
- ParentClientIdentity: /wiki/spaces/QA/pages/11796518

...

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

Response Elements

Clients

Element	Data Type	Description	Sample Data	PwsClientSummary	Client Summary Record(s) retrieved by the service

Usage Example(s)

...

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

...

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 01
collapse	true

 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetClientListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetClientListResult      <PwsClientSummary>xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages       <ClientId i:nil="true"/>
          xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
       <ClientNumber>12938028213<ClientNumber>     <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <ClientUid>1152921504606966758<ClientUid>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
                 <ClientName>Orion Inc.<ClientName><ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-17T19:52:55.4411759Z</ServerTimestampUtc>
            <a:Clients xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
    <InactiveFlag>false<InactiveFlag>           <b:PwsClientSummary>
       <ParentClientIdentity>                      <ClientId <b:ClientId i:nil="true"/>
                  <b:ClientNumber>C000121</b:ClientNumber>
  <ClientNumber>12938028212<ClientNumber>                <b:ClientUid>1152921504606998462</b:ClientUid>
     <ClientUid>1152921504606960351<ClientUid>             <b:ClientName>Parent Inc.</b:ClientName>
    </ParentClientIdentity>                </PwsClientSummary><b:InactiveFlag>false</b:InactiveFlag>
               <PwsClientSummary>   <b:ParentClientIdentity i:nil="true"/>
              <ClientId i:nil="true"/></b:PwsClientSummary>
               <b:PwsClientSummary>
  <ClientNumber>12938028214<ClientNumber>                <b:ClientId i:nil="true"/>
 <ClientUid>1152921504606966759<ClientUid>                 <b:ClientNumber>C000123</b:ClientNumber>
 <ClientName>Milky Way Inc.<ClientName>               <b:ClientUid>1152921504606998464</b:ClientUid>
   <InactiveFlag>false<InactiveFlag>               <b:ClientName>Child Inc.</b:ClientName>
  <ParentClientIdentity>                 <b:InactiveFlag>false</b:InactiveFlag>
    <ClientId i:nil="true"/>             <b:ParentClientIdentity>
        <ClientNumber>12938028212<ClientNumber>             <b:ClientId i:nil="true"/>
       <ClientUid>1152921504606960351<ClientUid>              <b:ClientNumber>C000121</b:ClientNumber>
     </ParentClientIdentity>                </PwsClientSummary>
<b:ClientUid>1152921504606998462</b:ClientUid>
           </Clients>

Code Block

language	xml
title	Example 02 - Client is specified
collapse	true

<Clients>       <PwsClientSummary></b:ParentClientIdentity>
      <ClientId i:nil="true"/>       <ClientNumber>Projector PSA<ClientNumber></b:PwsClientSummary>
      <ClientUid>1152921504606961482<ClientUid>      </a:Clients>
<ClientName>Projector PSA<ClientName>       <InactiveFlag>false<InactiveFlag> </PwsGetClientListResult>
     <ParentClientIdentity i:nil="true"/> </PwsGetClientListResponse>
   </PwsClientSummary>s:Body>
</Clients>s:Envelope>

PwsGetClientList - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorNumber
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 21	New Version Current
Changes made by	Bettina Borces	Bettina Borces
Saved on	Dec 27, 2017	Apr 04, 2018

Versions Compared

Key

Request Format

Request Elements

Request Elements

Usage Example(s)

Request Usage Example(s)

Response Format

Response Elements

Usage Example(s)

Response Usage Example(s)

PwsGetClientList - Common Errors and Warnings

Page Comparison

Versions Compared

Key

Request Format

Request Elements

Request Elements

Usage Example(s)

Request Usage Example(s)

Response Format

Response Elements

Usage Example(s)

Response Usage Example(s)

PwsGetClientList - Common Errors and Warnings