...
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Messages | |||||
ResponseId | Int32 | Click here for more information. | |||
Status | RequestStatus | Click here for more information. | |||
ServerTimestampUtc | DateTime | Click here for more information. | |||
RedirectUrl | String | ||||
SessionTicket | String | Click here for more information. | |||
AccountIdentity | |||||
UserIdentity | |||||
SuperUserFlag | Boolean | ||||
DocumentServerUrl | String | ||||
Account | |||||
User |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<pws:PwsAuthenticate>
<pws:serviceRequest>
<req:Password>1JiLei$</req:Password>
<req:UserName>larry@revcorp.min</req:UserName>
</pws:serviceRequest>
</pws:PwsAuthenticate> |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Messages |
ResponseId | Int32 |
Click here for more information. |
Status | RequestStatus |
Click here for more information. |
ServerTimestampUtc | DateTime |
Click here for more information. |
RedirectUrl | String |
SessionTicket | String |
Click here for more information. |
AccountIdentity |
UserIdentity |
SuperUserFlag | Boolean |
DocumentServerUrl |
String |
Account |
Account
User
User |
String
Response Usage Example(s)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<PwsGetClientResponse><PwsAuthenticateResponse 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> <UdfId i:nil="true"/> <UdfName>Satisfaction</UdfName> <UdfUid>1152921504606856814</UdfUid> <BooleanValue i:nil="true"/> <DataType>S</DataType> <DateValue i:nil="true"/> <IntegerValue i:nil="true"/> <ResourceIdentityValue i:nil="true"/> <TextValue i:nil="true"/> <UdfTreatment>A</UdfTreatment> <StoplightValues> <PwsStoplightValue> <AsOfDate>2017-12-21T00:00:00Z</AsOfDate> <SortOrder>3</SortOrder> </PwsStoplightValue> </StoplightValues> <NumericValue i:nil="true"/> <RelationValue i:nil="true"/> </PwsUserDefinedFieldDetail> <PwsUserDefinedFieldDetail> <UdfId i:nil="true"/> <UdfName>Headquarters</UdfName> <UdfUid>1152921504606858027</UdfUid> <BooleanValue i:nil="true"/> <DataType>T</DataType> <DateValue i:nil="true"/> <IntegerValue i:nil="true"/> <ResourceIdentityValue i:nil="true"/> <TextValue>This cllient has an additional location in San Francisco, CA.</TextValue> <UdfTreatment>A</UdfTreatment> <StoplightValues/> <NumericValue i:nil="true"/> <RelationValue i:nil="true"/> </PwsUserDefinedFieldDetail> </UserDefinedFields> <InheritInvoiceEmailSettingsFlag>false</InheritInvoiceEmailSettingsFlag> <InvoiceEmailSettings> <EmailFromUserIdentity> <UserDisplayName>Jane Doe</UserDisplayName> <UserId i:nil="true"/> <UserReferenceSystemId>Employee - 01</UserReferenceSystemId> <UserUid>1152921504607011056</UserUid> </EmailFromUserIdentity> <EmailInvoiceTemplateIdentity> <InvoiceTemplateId i:nil="true"/> <InvoiceTemplateName>E001</InvoiceTemplateName><PwsAuthenticateResult 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/"> <InvoiceTemplateUid>1152921504606878906</InvoiceTemplateUid> <b:PwsMessage> </EmailInvoiceTemplateIdentity> <b:AdditionalErrorText>Message 136: This request was executed against the QA Marlboro [secureqa.projectorpsa.com] environment.</b:AdditionalErrorText> <InvoiceEmailEnabledFlag>true</InvoiceEmailEnabledFlag> <b:ErrorCode>NonProductionEnvironment</b:ErrorCode> <InvoiceEmailType>P</InvoiceEmailType> <b:ErrorNumber>136</b:ErrorNumber> <b:ErrorText>This web service request <Recipients>was executed against a non-production instance of Projector.</b:ErrorText> <b:Type>Information</b:Type> <PwsInvoiceEmailRecipient> <b:ReferenceId1 i:nil="true"/> <RecipientType>T</RecipientType> <b:ReferenceId2 i:nil="true"/> </b:PwsMessage> <UserIdentity> </Messages> <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId> <UserDisplayName>Web Services</UserDisplayName><Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status> <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-16T18:43:11.6585593Z</ServerTimestampUtc> <UserId <a:RedirectUrl i:nil="true"/> <a:SessionTicket>ARQC8d/V3CZk+kOWf7w3KQ==</a:SessionTicket> <UserReferenceSystemId>WS01</UserReferenceSystemId><a:AccountIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:AccountCode>revcorp-min</b:AccountCode> <UserUid>1152921504607067736</UserUid><b:AccountId i:nil="true"/> <b:AccountUid>1152921504606848622</b:AccountUid> </UserIdentity>a:AccountIdentity> <a:UserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> </PwsInvoiceEmailRecipient> <b:UserDisplayName>Krakauer, Larry</b:UserDisplayName> <b:UserId i:nil="true"/> </Recipients> <b:UserReferenceSystemId>097</b:UserReferenceSystemId> </InvoiceEmailSettings> <b:UserUid>1152921504606944254</b:UserUid> <InheritRenderReceiptsFlag>false<</InheritRenderReceiptsFlag>a:UserIdentity> <a:SuperUserFlag>false</a:SuperUserFlag> <RenderReceiptsFlag>false</RenderReceiptsFlag> <a:DocumentServerUrl>https://docqa.projectorpsa.com/1</a:DocumentServerUrl> <AutoApplyAvailableBalanceFlag>false</AutoApplyAvailableBalanceFlag><a:Account xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <InheritAutoApplyAvailableBalanceFlag>false</InheritAutoApplyAvailableBalanceFlag><b:AccountCode>revcorp-min</b:AccountCode> <InheritTaxTypesFlag>false</InheritTaxTypesFlag><b:AccountId i:nil="true"/> <b:AccountUid>1152921504606848622</b:AccountUid> <TaxType1Identity> <b:Name>Revolutionary Solutions Corp <TaxTypeCode>VAT</TaxTypeCode>(Min Zeng)</b:Name> </a:Account> <TaxTypeId<a:User ixmlns:nilb="true"/http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UserDisplayName>Krakauer, Larry</b:UserDisplayName> <TaxTypeUid>1152921504606868258</TaxTypeUid> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>097</b:UserReferenceSystemId> </TaxType1Identity> <b:UserUid>1152921504606944254</b:UserUid> <TaxType2Identity i:nil="true"/> <b:EmailAddress>Larry@revcorp.min</b:EmailAddress> <TaxType3Identity i:nil="true"/><b:FirstName>Larry</b:FirstName> </ClientDetail><b:LastName>Krakauer</b:LastName> </PwsClientElement><b:MiddleName>Japan</b:MiddleName> </a:Clients>User> </PwsGetClientResult>PwsAuthenticateResult> </PwsGetClientResponse>PwsAuthenticateResponse> |
PwsGetClient - Common Errors and Warnings
...