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.
Request Format
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information. | 1 | ||
String (50) | No | Click here for more information. | ARQC8d/V3CZk+kOWf7w3KQ== | ||
AccountCode | String (30) | Yes | The account code of the web service user's installation | revcorp-doc | |
CultureName | String (15) | No | The culture name is a unique identifier for a culture | en-US | |
Fingerprint | String | No | Authentication that grants user special permissions; Leave blank unless otherwise instructed by Projector support. | ||
Password | String (28) | Yes | The password of the web service user | 1JiLei$ | |
UserName | String (100) | Yes | The user name of the web service user | bruce@revcorp.doc | |
UtcOffsetMinutes | Int16 | No | Can be used (optionally) to specify the offset, in minutes between local time and UTC time. Should be expressed as a positive integer if local time is later than UTC time or a negative integer otherwise. Used in some circumstances to determine the current date sensitive to the caller’s local time. | ||
CrossoverTicket | String | No | Used internally; please disregard. |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<pws:PwsAuthenticate>
<pws:serviceRequest>
<req:AccountCode>revcorp-doc</req:AccountCode>
<req:Password>1JiLei$</req:Password>
<req:UserName>bruce@revcorp.doc</req:UserName>
</pws:serviceRequest>
</pws:PwsAuthenticate> |
Response Format
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | Click here for more information. | ||
Int32 | Click here for more information. | 0 | |
RequestStatus | Click here for more information. | Ok | |
DateTime | Click here for more information. | 2018-01-16T18:43:11.6585593Z | |
RedirectUrl | String | Projector accounts are hosted on multiple servers. To simplify the authentication process, an authentication request may be issued to any server endpoint. However, if the account’s data is hosted on a different server, this will be the base URL of the server that hosts the data. The same authentication request should be re-sent to the specified endpoint. Please click _here_ for more details. | |
String (24) | Click here for more information. | ARQC8d/V3CZk+kOWf7w3KQ== | |
AccountIdentity | The unique keys used to identify an account | ||
UserIdentity | The unique keys used to identify an user | ||
SuperUserFlag | Boolean | If true, web service user is a Projector support user. | true/false |
DocumentServerUrl | String | The base URL for uploading and downloading documents | https://doc.projectorpsa.com/1 |
Account | Click here for more information. | ||
User | Click here for more information. |
Response Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<PwsAuthenticateResponse>
<PwsAuthenticateResult>
<Messages i:nil="true"/>
<ResponseId>0</ResponseId>
<Status>Ok</Status>
<ServerTimestampUtc>2018-01-16T18:43:11.6585593Z</ServerTimestampUtc>
<a:RedirectUrl i:nil="true"/>
<a:SessionTicket>ARQC8d/V3CZk+kOWf7w3KQ==</a:SessionTicket>
<a:AccountIdentity>
<b:AccountCode>revcorp-doc</b:AccountCode>
<b:AccountId i:nil="true"/>
<b:AccountUid>1152921504606849994</b:AccountUid>
</a:AccountIdentity>
<a:UserIdentity>
<b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>097</b:UserReferenceSystemId>
<b:UserUid>1152921504606950320</b:UserUid>
</a:UserIdentity>
<a:SuperUserFlag>false</a:SuperUserFlag>
<a:DocumentServerUrl>https://doc.projectorpsa.com/1</a:DocumentServerUrl>
<a:Account>
<b:AccountCode>revcorp-doc</b:AccountCode>
<b:AccountId i:nil="true"/>
<b:AccountUid>1152921504606849994</b:AccountUid>
<b:Name>Revolutionary Solutions Corp (Documentation)</b:Name>
</a:Account>
<a:User>
<b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId i:nil="true"/>
<b:UserUid>1152921504606950320</b:UserUid>
<b:EmailAddress>bruce@revcorp.doc</b:EmailAddress>
<b:FirstName>Bruce</b:FirstName>
<b:LastName>Wayne</b:LastName>
<b:MiddleName i:nil="true"/>
</a:User>
</PwsAuthenticateResult>
</PwsAuthenticateResponse>
|
PwsAuthenticate - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 10002 | InvalidCredentials | The specified credentials are not valid. Please try again. |
| 50220 | WebServicesPermissionDenied | The specified user does not have permission to execute web services, or web services is not enabled for this account. |