A Series One Time Code (OTC)
Access token request endpoint. Returns a usable access token that can be used to access the API.
None.
AccessTokenRequest
AccessTokenRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientId |
API client consumer id |
string |
Required |
| ClientSecret |
API client consumer secret |
string |
Required |
| AuthCode |
Authorization code |
string |
Required |
| Username | string |
Required |
{
"ClientId": "o7p7zumt2qa5xfybvhepeyexg26ijdua",
"ClientSecret": "aWw2ZnJ4ZGR3YWN1MDdobzZyc2llbng2d3Ayc29nZTc=",
"AuthCode": "sxsrub6j0jw6ccdbixyiq1opun7ptphm",
"Username": null
}
<AccessTokenRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests"> <AuthCode>sxsrub6j0jw6ccdbixyiq1opun7ptphm</AuthCode> <ClientId>o7p7zumt2qa5xfybvhepeyexg26ijdua</ClientId> <ClientSecret>aWw2ZnJ4ZGR3YWN1MDdobzZyc2llbng2d3Ayc29nZTc=</ClientSecret> <Username i:nil="true" /> </AccessTokenRequest>
ClientId=o7p7zumt2qa5xfybvhepeyexg26ijdua&ClientSecret=aWw2ZnJ4ZGR3YWN1MDdobzZyc2llbng2d3Ayc29nZTc=&AuthCode=sxsrub6j0jw6ccdbixyiq1opun7ptphm
AccessTokenResponse
AccessTokenResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header |
Access token response message header. |
ResponseHeader |
None. |
| Body |
Access token response message body. |
AccessTokenResponseBody |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| Message |
Message |
string |
None. |
| StatusCode |
Status code |
ResponseStatus |
None. |
| Status |
Status |
string |
None. |
| ErrorId |
Error id |
string |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| AccessToken |
Access token |
string |
None. |
| PriorityLevel |
Operator Priority Level |
integer |
None. |
| AdministratorId |
Administrator Id |
integer |
None. |
{
"Header": {
"Message": "",
"StatusCode": 0,
"Status": "Ok",
"ErrorId": null
},
"Body": {
"AccessToken": "2j4ksda234kjsafdsaf14sfsdag1==",
"PriorityLevel": 0,
"AdministratorId": 0
}
}
<AccessTokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses">
<Body>
<AccessToken>2j4ksda234kjsafdsaf14sfsdag1==</AccessToken>
<AdministratorId>0</AdministratorId>
<PriorityLevel>0</PriorityLevel>
</Body>
<Header>
<ErrorId i:nil="true" />
<Message></Message>
<Status>Ok</Status>
<StatusCode>Ok</StatusCode>
</Header>
</AccessTokenResponse>