Schemas Postman

Hold Instruction. Delete item by ID POST

Delete Hold Instruction data by ID

# ENDPOINT
/api/holdInstruction/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

<p style="color:green;font-size:16px;">200 - Response successfully when status is OK</p>

Schema: HeaderResponseStatusOk
Type: application/json
Variable Name Type Format 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

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError
Type: application/json
Variable Name Type Format 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 = 157)
{
    "status": "error",
    "error_description": "[ERROR-PAYMENT-FEE-EXISTS : Payment fee must be deleted for this hold.]",
    "error": {},
    "data_type": "",
    "total_records": -2,
    "data": {}
}
when trying to delete record which doesn't exist (id = 111111)
{
    "status": "error",
    "error_description": "[RECORD-NOT-FOUND]",
    "error": {},
    "data_type": "",
    "total_records": -2,
    "data": {}
}
# Other endpoints
Name Endpoint
Hold Instruction. Fetch data by request /api/holdInstruction/getData/holdInstructionSearchRequest
Hold Instruction. Fetch data by ID / UID /model/holdInstruction/getDb/{id}
Hold Instruction. Validate data /model/holdInstruction/validate
Hold Instruction. Prepare data /model/holdInstruction/prepare
Hold Instruction. Create/update data /model/holdInstruction/putDb
Hold Instruction. Check Available Funds /api/holdInstruction/checkAvailableFunds/holdInstructionSetModel
Hold Instruction. Set HoldInstruction /api/setHoldInstruction/holdInstructionSetModel