Errors

The envelope

Errors are RFC 9457 problem documents, served as application/problem+json.

{
  "type": "https://fentlig.se/developers/errors/notice-not-found",
  "title": "Notice not found",
  "status": 404,
  "detail": "No notice matches the identifier 'f4161f6d'.",
  "instance": "/v1/notices/f4161f6d",
  "code": "NOTICE_NOT_FOUND"
}

• code is what to branch on. It is stable for the life of /v1.
• type resolves to the page below explaining that class.
• detail describes this occurrence, in English. Show it to a developer, not to an end user.
• title is a fixed, human-readable name for the class. Branch on code instead.

Classes

• 400DOCUMENT_QUERY_TOO_SHORTThe `document_search` value has no word long enough to look up, so the documents were not searched.
• 400PAGINATION_TOO_DEEPOnly the first 1,000 results of a list can be paged: `(page - 1) x limit` must be below 1000. This applies to notice, contract and organization lists.
• 400SEARCH_QUERY_TOO_BROADThe `search` value has no word that narrows the result: it holds only excluded words, or only words that appear in most notices. The search was not run.
• 400VALIDATION_ERRORA query parameter or path segment did not match what the operation accepts.
• 401API_KEY_REQUIREDThe operation answers only to an API key, and none was sent.
• 401INVALID_API_KEYThe key sent in the `Authorization` header is unknown, revoked or expired.
• 401UNAUTHORIZEDThe path answers only to someone signed in to the Fentlig app. It is not part of the published API, and an API key does not open it.
• 403ACCESS_LAPSEDThe key is valid, but the workspace's subscription has ended, so every one of its keys is refused.
• 403ENTITLEMENT_REQUIREDThe key is valid, but the workspace's plan does not include API access. Reading a single notice still answers; listing does not.
• 403FACETS_NOT_PUBLICCounts of open notices per region and industry need an API key, and none was sent.
• 403INSUFFICIENT_SCOPEThe key is valid but does not carry the scope this request needs.
• 403LIST_NOT_PUBLICListing notices needs an API key, and none was sent.
• 403SITEMAP_NOT_PUBLICThe list of published notice addresses needs an API key, and none was sent.
• 403TRIAL_NOT_INCLUDEDThe key is valid, but the account is on a trial, and keys answer only once a plan is chosen.
• 404NOT_FOUNDNothing is served at that path.
• 404NOTICE_NOT_FOUNDNo published notice matches that id or slug. It may never have been published, or it may be outside the published set.
• 405METHOD_NOT_ALLOWEDThe path exists but does not accept that method.
• 429RATE_LIMIT_EXCEEDEDToo many requests in the current window, from this key or, without a key, from this address.
• 500INTERNAL_ERRORThe request was understood and we failed to answer it.