Versions Compared

Key

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

Overview


This web service

...

acquires and Oauth Token

Request Format


Panel
titlePwsAcquireOauth2Token Request
  • PwsAcquireOauth2Token

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information


SessionTicket

String

Yes


Click here for more information


ClientIdentifier

String





ClientSecret

String





Code

String





CodeVerifier

String





GrantType

String





RedirectUri

String





RefreshToken

String





Request Usage Example(s)


Response Format


Panel
titlePwsAcquireOauth2Token Response
  • PwsAcquireOauth2TokenResponse
    • PwsAcquireOauth2TokenResult: PwsAcquireOauth2TokenRs
      • Messages: PwsMessage[]
      • ResponseId: Int32
      • Status: RequestStatus
      • ServerTimestampUtc: DateTime
      • AccessToken: String
      • ExpiresInSeconds: Int32
      • MaxLifetimeMinutes: Int32
      • RedirectUrl: String
      • RefreshToken: String
      • RestServiceAuthority: String
      • SoapServiceAuthority: String
      • TimeoutMinutes: Int32
      • TokenType: String

Response Elements


Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

The web service response status and message. Click here for more information.


ResponseId

Int32

Click here for more information


Status

RequestStatus

Click here for more information


ServerTimestampUtc

DateTime

Click here for more information


AccessToken

String



ExpiresInSeconds

Int32



MaxLifetimeMinutes

Int32



RedirectUrl

String



RefreshToken

String



RestServiceAuthority

String



SoapServiceAuthority

String



TimeoutMinutes

Int32



TokenType

String



PwsAcquireOauth2Token - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

165ProjectNoteTruncatedThe project note exceeded the maximum length of 1024 characters and was truncated.