API Docs. Elcoin Ltd

Currency Pairs. Fetch data by request POST

Get Currency Pairs data by request

# ENDPOINT

/api/currencyPairs/getData/currencyPairsSearchRequest

# REQUEST arguments

Variable	Value	Example	Usage	Description
X-App-Sig header 0	DEV-SKIP	DEV-SKIP	M	Dev Authentication

# REQUEST BODY

# RESPONSE

# REQUEST arguments

Variable	Name	Type	Format	Usage	Description
X-App-Sig	X-App-Sig	header	string	M	Dev Authentication
Example	DEV-SKIP

# REQUEST BODY

Schema: currencyPairsSearchRequest

Type: object

Variable	Name	Type	Format	Usage	Description
base_currency	base_currency	string		M	Operation currency From
currency	currency	string			Currency of the account

# REQUEST BODY EXAMPLE

							{
    "currency": "USD"
}

# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: currencyPairs

Type: application/json

Variable	Name	Type	Description
status	status	string	Request execution status
error_description	Error Description	string	Description of error
error	Error Code	string	Error code
data_type	data_type	string	Type of data
total_records	total_records	string	Total count of records
data	data	array	data of Response

attribute: data

Variable	Name	Type	Format	Description
action	Action	string
base_currency	base_currency	string		Operation currency From
create_date	Create Date	string	DATETIME	The date entry was created on
create_user	Create User	string		The username of ABS user who has created an entry
currency	currency	string		Currency of the account
description	description	string		Description of a given record
form_title	form_title	string		Service field
id	id	integer	INT64	Record's sequence number generated in the system.
modify_date	Modify Date	string	DATETIME	The date entry was last modified on
modify_user	Modify User	string		The username of ABS user who has made last changes to the entry
number_days	Days to Value	integer
state	state	integer	INT64	Record state for replication
uid	uid	string		Unique record identifier which is used to distinguish between existing records
version	version	integer	INT64	Record version for replication

# RESPONSE POSITIVE EXAMPLE

							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": 4,
    "data": [
        {
            "id": 59,
            "uid": "",
            "version": 65548532,
            "state": 0,
            "modify_date": "2019-10-01T12:21:22.464",
            "modify_user": "erusbergs",
            "create_date": "2019-10-01T12:21:22.449",
            "create_user": "erusbergs",
            "currency": "USD",
            "base_currency": "AUD",
            "description": "AUDUSD",
            "number_days": 2
        },
        {
            "id": 41,
            "uid": "",
            "version": 51856449,
            "state": 0,
            "modify_date": "2019-09-13T14:16:53.488",
            "modify_user": "erusbergs",
            "create_date": "2019-08-15T13:24:18.920",
            "create_user": "eriksr",
            "currency": "USD",
            "base_currency": "EUR",
            "description": "EURUSD",
            "number_days": 2
        },
        {
            "id": 38,
            "uid": "",
            "version": 51856488,
            "state": 0,
            "modify_date": "2019-09-13T14:17:03.663",
            "modify_user": "erusbergs",
            "create_date": "2019-08-15T13:23:59.143",
            "create_user": "eriksr",
            "currency": "USD",
            "base_currency": "GBP",
            "description": "GBPUSD",
            "number_days": 2
        },
        {
            "id": 81,
            "uid": "",
            "version": 65574833,
            "state": 0,
            "modify_date": "2019-10-01T12:44:02.226",
            "modify_user": "erusbergs",
            "create_date": "2019-10-01T12:44:02.225",
            "create_user": "erusbergs",
            "currency": "USD",
            "base_currency": "NZD",
            "description": "NZDUSD",
            "number_days": 2
        }
    ]
}

# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError

Type: application/json

Variable	Name	Type	Description
status	status	string	Request execution status
error_description	Error Description	string	Description of error
error	Error Code	string	Error code
data_type	data_type	string	Type of data
total_records	total_records	string	Total count of records
data	data	object	Empty object

# RESPONSE NEGATIVE EXAMPLE

							{
    "status": "error",
    "error_description": "[ERROR-VALIDATE-REQUEST] [ERROR-INCORRECT-FROM-CURRENCY-CODE]",
    "error": {},
    "data_type": "",
    "total_records": -2,
    "data": {}
}

# Other endpoints

Name	Endpoint
Currency Rate. Fetch data by request	/api/currencyRate/getData/currencyRateRequest
Currency Rate. Fetch data by ID	/model/currencyRate/getDb/{id}
Currency Rate. Create/update data	/model/currencyRate/putDb
Currency Rate. Delete item by ID	/api/currencyRate/deleteItem/{id}
Currency. Fetch data by ID / UID	/model/currency/getDb/{id}
Currency. Create/update data	/model/currency/putDb
Currency. Delete item by ID	/api/currency/deleteItem/{id}
Currency Pairs. Fetch data by ID / UID	/model/currencyPairs/getDb/{id}
Currency Pairs. Create/update data	/model/currencyPairs/putDb
Currency Pairs. Delete item by ID	/api/currencyPairs/deleteItem/{id}