Overview
This web service allows user a caller to retrieve a session ticket for subsequent web service requests after receiving valid account information such as an account code, a user name and password. If you intent to use the method with OAuth, the OAuth 2.0 Client Application Developer Guide is a valuable reference.
Request Format
Panel | ||
---|---|---|
| ||
|
...
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-mindoc | |
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 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 | larry@revcorp bruce@revcorp.mindoc | |
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. |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/"> <soapenv:Header/> <soapenv:Body> <pws:PwsAuthenticate> <pws:serviceRequest> <req:AccountCode>revcorp-min<doc</req:AccountCode> <req:Password>1JiLei$<Password>kouling</req:Password> <req:UserName>larry@revcorpUserName>bruce@revcorp.min<doc</req:UserName> </pws:serviceRequest> </pws:PwsAuthenticate> </soapenv:Body> </soapenv:Envelope> |
Response Format
Panel | ||
---|---|---|
| ||
|
Response Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
Messages | Click here for more information. | ||||
Int32 | Click here for more information. | 0 | |||
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. |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <PwsAuthenticateResponse><s:Body> <PwsAuthenticateResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsAuthenticateResult><PwsAuthenticateResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Messages i:nil="true xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ResponseId>0<<ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId> <Status>Ok<<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status> <ServerTimestampUtc>2018<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-16T1818T15:4302:1100.6585593Z<3123466Z</ServerTimestampUtc> <a:RedirectUrl i:nil="true"/> <a:SessionTicket>ARQC8d/V3CZkSessionTicket>AUGTzGBZqJYkAuFk3+kOWf7w3KQSPfw==</a:SessionTicket> <a:AccountIdentity>AccountIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:AccountCode>revcorp-min<doc</b:AccountCode> <b:AccountId i:nil="true"/> <b:AccountUid>1152921504606848622<AccountUid>1152921504606849994</b:AccountUid> </a:AccountIdentity> <a:UserIdentity>UserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UserDisplayName>Krakauer,UserDisplayName>Bruce Larry<Wayne</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>097</b:UserReferenceSystemId>UserReferenceSystemId i:nil="true"/> <b:UserUid>1152921504606944254<UserUid>1152921504606950320</b:UserUid> </a:UserIdentity> <a:SuperUserFlag>false</a:SuperUserFlag> <a:DocumentServerUrl>https://doc.projectorpsa.com/1</a:DocumentServerUrl> <a:Account>Account xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:AccountCode>revcorp-min<doc</b:AccountCode> <b:AccountId i:nil="true"/> <b:AccountUid>1152921504606848622<AccountUid>1152921504606849994</b:AccountUid> <b:Name>Revolutionary Solutions Corp (Min ZengDocumentation)</b:Name> </a:Account> <a:User>User xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UserDisplayName>Krakauer,UserDisplayName>Bruce Larry<Wayne</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>097</b:UserReferenceSystemId>:UserReferenceSystemId i:nil="true"/> <b:UserUid>1152921504606944254<UserUid>1152921504606950320</b:UserUid> <b:EmailAddress>Larry@revcorpEmailAddress>bruce@revcorp.min<doc</b:EmailAddress> <b:FirstName>Larry<FirstName>Bruce</b:FirstName> <b:LastName>Krakauer<LastName>Wayne</b:LastName> <b:MiddleName>Japan</b:MiddleName>MiddleName i:nil="true"/> </a:User> </PwsAuthenticateResult> </PwsAuthenticateResponse> </s:Body> </s:Envelope> |
PwsAuthenticate - Common 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. |