Source guide · English only · Markdown · Provenance

API errors

Every failed HTTP request returns a closed envelope:

{
  "error": {
    "type": "urn:dominican-locations:problem:invalid_parameter",
    "code": "invalid_parameter",
    "message": "Request parameters are invalid",
    "param": "q",
    "docUrl": "https://github.com/gustavovalverde/dominican-locations/blob/main/docs/api-errors.md#invalid_parameter",
    "requestId": "req-..."
  }
}

The type URI and code are stable. param is either the rejected parameter name or null when the error is not tied to one input. requestId identifies the request in server logs.

Codes

Catalog unavailable

No active catalog can serve the request.

Catalog publication restricted

The active or requested release has not cleared its provenance and redistribution gates.

Release not found

The requested release key does not exist.

Place not found

The requested public place ID does not exist in the release.

Invalid parameter

A path or query value failed schema validation.

Invalid cursor

The cursor is malformed or belongs to a different release, operation, search, parent, or filter set.

Unsupported filter

The current query implementation cannot safely provide a requested filter.

Malformed JSON

The request body is not valid JSON.

Route not found

No public route matches the request.

Internal error

An unexpected server failure occurred.