Versions Compared

Version Old Version 82 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
AVWN2cthcvkr13Vtxbkl4QATAj5CRx7eosFAdLjFCVyg==
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     <PwsGetClient>
         <serviceRequest>
            <SessionTicket>AVWN2cthcvkr13Vtxbkl4Q==</SessionTicket>
            <ClientIdentities>
   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>
 <PwsClientRef>                   <ClientNumber>C000117</com:ClientNumber><req:RequestId>1</req:RequestId>
               </PwsClientRef><req:SessionTicket>ATAj5CRx7eosFAdLjFCVyg==</req:SessionTicket>
            <req:ClientIdentities>
               <com:PwsClientRef>
               </ClientIdentities>   <com:ClientNumber>C000158</com:ClientNumber>
               </serviceRequest>com:PwsClientRef>
            </PwsGetClient>

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 information01
StatusStringRequestStatusClick here for more informationOk
ServerTimestampUtcDateTimeClick here for more information
20172023-1211-21T1306T18:4017:5857.4991255Z6501708Z
ClientsPwsClientDetail PwsClientElement [0..100]Details of the clients that were fetched

...

Code Block
languagexml
titleResponse 01PwsGetClientRs
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
<PwsGetClientResponse>      <PwsGetClientResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
  <PwsGetClientResult>             <Messages i:nil="true"/>
            <ResponseId>0</ResponseId>
            <Status>Ok</Status>
            <ServerTimestampUtc>2017-12-21T13:40:58.4991255Z</ServerTimestampUtc>
            <Clients>
               <PwsClientElement>
                  <ClientDetail>
                     <ClientId i:nil="true"/>
                     <ClientNumber>C000117</ClientNumber>
                     <ClientUid>1152921504606989806</ClientUid>
                     <ClientName>Acme 123</ClientName>
                     <InactiveFlag>false</InactiveFlag>
                     <ParentClientIdentity i:nil="true"/>
                     <Address>
                        <AddressLine1>100 Main Street</AddressLine1>
                        <AddressLine2 i:nil="true"/>
                        <Attention>Jane Doe</Attention>
                        <City>Boston</City>
                        <CompanyName>Acme 123</CompanyName>
                        <Country>MA</Country>
                        <StateOrProvince>MA</StateOrProvince>
                        <ZipOrPostalCode>02114</ZipOrPostalCode>
                     </Address>
                     <BillingCycleIdentity>
                        <BillingCycleId i:nil="true"/>
                        <BillingCycleName>Monthly</BillingCycleName>
                        <BillingCycleUid>1152921504606853180</BillingCycleUid>
                     </BillingCycleIdentity>
                     <BillingInstructions>This client should be billed on the 15th of every month</BillingInstructions>
                     <ClientMessage>We appreciate your business!</ClientMessage>
                     <ClientMessagePlain>We appreciate your business!</ClientMessagePlain>
                     <InheritAddressFlag>false</InheritAddressFlag>
                     <InheritBillingCycleFlag>false</InheritBillingCycleFlag>
                     <InheritBillingInstructionsFlag>false</InheritBillingInstructionsFlag>
                     <InheritClientMessageFlag>false</InheritClientMessageFlag>
                     <InheritInvoiceContentFlag>false</InheritInvoiceContentFlag>
                     <InheritInvoiceScopeFlag>false</InheritInvoiceScopeFlag>
                     <InheritInvoiceTemplateFlag>false</InheritInvoiceTemplateFlag>
                     <InheritPaymentTermFlag>false</InheritPaymentTermFlag>
                     <InheritPurchaseOrderNumberFlag>false</InheritPurchaseOrderNumberFlag>
                     <InheritStandardRatesFlag>true</InheritStandardRatesFlag>
                     <InheritTimeBillingTypeFlag>false</InheritTimeBillingTypeFlag>
                     <InvoiceContent>B</InvoiceContent>
                     <InvoiceScope>E</InvoiceScope>
                     <InvoiceTemplateIdentity>
                        <InvoiceTemplateId i:nil="true"/>
                        <InvoiceTemplateName>A100</InvoiceTemplateName>
                        <InvoiceTemplateUid>1152921504606878901</InvoiceTemplateUid>
                     </InvoiceTemplateIdentity>
                     <NewClientNumber i:nil="true"/>
                     <PaymentTermIdentity>
                        <PaymentTermId i:nil="true"/>
                        <PaymentTermName>Net 15</PaymentTermName>
                        <PaymentTermUid>1152921504606856053</PaymentTermUid>
                     </PaymentTermIdentity>
                     <PurchaseOrderNumber>Acme 123</PurchaseOrderNumber>
                     <StandardBillingAdjustedDiscountPercent i:nil="true"/>
                     <StandardContractDiscountPercent i:nil="true"/>
                     <StandardRateCardIdentity i:nil="true"/>
                     <TimeBillingType>H</TimeBillingType>
                     <Timestamp>AAAAAA61PAw=</Timestamp>
                     <UserDefinedFields>
                        <PwsUserDefinedFieldDetail>
                           <UdfId i:nil="true"/>
                           <UdfName>Sign On Date</UdfName>
                           <UdfUid>1152921504606856792</UdfUid>
                           <BooleanValue i:nil="true"/>
                           <DataType>D</DataType>
                           <DateValue>2017-12-21T00:00:00Z</DateValue>
                           <IntegerValue i:nil="true"/>
                           <ResourceIdentityValue i:nil="true"/>
                           <TextValue i:nil="true"/>
                           <UdfTreatment>A</UdfTreatment>
                           <StoplightValues/>
                           <NumericValue i:nil="true"/>
                           <RelationValue i:nil="true"/>
                        </PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail>
                           <UdfId i:nil="true"/>
                           <UdfName>Contact Name</UdfName>
                           <UdfUid>1152921504606856794</UdfUid>
                           <BooleanValue i:nil="true"/>
                           <DataType>R</DataType>
                           <DateValue i:nil="true"/>
                           <IntegerValue i:nil="true"/>
                           <ResourceIdentityValue>
                              <ResourceDisplayName>John Smith</ResourceDisplayName>
                              <ResourceId i:nil="true"/>
                              <ResourceReferenceSystemId>SL (USA) - 03</ResourceReferenceSystemId>
                              <ResourceUid>1152921504607062225</ResourceUid>
                           </ResourceIdentityValue>
                           <TextValue i:nil="true"/>
                           <UdfTreatment>A</UdfTreatment>
                           <StoplightValues/>
                           <NumericValue i:nil="true"/>
                           <RelationValue i:nil="true"/>
                        </PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail>
                           <UdfId i:nil="true"/>
                           <UdfName>Additional Info</UdfName>
                           <UdfUid>1152921504606856795</UdfUid>
                           <BooleanValue i:nil="true"/>
                           <DataType>T</DataType>
                           <DateValue i:nil="true"/>
                           <IntegerValue i:nil="true"/>
                           <ResourceIdentityValue i:nil="true"/>
                           <TextValue>Client Info pending</TextValue>
                           <UdfTreatment>A</UdfTreatment>
                           <StoplightValues/>
                           <NumericValue i:nil="true"/>
                           <RelationValue i:nil="true"/>
                        </PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail>
                           <UdfId i:nil="true"/>
                           <UdfName>Grade</UdfName>
                           <UdfUid>1152921504606856796</UdfUid>
                           <BooleanValue i:nil="true"/>
                           <DataType>L</DataType>
                           <DateValue i:nil="true"/>
                           <IntegerValue i:nil="true"/>
                           <ResourceIdentityValue i:nil="true"/>
                           <TextValue>CL-1A</TextValue>
                           <UdfTreatment>A</UdfTreatment>
                           <StoplightValues/>
                           <NumericValue i:nil="true"/>
                           <RelationValue i:nil="true"/>
                        </PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail>
                           <UdfId i:nil="true"/>
                           <UdfName>Category</UdfName>
                           <UdfUid>1152921504606856797</UdfUid>
                           <BooleanValue>true</BooleanValue>
                           <DataType>Y</DataType>
                           <DateValue i:nil="true"/>
                           <IntegerValue i:nil="true"/>
                           <ResourceIdentityValue i:nil="true"/>
                           <TextValue i:nil="true"/>
                           <UdfTreatment>A</UdfTreatment>
                           <StoplightValues/>
                           <NumericValue i:nil="true"/>
                           <RelationValue i:nil="true"/>
                        </PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail>
           <PwsGetClientResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages   <UdfId i:nil="true"/xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                 <b:PwsMessage>
         <UdfName>Satisfaction</UdfName>         <b:AdditionalErrorText>Message 136: This request was executed against the QA [appqa.projectorpsa.com] environment.</b:AdditionalErrorText>
        <UdfUid>1152921504606856814</UdfUid>          <b:ErrorCode>NonProductionEnvironment</b:ErrorCode>
                 <BooleanValue i:nil="true"/><b:ErrorNumber>136</b:ErrorNumber>
                  <b:ErrorText>This web service request was executed against a  <DataType>S</DataType>
        non-production instance of Projector.</b:ErrorText>
                  <DateValue i:nil="true"/><b:Type>Information</b:Type>
                           <IntegerValue <b:ReferenceId1 i:nil="true"/>
                           <ResourceIdentityValue <b:ReferenceId2 i:nil="true"/>
               </b:PwsMessage>
           <TextValue i:nil="true"/> </Messages>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
                <UdfTreatment>A</UdfTreatment><Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2023-11-06T18:17:57.6501708Z</ServerTimestampUtc>
             <StoplightValues>
  <a:Clients xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsClientElement>
           <PwsStoplightValue>       <b:ClientDetail>
                          <AsOfDate>2017-12-21T00:00:00Z</AsOfDate><b:ClientId i:nil="true"/>
                     <b:ClientNumber>C000158</b:ClientNumber>
           <SortOrder>3</SortOrder>          <b:ClientUid>1152921504607017770</b:ClientUid>
                    </PwsStoplightValue> <b:ClientName>Projector PSA</b:ClientName>
                         </StoplightValues>
  <b:InactiveFlag>false</b:InactiveFlag>
                        <NumericValue <b:ParentClientIdentity i:nil="true"/>
                     <b:Address>
     <RelationValue i:nil="true"/>                      <b:AddressLine1>98 N Washington <Street</PwsUserDefinedFieldDetail>b:AddressLine1>
                        <PwsUserDefinedFieldDetail>
<b:AddressLine2 i:nil="true"/>
                          <UdfId<b:Attention i:nil="true"/>/>
                        <b:City>Boston</b:City>
                   <UdfName>Headquarters</UdfName>     <b:CompanyName>Projector PSA</b:CompanyName>
                     <UdfUid>1152921504606858027</UdfUid>   <b:Country>United States</b:Country>
                       <BooleanValue i:nil="true"/><b:StateOrProvince>MA</b:StateOrProvince>
                        <b:ZipOrPostalCode>02114</b:ZipOrPostalCode>
      <DataType>T</DataType>               </b:Address>
               <DateValue i:nil="true"/>      <b:BillingCycleIdentity>
                        <IntegerValue<b:BillingCycleId i:nil="true"/>
                        <b:BillingCycleName>Monthly</b:BillingCycleName>
     <ResourceIdentityValue i:nil="true"/>                  <b:BillingCycleUid>1152921504606853180</b:BillingCycleUid>
         <TextValue>This    cllient has an additional location in San Francisco, CA.</TextValue>b:BillingCycleIdentity>
                     <b:BillingInstructions i:nil="true"/>
          <UdfTreatment>A</UdfTreatment>           <b:ClientMessage i:nil="true"/>
               <StoplightValues/>      <b:ClientMessagePlain i:nil="true"/>
                    <NumericValue i:nil="true"/><b:InheritAddressFlag>false</b:InheritAddressFlag>
                     <b:InheritBillingCycleFlag>false</b:InheritBillingCycleFlag>
     <RelationValue i:nil="true"/>               <b:InheritBillingInstructionsFlag>false</b:InheritBillingInstructionsFlag>
         </PwsUserDefinedFieldDetail>                 <b:InheritClientMessageFlag>false</b:InheritClientMessageFlag>
    </UserDefinedFields>                 <b:InheritInvoiceContentFlag>false</b:InheritInvoiceContentFlag>
    <InheritInvoiceEmailSettingsFlag>false</InheritInvoiceEmailSettingsFlag>                 <b:InheritInvoiceScopeFlag>false</b:InheritInvoiceScopeFlag>
    <InvoiceEmailSettings>                 <b:InheritInvoiceTemplateFlag>false</b:InheritInvoiceTemplateFlag>
       <EmailFromUserIdentity>              <b:InheritPaymentTermFlag>false</b:InheritPaymentTermFlag>
             <UserDisplayName>Jane Doe</UserDisplayName>       <b:InheritPurchaseOrderNumberFlag>false</b:InheritPurchaseOrderNumberFlag>
                    <UserId i:nil="true"/><b:InheritStandardRatesFlag>true</b:InheritStandardRatesFlag>
                       <b:InheritTimeBillingTypeFlag>false</b:InheritTimeBillingTypeFlag>
   <UserReferenceSystemId>Employee - 01</UserReferenceSystemId>                <b:InvoiceContent>B</b:InvoiceContent>
           <UserUid>1152921504607011056</UserUid>          <b:InvoiceScope>E</b:InvoiceScope>
              </EmailFromUserIdentity>       <b:InvoiceTemplateIdentity i:nil="true"/>
                <EmailInvoiceTemplateIdentity>     <b:NewClientNumber i:nil="true"/>
                     <InvoiceTemplateId i:nil="true"/><b:PaymentTermIdentity>
                           <InvoiceTemplateName>E001</InvoiceTemplateName><b:PaymentTermId i:nil="true"/>
                           <InvoiceTemplateUid>1152921504606878906</InvoiceTemplateUid><b:PaymentTermName>Net 30</b:PaymentTermName>
                        </EmailInvoiceTemplateIdentity><b:PaymentTermUid>1152921504606856054</b:PaymentTermUid>
                        <InvoiceEmailEnabledFlag>true</InvoiceEmailEnabledFlag></b:PaymentTermIdentity>
                        <InvoiceEmailType>P</InvoiceEmailType><b:PurchaseOrderNumber i:nil="true"/>
                     <b:StandardBillingAdjustedDiscountPercent i:nil="true"/>
 <Recipients>                            <PwsInvoiceEmailRecipient><b:StandardContractDiscountPercent i:nil="true"/>
                     <b:StandardRateCardIdentity i:nil="true"/>
         <RecipientType>T</RecipientType>            <b:TimeBillingType>H</b:TimeBillingType>
                  <UserIdentity>   <b:Timestamp>AAAAADI328g=</b:Timestamp>
                     <b:UserDefinedFields/>
        <UserDisplayName>Web Services</UserDisplayName>            <b:InheritInvoiceEmailSettingsFlag>false</b:InheritInvoiceEmailSettingsFlag>
                     <UserId i:nil="true"/><b:InvoiceEmailSettings>
                        <b:EmailFromUserIdentity i:nil="true"/>
        <UserReferenceSystemId>WS01</UserReferenceSystemId>                <b:EmailInvoiceTemplateIdentity i:nil="true"/>
                <UserUid>1152921504607067736</UserUid>        <b:InvoiceEmailEnabledFlag>false</b:InvoiceEmailEnabledFlag>
                      </UserIdentity>  <b:InvoiceEmailType i:nil="true"/>
                        <<b:Recipients/PwsInvoiceEmailRecipient>>
                        </Recipients>b:InvoiceEmailSettings>
                     </InvoiceEmailSettings><b:InheritRenderReceiptsFlag>false</b:InheritRenderReceiptsFlag>
                     <InheritRenderReceiptsFlag>false</InheritRenderReceiptsFlag><b:RenderReceiptsFlag>false</b:RenderReceiptsFlag>
                     <RenderReceiptsFlag>false</RenderReceiptsFlag><b:AutoApplyAvailableBalanceFlag>false</b:AutoApplyAvailableBalanceFlag>
                     <AutoApplyAvailableBalanceFlag>false</AutoApplyAvailableBalanceFlag><b:InheritAutoApplyAvailableBalanceFlag>false</b:InheritAutoApplyAvailableBalanceFlag>
                     <InheritAutoApplyAvailableBalanceFlag>false</InheritAutoApplyAvailableBalanceFlag><b:InheritTaxTypesFlag>true</b:InheritTaxTypesFlag>
                      <InheritTaxTypesFlag>false</InheritTaxTypesFlag><b:TaxType1Identity i:nil="true"/>
                     <TaxType1Identity>
<b:TaxType2Identity i:nil="true"/>
                       <TaxTypeCode>VAT</TaxTypeCode><b:TaxType3Identity i:nil="true"/>
                        <TaxTypeId i:nil="true"/>
<b:InheritRenderedInvoiceFormatFlag>false</b:InheritRenderedInvoiceFormatFlag>
                       <TaxTypeUid>1152921504606868258</TaxTypeUid><b:RenderedInvoiceFormat>P</b:RenderedInvoiceFormat>
                     </TaxType1Identity><b:Prefix>PPSA</b:Prefix>
                     <TaxType2Identity i:nil="true"/></b:ClientDetail>
                     <TaxType3Identity i:nil="true"<b:InvoiceRecipients/>
                  </ClientDetail><b:NumClientLevels>4</b:NumClientLevels>
               </b:PwsClientElement>
            </a:Clients>
         </PwsGetClientResult>
      </PwsGetClientResponse>
   </s:Body>
</s:Envelope>



PwsGetClient - Common Errors and Warnings

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.