Overview

This web service allows 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

PwsAuthenticateRq

PwsAuthenticateRq
- RequestId: Int32
- SessionTicket: String (50)
- AccountCode: String (30)
- CultureName: String (15)
- Fingerprint: String
- Password: String (28)
- UserName: String (100)
- UtcOffsetMinutes: Int16
- CrossoverTicket: String

Request Elements

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information.	1
SessionTicket	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	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)

Example 01

<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-doc</req:AccountCode>
            <req:Password>kouling</req:Password>
            <req:UserName>bruce@revcorp.doc</req:UserName>
         </pws:serviceRequest>
      </pws:PwsAuthenticate>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsAuthenticateRs

PwsAuthenticateRs
- Messages: PwsMessage[]
- ResponseId: Int32
- RequestStatus: RequestStatus
- ServerTimestampUtc: DateTime
- RedirectUrl: String
- SessionTicket: String
- AccountIdentity: PwsAccountRef
- UserIdentity: PwsUserRef
- SuperUserFlag: Boolean
- DocumentServerUrl: String
- Account: PwsAccountSummary
- User: PwsUserSummary

Response Elements

Element	Data Type	Description	Sample Data
Messages	PwsMessage[]	Click here for more information.
ResponseId	Int32	Click here for more information.	0
Status	RequestStatus	Click here for more information.	Ok
ServerTimestampUtc	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.
SessionTicket	String (24)	Click here for more information.	ARQC8d/V3CZk+kOWf7w3KQ==
AccountIdentity	PwsAccountRef	The unique keys used to identify an account
UserIdentity	PwsUserRef	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	PwsAccountSummary	Click here for more information.
User	PwsUserSummary	Click here for more information.

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <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/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-18T15:02:00.3123466Z</ServerTimestampUtc>
            <a:RedirectUrl i:nil="true"/>
            <a:SessionTicket>AUGTzGBZqJYkAuFk3+SPfw==</a:SessionTicket>
            <a:AccountIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:AccountCode>revcorp-doc</b:AccountCode>
               <b:AccountId i:nil="true"/>
               <b:AccountUid>1152921504606849994</b:AccountUid>
            </a:AccountIdentity>
            <a:UserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
               <b:UserId i:nil="true"/>
               <b:UserReferenceSystemId i:nil="true"/>
               <b:UserUid>1152921504606950320</b:UserUid>
            </a:UserIdentity>
            <a:SuperUserFlag>false</a:SuperUserFlag>
            <a:DocumentServerUrl>https://doc.projectorpsa.com/1</a:DocumentServerUrl>
            <a:Account xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <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 xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <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>
   </s:Body>
</s:Envelope>

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.