API Docs. Elcoin Ltd

Limit. Delete item by ID POST

Delete Payment Limit data by ID

# ENDPOINT

/api/paymentLimit/deleteItem/{id}

# REQUEST arguments

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

# RESPONSE

# REQUEST arguments

Variable	Name	Type	Format	Usage	Description
X-App-Sig	X-App-Sig	header	string	M	Dev Authentication
Example	DEV-SKIP
id	id	path	integer	M	Record ID

# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: HeaderResponseStatusOk

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

# 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

							when trying to delete record which exists (ID = 2)

{
    "status": "error",
    "error_description": "[ERROR : Delete already activated limit not allowed]",
    "error": {},
    "data_type": "",
    "total_records": -2,
    "data": {}
}

when trying to delete record which doesn't exist (id = 111111)

{
    "status": "error",
    "error_description": "[ERROR-RECORD-LOCKED-OR-NOT-FOUND]",
    "error": {},
    "data_type": "",
    "total_records": -2,
    "data": {}
}

# Other endpoints

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