Api Function Name

serial_batch_jobs_delete

This will allow the user to delete a batch job.

End Point URL

The url end point is: https://api.arcticspascore.com/live/

Parameters

action Type Example Required Description
action varchar serial_batch_jobs_delete yes
batch_job_id int 999 yes

The job id for the batch.

Response Codes

Response Code Response Message
35000 batch_job_id cannot be empty
35001 batch_job_id must be numeric
35002 batch_job_id is not valid
35003 you cannot delete this batch_job_id whilst its processing
35999 batch_job_id has been deleted

Example Responses

Response Code Response Format Example
35999 json 
{
    "MainResponse": {
        "APIName": "Arctic Spas Core Live API",
        "APIFunctionName": "serial_batch_jobs_delete",
        "HttpResponseCode": 200,
        "RequestID": 1472404,
        "QueryDateTimeGMT": "2021-11-09 19:18:52",
        "ResponseTime": 0.1444909572601318359375,
        "ResponseCode": 35999,
        "ResponseMessage": "batch_job_id has been deleted"
    }
}