CANCEL OUTSOURCED JOB

Description: API to cancel a job on another server using the job's Tracking ID. You can cancel multiple jobs in a single API call.


A. URL:

http://ctsgtest.com/api/outsource/job/cancel/
 

B. Method:

POST
 

C. Parameters:

  1. Parameter:
    jobs
    Description:
    The tracking IDs (Job IDs) of the jobs to be cancelled.
    Type:
    JSON-formatted String
    JSON Values:
    TrackingID : the identity of the job on database. Usually the job ID.
    Example:
    [{"TrackingID":"PYE2"},{"TrackingID":"PYF2"}]
  2. Parameter:
    id
    Example:
    193
    Type:
    String
    Description:
    the ID of the user making the API call
  3. Parameter:
    key
    Example:
    123
    Type:
    String
    Description:
    the API key of the user making the API call
  4. Parameter:
    hash
    Example:
    16d042ea4e74b6a48be3775b68fd8ce6
    Type:
    String
    Description:
    Secret code that is generated with the API call.
    It is an MD5 encryption of the string concatenation from the values of: APIKey + APISecret + UserID.

D. Response example:

{ "STATUS": "SUCCESS", "MESSAGE": "JOBS CANCELED IN DATABASE", "DATA": [ { "status": "SUCCESS", "id": "PYE2" }, { "status": "SUCCESS", "id": 38 }, { "status": "SUCCESS", "id": "PYF2" }, { "status": "SUCCESS", "id": 39 } ] } 
{
  "STATUS": "SUCCESS",
  "MESSAGE": "JOBS CANCELED IN DATABASE",
  "DATA": [
    {
      "status": "SUCCESS",
      "id": "PYE2"
    },
    {
      "status": "SUCCESS",
      "id": 38
    },
    {
      "status": "SUCCESS",
      "id": "PYF2"
    },
    {
      "status": "SUCCESS",
      "id": 39
    }
  ]
}

E. Example of API Call:

POST Cancel Job

Result