A Series One Time Code (OTC)
Authorization code request endpoint. Returns an authorization code that can be exchanged with an access token.
None.
AuthCodeRequest
AuthCodeRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientId |
API client consumer id |
string |
Required |
| ClientSecret |
API client consumer secret |
string |
Required |
| Username |
Operator Username |
string |
Required |
| Password |
Operator Password |
string |
Required |
{
"ClientId": "o7p7zumt2qa5xfybvhepeyexg26ijdua",
"ClientSecret": "aWw2ZnJ4ZGR3YWN1MDdobzZyc2llbng2d3Ayc29nZTc=",
"Username": "user",
"Password": "password"
}
<AuthCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests"> <ClientId>o7p7zumt2qa5xfybvhepeyexg26ijdua</ClientId> <ClientSecret>aWw2ZnJ4ZGR3YWN1MDdobzZyc2llbng2d3Ayc29nZTc=</ClientSecret> <Password>password</Password> <Username>user</Username> </AuthCodeRequest>
ClientId=o7p7zumt2qa5xfybvhepeyexg26ijdua&ClientSecret=aWw2ZnJ4ZGR3YWN1MDdobzZyc2llbng2d3Ayc29nZTc=&Username=your-user-name&Password=your-password
AuthCodeResponse
AuthCodeResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header | ResponseHeader |
None. |
|
| Body | AuthCodeResponseBody |
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 |
|---|---|---|---|
| AuthCode |
Authorization Code, exchange this for an access token |
string |
None. |
{
"Header": {
"Message": "",
"StatusCode": 0,
"Status": "Ok",
"ErrorId": null
},
"Body": {
"AuthCode": "2j4ksda234kjsafdsaf14sfsdag1=="
}
}
<AuthCodeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses">
<Body>
<AuthCode>2j4ksda234kjsafdsaf14sfsdag1==</AuthCode>
</Body>
<Header>
<ErrorId i:nil="true" />
<Message></Message>
<Status>Ok</Status>
<StatusCode>Ok</StatusCode>
</Header>
</AuthCodeResponse>