Try in sandboxSign-in required · shared test environment
POST/api/search_others/
Send JSON over HTTPS with your assigned api_key in the body. Use the appropriate test or production host.
Request body
OthersRequest
Protocol requirements come from OpenAPI 0.4.1. Credentials are required for access. Gear submissions must also satisfy the required and conditional Data Rules, even where the test schema allows omissions.
| Field / type | Requirement | Description |
|---|---|---|
format_version number | Optional | File Format Version Use 0.3 Default: 0.3 |
api_key string · min length 32, max length 38 | Required for access | API credential. Keep credentials server-side and redact them from logs and support reports. |
max_sets integer · min 1, max 100000 | null | Optional | Maximum number of sets to return. Default is 10,000. Maximum is 100,000 Default: 10000 |
start_datetime_utc string (date-time) | Optional | Allows gathering of data since last download. Default: "1970-01-01T00:00:00Z" |
from_latitude number · min -90, max 90 | Optional | Latitude Default: -90 |
to_latitude number · min -90, max 90 | Optional | Latitude Default: 90 |
from_longitude number · min -180, max 180 | Optional | From Longitude Default: -180 |
to_longitude number · min -180, max 180 | Optional | To Longitude Default: 180 |
include_own boolean | null | Optional | Include own gear in response Default: false |
Example request
Replace the credential placeholder with your test key in your server-side client. This request limits the number of returned sets to 100; a capped response is not a complete synchronization.
{
"api_key": "YOUR_TEST_API_KEY",
"format_version": 0.3,
"max_sets": 100,
"start_datetime_utc": "1970-01-01T00:00:00Z",
"include_own": false
}Response
HTTP 200 · OthersResponse
The published response model describes possible fields. Your category, record sharing and field approvals determine the data you may receive.
| Field / type | Requirement | Description |
|---|---|---|
format_version number | Optional | Default: 0.3 |
as_of_utc string (date-time) | Optional | Response synchronization timestamp. Save only after successfully processing the response. |
updates OthersUpdate | null | Optional | View OthersUpdate fields |
deletes OthersDelete | null | Optional | View OthersDelete fields |
OthersUpdate
| Field / type | Requirement | Description |
|---|---|---|
description string | Optional | Default: "New or changed locations of others gear" |
sets array<OthersUpdateSet> | null | Optional | View OthersUpdateSet fields |
OthersDelete
| Field / type | Requirement | Description |
|---|---|---|
description string | Optional | Default: "List of sets to be removed" |
sets array<OthersDeleteSet> | null | Optional | View OthersDeleteSet fields |
OthersUpdateSet
| Field / type | Requirement | Description |
|---|---|---|
set_id string | Required | UUID of this set. |
deployment_type string | Required | single or line or trawl |
traps array<OthersUpdateTrap> | Required | Each location in set that can be plotted View OthersUpdateTrap fields |
trawl_path TrawlPath | null | Optional | Optional path of trawl deployment. View TrawlPath fields |
OthersDeleteSet
| Field / type | Requirement | Description |
|---|---|---|
set_id string | Required | UUID of set to be removed from display |
OthersUpdateTrap
| Field / type | Requirement | Description |
|---|---|---|
sequence integer | Required | Sequence of the returned gear mark. New submissions must follow Appendix A: start at 1; use 1 and 2 for trawl ends. Older data may differ. |
latitude number | Required | Latitude in degrees for this trap. |
longitude number | Required | Longitude in degrees for this trap |
TrawlPath
| Field / type | Requirement | Description |
|---|---|---|
type string | Required by Data Rules | Must be LineString when a trawl_path is supplied. Default: "LineString" |
coordinates array<array<number>> | Required |
Errors and updates
HTTP 422 returns validation errors in detail, including loc (field
location), msg (message) and type. Handle other HTTP errors and
connection failures as well.
Use start_datetime_utc to request changes since the last successful download. Apply updates.sets and remove deletes.sets from your display before saving as_of_utc.
max_sets defaults to 10,000 and permits 1–100,000. No pagination cursor is defined.
If a response reaches the limit, do not assume synchronization is complete or advance past unprocessed
records; confirm a complete retrieval strategy with Polaris.
HTTPValidationError
| Field / type | Requirement | Description |
|---|---|---|
detail array<ValidationError> | Optional | View ValidationError fields |
ValidationError
| Field / type | Requirement | Description |
|---|---|---|
loc array<string | integer> | Required | |
msg string | Required | |
type string | Required | |
input any | Optional | |
ctx object | Optional |