[GET] - Company Family Tree Job Results

Follow

Use Company Family Tree Job Results to retrieve the result of a job submitted previously. You need to download the results from the URL returned in the response.

Endpoint

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

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

Here are the major responses the API may return.

For details on the errors, please refer to the API Error Codes article.

HTTP 200

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

application/json Example

{
  "jobId": "s04eabq2bt0ncgpa1095",
  "jobType": "familyTree",
  "jobStatus": "finished",
  "createdDate": "2016-09-15T03:36:05.000-07:00",
  "creditsConsumed": 10,
  "resultsUrl": "https://dwk2zqmtd2046.cloudfront.net/targetCompanySearchAsyncExport/s04eabq2bt0ncgpa1095/response/ta..."
}

application/xml Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bulkJob>
    <createdDate>2016-09-15T03:36:05.000-07:00</createdDate>
    <creditsConsumed>10</creditsConsumed>
    <jobId>s04eabq2bt0ncgpa1095</jobId>
    <jobStatus>finished</jobStatus>
    <jobType>familyTree</jobType>
    <resultsUrl>https://api-bulk-job-response.dev.insideview.com/familyTree/i4vntr3k64a1t286dr73/response/familyTree_i4vntr3k64a1t286dr73_2016-10-04T22-53-19-000-07-00?Policy=MDU1fX19XX0_&amp;Signature=QuiwrTnvDOLs4jBGpsutkGU~v3cGnK77ObaKU0luddW~q0dpoqsbb5sX1cf29~UODP968rSkZouf~g3XoAwhuSKfd272s1tYQaCz8ve5F2Ss8x3-DIV~3uiafAOS~3MixnffN0W4koX-hHu-q~Kt2SYTUmJerMhCy1LfgSvExp0myGwlk53uoh052BWznkCCjh7Iish5rosm3SDcxWsRPKhh40MW54Mh7eUMWFw47ABpUbsFZIZmahmS8sCAxxIsIUO1grUZzY-LgtDfvUT~6mBaN6IXGF0P~2c9zTUwjwfJlvnGbt2IOezJnSpCReKoWEma0-3zXwbtH4AFWcgNTQ__&amp;Key-Pair-Id=APKAIIOSMLC3MB3GXLJQ</resultsUrl>
</bulkJob>

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