Overview
User management, Client notifications, Authentication web-services
Version information
Version: v1
Contact information
Contact: DevExperts Contact Email: dxcore-dev@devexperts.com
Tags
-
ClientNotifications
-
dxRegister
-
dxWeb
-
TransactionImport
Authentication
The DxRegister API supports two methods of authentication:
-
HTTP Basic authentication
-
Authentication via session token (the recommended method)
Basic HTTP authentication
Basic authentication is the simplest type of authentication. You can find a description of the algorithm at the following link: https://en.wikipedia.org/wiki/Basic_access_authentication
To use it, send Basic <credentials> in the Authorization header of the HTTP request. Here, <credentials> is a BASE64-encoded string of username@domain:password (credentials are provided by our support team).
For example, if you wish to perform basic authentication with username=testUser, domain=default, password=testpass, then in the Authorization header you should pass Basic BASE64(testUser@default:testpass), which results in Authorization:Basic dGVzdFVzZXJAZGVmYXVsdDp0ZXN0cGFzcw==.
Authentication by session token
-
To authenticate using a session token, you first need to log in and generate it. Send a
POSTrequest to the/loginresource with the following JSON in the request body (credentials are provided by our support team).
Note: to login on behalf of another user LOGIN_ON_BEHALF permission is required.
{
"username": <username>,
"domain": <domain>,
"password": <password>
}
You will receive a response with a session token and its timeout - lifetime of token in milliseconds:
{
"sessionToken": <sessionToken>,
"timeout": <timeout>
}
-
Thereafter, for each HTTP request, send this
sessionTokenin theAuthorizationheader in the formatDXAPI sessionToken.
For example, if the session token is aaabbbccc, then in the HTTP request you should send Authorization: DXAPI aaabbbccc.
-
After successful authentication request, in order to prolongate
sessionTokenlifetime you need to send 'POST' request to the '/ping' resource with empty body andsessionTokeninAuthorizationheader as described before. Ping request should be sent beforesessionTokenexpiration. If '/ping' request completed successfully you will receive a response with asession tokenand its newtimeout:
{
"sessionToken": <sessionToken>,
"timeout": <timeout>
}
When a ping is received, server checks session duration. If a session is more than halfway through its duration, it is extended by half of the original duration. Otherwise, nothing happens.
Example:
-
A session starts at 10:00 and expires at 10:30 (30-minute duration).
-
Pings before 10:15 do nothing.
-
A ping after 10:15 extends the session to 10:45.
-
No further extension will occur until after 10:30, at which point another ping will extend it to 11:00.
Scenarios
User Onboarding
To onboard a user, refer to the "Create new client with accounts" section.
Definitions
Account
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
clearingCode |
Clearing code of this account. Pair clearingCode+accountCode should be unique. By default broker clearing code is used if not specified |
false |
string |
|
accountCode |
Account code of this account. Pair clearingCode+accountCode should be unique |
true |
string |
|
brokerCode |
Code of broker this account belongs to. It should be empty or equal to broker code of account owner |
false |
string |
|
type |
Type of account. CLIENT if not specified |
false |
enum (CLIENT, OFFSET, REFERENCE) |
|
status |
Status of account. FULL_TRADING if not specified |
false |
enum (FULL_TRADING, CLOSE_ONLY, NO_TRADING, TERMINATED, EXPIRED) |
|
accountCashType |
MARGIN means margin trading is allowed for account. CASH means margin trading is not allowed. MARGIN if not specified |
false |
enum (MARGIN, CASH) |
|
expirationDate |
Time when DEMO account will be marked as EXPIRED. Not applicable for LIVE accounts |
false |
string (date-time) |
|
accountType |
Account type. DEMO if not specified |
false |
enum (DEMO, CHALLENGE, LIVE) |
|
currency |
Account currency symbol. E.g. USD, EUR, CHF, etc. |
true |
string |
|
balance |
Account balance. 0 if not specified |
false |
number (double) |
|
credit |
false |
number (double) |
||
equityOptionsLevel |
Level of Equity Options trading |
false |
integer (int32) |
|
categories |
Account groups account should be included in |
false |
Account group array |
|
futuresOptionsLevel |
Level of Futures Options trading |
false |
integer (int32) |
|
allowedInstruments |
Account allowed instruments |
false |
string array |
|
alpacaOmnibusSubAccountId |
Alpaca Omnibus Sub account id |
false |
string |
|
selfDepositBalanceAllowed |
Whether user allowed to deposit balance. Value of the flag is skipped for non DEMO accounts |
false |
boolean |
|
pdtAccount |
false |
boolean |
Account group
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
category |
Account group category type. E.g. Commissions, RankedGroupCommissions, DxBroRiskControl etc. |
true |
string |
|
value |
Exact name of account group account belongs to |
true |
string |
Account update model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
expirationDate |
Account expiration time. Applicable only for DEMO accounts |
false |
string (date-time) |
|
status |
Account status |
false |
enum (FULL_TRADING, CLOSE_ONLY, NO_TRADING, TERMINATED, EXPIRED) |
|
credit |
false |
number (double) |
||
equityOptionsLevel |
Level of Equity Options trading |
false |
integer (int32) |
|
isPdtAccount |
Whether account is PDT, false if not specified |
false |
boolean |
|
futuresOptionsLevel |
Level of Futures Options trading |
false |
integer (int32) |
|
allowedInstruments |
Account allowed instruments |
false |
string array |
|
alpacaOmnibusSubAccountId |
Alpaca Omnibus Sub account id |
false |
string |
|
selfDepositBalanceAllowed |
Whether user allowed to deposit balance. Value of the flag is skipped for non DEMO accounts |
false |
boolean |
Adjustment model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
currency |
Currency of transfer. E.g. USD, EUR, CHF, etc. |
true |
string |
|
amount |
Amount of transfer |
true |
number (double) |
|
description |
Description of transfer |
false |
string |
|
transferId |
Unique identifier of this transfer |
false |
string |
Broker model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
true |
string |
||
brokerCode |
true |
string |
||
namespace |
true |
string |
||
parentBrokerCode |
false |
string |
||
countryCode |
false |
string |
||
type |
false |
enum (TRADING_FIRM, EXEC_BROKER, SUP_BROKER, OMNIBUS) |
||
description |
false |
string |
||
clientPrincipalGroup |
false |
string |
||
dealerPrincipalGroup |
false |
string |
Broker notification recipient
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
domain |
true |
string |
||
login |
true |
string |
Category model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
category |
true |
string |
||
values |
false |
CategoryValueModel array |
CategoryValueModel
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
value |
true |
string |
Client group model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
domain |
domain of the group. Pair domain+name is unique for the group |
false |
string |
|
name |
name of the group. Pair domain+name is unique for the group |
false |
string |
|
clients |
direct members of this group, formatted as 'domain@login'. In input requests may be omitted |
false |
string array |
|
ancestors |
direct ancestors of this group, formatted as 'domain@name'. In input requests may be omitted |
false |
string array |
Client model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
domain |
Domain of client. If not specified domain of broker will be used |
false |
string |
|
login |
login of client |
true |
string |
|
accounts |
List of accounts client owns |
false |
Account array |
|
fullName |
Client’s full name |
false |
string |
|
Client’s email |
false |
string |
||
brokerCode |
Code of broker this client belongs to |
false |
string |
|
type |
Type of client |
false |
enum (CLIENT, OTHER) |
|
status |
Client’s status |
false |
enum (ONLINE, OFFLINE, DISABLED) |
|
password |
Client’s password |
false |
string |
|
passwordExpiry |
Password expiration period in days |
false |
integer (int32) |
|
passwordReset |
Whether client should reset password on first login |
false |
boolean |
|
createdDateTime |
Timestamp when client was created in system |
false |
string (date-time) |
|
lastLogin |
Last login time |
false |
string (date-time) |
|
groups |
List of groups names, which have client as member formatted as 'domain@name' |
false |
string array |
|
birthPlace |
Client’s birth place |
false |
string |
|
birthDate |
Client’s birth date |
false |
string (date) |
|
citizenship |
Client’s citizenship |
false |
string |
|
phone |
Client’s phone number |
false |
string |
|
insuranceNumber |
Client’s insurance number |
false |
string |
|
company |
Client’s company |
false |
string |
|
contractDate |
Client’s contract date |
false |
string (date) |
|
location |
Client’s location |
false |
||
document |
Client’s document |
false |
||
comments |
Comments applicable to client |
false |
string |
|
dxFeedAccountId |
DXFeed account id |
false |
string |
Client notification message delivery status for a recipient
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
recipient |
false |
|||
readTime |
false |
integer (int64) |
||
acknowledgmentTime |
false |
integer (int64) |
Client notification model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
recipients |
false |
|||
sendToAll |
false |
enum (ALL, LIVE, DEMO) |
||
priority |
true |
enum (LOW, HIGH, CRITICAL) |
||
subject |
true |
string |
||
message |
true |
string |
||
expirationDate |
true |
string (date-time) |
||
mustAcknowledge |
true |
boolean |
Client update model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
fullName |
false |
string |
||
false |
string |
|||
password |
false |
string |
||
passwordExpiry |
false |
integer (int32) |
||
passwordReset |
false |
boolean |
||
status |
Status of the user to set |
false |
enum (ONLINE, OFFLINE, DISABLED) |
|
groupsAdded |
Principal Groups to place the user to |
false |
Client group model array |
|
groupsRemoved |
Principal Groups to remove the user from |
false |
Client group model array |
|
birthPlace |
false |
string |
||
birthDate |
false |
string (date) |
||
citizenship |
false |
string |
||
phone |
false |
string |
||
insuranceNumber |
false |
string |
||
company |
false |
string |
||
contractDate |
false |
string (date) |
||
location |
false |
|||
document |
false |
|||
comments |
false |
string |
||
dxFeedAccountId |
false |
string |
Commission model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
quantity |
Commission/fee/tax quantity |
true |
number (double) |
|
type |
Commission/fee/tax type. Can be omitted |
false |
string |
Deposit model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
currency |
Currency of transfer. E.g. USD, EUR, CHF, etc. |
true |
string |
|
amount |
Amount of transfer |
true |
number (double) |
|
description |
Description of transfer |
false |
string |
|
transferId |
Unique identifier of this transfer |
false |
string |
DocumentModel
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
false |
string |
||
series |
false |
string |
||
number |
false |
string |
||
issuedBy |
false |
string |
||
issuedDate |
false |
string (date) |
DxFeed account suspension model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
accountId |
Account ID |
true |
string |
DxFeed subscriptions update model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
accountId |
Account ID |
true |
string |
|
subscriptions |
Subscription list |
true |
SubscriptionItem array |
Error description
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
errorCode |
error code |
true |
integer (int32) |
|
errorMessage |
brief error description |
true |
string |
Error description extended by additional details
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
errorCode |
error code |
true |
integer (int32) |
|
errorMessage |
brief error description |
true |
string |
|
errorDetails |
Additional details about error |
false |
string array |
Failed transaction
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
transactionId |
id of passed transaction |
true |
string |
|
errorCode |
Error code |
true |
enum (INCORRECT_QUANTITY, ACCOUNT_NOT_FOUND, SYMBOL_NOT_FOUND, CASH_TRANSACTION_IS_NOT_IN_ACCOUNT_CURRENCY, NON_CASH_TRANSACTION_IS_NOT_IN_ACCOUNT_CURRENCY, ACTION_TYPE_IS_MISSED, ACTION_TYPE_IS_NOT_SUPPORTED_FOR_INSTRUMENT_TYPE, ONLY_DELETE_AND_UPDATE_FOR_TRADE, COST_BASIS_NOT_SPECIFIED_FOR_NON_CASH_POSITION, INCORRECT_COST_BASIS, COST_BASIS_SIGN_MISMATCH_QUANTITY_SIGN, TRANSACTION_NOT_FOUND_FOR_UPDATE_OR_DELETE, MULTILEG_TRANSACTION_CAN_NOT_BE_UPDATED, EMPTY_TRANSACTION_ID, DUPLICATE_TRANSACTION_ID, INCORRECT_TRANSACTION_ID, COLUMN_CANNOT_BE_UPDATED_FOR_TRADE, MISMATCH_TRANSACTION_TYPE, ACCOUNT_NUMBER_CANNOT_BE_UPDATED, UNEXPECTED_ERROR, INCORRECT_CASH_EFFECT, INCORRECT_PRICE, INCORRECT_COMMISSION_VALUE, MISMATCH_TRADE_TYPE) |
|
errorText |
Error description |
true |
string |
LocationModel
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
countryCode |
false |
string |
||
zipCode |
false |
string |
||
address |
false |
string |
Login request model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
username |
false |
string |
||
domain |
false |
string |
||
password |
false |
string |
||
appKey |
false |
string |
LoginResult
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
sessionToken |
false |
string |
||
timeout |
false |
integer (int64) |
Notification delivery information per recipients
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
notificationId |
false |
string |
||
statuses |
false |
Client notification message delivery status for a recipient array |
Rename account group
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
category |
Key of account group category |
false |
string |
|
oldValue |
Old group name |
false |
string |
|
newValue |
New group name |
false |
string |
SSOTokenInfo
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
expirationTime |
false |
integer (int64) |
||
userName |
false |
string |
||
userDomain |
false |
string |
||
userId |
false |
integer (int32) |
||
serialNumber |
false |
integer |
SubscriptionItem
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
feedName |
Name of subscription |
true |
string |
|
endDate |
Subscription end date |
false |
string |
Token request model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
dxCoreSessionToken |
false |
string |
||
tokenDuration |
false |
integer (int64) |
||
tokenOrigin |
false |
string |
Transaction model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
accountCode |
Account code |
true |
string |
|
quantity |
Quantity of transaction |
true |
number (double) |
|
symbol |
Instrument symbol. E.g IBM, AAPL, TSLA, etc |
true |
string |
|
timestamp |
Transaction timestamp in ISO date-time format yyyy-MM-dd’T’HH:mm:ss.SSS’Z'. If not set, timestamp is set to datetime of the API call. |
false |
string (date-time) |
|
costBasis |
Total transaction cost. For Stocks/ETF/Mutual Funds should be Negative, if Qty is positive, and vice versa |
false |
number (double) |
|
cashEffect |
Transaction cash effect. If omitted then the transaction will not impact underlying account balance, only the corresponding instrument/position is updated |
false |
number (double) |
|
activityType |
Transaction activity type. If omitted, the transfer type of ADJUSTMENT with the product leg should be used |
false |
enum (DIVIDEND, DEPOSIT, WITHDRAWAL, COMMISSION, EXPIRATION, DELISTING, SPIN_OFF, RENAME, M_AND_A, SPLIT, REBATE, EXERCISE, POSITION_UPDATE, ADJUSTMENT, TRADE, SERVICE_CHARGE, FINANCING, ASSIGNMENT, OVERNIGHT_SHORT_FEE, MARGIN_INTEREST, BOOK_TRADE, CORPORATE_ACTION) |
|
transactionId |
Unique id of transaction in format sessionCode:actionCode |
true |
string |
|
action |
Action to perform with transaction |
true |
enum (CREATE, UPDATE, DELETE) |
|
transactionDescription |
Transaction description |
false |
string |
|
commissions |
list of commissions |
false |
Commission model array |
|
fees |
list of fees |
false |
Commission model array |
|
taxes |
list of taxes |
false |
Commission model array |
|
clearingCode |
Clearing code. If omitted default one will be used |
false |
string |
|
calculateCashEffect |
Boolean flag defining whether system should calculate cashEffect value automatically based on costBasis value. |
false |
boolean |
Transactions import result
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
createdTransactions |
List of created transaction IDs in format sessionCode:actionCode |
true |
string array |
|
updatedTransactions |
List of updated transaction IDs in format sessionCode:actionCode |
true |
string array |
|
deletedTransactions |
List of deleted transaction IDs in format sessionCode:actionCode |
true |
string array |
|
failedTransactions |
List of transactions failed to import with errors |
true |
Failed transaction array |
Withdrawal model
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
currency |
Currency of transfer. E.g. USD, EUR, CHF, etc. |
true |
string |
|
amount |
Amount of transfer |
true |
number (double) |
|
description |
Description of transfer |
false |
string |
|
transferId |
Unique identifier of this transfer |
false |
string |
Paths
Create and send notification to traders
POST /api/clientnotifications
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Client notification model |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Failure with possible error codes : - 20001: Some of the required field is empty - 20020: Access denied - 20022: Invalid json message format - 20028: Subject field exceeds text limit - 20029: Message field exceeds text limit - 20030: Expiration time in the past |
|
404 |
Failure with possible error codes : - 20027: Specified recipient is not found - 20014: Specified owner is not found or not a client |
|
500 |
Failure with possible error codes : - 10001: Unknown error |
Consumes
-
application/json
Produces
-
text/plain
Tags
-
ClientNotifications
Get notification delivery information
GET /api/clientnotifications/notification/{notificationId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
notificationId |
Notification Id |
true |
string |
|
QueryParameter |
recipients |
Recipients |
false |
array (<login>@<domain>[&recipients=<login>@<domain>]) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Failure with possible error codes : - 30020: Bad recipients format |
|
404 |
Failure with possible error codes : - 30019: Specified message is not found |
|
500 |
Failure with possible error codes : - 10001: Unknown error |
Produces
-
application/json
Tags
-
ClientNotifications
Update notification expiration date
PUT /api/clientnotifications/notification/{notificationId}/date/{expirationDate}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
notificationId |
Notification Id |
true |
string |
|
PathParameter |
expirationDate |
Notification expiration date |
true |
string (date-time) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
403 |
Failure with possible error codes : - 20020: Access denied |
|
404 |
Failure with possible error codes : - 30019: Specified message is not found |
|
500 |
Failure with possible error codes : - 10001: Unknown error |
Produces
-
text/plain
Tags
-
ClientNotifications
Retrieve accounts info
GET /api/register/account
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
type |
type of accounts |
false |
string |
|
QueryParameter |
status |
status of accounts |
false |
string |
|
QueryParameter |
attributes |
required attributes |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Account array |
500 |
Failure with possible error codes : - 10001: Unknown error |
Produces
-
application/json
Tags
-
dxRegister
Retrieve account info
GET /api/register/account/{clearingCode}/{accountCode}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
clearingCode |
clearing code of the account |
true |
string |
|
PathParameter |
accountCode |
code of the account |
true |
string |
|
QueryParameter |
attributes |
required attributes |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
404 |
Failure with possible error codes : - 30007: Specified account is not found |
|
500 |
Failure with possible error codes : - 10001: Unknown error |
Produces
-
application/json
Tags
-
dxRegister
Update account
PUT /api/register/account/{clearingCode}/{accountCode}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
clearingCode |
clearing code of the account |
true |
string |
|
PathParameter |
accountCode |
code of the account |
true |
string |
|
BodyParameter |
body |
Account update model |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Failure with possible error codes : - 20001: Some of the required field is empty - 20022: Invalid json message format - 20008: Wrong account type |
|
404 |
Failure with possible error codes : - 30007: Specified account is not found |
|
500 |
Failure with possible error codes : - 10001: Unknown error - 30014: Field cannot be updated |
Produces
-
application/json
Tags
-
dxRegister
Create account adjustment for specified account
POST /api/register/account/{clearingCode}/{accountCode}/adjustment
Description
Adjustment currency should be the same as account currency. If amount of adjustment is negative and more than available 'withdrawable amount', then request is rejected.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
clearingCode |
account clearing code |
true |
string |
|
PathParameter |
accountCode |
account code |
true |
string |
|
BodyParameter |
body |
adjustment |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
409 |
Failure with possible error codes : |
|
422 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxRegister
Create account adjustment for specified account
PUT /api/register/account/{clearingCode}/{accountCode}/adjustment/{id}
Description
Adjustment currency should be the same as account currency. If amount of adjustment is negative and more than available 'withdrawable amount', then request is rejected.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
clearingCode |
account clearing code |
true |
string |
|
PathParameter |
accountCode |
account code |
true |
string |
|
PathParameter |
id |
unique identifier of this adjustment |
true |
string |
|
BodyParameter |
body |
adjustment |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
409 |
Failure with possible error codes : |
|
422 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxRegister
Retrieve category for account
GET /api/register/account/{clearingCode}/{accountCode}/category/{categoryCode}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
clearingCode |
account clearing code |
true |
string |
|
PathParameter |
accountCode |
account code |
true |
string |
|
PathParameter |
categoryCode |
category code |
true |
string |
|
QueryParameter |
attributes |
required attributes |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxRegister
Set category for account
PUT /api/register/account/{clearingCode}/{accountCode}/category/{categoryCode}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
clearingCode |
account clearing code |
true |
string |
|
PathParameter |
accountCode |
account code |
true |
string |
|
PathParameter |
categoryCode |
category code |
true |
string |
|
BodyParameter |
body |
group name |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
OK |
No Content |
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxRegister
Delete category for account
DELETE /api/register/account/{clearingCode}/{accountCode}/category/{categoryCode}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
clearingCode |
account clearing code |
true |
string |
|
PathParameter |
accountCode |
account code |
true |
string |
|
PathParameter |
categoryCode |
category code |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
OK |
No Content |
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxRegister
Create account deposit
POST /api/register/account/{clearingCode}/{accountCode}/deposit
Description
Deposit currency should be the same as account currency
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
clearingCode |
account clearing code |
true |
string |
|
PathParameter |
accountCode |
account code |
true |
string |
|
BodyParameter |
body |
deposit |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
409 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxRegister
Create account deposit
PUT /api/register/account/{clearingCode}/{accountCode}/deposit/{id}
Description
Deposit currency should be the same as account currency
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
clearingCode |
account clearing code |
true |
string |
|
PathParameter |
accountCode |
account code |
true |
string |
|
PathParameter |
id |
unique identifier of this deposit |
true |
string |
|
BodyParameter |
body |
deposit |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
409 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxRegister
Add account trade permission
POST /api/register/account/{clearingCode}/{accountCode}/permission/trade/{domain}/{name}
Description
Add permission to trade on account for specified user if it wasn’t added before. User and account must exist.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
clearingCode |
Clearing code of the account |
true |
string |
|
PathParameter |
accountCode |
Code of the account |
true |
string |
|
PathParameter |
domain |
User domain |
true |
string |
|
PathParameter |
name |
User name |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
400 |
Failure with possible error codes : |
|
403 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
dxRegister
Remove account trade permission
DELETE /api/register/account/{clearingCode}/{accountCode}/permission/trade/{domain}/{name}
Description
Remove existing trade permission from account for specified user. User and account must exist.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
clearingCode |
Clearing code of the account |
true |
string |
|
PathParameter |
accountCode |
Code of the account |
true |
string |
|
PathParameter |
domain |
User domain |
true |
string |
|
PathParameter |
name |
User name |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
400 |
Failure with possible error codes : |
|
403 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
dxRegister
Create account withdrawal for specified account
POST /api/register/account/{clearingCode}/{accountCode}/withdrawal
Description
Withdrawal currency should be the same as account currency. If amount to withdraw is more than available 'withdrawable amount', then request is rejected.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
clearingCode |
account clearing code |
true |
string |
|
PathParameter |
accountCode |
account code |
true |
string |
|
BodyParameter |
body |
withdrawal |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
409 |
Failure with possible error codes : |
|
422 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxRegister
Create account withdrawal for specified account
PUT /api/register/account/{clearingCode}/{accountCode}/withdrawal/{id}
Description
Withdrawal currency should be the same as account currency. If amount to withdraw is more than available 'withdrawable amount', then request is rejected.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
clearingCode |
account clearing code |
true |
string |
|
PathParameter |
accountCode |
account code |
true |
string |
|
PathParameter |
id |
unique identifier of this withdrawal |
true |
string |
|
BodyParameter |
body |
withdrawal |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
409 |
Failure with possible error codes : |
|
422 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxRegister
Retrieve brokers info
GET /api/register/broker
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
type |
type of brokers |
false |
string |
|
QueryParameter |
attributes |
required attributes |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Broker model array |
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
dxRegister
Retrieve broker info
GET /api/register/broker/{brokerCode}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
brokerCode |
code of the broker |
true |
string |
|
QueryParameter |
attributes |
required attributes |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
dxRegister
Retrieve categories by broker
GET /api/register/broker/{brokerCode}/category
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
brokerCode |
code of the broker |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Category model array |
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
dxRegister
Create new account category
POST /api/register/broker/{brokerCode}/category
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
brokerCode |
code of the broker |
true |
string |
|
BodyParameter |
body |
category |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxRegister
Rename account category
PUT /api/register/broker/{brokerCode}/category
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
brokerCode |
code of the broker |
true |
string |
|
BodyParameter |
body |
rename model |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxRegister
Delete account category
DELETE /api/register/broker/{brokerCode}/category
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
brokerCode |
code of the broker |
true |
string |
|
BodyParameter |
body |
category |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
OK |
No Content |
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxRegister
Retrieve category by broker
GET /api/register/broker/{brokerCode}/category/{categoryCode}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
brokerCode |
code of the broker |
true |
string |
|
PathParameter |
categoryCode |
code of the category |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
dxRegister
Retrieve all settings categories
GET /api/register/category
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Category model array |
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
dxRegister
Retrieve clients info
GET /api/register/client
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
attributes |
required attributes |
false |
string |
|
QueryParameter |
type |
type of users |
false |
enum (CLIENT, OTHER) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Client model array |
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
dxRegister
Create new client with accounts
POST /api/register/client
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Client model |
true |
||
QueryParameter |
accountAccess |
Owner permission on account |
false |
enum (VIEW_ONLY, TRADE) |
TRADE |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Failure with possible error codes: |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxRegister
Retrieve client groups info
GET /api/register/client/group
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
attributes |
required attributes |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Client group model array |
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
dxRegister
Retrieve client group info
GET /api/register/client/group/{domain}/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
domain |
domain of the group |
true |
string |
|
PathParameter |
name |
login of the group |
true |
string |
|
QueryParameter |
attributes |
required attributes |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
dxRegister
Suspends DxFeed account
POST /api/register/client/market-data-account-suspension
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
DxFeed account suspension model |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Request body is not valid |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
No Content |
Produces
-
text/plain
Tags
-
dxRegister
Add user’s DxFeed market data subscriptions
POST /api/register/client/market-data-subscription-activation
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
DxFeed subscriptions model |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Request body is not valid |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
No Content |
Produces
-
text/plain
Tags
-
dxRegister
Remove user’s DxFeed market data subscriptions
POST /api/register/client/market-data-subscription-cancelation
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
DxFeed subscriptions model |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Request body is not valid |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
No Content |
Produces
-
text/plain
Tags
-
dxRegister
Retrieve client info
GET /api/register/client/{domain}/{login}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
domain |
domain of the subject |
true |
string |
|
PathParameter |
login |
login of the subject |
true |
string |
|
QueryParameter |
attributes |
required attributes |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
dxRegister
Update client
PUT /api/register/client/{domain}/{login}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
if-match |
version of the subject |
false |
string |
|
PathParameter |
domain |
domain of the subject |
true |
string |
|
PathParameter |
login |
login of the subject |
true |
string |
|
BodyParameter |
body |
Client model. |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
409 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
dxRegister
Delete client
DELETE /api/register/client/{domain}/{login}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
domain |
domain of the subject |
true |
string |
|
PathParameter |
login |
login of the subject |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
OK |
No Content |
403 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Tags
-
dxRegister
Create new account with the specified owner
POST /api/register/client/{domain}/{login}/account
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
domain |
Client domain |
true |
string |
|
PathParameter |
login |
Client login |
true |
string |
|
BodyParameter |
body |
Account model |
true |
||
QueryParameter |
accountAccess |
Owner permission on account |
false |
enum (VIEW_ONLY, TRADE) |
TRADE |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Failure with possible error codes : |
|
404 |
Failure Possible error codes: |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxRegister
Disable client and terminate accounts
POST /api/register/client/{domain}/{login}/disable-user-and-terminate-accounts
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
domain |
domain of the subject |
true |
string |
|
PathParameter |
login |
login of the subject |
true |
string |
|
BodyParameter |
body |
Disable user and terminate accounts model |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
400 |
Failure with possible error codes : |
|
404 |
Failure with possible error codes : |
|
409 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
dxRegister
Add client to group
POST /api/register/client/{domain}/{login}/group/{groupDomain}/{groupName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
if-match |
version of the subject |
true |
string |
|
PathParameter |
domain |
domain of the subject |
true |
string |
|
PathParameter |
login |
login of the subject |
true |
string |
|
PathParameter |
groupDomain |
domain of the group |
true |
string |
|
PathParameter |
groupName |
name of the group |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
OK |
No Content |
404 |
Failure with possible error codes : |
|
409 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Tags
-
dxRegister
Delete client from group
DELETE /api/register/client/{domain}/{login}/group/{groupDomain}/{groupName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
if-match |
version of the subject |
true |
string |
|
PathParameter |
domain |
domain of the subject |
true |
string |
|
PathParameter |
login |
login of the subject |
true |
string |
|
PathParameter |
groupDomain |
domain of the group |
true |
string |
|
PathParameter |
groupName |
name of the group |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
OK |
No Content |
404 |
Failure with possible error codes : |
|
409 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Tags
-
dxRegister
Import transactions
POST /api/transaction-import
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Transactions to import |
true |
Transaction model array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Failure with possible error codes : |
|
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
TransactionImport
Check user’s credentials using GET method
GET /checkLogin
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
login |
user login |
true |
string |
|
QueryParameter |
domain |
user domain |
true |
string |
|
QueryParameter |
token |
SSO token |
false |
string |
|
QueryParameter |
password |
user’s password |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
400 |
Query parameters are not valid |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxWeb
Check user’s credentials using POST method
POST /checkLogin
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
FormDataParameter |
login |
user login |
true |
string |
|
FormDataParameter |
domain |
user domain |
true |
string |
|
FormDataParameter |
token |
SSO token |
false |
string |
|
FormDataParameter |
password |
user’s password |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
400 |
Form parameters are not valid |
|
500 |
Failure with possible error codes : |
Consumes
-
application/x-www-form-urlencoded
Produces
-
application/json
Tags
-
dxWeb
HTTP GET request for token generation
GET /generateToken
Description
To login on behalf of another user LOGIN_ON_BEHALF permission is required
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
login |
login of user to generate token for |
true |
string |
|
QueryParameter |
domain |
domain of user to generate token for |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
response with result of token generation |
No Content |
403 |
access forbidden |
No Content |
500 |
Failure with possible error codes : |
Produces
-
text/plain
Tags
-
dxWeb
HTTP POST request for token generation
POST /generateToken
Description
To login on behalf of another user LOGIN_ON_BEHALF permission is required
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
FormDataParameter |
login |
login of user to generate token for |
true |
string |
|
FormDataParameter |
domain |
domain of user to generate token for |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
response with result of token generation |
No Content |
403 |
access forbidden |
No Content |
500 |
Failure with possible error codes : |
Consumes
-
application/x-www-form-urlencoded
Produces
-
text/plain
Tags
-
dxWeb
HTTP POST request for token generation by given dxCore session
POST /getSSOToken
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
token request |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Response with SSO token in case of success |
No Content |
400 |
Form parameters are not valid |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
text/plain
Tags
-
dxWeb
HTTP POST request for getting SSO token info
POST /getSSOTokenInfo
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
FormDataParameter |
token |
Token for which is needed to get info |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Response with result of getting SSO token info |
|
400 |
Token is malformed or expired |
No Content |
500 |
Failure with possible error codes : |
Consumes
-
application/x-www-form-urlencoded
Produces
-
application/json
Tags
-
dxWeb
HTTP POST request for login and token generation
POST /login
Description
To login on behalf of another user LOGIN_ON_BEHALF permission is required
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
login request |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Response with result of login with token in case of success |
|
400 |
Form parameters are not valid |
|
403 |
Authentication failed |
|
500 |
Failure with possible error codes : |
Consumes
-
application/json
Produces
-
application/json
Tags
-
dxWeb
HTTP POST request for logout all sessions for user by id
POST /logoutUserById
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
FormDataParameter |
userId |
userId |
true |
integer (int32) |
|
HeaderParameter |
Authorization |
Authorization header |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Response with result of logout in case of success |
No Content |
400 |
One of the parameters is not set |
No Content |
403 |
Method is not supported for system user |
No Content |
404 |
The user with the specified ID does not exist |
No Content |
500 |
Failure with possible error codes : |
Consumes
-
application/x-www-form-urlencoded
Produces
-
text/plain
Tags
-
dxWeb
HTTP POST request for logout all sessions for user by login and domain
POST /logoutUserByLogin
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
FormDataParameter |
login |
login |
true |
string |
|
FormDataParameter |
domain |
domain |
true |
string |
|
HeaderParameter |
Authorization |
Authorization header |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Response with result of logout in case of success |
No Content |
400 |
One of the parameters is not set |
No Content |
403 |
Method is not supported for system user |
No Content |
404 |
The user with the specified ID does not exist |
No Content |
500 |
Failure with possible error codes : |
Consumes
-
application/x-www-form-urlencoded
Produces
-
text/plain
Tags
-
dxWeb
HTTP POST request for logout all sessions for user by token and user id
POST /logoutUserByToken
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
FormDataParameter |
login |
login of user for logout by token |
true |
string |
|
FormDataParameter |
domain |
domain of user for logout by token |
true |
string |
|
FormDataParameter |
token |
token |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Response with result of logout in case of success |
No Content |
400 |
One of the parameters is not set |
No Content |
403 |
Method is not supported for system user |
No Content |
404 |
The user with the specified ID does not exist |
No Content |
500 |
Failure with possible error codes : |
Consumes
-
application/x-www-form-urlencoded
Produces
-
text/plain
Tags
-
dxWeb
HTTP POST request for session prolongation
POST /ping
Description
When a ping is received, server checks session duration.
If a session is more than halfway through its duration, it is extended by half of the original duration.
Otherwise, nothing happens.
Example:
- A session starts at 10:00 and expires at 10:30 (30-minute duration).
- Pings before 10:15 do nothing.
- A ping after 10:15 extends the session to 10:45.
- No further extension will occur until after 10:30, at which point another ping will extend it to 11:00.
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Response with result of prolongation with token and new duration |
|
403 |
Session already expired |
No Content |
500 |
Failure with possible error codes : |
Produces
-
application/json
Tags
-
dxWeb