Skip to content
On this page

Error Responses

Error can be a JSON object or array depending on the circumstances.

This list does not include error with status code 500.

Format:

json
{
	"message": string,
	"field": string
}

Explanation:

PropertyTypeDetails
messagestringExplains what particular error is about
fieldstring (only with resource error)Field in the request body the error refers to

Here is a list of errors you might encounter

Request Format Error

Content types must be set according to the guide.

HTTP CodeMessageTriggered By
415only accepts application/json in POST, PUT and PATCH methodnot using application/json in Content-Type when necessary
400received malformed JSONJSON received cannot be properly parsed

Authentication Error

HTTP CodeMessageTriggered By
403user must be explicitly allowed the resource by Omsinuser not having access permission from Omsin, you can contact him if you think this is a mistake
401jwt: <jwt message>invalid jwt token

Resource Error

The response should be self-explanatory.

Made with ❤️ and VitePress. Released under the MIT License.