Versions Compared

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
AVWN2cthcvkr13Vtxbkl4QAavFwbZgVb9V4tr3R7BbzQ==
ClientIdentitiesPwsClientRef [1..100]Yes
These are the identities of the clients to be fetched

...

Code Block
languagexml
titleRequest 01
collapsetrue
     <PwsGetClient>
   <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/>
 <serviceRequest>  <soapenv:Body>
      <pws:PwsGetClient>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
   <SessionTicket>AVWN2cthcvkr13Vtxbkl4Q         <req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
            <ClientIdentities><req:ClientIdentities>
               <PwsClientRef><com:PwsClientRef>
                  <ClientNumber>C000117<<com:ClientNumber>C000121</com:ClientNumber>
               </com:PwsClientRef>
            </req:ClientIdentities>
         </pws:serviceRequest>
      </pws:PwsGetClient>
   </soapenv:Body>
</soapenv:Envelope>


Response Format


Panel
titlePwsGetClientRs

...

Code Block
languagexml
titleResponse 01
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>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-17T19:38:49.0775059Z</ServerTimestampUtc>
            <a:Clients xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsClientElement>
                  <b:ClientDetail>
                     <b:ClientId i:nil="true"/>
                     <b:ClientNumber>C000121</b:ClientNumber>
                     <b:ClientUid>1152921504606998462</b:ClientUid>
                     <b:ClientName>Parent Inc.</b:ClientName>
                     <b:InactiveFlag>false</b:InactiveFlag>
                     <b:ParentClientIdentity i:nil="true"/>
                     <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>
                   <PwsGetClientResponse>  </b:Address>
       <PwsGetClientResult>             <Messages i:nil="true"/><b:BillingCycleIdentity>
            <ResponseId>0</ResponseId>             <Status>Ok</Status><b:BillingCycleId i:nil="true"/>
              <ServerTimestampUtc>2017-12-21T13:40:58.4991255Z</ServerTimestampUtc>          <b:BillingCycleName>Monthly</b:BillingCycleName>
  <Clients>                <PwsClientElement>      <b:BillingCycleUid>1152921504606853180</b:BillingCycleUid>
            <ClientDetail>         </b:BillingCycleIdentity>
            <ClientId i:nil="true"/>        <b:BillingInstructions>Please bill this client at the end of each month.</b:BillingInstructions>
    <ClientNumber>C000117</ClientNumber>                 <b:ClientMessage>We appreciate your business!</b:ClientMessage>
 <ClientUid>1152921504606989806</ClientUid>                    <b:ClientMessagePlain>We appreciate <ClientName>Acmeyour 123</ClientName>business!</b:ClientMessagePlain>
                     <InactiveFlag>false</InactiveFlag><b:InheritAddressFlag>false</b:InheritAddressFlag>
                     <ParentClientIdentity i:nil="true"/><b:InheritBillingCycleFlag>false</b:InheritBillingCycleFlag>
                     <Address><b:InheritBillingInstructionsFlag>false</b:InheritBillingInstructionsFlag>
                     <b:InheritClientMessageFlag>false</b:InheritClientMessageFlag>
  <AddressLine1>100 Main Street</AddressLine1>                  <b:InheritInvoiceContentFlag>false</b:InheritInvoiceContentFlag>
      <AddressLine2 i:nil="true"/>              <b:InheritInvoiceScopeFlag>false</b:InheritInvoiceScopeFlag>
          <Attention>Jane Doe</Attention>          <b:InheritInvoiceTemplateFlag>false</b:InheritInvoiceTemplateFlag>
              <City>Boston</City>       <b:InheritPaymentTermFlag>false</b:InheritPaymentTermFlag>
                 <CompanyName>Acme 123</CompanyName>   <b:InheritPurchaseOrderNumberFlag>false</b:InheritPurchaseOrderNumberFlag>
                     <Country>MA</Country><b:InheritStandardRatesFlag>false</b:InheritStandardRatesFlag>
                        <StateOrProvince>MA</StateOrProvince><b:InheritTimeBillingTypeFlag>false</b:InheritTimeBillingTypeFlag>
                        <ZipOrPostalCode>02114</ZipOrPostalCode><b:InvoiceContent>B</b:InvoiceContent>
                     </Address><b:InvoiceScope>E</b:InvoiceScope>
                     <BillingCycleIdentity><b:InvoiceTemplateIdentity>
                        <BillingCycleId<b:InvoiceTemplateId i:nil="true"/>
                        <BillingCycleName>Monthly</BillingCycleName><b:InvoiceTemplateName>A100</b:InvoiceTemplateName>
                        <BillingCycleUid>1152921504606853180</BillingCycleUid><b:InvoiceTemplateUid>1152921504606878901</b:InvoiceTemplateUid>
                     </BillingCycleIdentity>b:InvoiceTemplateIdentity>
                     <BillingInstructions>This client should be billed on the 15th of every month</BillingInstructions><b:NewClientNumber i:nil="true"/>
                     <b:PaymentTermIdentity>
        <ClientMessage>We appreciate your business!</ClientMessage>               <b:PaymentTermId i:nil="true"/>
      <ClientMessagePlain>We appreciate your business!</ClientMessagePlain>                 <b:PaymentTermName>Net 30</b:PaymentTermName>
   <InheritAddressFlag>false</InheritAddressFlag>                      <InheritBillingCycleFlag>false</InheritBillingCycleFlag><b:PaymentTermUid>1152921504606856054</b:PaymentTermUid>
                     <InheritBillingInstructionsFlag>false<</InheritBillingInstructionsFlag>b:PaymentTermIdentity>
                     <InheritClientMessageFlag>false</InheritClientMessageFlag><b:PurchaseOrderNumber>P-001</b:PurchaseOrderNumber>
                     <InheritInvoiceContentFlag>false</InheritInvoiceContentFlag><b:StandardBillingAdjustedDiscountPercent>5</b:StandardBillingAdjustedDiscountPercent>
                     <InheritInvoiceScopeFlag>false</InheritInvoiceScopeFlag><b:StandardContractDiscountPercent>10</b:StandardContractDiscountPercent>
                     <b:StandardRateCardIdentity>
   <InheritInvoiceTemplateFlag>false</InheritInvoiceTemplateFlag>                      <InheritPaymentTermFlag>false</InheritPaymentTermFlag><b:RateCardId i:nil="true"/>
                     <InheritPurchaseOrderNumberFlag>false</InheritPurchaseOrderNumberFlag>   <b:RateCardName>USA Rate Card</b:RateCardName>
                <InheritStandardRatesFlag>true</InheritStandardRatesFlag>        <b:RateCardType>R</b:RateCardType>
             <InheritTimeBillingTypeFlag>false</InheritTimeBillingTypeFlag>           <b:RateCardUid>1152921504606860819</b:RateCardUid>
          <InvoiceContent>B</InvoiceContent>           </b:StandardRateCardIdentity>
          <InvoiceScope>E</InvoiceScope>           <b:TimeBillingType>H</b:TimeBillingType>
           <InvoiceTemplateIdentity>          <b:Timestamp>AAAAAA97WG8=</b:Timestamp>
              <InvoiceTemplateId i:nil="true"/>      <b:UserDefinedFields>
                  <InvoiceTemplateName>A100</InvoiceTemplateName>      <b:PwsUserDefinedFieldDetail>
                  <InvoiceTemplateUid>1152921504606878901</InvoiceTemplateUid>         <b:UdfId i:nil="true"/>
           </InvoiceTemplateIdentity>                <b:UdfName>CL-Date</b:UdfName>
     <NewClientNumber i:nil="true"/>                      <b:UdfUid>1152921504606856792</b:UdfUid>
  <PaymentTermIdentity>                         <PaymentTermId<b:BooleanValue i:nil="true"/>
                        <PaymentTermName>Net 15</PaymentTermName>   <b:DataType>D</b:DataType>
                           <PaymentTermUid>1152921504606856053</PaymentTermUid><b:DateValue>2018-01-17T00:00:00Z</b:DateValue>
                            </PaymentTermIdentity><b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
    <PurchaseOrderNumber>Acme 123</PurchaseOrderNumber>                      <StandardBillingAdjustedDiscountPercent<b:TextValue i:nil="true"/>
                        <StandardContractDiscountPercent   i:nil="true"/><b:UdfTreatment>A</b:UdfTreatment>
                          <StandardRateCardIdentity i:nil="true"<b:StoplightValues/>
                     <TimeBillingType>H</TimeBillingType>      <b:NumericValue i:nil="true"/>
                           <Timestamp>AAAAAA61PAw=</Timestamp><b:RelationValue i:nil="true"/>
                        <UserDefinedFields></b:PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail><b:PwsUserDefinedFieldDetail>
                           <UdfId<b:UdfId i:nil="true"/>
                           <UdfName>Sign On Date</<b:UdfName>CL-Integer</b:UdfName>
                           <UdfUid>1152921504606856792<<b:UdfUid>1152921504606856793</b:UdfUid>
                           <BooleanValue<b:BooleanValue i:nil="true"/>
                           <DataType>D<<b:DataType>I</b:DataType>
                           <DateValue>2017-12-21T00:00:00Z</DateValue><b:DateValue i:nil="true"/>
                           <IntegerValue i:nil="true"/><b:IntegerValue>10</b:IntegerValue>
                           <ResourceIdentityValue<b:ResourceIdentityValue i:nil="true"/>
                           <TextValue<b:TextValue i:nil="true"/>
                           <UdfTreatment>A<<b:UdfTreatment>A</b:UdfTreatment>
                           <StoplightValues<b:StoplightValues/>
                           <NumericValue i:nil="true"/><b:NumericValue>10</b:NumericValue>
                           <RelationValue<b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail><b:PwsUserDefinedFieldDetail>
                           <UdfId<b:UdfId i:nil="true"/>
                           <UdfName>Contact Name</<b:UdfName>CL-Resource</b:UdfName>
                           <UdfUid>1152921504606856794<<b:UdfUid>1152921504606856794</b:UdfUid>
                           <BooleanValue<b:BooleanValue i:nil="true"/>
                           <DataType>R<<b:DataType>R</b:DataType>
                           <DateValue<b:DateValue i:nil="true"/>
                           <IntegerValue<b:IntegerValue i:nil="true"/>
                           <ResourceIdentityValue><b:ResourceIdentityValue>
                              <ResourceDisplayName>John<b:ResourceDisplayName>John Smith<Doe</b:ResourceDisplayName>
                              <ResourceId<b:ResourceId i:nil="true"/>
                              <ResourceReferenceSystemId>SL (USA) - 03</<b:ResourceReferenceSystemId>E123</b:ResourceReferenceSystemId>
                              <ResourceUid>1152921504607062225</<b:ResourceUid>1152921504607062225</b:ResourceUid>
                           </b:ResourceIdentityValue>
                           <TextValue<b:TextValue i:nil="true"/>
                           <UdfTreatment>A<<b:UdfTreatment>A</b:UdfTreatment>
                           <StoplightValues<b:StoplightValues/>
                           <NumericValue<b:NumericValue i:nil="true"/>
                           <RelationValue<b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail><b:PwsUserDefinedFieldDetail>
                           <UdfId<b:UdfId i:nil="true"/>
                           <UdfName>Additional Info</<b:UdfName>CL-Text</b:UdfName>
                           <UdfUid>1152921504606856795<<b:UdfUid>1152921504606856795</b:UdfUid>
                           <BooleanValue<b:BooleanValue i:nil="true"/>
                           <DataType>T<<b:DataType>T</b:DataType>
                           <DateValue<b:DateValue i:nil="true"/>
                           <IntegerValue<b:IntegerValue i:nil="true"/>
                           <ResourceIdentityValue<b:ResourceIdentityValue i:nil="true"/>
                           <TextValue>Client Info pending</<b:TextValue>Parent Client</b:TextValue>
                           <UdfTreatment>A<<b:UdfTreatment>A</b:UdfTreatment>
                           <StoplightValues<b:StoplightValues/>
                           <NumericValue<b:NumericValue i:nil="true"/>
                           <RelationValue<b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail><b:PwsUserDefinedFieldDetail>
                           <UdfId<b:UdfId i:nil="true"/>
                           <UdfName>Grade</ <b:UdfName>CL-Text List</b:UdfName>
                           <UdfUid>1152921504606856796<<b:UdfUid>1152921504606856796</b:UdfUid>
                           <BooleanValue<b:BooleanValue i:nil="true"/>
                           <DataType>L<<b:DataType>L</b:DataType>
                           <DateValue<b:DateValue i:nil="true"/>
                           <IntegerValue<b:IntegerValue i:nil="true"/>
                           <ResourceIdentityValue<b:ResourceIdentityValue i:nil="true"/>
                           <TextValue>CL<b:TextValue>CL-1A</b:TextValue>
                           <UdfTreatment>A<<b:UdfTreatment>A</b:UdfTreatment>
                           <StoplightValues<b:StoplightValues/>
                           <NumericValue<b:NumericValue i:nil="true"/>
                           <RelationValue<b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail><b:PwsUserDefinedFieldDetail>
                            <UdfId<b:UdfId i:nil="true"/>
                           <UdfName>Category</<b:UdfName>CL-Boolean</b:UdfName>
                           <UdfUid>1152921504606856797<<b:UdfUid>1152921504606856797</b:UdfUid>
                           <BooleanValue>true<<b:BooleanValue>true</b:BooleanValue>
                           <DataType>Y<<b:DataType>Y</b:DataType>
                           <DateValue<b:DateValue i:nil="true"/>
                           <IntegerValue<b:IntegerValue i:nil="true"/>
                           <ResourceIdentityValue<b:ResourceIdentityValue i:nil="true"/>
                           <TextValue<b:TextValue i:nil="true"/>
                           <UdfTreatment>A<<b:UdfTreatment>A</b:UdfTreatment>
                           <StoplightValues<b:StoplightValues/>
                           <NumericValue<b:NumericValue i:nil="true"/>
                           <RelationValue<b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail><b:PwsUserDefinedFieldDetail>
                           <UdfId<b:UdfId i:nil="true"/>
                           <UdfName>Satisfaction</<b:UdfName>CL-Stoplight</b:UdfName>
                           <UdfUid>1152921504606856814<<b:UdfUid>1152921504606856814</b:UdfUid>
                           <BooleanValue<b:BooleanValue i:nil="true"/>
                           <DataType>S<<b:DataType>S</b:DataType>
                           <DateValue<b:DateValue i:nil="true"/>
                           <IntegerValue<b:IntegerValue i:nil="true"/>
                           <ResourceIdentityValue<b:ResourceIdentityValue i:nil="true"/>
                           <TextValue<b:TextValue i:nil="true"/>
                           <UdfTreatment>A<<b:UdfTreatment>A</b:UdfTreatment>
                           <StoplightValues><b:StoplightValues>
                              <PwsStoplightValue><b:PwsStoplightValue>
                                 <AsOfDate>2017<b:AsOfDate>2018-1201-21T0017T00:00:00Z</b:AsOfDate>
                                 <SortOrder>3<<b:SortOrder>2</b:SortOrder>
                              </b:PwsStoplightValue>
                           </b:StoplightValues>
                           <NumericValue<b:NumericValue i:nil="true"/>
                           <RelationValue<b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail><b:PwsUserDefinedFieldDetail>
                           <UdfId<b:UdfId i:nil="true"/>
                           <UdfName>Headquarters</<b:UdfName>CL-Multiline</b:UdfName>
                           <UdfUid>1152921504606858027<<b:UdfUid>1152921504606858027</b:UdfUid>
                           <BooleanValue <b:BooleanValue i:nil="true"/>
                           <DataType>T<<b:DataType>T</b:DataType>
                           <DateValue<b:DateValue i:nil="true"/>
                           <IntegerValue<b:IntegerValue i:nil="true"/>
                           <ResourceIdentityValue<b:ResourceIdentityValue i:nil="true"/>
                           <TextValue>This<b:TextValue>This cllientis hasa an additional location in San Francisco, CAparent client.</b:TextValue>
                           <UdfTreatment>A<<b:UdfTreatment>A</b:UdfTreatment>
                           <StoplightValues<b:StoplightValues/>
                           <NumericValue<b:NumericValue i:nil="true"/>
                           <RelationValue<b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                     </b:UserDefinedFields>
                     <InheritInvoiceEmailSettingsFlag>false<<b:InheritInvoiceEmailSettingsFlag>false</b:InheritInvoiceEmailSettingsFlag>
                     <InvoiceEmailSettings><b:InvoiceEmailSettings>
                        <EmailFromUserIdentity><b:EmailFromUserIdentity>
                           <UserDisplayName>Jane Doe</<b:UserDisplayName>Bettina Borces</b:UserDisplayName>
                           <UserId<b:UserId i:nil="true"/>
                           <UserReferenceSystemId>Employee<b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                           <UserUid>1152921504607011056<<b:UserUid>1152921504607011056</b:UserUid>
                        </b:EmailFromUserIdentity>
                        <EmailInvoiceTemplateIdentity><b:EmailInvoiceTemplateIdentity>
                           <InvoiceTemplateId<b:InvoiceTemplateId i:nil="true"/>
                           <InvoiceTemplateName>E001<<b:InvoiceTemplateName>E001</b:InvoiceTemplateName>
                           <InvoiceTemplateUid>1152921504606878906<<b:InvoiceTemplateUid>1152921504606878906</b:InvoiceTemplateUid>
                        </b:EmailInvoiceTemplateIdentity>
                        <InvoiceEmailEnabledFlag>true<<b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag>
                        <InvoiceEmailType>P<<b:InvoiceEmailType>P</b:InvoiceEmailType>
                        <Recipients><b:Recipients>
                           <PwsInvoiceEmailRecipient><b:PwsInvoiceEmailRecipient>
                              <RecipientType>T<<b:RecipientType>T</b:RecipientType>
                              <UserIdentity><b:UserIdentity>
                                 <UserDisplayName>Web<b:UserDisplayName>Abby Services<Whelan</b:UserDisplayName>
                                 <UserId<b:UserId i:nil="true"/>
                                 <UserReferenceSystemId>WS01<<b:UserReferenceSystemId>OPA02</b:UserReferenceSystemId>
                                 <UserUid>1152921504607067736<<b:UserUid>1152921504607062210</b:UserUid>
                              </b:UserIdentity>
                           </b:PwsInvoiceEmailRecipient>
                        </b:Recipients>
                     </b:InvoiceEmailSettings>
                     <InheritRenderReceiptsFlag>false<<b:InheritRenderReceiptsFlag>false</b:InheritRenderReceiptsFlag>
                     <RenderReceiptsFlag>false<<b:RenderReceiptsFlag>false</b:RenderReceiptsFlag>
                     <AutoApplyAvailableBalanceFlag>false<<b:AutoApplyAvailableBalanceFlag>false</b:AutoApplyAvailableBalanceFlag>
                     <InheritAutoApplyAvailableBalanceFlag>false<<b:InheritAutoApplyAvailableBalanceFlag>false</b:InheritAutoApplyAvailableBalanceFlag>
                     <InheritTaxTypesFlag>false<<b:InheritTaxTypesFlag>false</b:InheritTaxTypesFlag>
                     <TaxType1Identity><b:TaxType1Identity>
                        <TaxTypeCode>VAT<<b:TaxTypeCode>VAT</b:TaxTypeCode>
                        <TaxTypeId<b:TaxTypeId i:nil="true"/>
                        <TaxTypeUid>1152921504606868258<<b:TaxTypeUid>1152921504606868258</b:TaxTypeUid>
                     </b:TaxType1Identity>
                     <TaxType2Identity<b:TaxType2Identity i:nil="true"/>
                     <TaxType3Identity<b:TaxType3Identity i:nil="true"/>
                  </b:ClientDetail>
               </b:PwsClientElement>
            </a:Clients>
         </PwsGetClientResult>
      </PwsGetClientResponse>
   </s:Body>
</s:Envelope>

PwsGetClient - Common Errors and Warnings

...