Versions Compared

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

Request Format

Panel
titlePwsGetCompanyList Request


Request Elements

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

 

 

Click here for more information.

 

SessionTicket

String

 

 

Click here for more information.

 

CompanyIdentity

PwsCompanyRef

 

 

 

 

MaxRowsToReturn

Int32

 

 

 

 

QueryString

String

 

 

 

 

Request Usage Example(s)


Code Block
languagexml
titleExample 01 - Client is not specified
collapsetrue


Response Format

Panel
titlePwsGetCompanyList Response


Response Elements

Element

Data Type

Description

Sample Data

Messages

PwsMessage

 

 

ResponseId

Int32

Click here for more information.

 

Status

RequestStatus

Click here for more information.

 

ServerTimestampUtc

DateTime

Click here for more information.

 

Companies

PwsCompanySummary

 

 

Response Usage Example(s)

...