Skip to content

search_others

Retrieve the permitted anonymized view of other manufacturers’ gear. include_own optionally includes your own gear. Filter by a bounding box and start_datetime_utc.

On this page

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.

Process updates.sets and deletes.sets. The shared view contains set_id, deployment_type and trawl_path; trap sequence, latitude and longitude; and retrieved set IDs. It excludes identity, device and other gear fields, including accuracy.

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.

OthersRequest request fields
Field / typeRequirementDescription
format_version numberOptionalFile Format Version Use 0.3 Default: 0.3
api_key string · min length 32, max length 38Required for accessAPI credential. Keep credentials server-side and redact them from logs and support reports.
max_sets integer · min 1, max 100000 | nullOptionalMaximum number of sets to return. Default is 10,000. Maximum is 100,000 Default: 10000
start_datetime_utc string (date-time)OptionalAllows gathering of data since last download. Default: "1970-01-01T00:00:00Z"
from_latitude number · min -90, max 90OptionalLatitude Default: -90
to_latitude number · min -90, max 90OptionalLatitude Default: 90
from_longitude number · min -180, max 180OptionalFrom Longitude Default: -180
to_longitude number · min -180, max 180OptionalTo Longitude Default: 180
include_own boolean | nullOptionalInclude 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.

search_others request
{
  "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.

OthersResponse response fields
Field / typeRequirementDescription
format_version numberOptional Default: 0.3
as_of_utc string (date-time)OptionalResponse synchronization timestamp. Save only after successfully processing the response.
updates OthersUpdate | nullOptional View OthersUpdate fields
deletes OthersDelete | nullOptional View OthersDelete fields

OthersUpdate

OthersUpdate nested response fields
Field / typeRequirementDescription
description stringOptional Default: "New or changed locations of others gear"
sets array<OthersUpdateSet> | nullOptional View OthersUpdateSet fields

OthersDelete

OthersDelete nested response fields
Field / typeRequirementDescription
description stringOptional Default: "List of sets to be removed"
sets array<OthersDeleteSet> | nullOptional View OthersDeleteSet fields

OthersUpdateSet

OthersUpdateSet nested response fields
Field / typeRequirementDescription
set_id stringRequiredUUID of this set.
deployment_type stringRequiredsingle or line or trawl
traps array<OthersUpdateTrap>RequiredEach location in set that can be plotted View OthersUpdateTrap fields
trawl_path TrawlPath | nullOptionalOptional path of trawl deployment. View TrawlPath fields

OthersDeleteSet

OthersDeleteSet nested response fields
Field / typeRequirementDescription
set_id stringRequiredUUID of set to be removed from display

OthersUpdateTrap

OthersUpdateTrap nested response fields
Field / typeRequirementDescription
sequence integerRequiredSequence 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 numberRequiredLatitude in degrees for this trap.
longitude numberRequiredLongitude in degrees for this trap

TrawlPath

TrawlPath nested response fields
Field / typeRequirementDescription
type stringRequired by Data RulesMust 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

HTTPValidationError error fields
Field / typeRequirementDescription
detail array<ValidationError>Optional View ValidationError fields

ValidationError

ValidationError error fields
Field / typeRequirementDescription
loc array<string | integer>Required
msg stringRequired
type stringRequired
input anyOptional
ctx objectOptional