Error details

Look up the message for one or more error codes.

POST/Common/ErrorDetails

Access requires the permission error_details

Pass the error ids you received and get the human message for each. Useful for turning a stored Err... code into text without hard-coding the table. The full catalogue is on the errors reference.

Path parameters

None.

Query parameters

None.

Body parameters

Name	Type	Required	Description
`SessionId`	string	Yes	Your session id.
`ErrorIds`	array of string	Yes	The error codes to resolve.

Request

curl -X POST https://api.hermeseus.com/api/Common/ErrorDetails \
  -H "Content-Type: application/json" \
  -d '{
    "SessionId": "8f3c81d2-4a5b-4c6d-9e0f-1a2b3c4d5e6f",
    "ErrorIds": ["Err0102005", "Err0101001"]
  }'

const res = await fetch("https://api.hermeseus.com/api/Common/ErrorDetails", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    SessionId: "8f3c81d2-4a5b-4c6d-9e0f-1a2b3c4d5e6f",
    ErrorIds: ["Err0102005", "Err0101001"]
  })
});

const data = await res.json();

import requests

res = requests.post(
    "https://api.hermeseus.com/api/Common/ErrorDetails",
    json={
        "SessionId": "8f3c81d2-4a5b-4c6d-9e0f-1a2b3c4d5e6f",
        "ErrorIds": ["Err0102005", "Err0101001"],
    },
)

data = res.json()

Response

Field	Type	Description
`Success`	boolean	`true` on success.
`ErrorDetails`	array of object	One entry per requested id, each with `Id` and `Message`.
`Error`	object	`null` on success.

{
  "Success": true,
  "ErrorDetails": [
    { "Id": "Err0102005", "Message": "Fare has expired or is no longer available. Please search again." },
    { "Id": "Err0101001", "Message": "Invalid session. Please create a new session." }
  ],
  "Error": null
}

Errors

Code	Meaning	Fix
`Err0106001`	`ErrorIds` is missing or not an array.	Send an array of error codes.