POST oauth2/onetime/token

Request Information

URI Parameters

None.

Body Parameters

OneTimeTokenRequest
NameDescriptionTypeAdditional information
ClientId

string

Required

BrokerId

globally unique identifier

None.

UserName

string

None.

TradingAccount

string

None.

Server

string

None.

Payload

Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "clientId": "sample string 1",
  "brokerId": "3be9edf1-5491-4d5c-a5c6-423218dfb6cc",
  "userName": "sample string 3",
  "tradingAccount": "sample string 4",
  "server": "sample string 5",
  "payload": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<OneTimeTokenRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/App.Auth.Models">
  <BrokerId>3be9edf1-5491-4d5c-a5c6-423218dfb6cc</BrokerId>
  <ClientId>sample string 1</ClientId>
  <Payload xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Payload>
  <Server>sample string 5</Server>
  <TradingAccount>sample string 4</TradingAccount>
  <UserName>sample string 3</UserName>
</OneTimeTokenRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OneTimeTokenRequest'.

Response Information

Resource Description

OneTimeTokenResponse
NameDescriptionTypeAdditional information
Code

string

None.

Response Formats

application/json, text/json

Sample:
{
  "code": "sample string 1"
}

application/xml, text/xml

Sample:
<OneTimeTokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/App.Auth.Models">
  <Code>sample string 1</Code>
</OneTimeTokenResponse>