Archive a Screening

Production

https://api.polestar-production.com

PUT

/purpletrac/v1/transaction/{id}

Pole Star offers the ability to archive a vessel after screening and/or tracking have concluded. This is also known as deregistering a vessel.

Archiving a vessel does not remove any information, it is a way of separating active from historic transactions for housekeeping purposes.

Note that any tracked vessel which is archived will automatically stop tracking.

To archive a vessel include the transaction id and the transaction status (set to "C") in the request body.

Refer to Screening Vessels to see how to use this endpoint to archive a vessel screening.

Refer to Tracking a Vessel to see how this endpoint is used in the vessel tracking workflow.

Request

Authorization

API Key

Add parameter in query

api_key

Example:

api_key: ********************

Path Params

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The screening was archived. It stays readable and keeps its reports.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.polestar-production.com/purpletrac/v1/transaction/?username=undefined&api_key=%3Capi-key%3E' \
--header 'Content-Type: application/json' \
--data '{
    "id": 199473,
    "status": "C"
}'

Response Example

200 - Default

{
    "added_via": "MANUAL",
    "ais_gap_status": "F",
    "ais_received": null,
    "ais_reporting": true,
    "auto_deregister": true,
    "auto_deregistered": false,
    "auto_register": true,
    "blv": null,
    "carbon_rating_screen": false,
    "client_reference": "my custom reference",
    "closed_date": null,
    "container_screen_id": null,
    "creation_date": "2023-12-05T13:24:46.500470",
    "has_gaps": true,
    "id": 2849764,
    "inmarsatc_expected": null,
    "inmarsatc_interval": 2,
    "inmarsatc_received": null,
    "inmarsatc_reporting": true,
    "only_tracking_by_ais": false,
    "overall_severity": "WARNING",
    "registered_date": null,
    "registered_name": "9221126",
    "report_generation_complete": true,
    "resource_uri": "/api/v1/transaction/2849764",
    "screened_date": "2023-12-05T13:39:33.980235",
    "screening_status": "WARNING",
    "ship": "/api/v1/shipdetails/272962",
    "status": "C",
    "tracking_date": null,
    "tracking_expiry": null,
    "transceiver_domain": "",
    "transceiver_domain_id": "",
    "user": "/api/v1/user/6913",
    "voyage": null
}

Modified at 2026-09-18 08:35:54

Submit a vessel for rescreening

Voyage updates