Overview
This web service acquires and Oauth Token
Request Format
PwsAcquireOauth2Token Request
- PwsAcquireOauth2Token
- serviceRequest: PwsAcquireOauth2TokenRq
- RequestId: Int32
- SessionTicket: String
- ClientIdentifier: String
- ClientSecret: String
- Code: String
- CodeVerifier: String
- GrantType: String
- RedirectUri: String
- RefreshToken: String
- serviceRequest: PwsAcquireOauth2TokenRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information | |||
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
PwsAcquireOauth2Token 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
- PwsAcquireOauth2TokenResult: PwsAcquireOauth2TokenRs
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
Int32 | Click here for more information | ||
RequestStatus | Click here for more information | ||
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
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 165 | ProjectNoteTruncated | The project note exceeded the maximum length of 1024 characters and was truncated. |