API Docs. Elcoin Ltd

Client. Delete item by ID POST

Delete Client data by ID

# ENDPOINT

/api/client/deleteItem/{id}

# REQUEST arguments

Variable	Value	Example	Usage	Description
X-App-Sig header 0			M
id path 0		59	M	Id record

# RESPONSE

# REQUEST arguments

Variable	Name	Type	Format	Usage	Description
X-App-Sig	X-App-Sig	header	string	M
id	id	path	integer	M	Id record
Example	59

# 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

# RESPONSE POSITIVE EXAMPLE

							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": -2,
    "data": {}
}

# 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": "[CAN'T DELETE CLIENT: THERE IS OPENED ACCOUNT OR DEAL : A]",
    "error": {},
    "data_type": "",
    "total_records": -2,
    "data": {}
}

# Other endpoints

Name	Endpoint
Client. Fetch data by request	/api/client/getData/clientSearchRequest
Client. Fetch data by ID	/model/client/getDb/{id}
Client. Validate data	/model/client/validate
Client. Prepare data	/model/client/prepare
Client. Create/update data	/model/client/putDb