API Docs. Elcoin Ltd

Currency. Fetch data by ID / UID POST

Fetch Currency data by ID or UID

# ENDPOINT

/model/currency/getDb/{id}

# REQUEST arguments

Variable	Value	Example	Usage	Description
X-App-Sig header 0			M	Dev Authentication
id path 0		176 - by ID 9905369f-ac65-f1ae-5f14-28af34571ebb - by UID	M	Record ID or UID

# RESPONSE

# REQUEST arguments

Variable	Name	Type	Format	Usage	Description
X-App-Sig	X-App-Sig	header	string	M	Dev Authentication
id	id	path	integer	M	Record ID or UID
Example	176 - by ID 9905369f-ac65-f1ae-5f14-28af34571ebb - by UID

# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: currency

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	data of Response

attribute: data

Variable	Name	Type	Format	Description
action	Action	string
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
currency_order	Currency order	integer
currency_status	Currency Status	string		Currency Status
currency_type	Currency type	string
decimal_points	Decimal points	integer
decimals_exponenta	Decimals exponenta	number
description	description	string		Description of a given record
exchange_margin	Exchange margin	number
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
normalized_precision	Normalized precision	INTEGER
numeric_code	numeric_code	integer	INTEGER	ISO numeric code of a given country
state	state	integer	INT64	Record state for replication
uid	uid	string		Unique record identifier which is used to distinguish between existing records
unit	unit	integer	int64	Unit
version	version	integer	INT64	Record version for replication

# RESPONSE POSITIVE EXAMPLE

							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "system.api.currency.currencyModel",
    "total_records": 1,
    "data": {
        "currency": "KYD",
        "description": "Cayman Islands Dollar",
        "decimal_points": 2,
        "currency_order": 0,
        "currency_status": "closed",
        "unit": 1,
        "numeric_code": 136,
        "exchange_margin": 0.0,
        "uid": "9905369f-ac65-f1ae-5f14-28af34571ebb",
        "id": 175,
        "version": 1134347,
        "state": 0,
        "create_user": "alez7",
        "create_date": "2019-12-11T16:30:42.065",
        "modify_user": "alez7",
        "modify_date": "2019-12-11T16:33:47.335"
    }
}

# 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": "[RECORD-NOT-FOUND : Object currencyModel cannot find record currency.id with value 176]",
    "error": {},
    "data_type": "system.api.currency.currencyModel",
    "total_records": 1,
    "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. Create/update data	/model/currency/putDb
Currency. Delete item by ID	/api/currency/deleteItem/{id}
Currency Pairs. Fetch data by request	/api/currencyPairs/getData/currencyPairsSearchRequest
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}