Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 67
Next »
Overview
This web service inserts or updates a single client based on a detailed client structure (PwsClientDetail). The service returns the identity (PwsClientRef) of the client that has been inserted or updated. The caller can optionally request that the full client detail (PwsClientElement) be included in the response.
Request Elements
| Element | Data Type | Required? | Default | Description | Sample Data |
|---|
| RequestId | Int32 | No |
| Click here for more information | 1 |
| SessionTicket | String (50) | Yes |
| Click here for more information | AavFwbZgVb9V4tr3R7BbzQ== |
| Client | PwsClientDetail | Yes |
| The detailed client information to be inserted or updated |
|
| FullDetailFlag | Boolean | No | false | If set to true, include full detailed client element in response | true/false |
| ParentClientClearFlag | Boolean | No | false | If set to true, the parent client will be set to null | true/false |
Request Usage Example(s)
<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:PwsSaveClient>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>ATAj5CRx7eosFAdLjFCVyg==</req:SessionTicket>
<req:Client>
<com:ClientNumber>C000158</com:ClientNumber>
<com:InactiveFlag>false</com:InactiveFlag>
<com:Address>
<com:AddressLine1>98 North Washington Street</com:AddressLine1>
<com:AddressLine2>400</com:AddressLine2>
<com:Attention>Office Administrator</com:Attention>
<com:City>Boston</com:City>
<com:CompanyName>Projector PSA</com:CompanyName>
<com:Country>USA</com:Country>
<com:StateOrProvince>MA</com:StateOrProvince>
<com:ZipOrPostalCode>02114</com:ZipOrPostalCode>
</com:Address>
<com:BillingCycleIdentity>
<com:BillingCycleName>Monthly</com:BillingCycleName>
</com:BillingCycleIdentity>
<com:BillingInstructions>Please bill on the last day of the month.</com:BillingInstructions>
<com:ClientMessage>We appreciate your business.</com:ClientMessage>
<com:ClientMessagePlain>We appreciate your business.</com:ClientMessagePlain>
<com:InheritAddressFlag>false</com:InheritAddressFlag>
<com:InheritBillingCycleFlag>false</com:InheritBillingCycleFlag>
<com:InheritBillingInstructionsFlag>false</com:InheritBillingInstructionsFlag>
<com:InheritClientMessageFlag>false</com:InheritClientMessageFlag>
<com:InheritInvoiceContentFlag>false</com:InheritInvoiceContentFlag>
<com:InheritInvoiceScopeFlag>false</com:InheritInvoiceScopeFlag>
<com:InheritInvoiceTemplateFlag>false</com:InheritInvoiceTemplateFlag>
<com:InheritPaymentTermFlag>false</com:InheritPaymentTermFlag>
<com:InheritPurchaseOrderNumberFlag>false</com:InheritPurchaseOrderNumberFlag>
<com:InheritStandardRatesFlag>true</com:InheritStandardRatesFlag>
<com:InheritTimeBillingTypeFlag>false</com:InheritTimeBillingTypeFlag>
<com:InvoiceContent>B</com:InvoiceContent>
<com:InvoiceScope>E</com:InvoiceScope>
<com:InvoiceTemplateIdentity>
<com:InvoiceTemplateName>A200</com:InvoiceTemplateName>
</com:InvoiceTemplateIdentity>
<com:PaymentTermIdentity>
<com:PaymentTermName>Net 30</com:PaymentTermName>
</com:PaymentTermIdentity>
<com:PurchaseOrderNumber>PPSA</com:PurchaseOrderNumber>
<com:StandardBillingAdjustedDiscountPercent>15</com:StandardBillingAdjustedDiscountPercent>
<com:StandardContractDiscountPercent>10</com:StandardContractDiscountPercent>
<!--com:StandardRateCardIdentity>
<com:RateCardName>USA</com:RateCardName>
</com:StandardRateCardIdentity-->
<com:TimeBillingType>H</com:TimeBillingType>
<com:UserDefinedFields>
<com:PwsUserDefinedFieldDetail>
<com:UdfName>CL-Text</com:UdfName>
<com:TextValue>Updated on November 6th, 2023</com:TextValue>
</com:PwsUserDefinedFieldDetail>
</com:UserDefinedFields>
<com:InheritInvoiceEmailSettingsFlag>false</com:InheritInvoiceEmailSettingsFlag>
<com:InvoiceEmailSettings>
<com:EmailFromUserIdentity>
<com:UserDisplayName>Bettina</com:UserDisplayName>
</com:EmailFromUserIdentity>
<com:EmailInvoiceTemplateIdentity>
<com:InvoiceTemplateName>E002</com:InvoiceTemplateName>
</com:EmailInvoiceTemplateIdentity>
<com:InvoiceEmailEnabledFlag>true</com:InvoiceEmailEnabledFlag>
<com:InvoiceEmailType>W</com:InvoiceEmailType>
<com:Recipients>
<com:PwsInvoiceEmailRecipient>
<com:RecipientType>T</com:RecipientType>
<com:UserIdentity>
<com:UserDisplayName>Template Client</com:UserDisplayName>
</com:UserIdentity>
</com:PwsInvoiceEmailRecipient>
</com:Recipients>
</com:InvoiceEmailSettings>
<com:InheritRenderReceiptsFlag>false</com:InheritRenderReceiptsFlag>
<com:RenderReceiptsFlag>true</com:RenderReceiptsFlag>
<com:AutoApplyAvailableBalanceFlag>false</com:AutoApplyAvailableBalanceFlag>
<com:InheritAutoApplyAvailableBalanceFlag>false</com:InheritAutoApplyAvailableBalanceFlag>
<com:InheritTaxTypesFlag>true</com:InheritTaxTypesFlag>
<com:InheritRenderedInvoiceFormatFlag>false</com:InheritRenderedInvoiceFormatFlag>
<com:RenderedInvoiceFormat>P</com:RenderedInvoiceFormat>
<com:Prefix>11062023</com:Prefix>
</req:Client>
<req:FullDetailFlag>true</req:FullDetailFlag>
<req:ParentClientClearFlag>false</req:ParentClientClearFlag>
<req:DisallowDuplicateNameFlag>true</req:DisallowDuplicateNameFlag>
<req:FixInheritanceFlag>false</req:FixInheritanceFlag>
</pws:serviceRequest>
</pws:PwsSaveClient>
</soapenv:Body>
</soapenv:Envelope>
<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:PwsSaveClient>
<pws:serviceRequest>
<req:RequestId>2</req:RequestId>
<req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
<req:Client>
<com:ClientName>Web Services Inc. - extended</com:ClientName>
<com:InactiveFlag>false</com:InactiveFlag>
<com:ParentClientIdentity>
<com:ClientNumber>C000124</com:ClientNumber>
</com:ParentClientIdentity>
<com:InheritAddressFlag>true</com:InheritAddressFlag>
<com:InheritBillingCycleFlag>true</com:InheritBillingCycleFlag>
<com:InheritBillingInstructionsFlag>true</com:InheritBillingInstructionsFlag>
<com:InheritClientMessageFlag>true</com:InheritClientMessageFlag>
<com:InheritInvoiceContentFlag>true</com:InheritInvoiceContentFlag>
<com:InheritInvoiceScopeFlag>true</com:InheritInvoiceScopeFlag>
<com:InheritInvoiceTemplateFlag>true</com:InheritInvoiceTemplateFlag>
<com:InheritPaymentTermFlag>true</com:InheritPaymentTermFlag>
<com:InheritPurchaseOrderNumberFlag>true</com:InheritPurchaseOrderNumberFlag>
<com:InheritStandardRatesFlag>true</com:InheritStandardRatesFlag>
<com:InheritTimeBillingTypeFlag>true</com:InheritTimeBillingTypeFlag>
<com:UserDefinedFields>
<com:PwsUserDefinedFieldDetail>
<com:UdfName>CL-Date</com:UdfName>
<com:DateValue>2018-02-28T00:00:00Z</com:DateValue>
</com:PwsUserDefinedFieldDetail>
<com:PwsUserDefinedFieldDetail>
<com:UdfName>CL-Text</com:UdfName>
<com:TextValue>Child of Client C00124</com:TextValue>
</com:PwsUserDefinedFieldDetail>
</com:UserDefinedFields>
<com:InheritInvoiceEmailSettingsFlag>true</com:InheritInvoiceEmailSettingsFlag>
<com:InheritRenderReceiptsFlag>true</com:InheritRenderReceiptsFlag>
<com:InheritAutoApplyAvailableBalanceFlag>true</com:InheritAutoApplyAvailableBalanceFlag>
<com:InheritTaxTypesFlag>true</com:InheritTaxTypesFlag>
</req:Client>
<req:FullDetailFlag>true</req:FullDetailFlag>
<req:ParentClientClearFlag>false</req:ParentClientClearFlag>
</pws:serviceRequest>
</pws:PwsSaveClient>
</soapenv:Body>
</soapenv:Envelope>
Response Elements
Response Usage Example(s)
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsSaveClientResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsSaveClientResult 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/">2</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-17T20:37:34.987952Z</ServerTimestampUtc>
<a:Client xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:ClientDetail>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000127</b:ClientNumber>
<b:ClientUid>1152921504606998468</b:ClientUid>
<b:ClientName>Web Services Inc. - extended</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000124</b:ClientNumber>
<b:ClientUid>1152921504606998465</b:ClientUid>
</b:ParentClientIdentity>
<b:Address>
<b:AddressLine1>123 Main Street</b:AddressLine1>
<b:AddressLine2>Suite 100</b:AddressLine2>
<b:Attention>Billing</b:Attention>
<b:City>Boston</b:City>
<b:CompanyName>Acme Inc.</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 on the last day of the month.</b:BillingInstructions>
<b:ClientMessage>We appreciate your business.</b:ClientMessage>
<b:ClientMessagePlain>We appreciate your business.</b:ClientMessagePlain>
<b:InheritAddressFlag>true</b:InheritAddressFlag>
<b:InheritBillingCycleFlag>true</b:InheritBillingCycleFlag>
<b:InheritBillingInstructionsFlag>true</b:InheritBillingInstructionsFlag>
<b:InheritClientMessageFlag>true</b:InheritClientMessageFlag>
<b:InheritInvoiceContentFlag>true</b:InheritInvoiceContentFlag>
<b:InheritInvoiceScopeFlag>true</b:InheritInvoiceScopeFlag>
<b:InheritInvoiceTemplateFlag>true</b:InheritInvoiceTemplateFlag>
<b:InheritPaymentTermFlag>true</b:InheritPaymentTermFlag>
<b:InheritPurchaseOrderNumberFlag>true</b:InheritPurchaseOrderNumberFlag>
<b:InheritStandardRatesFlag>true</b:InheritStandardRatesFlag>
<b:InheritTimeBillingTypeFlag>true</b:InheritTimeBillingTypeFlag>
<b:InvoiceContent>B</b:InvoiceContent>
<b:InvoiceScope>E</b:InvoiceScope>
<b:InvoiceTemplateIdentity>
<b:InvoiceTemplateId i:nil="true"/>
<b:InvoiceTemplateName>A200</b:InvoiceTemplateName>
<b:InvoiceTemplateUid>1152921504606878904</b:InvoiceTemplateUid>
</b:InvoiceTemplateIdentity>
<b:NewClientNumber i:nil="true"/>
<b:PaymentTermIdentity>
<b:PaymentTermId i:nil="true"/>
<b:PaymentTermName>Net 60</b:PaymentTermName>
<b:PaymentTermUid>1152921504606856055</b:PaymentTermUid>
</b:PaymentTermIdentity>
<b:PurchaseOrderNumber>WS-001</b:PurchaseOrderNumber>
<b:StandardBillingAdjustedDiscountPercent>15</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>AAAAAA97Yvs=</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-02-28T00: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-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>Child of Client C00124</b:TextValue>
<b:UdfTreatment>A</b:UdfTreatment>
<b:StoplightValues/>
<b:NumericValue i:nil="true"/>
<b:RelationValue i:nil="true"/>
</b:PwsUserDefinedFieldDetail>
</b:UserDefinedFields>
<b:InheritInvoiceEmailSettingsFlag>true</b:InheritInvoiceEmailSettingsFlag>
<b:InvoiceEmailSettings>
<b:EmailFromUserIdentity>
<b:UserDisplayName>Betty Smith</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
<b:UserUid>1152921504607011056</b:UserUid>
</b:EmailFromUserIdentity>
<b:EmailInvoiceTemplateIdentity>
<b:InvoiceTemplateId i:nil="true"/>
<b:InvoiceTemplateName>E004</b:InvoiceTemplateName>
<b:InvoiceTemplateUid>1152921504606878909</b:InvoiceTemplateUid>
</b:EmailInvoiceTemplateIdentity>
<b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag>
<b:InvoiceEmailType>W</b:InvoiceEmailType>
<b:Recipients>
<b:PwsInvoiceEmailRecipient>
<b:RecipientType>T</b:RecipientType>
<b:UserIdentity>
<b:UserDisplayName>John Doe</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
<b:UserUid>1152921504607054221</b:UserUid>
</b:UserIdentity>
</b:PwsInvoiceEmailRecipient>
</b:Recipients>
</b:InvoiceEmailSettings>
<b:InheritRenderReceiptsFlag>true</b:InheritRenderReceiptsFlag>
<b:RenderReceiptsFlag>true</b:RenderReceiptsFlag>
<b:AutoApplyAvailableBalanceFlag>true</b:AutoApplyAvailableBalanceFlag>
<b:InheritAutoApplyAvailableBalanceFlag>true</b:InheritAutoApplyAvailableBalanceFlag>
<b:InheritTaxTypesFlag>true</b:InheritTaxTypesFlag>
<b:TaxType1Identity>
<b:TaxTypeCode>VAT</b:TaxTypeCode>
<b:TaxTypeId i:nil="true"/>
<b:TaxTypeUid>1152921504606868258</b:TaxTypeUid>
</b:TaxType1Identity>
<b:TaxType2Identity i:nil="true"/>
<b:TaxType3Identity i:nil="true"/>
</b:ClientDetail>
</a:Client>
<a:ClientIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000127</b:ClientNumber>
<b:ClientUid>1152921504606998468</b:ClientUid>
</a:ClientIdentity>
</PwsSaveClientResult>
</PwsSaveClientResponse>
</s:Body>
</s:Envelope>
PwsSaveClient - Common Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|
| 105 | AtLeastOneItemNotFound | At least one requested item was not found. The remaining items, if any, were returned. |
| 11038 | NoClientsSpecified | No clients were specified for retrieval by this request. |
| 11040 | MaximumClientIdentitiesExceeded | Please specify between 1 and 100 client identities for retrieval. |
| 11042 | InappropriateStandardRateCardSpecified | The specified standard rate card is not appropriate (it is likely an RDC rate card). |
| 50045 | ViewPermissionDenied | You do not have permission to view this item. |
| 57631 | ClientNotSpecified | A specified client identity was incomplete. Each client identity must specify either a client id, client uid or client number. |
| 57634 | UnexpectedErrorRetrievingClients | There was an unexpected error while trying to retrieve a client. |