You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
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)
<PwsAuthenticateResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<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/">
<b:PwsMessage>
<b:AdditionalErrorText>Message 136: This request was executed against the QA Marlboro [secureqa.projectorpsa.com] environment.</b:AdditionalErrorText>
<b:ErrorCode>NonProductionEnvironment</b:ErrorCode>
<b:ErrorNumber>136</b:ErrorNumber>
<b:ErrorText>This web service request was executed against a non-production instance of Projector.</b:ErrorText>
<b:Type>Information</b:Type>
<b:ReferenceId1 i:nil="true"/>
<b:ReferenceId2 i:nil="true"/>
</b:PwsMessage>
</Messages>
<ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-16T18:43:11.6585593Z</ServerTimestampUtc>
<a:RedirectUrl i:nil="true"/>
<a:SessionTicket>ARQC8d/V3CZk+kOWf7w3KQ==</a:SessionTicket>
<a:AccountIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:AccountCode>revcorp-min</b:AccountCode>
<b:AccountId i:nil="true"/>
<b:AccountUid>1152921504606848622</b:AccountUid>
</a:AccountIdentity>
<a:UserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:UserDisplayName>Krakauer, Larry</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>097</b:UserReferenceSystemId>
<b:UserUid>1152921504606944254</b:UserUid>
</a:UserIdentity>
<a:SuperUserFlag>false</a:SuperUserFlag>
<a:DocumentServerUrl>https://docqa.projectorpsa.com/1</a:DocumentServerUrl>
<a:Account xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:AccountCode>revcorp-min</b:AccountCode>
<b:AccountId i:nil="true"/>
<b:AccountUid>1152921504606848622</b:AccountUid>
<b:Name>Revolutionary Solutions Corp (Min Zeng)</b:Name>
</a:Account>
<a:User xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:UserDisplayName>Krakauer, Larry</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>097</b:UserReferenceSystemId>
<b:UserUid>1152921504606944254</b:UserUid>
<b:EmailAddress>Larry@revcorp.min</b:EmailAddress>
<b:FirstName>Larry</b:FirstName>
<b:LastName>Krakauer</b:LastName>
<b:MiddleName>Japan</b:MiddleName>
</a:User>
</PwsAuthenticateResult>
</PwsAuthenticateResponse>
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.
|