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

Request Format

Panel

title	PwsGetCompanyList Request

PwsGetCompanyList
- serviceRequest: PwsGetCompanyListRq
  - RequestId: Int32
  - SessionTicket: String
  - CompanyIdentity: PwsCompanyRef
  - MaxRowsToReturn: Int32
  - QueryString: String (255)

...

Element	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32	No		Click here for more information.
SessionTicket	String	Yes		Click here for more information.	ATtU220EvBSE2+GCN9U58g==
CompanyIdentity	PwsCompanyRef	No	MaxRowsToReturn	Int32	No	QueryString	String (255)	No

Request Usage Example(s)

...

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

...

For this service, the caller may specify a company identity to retrieve a specific company summary. If the identity is not specified, all companies fitting the other specified criteria will be returned. Click here for more information.
MaxRowsToReturn	Int32	No	The maximum number of records to be returned. This value is disregarded if a company is specified in CompanyIdentity.
QueryString	String (255)	No	A search string to narrow down the results. A company will be included in the results if the search string matches the company name or number. This value is disregarded if a company is specified in CompanyIdentity.

Request Usage Example(s)

Code Block

language	xml
title	Example 01 - no company identity
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:Body>Header/>
   <soapenv:Body>
      <pws:PwsGetCompanyList>
         <pws:serviceRequest>
            <req:SessionTicket>ATtU220EvBSE2+GCN9U58g==</req:SessionTicket>
            <req:MaxRowsToReturn>2</req:MaxRowsToReturn>
            <req:QueryString>Revo</req:QueryString>
         </pws:serviceRequest>
      </pws:PwsGetCompanyList>
   </soapenv:Body>
</soapenv:Envelope>

Code Block

...

panel

language

...

ServerTimestampUtc

...

DateTime

...

Click here for more information.

...

Companies

...

PwsCompanySummary

Response Usage Example(s)

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsGetCompanyListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">

Code Block

language	xml
title	Example 01
collapse	true

xml
title	PwsGetCompanyList Response

PwsGetCompanyListResponse
- PwsGetCompanyListResult: PwsGetCompanyListRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Companies: PwsCompanySummary

Response Elements

...

Element

...

Data Type

...

Description

...

Sample Data

...

Messages

...

PwsMessage

...

ResponseId

...

Int32

...

Click here for more information.

...

Ok

Example 02 - use company identity
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:PwsGetCompanyList>
         <pws:serviceRequest>
            <req:SessionTicket>ATtU220EvBSE2+GCN9U58g==</req:SessionTicket>
            <req:CompanyIdentity>
               <com:CompanyNumber>003</com:CompanyNumber>
            </req:CompanyIdentity>
         </pws:serviceRequest>
      </pws:PwsGetCompanyList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

Panel

title	PwsGetCompanyList Response

PwsGetCompanyListResponse
- PwsGetCompanyListResult: PwsGetCompanyListRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Companies: PwsCompanySummary[]

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.	0
Status	RequestStatus	Click here for more information	Ok
ServerTimestampUtc	DateTime	Click here for more information.	2018-03-12T19:05:15.1551043Z
Companies	PwsCompanySummary[]	The company summary records retrieved by the service. Click here for more information.

Response Usage Example(s)

Code Block

language	xml
title	Example 01 - no company identity
collapse	true

 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetCompanyListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetCompanyListResult xmlns:a="http://projectorpsa.com/DataContracts/Requests/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsMessage>
                  <b:AdditionalErrorText>Warning 104: {oldestSurvivingTimeCardWorkDateString}</b:AdditionalErrorText>
                  <b:ErrorCode>RowCountExceeded</b:ErrorCode>
                  <b:ErrorNumber>104</b:ErrorNumber>
                  <b:ErrorText>Not all data rows were returned by this request because the specified row count was smaller than the total number of rows available.</b:ErrorText>
                  <b:Type>Warning</b:Type>
               </b:PwsMessage>
            </Messages>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-12T19:05:15.1551043Z</ServerTimestampUtc>
            <a:Companies xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsCompanySummary>
                  <b:CompanyId i:nil="true"/>
                  <b:CompanyName>Revolutionary Solutions Corporation  US</b:CompanyName>
                  <b:CompanyUid>1152921504606852296</b:CompanyUid>
                  <b:CompanyNumber>001</b:CompanyNumber>
                  <b:Currency>
                     <b:CurrencyCode>USD</b:CurrencyCode>
       <PwsGetCompanyListResult xmlns:a="http://projectorpsa.com/DataContracts/Requests/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/" <b:CurrencyId i:nil="true"/>
                     <b:PwsMessage>
:CurrencyUid>1152921504606849879</b:CurrencyUid>
                 <b:AdditionalErrorText>Warning 104: {oldestSurvivingTimeCardWorkDateString}</b:AdditionalErrorText>Currency>
                  <b:ErrorCode>RowCountExceeded</b:ErrorCode>:TaxType1 i:nil="true"/>
                  <b:ErrorNumber>104</b:ErrorNumber>TaxType2 i:nil="true"/>
                  <b:ErrorText>Not all data rows were returned by this request because the specified row count was smaller than the total number of rows available.TaxType3 i:nil="true"/>
               </b:ErrorText>PwsCompanySummary>
                  <b:Type>Warning</b:Type>PwsCompanySummary>
               </b:PwsMessage>   <b:CompanyId i:nil="true"/>
        </Messages>           <b:CompanyName>Revolutionary Solutions <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>Corporation CA</b:CompanyName>
                 <Status xmlns="http<b://projectorpsa.com/CommonServices/">Ok</Status>CompanyUid>1152921504606852299</b:CompanyUid>
                 <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-12T19:05:15.1551043Z</ServerTimestampUtc> <b:CompanyNumber>002</b:CompanyNumber>
                  <a:Companies xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"><b:Currency>
                      <b:CurrencyCode>CAD</b:CurrencyCode>
  <b:PwsCompanySummary>                   <b:CompanyIdCurrencyId i:nil="true"/>
                  <b:CompanyName>Revolutionary Solutions Corporation  US<<b:CurrencyUid>1152921504606849881</b:CompanyName>CurrencyUid>
                  <b:CompanyUid>1152921504606852296<</b:CompanyUid>Currency>
                  <b:CompanyNumber>001</b:CompanyNumber>TaxType1>
                     <b:TaxTypeCode>GSTCA</b:Currency>TaxTypeCode>
                     <b:CurrencyCode>USD</b:CurrencyCode>:TaxTypeId i:nil="true"/>
                     <b:CurrencyId i:nil="true"/><b:TaxTypeUid>1152921504606859965</b:TaxTypeUid>
                     <b:CurrencyUid>1152921504606849879<AppliesToCostFlag>true</b:CurrencyUid>AppliesToCostFlag>
                     <<b:AppliesToMilestonesFlag>true</b:Currency>AppliesToMilestonesFlag>
                     <b:TaxType1 i:nil="true"/>AppliesToTimeFlag>true</b:AppliesToTimeFlag>
                     <b:TaxType2 i:nil="true"/>InactiveFlag>false</b:InactiveFlag>
                     <b:TaxType3 i:nil="true"/>TaxTypeName>Canada Goods &amp; Services Tax</b:TaxTypeName>
                  </b:PwsCompanySummary>TaxType1>
                  <b:PwsCompanySummary>TaxType2>
                     <b:CompanyId i:nil="true"/>:TaxTypeCode>HSTCA</b:TaxTypeCode>
                     <b:CompanyName>Revolutionary Solutions Corporation CA</b:CompanyName>:TaxTypeId i:nil="true"/>
                     <b:CompanyUid>1152921504606852299<TaxTypeUid>1152921504606859966</b:CompanyUid>TaxTypeUid>
                     <b:CompanyNumber>002<AppliesToCostFlag>true</b:CompanyNumber>AppliesToCostFlag>
                     <b:AppliesToMilestonesFlag>true</b:Currency>AppliesToMilestonesFlag>
                     <b:CurrencyCode>CAD<AppliesToTimeFlag>true</b:CurrencyCode>AppliesToTimeFlag>
                     <b:CurrencyId i:nil="true"/>InactiveFlag>false</b:InactiveFlag>
                     <b:CurrencyUid>1152921504606849881<TaxTypeName>Canada Harmonized Sales Tax</b:CurrencyUid>TaxTypeName>
                  </b:Currency>TaxType2>
                  <b:TaxType1>TaxType3>
                     <b:TaxTypeCode>GSTCA<TaxTypeCode>PSTQU</b:TaxTypeCode>
                     <b:TaxTypeId i:nil="true"/>
                     <b:TaxTypeUid>1152921504606859965<TaxTypeUid>1152921504606859971</b:TaxTypeUid>
                     <b:AppliesToCostFlag>true</b:AppliesToCostFlag>
                     <b:AppliesToMilestonesFlag>true</b:AppliesToMilestonesFlag>
                     <b:AppliesToTimeFlag>true</b:AppliesToTimeFlag>
                     <b:InactiveFlag>false</b:InactiveFlag>
                     <b:TaxTypeName>CanadaTaxTypeName>Quebec GoodsProvincial &amp;Sales Services Tax</b:TaxTypeName>
                  </b:TaxType1>TaxType3>
               </b:PwsCompanySummary>
            <b:TaxType2></a:Companies>
         </PwsGetCompanyListResult>
      </PwsGetCompanyListResponse>
   </s:Body>
</s:Envelope>
 <b:TaxTypeCode>HSTCA</b:TaxTypeCode>

Code Block

language	xml
title	Example 02 - use company identity
collapse	true

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetCompanyListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
          <b:TaxTypeId i:nil="true"/<PwsGetCompanyListResult xmlns:a="http://projectorpsa.com/DataContracts/Requests/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages         <b:TaxTypeUid>1152921504606859966</b:TaxTypeUid>
  xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <b:AppliesToCostFlag>true</b:AppliesToCostFlag><ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
                 <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
   <b:AppliesToMilestonesFlag>true</b:AppliesToMilestonesFlag>         <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-12T19:19:47.5775428Z</ServerTimestampUtc>
            <b:AppliesToTimeFlag>true</b:AppliesToTimeFlag>
     <a:Companies xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:InactiveFlag>false</b:InactiveFlag>PwsCompanySummary>
                     <b:TaxTypeName>Canada Harmonized Sales Tax</b:TaxTypeName><b:CompanyId i:nil="true"/>
                  <b:CompanyName>Revolutionary Solutions Corporation <China</b:TaxType2>CompanyName>
                  <b:TaxType3>
  :CompanyUid>1152921504606852297</b:CompanyUid>
                  <b:TaxTypeCode>PSTQU<CompanyNumber>003</b:TaxTypeCode>
  CompanyNumber>
                  <b:TaxTypeId i:nil="true"/>Currency>
                      <b:TaxTypeUid>1152921504606859971<CurrencyCode>CNY</b:TaxTypeUid>CurrencyCode>
                     <b:AppliesToCostFlag>true</b:AppliesToCostFlag>:CurrencyId i:nil="true"/>
                     <b:AppliesToMilestonesFlag>true<CurrencyUid>1152921504606849973</b:AppliesToMilestonesFlag>CurrencyUid>
                     <b:AppliesToTimeFlag>true<</b:AppliesToTimeFlag>Currency>
                     <b:InactiveFlag>false</b:InactiveFlag>
 <b:TaxType1 i:nil="true"/>
                   <b:TaxTypeName>Quebec Provincial Sales Tax</b:TaxTypeName>TaxType2 i:nil="true"/>
                    </b:TaxType3><b:TaxType3 i:nil="true"/>
               </b:PwsCompanySummary>
            </a:Companies>
         </PwsGetCompanyListResult>
      </PwsGetCompanyListResponse>
   </s:Body>
</s:Envelope>

PwsGetCompanyList - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
57339	CompanyNotFound	The specified company was not found.

Versions Compared

Old Version 4

New Version Current

Key

Request Format

Request Usage Example(s)

Request Usage Example(s)

Response Usage Example(s)

Response Elements

Response Format

Response Elements

Response Usage Example(s)

PwsGetCompanyList - Common Errors and Warnings

Page Comparison

Versions Compared

Old Version 4

New Version Current

Key

Request Format

Request Usage Example(s)

Request Usage Example(s)

Response Usage Example(s)

Response Elements

Response Format

Response Elements

Response Usage Example(s)

PwsGetCompanyList - Common Errors and Warnings