You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
Overview
This web service allows user to retrieve a session ticket for subsequent web service requests after receiving valid account information such as account code, user name and password.
- PwsAuthenticateRq
- RequestId: Int32
- SessionTicket: String
- AccountCode: String
- CultureName: String
- Fingerprint: String
- Password: String
- UserName: String
- UtcOffsetMinutes: Int16
- CrossoverTicket: String
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|
Messages | PwsMessage[] |
|
|
|
|
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 | PwsAccountRef |
|
|
|
|
UserIdentity | PwsUserRef |
|
|
|
|
SuperUserFlag | Boolean |
|
|
|
|
DocumentServerUrl | String |
|
|
|
|
Account | PwsAccountSummary |
|
|
|
|
User | PwsUserSummary |
|
|
|
|
Request Usage Example(s)
<pws:PwsAuthenticate>
<pws:serviceRequest>
<req:Password>1JiLei$</req:Password>
<req:UserName>larry@revcorp.min</req:UserName>
</pws:serviceRequest>
</pws:PwsAuthenticate>
Response Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|
Messages | PwsMessage[] | | | | |
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 | PwsAccountRef | | | | |
UserIdentity | PwsUserRef | | | | |
SuperUserFlag | Boolean | | | | |
DocumentServerUrl | String | | | | |
Account | PwsAccountSummary | | | | |
User | PwsUserSummary | | | | |
Response Usage Example(s)
<PwsGetClientResponse>
<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>
<InvoiceTemplateUid>1152921504606878906</InvoiceTemplateUid>
</EmailInvoiceTemplateIdentity>
<InvoiceEmailEnabledFlag>true</InvoiceEmailEnabledFlag>
<InvoiceEmailType>P</InvoiceEmailType>
<Recipients>
<PwsInvoiceEmailRecipient>
<RecipientType>T</RecipientType>
<UserIdentity>
<UserDisplayName>Web Services</UserDisplayName>
<UserId i:nil="true"/>
<UserReferenceSystemId>WS01</UserReferenceSystemId>
<UserUid>1152921504607067736</UserUid>
</UserIdentity>
</PwsInvoiceEmailRecipient>
</Recipients>
</InvoiceEmailSettings>
<InheritRenderReceiptsFlag>false</InheritRenderReceiptsFlag>
<RenderReceiptsFlag>false</RenderReceiptsFlag>
<AutoApplyAvailableBalanceFlag>false</AutoApplyAvailableBalanceFlag>
<InheritAutoApplyAvailableBalanceFlag>false</InheritAutoApplyAvailableBalanceFlag>
<InheritTaxTypesFlag>false</InheritTaxTypesFlag>
<TaxType1Identity>
<TaxTypeCode>VAT</TaxTypeCode>
<TaxTypeId i:nil="true"/>
<TaxTypeUid>1152921504606868258</TaxTypeUid>
</TaxType1Identity>
<TaxType2Identity i:nil="true"/>
<TaxType3Identity i:nil="true"/>
</ClientDetail>
</PwsClientElement>
</a:Clients>
</PwsGetClientResult>
</PwsGetClientResponse>
PwsGetClient - Common Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|
| 11038 | NoClientsSpecified | No clients were specified for retrieval by this request.
|
| 11040 | MaximumClientIdentitiesExceeded | Please specify between 1 and 100 client identities for retrieval.
|
| 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.
|