API Docs. Elcoin Ltd

Outward. Delete item by ID POST

Delete Payment Outward data by ID

# ENDPOINT

/api/paymentOutward/deleteItem/{id}

# REQUEST arguments

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

# 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
Example	6760338

# 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": "ERROR: Invalid handle.  Not initialized or points to a deleted object. (3135)",
    "error": {},
    "data_type": "api.paymentOutward.deleteItem.sss",
    "total_records": 1,
    "data": {}
}

# Other endpoints

Name	Endpoint
Outward. Fetch data by request	/api/paymentOutward/getData/paymentOutwardRequest
Outward. Fetch data by ID / UID	/model/paymentOutward/getDb/{id}
Outward. Validate data	/model/paymentOutward/validate
Outward. Prepare data	/model/paymentOutward/prepare
Outward. Create/update data	/model/paymentOutward/putDb
Outward. Fetch data by monitoring request	/api/paymentOutward/getData/paymentOutwardMonitoringRequest
Outward. Fetch document type	/api/paymentOutward/getDocumentType/paymentOutwardModel