[DELETE] - Company Family Tree Job

Follow

Use the Cancel Company Family Tree Job endpoint to cancel a job submitted but not yet processed.

Endpoint

DELETE https://api.insideview.com/api/v1/company/familyTree/job/{jobId}

Request

HTTP Headers

Header Name Type Required Description
accessToken String Yes Valid access token.
See Authentication and Authorization Overview for more details.
Accept String No Selects the response's content type.  
Valid values are application/json and application/xml (default).  

URI Parameters

Parameter Name Type Required Description
jobId String Yes Job ID

Responses

HTTP 200

Returns either a JSON or XML data structure depending on the request Accept header. 

application/json Example

{
  "jobId":"k4rv9gbthc6lgguadtcd",
  "status":"aborted"
  "type":"familyTree"
}    

application/xml Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BulkJobStatus>
  <jobId>k4rv9gbthc6lgguadtcd</jobId>
  <status>aborted</status>
  <type>familyTree</type>
</BulkJobStatus>

HTTP 400

Invalid query parameter(s)

HTTP 401

Unauthorized Error - Cannot use API's without setting a valid accessToken in header.

HTTP 405

Method Not Allowed - Your are not allowed to access this API.

HTTP 404

Invalid ID, record not found.

HTTP 429

Request is throttled.

 

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk