Versions Compared

Version Old Version 94 New Version Current
Changes made by

Bettina Borces

Bettina Borces

Saved on

Key

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

...

ElementData TypeRequired?DefaultDescriptionSample Data
RequestIdInt32No
Click here for more information
1
SessionTicketString (50)Yes
Click here for more information
AavFwbZgVb9V4tr3R7BbzQATAj5CRx7eosFAdLjFCVyg==
ClientIdentitiesPwsClientRef [1..100]Yes
These are the identities of the clients to be fetched.

Request Usage Example(s)


Code Block
languagexml
titleRequest 01PwsGetClientRq
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:PwsGetClient>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQSessionTicket>ATAj5CRx7eosFAdLjFCVyg==</req:SessionTicket>
            <req:ClientIdentities>
               <com:PwsClientRef>
                  <com:ClientNumber>C000121<ClientNumber>C000158</com:ClientNumber>
               </com:PwsClientRef>
            </req:ClientIdentities>
         </pws:serviceRequest>
      </pws:PwsGetClient>
   </soapenv:Body>
</soapenv:Envelope>


Response Format


Panel
titlePwsGetClientRs


Response Elements

...

ElementData TypeDescriptionSample Data
MessagesPwsMessage[]

The web service response status and message. Click here for more information.


ResponseIdInt32Click here for more information1
StatusRequestStatusClick here for more informationOk
ServerTimestampUtcDateTimeClick here for more information
20182023-0111-17T1906T18:3817:4957.0775059Z6501708Z
ClientsPwsClientDetail PwsClientElement [0..100]Details of the clients that were fetched

...

Code Block
languagexml
titleExample 01PwsGetClientRs
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetClientResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetClientResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>  <b:PwsMessage>
          <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>       <b:AdditionalErrorText>Message 136: This request was executed against the <ServerTimestampUtc xmlns="http://QA [appqa.projectorpsa.com/CommonServices/">2018-01-17T19:38:49.0775059Z</ServerTimestampUtc>] environment.</b:AdditionalErrorText>
                 <a:Clients xmlns<b:ErrorCode>NonProductionEnvironment</b="http://projectorpsa.com/DataContracts/Shared/Common/">:ErrorCode>
                  <b:ErrorNumber>136</b:PwsClientElement>ErrorNumber>
                  <b:ClientDetail>
      ErrorText>This web service request was executed against a non-production instance of Projector.</b:ErrorText>
              <b:ClientId i:nil="true"/>   <b:Type>Information</b:Type>
                  <b:ClientNumber>C000121</b:ClientNumber>:ReferenceId1 i:nil="true"/>
                     <b:ClientUid>1152921504606998462</b:ClientUid><b:ReferenceId2 i:nil="true"/>
               </b:PwsMessage>
     <b:ClientName>Parent Inc.</b:ClientName>       </Messages>
              <b:InactiveFlag>false</b:InactiveFlag><ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
                     <b:ParentClientIdentity i:nil="true"/><Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
                     <b:Address>
                        <b:AddressLine1>100 Main Street</b:AddressLine1>
                        <b:AddressLine2 i:nil="true"/>
                        <b:Attention>Finance</b:Attention>
                        <b:City>Boston</b:City>
                        <b:CompanyName>Acme 1000</b:CompanyName>
                        <b:Country>USA</b:Country>
                        <b:StateOrProvince>MA</b:StateOrProvince>
                        <b:ZipOrPostalCode>02114</b:ZipOrPostalCode>
                     </b:Address>
                     <b:BillingCycleIdentity>
                        <b:BillingCycleId i:nil="true"/>
                        <b:BillingCycleName>Monthly</b:BillingCycleName>
                        <b:BillingCycleUid>1152921504606853180</b:BillingCycleUid>
                     </b:BillingCycleIdentity>
                     <b:BillingInstructions>Please bill this client at the end of each month.</b:BillingInstructions>
                     <b:ClientMessage>We appreciate your business!</b:ClientMessage>
                     <b:ClientMessagePlain>We appreciate your business!</b:ClientMessagePlain>
                     <b:InheritAddressFlag>false</b:InheritAddressFlag>
                     <b:InheritBillingCycleFlag>false</b:InheritBillingCycleFlag>
                     <b:InheritBillingInstructionsFlag>false</b:InheritBillingInstructionsFlag>
                     <b:InheritClientMessageFlag>false</b:InheritClientMessageFlag>
                     <b:InheritInvoiceContentFlag>false</b:InheritInvoiceContentFlag>
                     <b:InheritInvoiceScopeFlag>false</b:InheritInvoiceScopeFlag>
                     <b:InheritInvoiceTemplateFlag>false</b:InheritInvoiceTemplateFlag>
                     <b:InheritPaymentTermFlag>false</b:InheritPaymentTermFlag>
                     <b:InheritPurchaseOrderNumberFlag>false</b:InheritPurchaseOrderNumberFlag>
                     <b:InheritStandardRatesFlag>false</b:InheritStandardRatesFlag>
                     <b:InheritTimeBillingTypeFlag>false</b:InheritTimeBillingTypeFlag>
                     <b:InvoiceContent>B</b:InvoiceContent>
                     <b:InvoiceScope>E</b:InvoiceScope>
                     <b:InvoiceTemplateIdentity>
                        <b:InvoiceTemplateId i:nil="true"/>
                        <b:InvoiceTemplateName>A100</b:InvoiceTemplateName>
                        <b:InvoiceTemplateUid>1152921504606878901</b:InvoiceTemplateUid>
                     </b:InvoiceTemplateIdentity>
                     <b:NewClientNumber i:nil="true"/>
                     <b:PaymentTermIdentity>
                        <b:PaymentTermId i:nil="true"/>
                        <b:PaymentTermName>Net 30</b:PaymentTermName>
                        <b:PaymentTermUid>1152921504606856054</b:PaymentTermUid>
                     </b:PaymentTermIdentity>
                     <b:PurchaseOrderNumber>P-001</b:PurchaseOrderNumber>
                     <b:StandardBillingAdjustedDiscountPercent>5</b:StandardBillingAdjustedDiscountPercent>
                     <b:StandardContractDiscountPercent>10</b:StandardContractDiscountPercent>
                     <b:StandardRateCardIdentity>
                        <b:RateCardId i:nil="true"/>
                        <b:RateCardName>USA Rate Card</b:RateCardName>
                        <b:RateCardType>R</b:RateCardType>
                        <b:RateCardUid>1152921504606860819</b:RateCardUid>
                     </b:StandardRateCardIdentity>
                     <b:TimeBillingType>H</b:TimeBillingType>
                     <b:Timestamp>AAAAAA97WG8=</b:Timestamp>
                     <b:UserDefinedFields>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>CL-Date</b:UdfName>
                           <b:UdfUid>1152921504606856792</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>D</b:DataType>
                           <b:DateValue>2018-01-17T00:00:00Z</b:DateValue>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>CL-Integer</b:UdfName>
                           <b:UdfUid>1152921504606856793</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>I</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue>10</b:IntegerValue>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue>10</b:NumericValue>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>CL-Resource</b:UdfName>
                           <b:UdfUid>1152921504606856794</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>R</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue>
                              <b:ResourceDisplayName>John Doe</b:ResourceDisplayName>
                              <b:ResourceId i:nil="true"/>
                              <b:ResourceReferenceSystemId>E123</b:ResourceReferenceSystemId>
                              <b:ResourceUid>1152921504607062225</b:ResourceUid>
                           </b:ResourceIdentityValue>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>CL-Text</b:UdfName>
                           <b:UdfUid>1152921504606856795</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>T</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue>Parent Client</b:TextValue>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>CL-Text List</b:UdfName>
                           <b:UdfUid>1152921504606856796</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>L</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue>CL-1A</b:TextValue>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>CL-Boolean</b:UdfName>
                           <b:UdfUid>1152921504606856797</b:UdfUid>
                           <b:BooleanValue>true</b:BooleanValue>
                           <b:DataType>Y</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>CL-Stoplight</b:UdfName>
                           <b:UdfUid>1152921504606856814</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>S</b:DataType>
                           <b:DateValue i:nil="true"/>
         <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2023-11-06T18:17:57.6501708Z</ServerTimestampUtc>
                 <b:IntegerValue i:nil="true"/<a:Clients xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsClientElement>
           <b:ResourceIdentityValue i:nil="true"/>      <b:ClientDetail>
                     <b:TextValueClientId i:nil="true"/>
     
                     <b:UdfTreatment>A<ClientNumber>C000158</b:UdfTreatment>
     ClientNumber>
                     <b:StoplightValues>
        ClientUid>1152921504607017770</b:ClientUid>
                     <b:PwsStoplightValue>ClientName>Projector PSA</b:ClientName>
                     <b:InactiveFlag>false</b:InactiveFlag>
          <b:AsOfDate>2018-01-17T00:00:00Z</b:AsOfDate>           <b:ParentClientIdentity i:nil="true"/>
                     <b:SortOrder>2</b:SortOrder>Address>
                        <b:AddressLine1>98 N Washington    <Street</b:PwsStoplightValue>AddressLine1>
                           </b:StoplightValues>
<b:AddressLine2 i:nil="true"/>
                          <b:NumericValueAttention i:nil="true"/>
                           <b:RelationValue i:nil="true"/><b:City>Boston</b:City>
                        <b:CompanyName>Projector <PSA</b:PwsUserDefinedFieldDetail>CompanyName>
                        <b:PwsUserDefinedFieldDetail>:Country>United States</b:Country>
                        <b:StateOrProvince>MA</b:StateOrProvince>
                   <b:UdfId i:nil="true"/>    <b:ZipOrPostalCode>02114</b:ZipOrPostalCode>
                       <b:UdfName>CL-Multiline<</b:UdfName>
   Address>
                       <b:UdfUid>1152921504606858027</b:UdfUid>
 BillingCycleIdentity>
                         <b:BooleanValueBillingCycleId i:nil="true"/>
 
                         <b:DataType>T<BillingCycleName>Monthly</b:DataType>BillingCycleName>
                        <b:BillingCycleUid>1152921504606853180</b:BillingCycleUid>
              <b:DateValue i:nil="true"/>      </b:BillingCycleIdentity>
                     <b:IntegerValueBillingInstructions i:nil="true"/>
    >
                      <b:ResourceIdentityValueClientMessage i:nil="true"/>
     
                     <b:TextValue>This is a parent client.</b:TextValue>
   ClientMessagePlain i:nil="true"/>
                       <b:UdfTreatment>A<InheritAddressFlag>false</b:UdfTreatment>
   InheritAddressFlag>
                       <b:StoplightValues/>
     InheritBillingCycleFlag>false</b:InheritBillingCycleFlag>
                     <b:NumericValue i:nil="true"/>
     InheritBillingInstructionsFlag>false</b:InheritBillingInstructionsFlag>
                     <b:RelationValue i:nil="true"/>InheritClientMessageFlag>false</b:InheritClientMessageFlag>
                        <<b:InheritInvoiceContentFlag>false</b:PwsUserDefinedFieldDetail>InheritInvoiceContentFlag>
                     <<b:InheritInvoiceScopeFlag>false</b:UserDefinedFields>InheritInvoiceScopeFlag>
                     <b:InheritInvoiceEmailSettingsFlag>false<InheritInvoiceTemplateFlag>false</b:InheritInvoiceEmailSettingsFlag>InheritInvoiceTemplateFlag>
                     <b:InvoiceEmailSettings>
 :InheritPaymentTermFlag>false</b:InheritPaymentTermFlag>
                      <b:EmailFromUserIdentity>
  :InheritPurchaseOrderNumberFlag>false</b:InheritPurchaseOrderNumberFlag>
                        <b:UserDisplayName>Betty Smith<InheritStandardRatesFlag>true</b:UserDisplayName>
     InheritStandardRatesFlag>
                     <b:InheritTimeBillingTypeFlag>false</b:UserId i:nil="true"/>InheritTimeBillingTypeFlag>
                     <b:InvoiceContent>B</b:InvoiceContent>
      <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>             <b:InvoiceScope>E</b:InvoiceScope>
              <b:UserUid>1152921504607011056</b:UserUid>       <b:InvoiceTemplateIdentity i:nil="true"/>
                </b:EmailFromUserIdentity>     <b:NewClientNumber i:nil="true"/>
                  <b:EmailInvoiceTemplateIdentity>   <b:PaymentTermIdentity>
                        <b:InvoiceTemplateIdPaymentTermId i:nil="true"/>
  
                        <b:InvoiceTemplateName>E001<PaymentTermName>Net 30</b:InvoiceTemplateName>
  PaymentTermName>
                        <b:InvoiceTemplateUid>1152921504606878906<PaymentTermUid>1152921504606856054</b:InvoiceTemplateUid>
 PaymentTermUid>
                      </b:EmailInvoiceTemplateIdentity>PaymentTermIdentity>
                        <b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag><b:PurchaseOrderNumber i:nil="true"/>
                        <b:InvoiceEmailType>P</b:InvoiceEmailType>
  <b:StandardBillingAdjustedDiscountPercent i:nil="true"/>
                     <b:Recipients>
    StandardContractDiscountPercent i:nil="true"/>
                      <b:PwsInvoiceEmailRecipient>
        StandardRateCardIdentity i:nil="true"/>
                     <b:RecipientType>T<TimeBillingType>H</b:RecipientType>TimeBillingType>
                     <b:Timestamp>AAAAADI328g=</b:Timestamp>
         <b:UserIdentity>            <b:UserDefinedFields/>
                     <b:UserDisplayName>Abby Whelan<InheritInvoiceEmailSettingsFlag>false</b:UserDisplayName>
           InheritInvoiceEmailSettingsFlag>
                     <b:UserId i:nil="true"/>
       InvoiceEmailSettings>
                         <b:UserReferenceSystemId>OPA02</b:UserReferenceSystemId>
     EmailFromUserIdentity i:nil="true"/>
                           <b:UserUid>1152921504607062210</b:UserUid><b:EmailInvoiceTemplateIdentity i:nil="true"/>
                              <<b:InvoiceEmailEnabledFlag>false</b:UserIdentity>InvoiceEmailEnabledFlag>
                           </b:PwsInvoiceEmailRecipient><b:InvoiceEmailType i:nil="true"/>
                        </b:Recipients><b:Recipients/>
                     </b:InvoiceEmailSettings>
                     <b:InheritRenderReceiptsFlag>false</b:InheritRenderReceiptsFlag>
                     <b:RenderReceiptsFlag>false</b:RenderReceiptsFlag>
                     <b:AutoApplyAvailableBalanceFlag>false</b:AutoApplyAvailableBalanceFlag>
                     <b:InheritAutoApplyAvailableBalanceFlag>false</b:InheritAutoApplyAvailableBalanceFlag>
                     <b:InheritTaxTypesFlag>false<InheritTaxTypesFlag>true</b:InheritTaxTypesFlag>
                     <b:TaxType1Identity>
  TaxType1Identity i:nil="true"/>
                     <b:TaxTypeCode>VAT</b:TaxTypeCode>   <b:TaxType2Identity i:nil="true"/>
                     <b:TaxTypeIdTaxType3Identity i:nil="true"/>
                        <b:TaxTypeUid>1152921504606868258<InheritRenderedInvoiceFormatFlag>false</b:TaxTypeUid>InheritRenderedInvoiceFormatFlag>
                     <<b:RenderedInvoiceFormat>P</b:TaxType1Identity>RenderedInvoiceFormat>
                     <b:TaxType2Identity i:nil="true"/>
  :Prefix>PPSA</b:Prefix>
                  </b:ClientDetail>
                  <b:TaxType3Identity i:nil="true"InvoiceRecipients/>
                  <<b:NumClientLevels>4</b:ClientDetail>NumClientLevels>
               </b:PwsClientElement>
            </a:Clients>
         </PwsGetClientResult>
      </PwsGetClientResponse>
   </s:Body>
</s:Envelope>

...

ErrorNumberErrorCodeErrorText
11038NoClientsSpecifiedNo clients were specified for retrieval by this request.
11040MaximumClientIdentitiesExceededPlease specify between 1 and 100 client identities for retrieval.
50045ViewPermissionDeniedYou do not have permission to view this item.
57631ClientNotSpecifiedA specified client identity was incomplete. Each client identity must specify either a client id, client uid or client number.
57634UnexpectedErrorRetrievingClientsThere was an unexpected error while trying to retrieve a client.