Schemas Postman

Subscription. Delete item by ID POST

Delete Subscription data by ID

# ENDPOINT
/api/subscription/deleteItem/{id}
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0 		M Dev Authentication
id
path
0 		M Id record
# 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 Id record
# 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 = 13)

{
    "status": "error",
    "error_description": "[Subscription code is in use in clients!]",
    "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
Subscription. Fetch data by request /api/subscription/getData/subscriptionSearchRequest
Subscription. Fetch data by ID / UID /model/subscription/getDb/{id}
Subscription. Validate data /model/subscription/validate
Subscription. Prepare data /model/subscription/prepare
Subscription. Create/update data /model/subscription/putDb