Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
titlePwsAuthenticateRq
  • PwsAuthenticateRq
    • RequestId: Int32
    • SessionTicket: String (24)
    • AccountCode: String (30)
    • CultureName: String (15)
    • Fingerprint: String
    • Password: String (28)
    • UserName: String (100)
    • UtcOffsetMinutes: Int16
    • CrossoverTicket: String

Request Elements

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

 No


Click here for more information.


SessionTicket

String (24)

 No


Click here for more information.


AccountCode

String (30)

Yes


The account code of the web service user's installation

revcorp-min

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

 larry@revcorp.min

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
languagexml
titleRequest 01
collapsetrue
      <pws:PwsAuthenticate>
         <pws:serviceRequest>
            <req:AccountCode>revcorp-min</req:AccountCode>
            <req:Password>1JiLei$</req:Password>
            <req:UserName>larry@revcorp.min</req:UserName>
         </pws:serviceRequest>
      </pws:PwsAuthenticate>


Response Format


Panel
titlePwsAuthenticateRs


Response Elements

Element

Data Type

Required?

Default

Description

Sample Data

Messages

PwsMessage[]





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





SessionTicket

String(24)



Click here for more information.

ARQC8d/V3CZk+kOWf7w3KQ==

AccountIdentity

PwsAccountRef





UserIdentity

PwsUserRef





SuperUserFlag

Boolean



If true, web service user is a Projector support user.


DocumentServerUrl

String





Account

PwsAccountSummary





User

PwsUserSummary





Response Usage Example(s)


Code Block
languagexml
titleResponse 01
collapsetrue
     <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-min</b:AccountCode>
               <b:AccountId i:nil="true"/>
               <b:AccountUid>1152921504606848622</b:AccountUid>
            </a:AccountIdentity>
            <a:UserIdentity>
               <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>
               <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>
               <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>

PwsAuthenticate - Common Errors and Warnings

ErrorNumberErrorCodeErrorText
10002
InvalidCredentials
The specified credentials are not valid. Please try again.