Vessel screening

Get screening batch status

Returns batch status, counts, timestamps, and errors.

Required scope: vessel:screen.

get/api/v1/screening-batches/{id}

Request

  • Base URL: https://arcnautical.com
  • URL: https://arcnautical.com/api/v1/screening-batches/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-ArcNautical-Key

Path parameters

idstring required

Resource identifier.

Response

Successful response.

idstring uuid required
status'queued' | 'running' | 'completed' | 'partial' | 'failed' required
total_countinteger required
completed_countinteger required
failed_countinteger required
error_bodyobject
created_atstring date-time
updated_atstring date-time
started_atstring date-time nullable
completed_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.