API Docs. Elcoin Ltd

Limit. Fetch data by ID / UID POST

Fetch Payment Limit data by ID or UID

# ENDPOINT

/model/paymentLimit/getDb/{id}

# REQUEST arguments

Variable	Value	Example	Usage	Description
X-App-Sig header 0			M	Dev Authentication
id path 0		64 - for ID 853981cd-ebe0-6d88-7914-ec63ec82659e - for 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	64 - for ID 853981cd-ebe0-6d88-7914-ec63ec82659e - for UID

# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: paymentLimit

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
activation_date	Activation Date	string	DATE	Activation date in the system
amount	amount	number	decimal	Operation amount
client_code	Client code	string		Unique client identifier. Issued automatically by the System upon new Customer registration.
client_group	client_group	string		Client group
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
cycle_code	cycle_code	string
description	description	string		Description of a given record
expiration_date	Expiration Date	string	DATE	Expiration date in the system
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
product_code	Product Code	string		Code of a given product
state	state	integer	INT64	Record state for replication
subscription_code	Subscription Code	string		Subscription code
type	type	string
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": "system.api.paymentLimit.paymentLimitModel",
    "total_records": 1,
    "data": {
        "subscription_code": "",
        "client_code": "en003jaqj",
        "client_group": "CLIENT",
        "product_code": "INTERNAL",
        "cycle_code": "OPERATION",
        "type": "AMOUNT_MAXIMUM",
        "amount": 250.0,
        "currency": "EUR",
        "activation_date": "2021-02-02",
        "expiration_date": null,
        "description": "INTERNAL",
        "uid": "853981cd-ebe0-6d88-7914-ec63ec82659e",
        "id": 64,
        "version": 675767986,
        "state": 0,
        "create_user": "JSOKOL",
        "create_date": "2021-02-02T09:59:41.288",
        "modify_user": "JSOKOL",
        "modify_date": "2021-02-02T09:59:41.290"
    }
}

# 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 paymentLimitModel cannot find record payment_limit.id with value 1]",
    "error": {},
    "data_type": "system.api.paymentLimit.paymentLimitModel",
    "total_records": 1,
    "data": {}
}

# Other endpoints

Name	Endpoint
Limit. Fetch data by request	/api/paymentLimit/getData/paymentLimitSearchRequest
Limit. Create/update data	/model/paymentLimit/putDb
Limit. Delete item by ID	/api/paymentLimit/deleteItem/{id}