Versions Compared

Key

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

...

Code Block
languagexml
titleExample 01 - no company identity
collapsetrue
<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:MaxRowsToReturn>2</req:MaxRowsToReturn>
            <req:QueryString>Revo</req:QueryString>
         </pws:serviceRequest>
      </pws:PwsGetCompanyList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

Panelcode

Response Usage Example(s)

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsGetCompanyListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
Code Block
languagexml
titleExample 01 - no company identity
collapsetrue
languagexml
titlePwsGetCompanyList Response

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

...

Ok

...

ServerTimestampUtc

...

DateTime

...

Click here for more information.

...

2018-03-12T19:05:15.1551043Z

...

Companies

...

PwsCompanySummary

...

The company summary record(s) retrieved by the service. Click here for more information.

Example 02 - use company identity
collapsetrue
<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
titlePwsGetCompanyList Response


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

StatusRequestStatusClick here for more information
Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-12T19:05:15.1551043Z

Companies

PwsCompanySummary

The company summary record(s) retrieved by the service. Click here for more information.


Response Usage Example(s)


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

Common Errors and Warnings

...