Overview

The CiiRUS Partner-API employs standard HTTP status codes to indicate the success or failure of requests. These familiar codes help you quickly identify the status of your API interactions. Whether your request is successful or encounters an issue, you'll receive an appropriate HTTP status code that provides valuable feedback on the outcome. This consistency ensures a clear and standardized approach, simplifying your integration process and helping you to address any errors efficiently.

HTTP Status Codes

Error Code	Description
`200 OK`	The request succeeded
`303 See Other`	The server sent this response to direct the client to get the requested resource at another URI with a GET request
`400 Bad Request`	The server is unable or unwilling to process the request due to a perceived issue on the client side
`401 Unauthorized`	The provided Authentication values are not valid
`403 Forbidden`	The client does not have access rights to the content
`404 Not Found`	The server cannot find the requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist.
`422 Unproccessable Content`	The request was well-formed but was unable to be followed due to semantic errors.
`500 Internal Server Error`	The server has encountered a situation it does not know how to handle
`503 Service Unavailable`	The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded

Error Reasons

📘
Please be aware that the list of error reasons is continuously evolving. If you encounter an error not listed below, don't hesitate to create a support ticket via CiiRUS Support by submitting a request to the following email: [email protected]

Within each section provided below, you'll discover a list of potential error reasons that might be encountered from various API endpoints. Alongside each error reason, we've included a detailed explanation of its cause and the appropriate steps to resolve the issue:

All Endpoints

The error reasons detailed in this section apply across all endpoints.

"message": "Forbidden"

Cause

Invalid or missing API credentials (e.g., incorrect Authorization header)
Request made from an IP address that is not whitelisted
Attempting to access or modify resources the API partner does not have permission for (e.g., updating a reservation not created by the partner)

Resolution

Verify API credentials are correct and properly encoded in the Authorization header
Ensure the request is made from a whitelisted IP address
Make sure the API call is scoped only to resources the partner has access to
If issues persist, contact CiiRUS Support with request details for further investigation

"message": "1 validation error(s) detected: ..."

Cause

The API validates all request parameters before processing. If a parameter fails to meet the expected data type, format, or required structure (e.g., an invalid date, incorrect string length, or malformed input), the request is rejected with a ValidationException.

This error typically means that:

A required field is missing or null
A field value is in the wrong format (e.g., an invalid date, number, or enum)
The field doesn't satisfy length or pattern constraints

Resolution

To fix this error:

Carefully review the field(s) mentioned in the error message.
Check for:
- Proper data types (e.g., DateTime should be in YYYY-MM-DD format)
- Correct string formatting (no typos, invalid characters, or missing digits)
- Valid enumeration values or options
Correct the parameter value(s) and re-submit the request.

"message": "The request signature we calculated does not match the signature you provided. Check your key and signing method."

Cause

The most common cause of this error is incorrect handling of the Authorization header during an HTTP redirect (status code 303 See Other in this case). When the initial request is valid but results in a redirect, some HTTP clients (like axios, fetch, HttpClient, or curl) may automatically follow the Location header and retain the original Authorization header—which is no longer valid for the redirected URL.

Resolution

To fix this error, ensure that your HTTP client removes the Authorization header when following a redirect. The redirected request should not reuse the signature or credentials from the original request.

Reservations

Service Unavailable

Cause

As this is a highly robust API function, a Service Unavailable error commonly arises when the API service encounters difficulties processing the request due to an excessive number of records being returned.

Resolution

Leverage the available parameters to refine the data retrieval, allowing you to obtain only the specific data you need. This approach can help mitigate the "Service Unavailable" error.

Units

"message": "Property has been deleted."

Cause

The supplier has deleted this property from its inventory.

Resolution

This is not a technical error - this is a message indicating that the property has been deleted - do not enable this property to your Inventory.

"message": "Property supplier has disabled this property for all agent connections."

Cause

The supplier has not enabled this property for any agent connections.

Resolution

This is not a technical error - Confirm with the supplier if this property should be enabled for agent connections. If yes, advise the supplier to enable the property to all channels. If no, do not enable this property to your Inventory.

"message": "Property supplier has not enabled this property connection."

Cause

The supplier has not enabled this property to your agent connection.

Resolution

This is not a technical error - Confirm with the supplier if this property should be enabled for your agent connection. If yes, advise the supplier to enable the property to for your agent, so you may enable the property as well. If no, do not enable this property to your Inventory.

"message": "Neither you or the supplier has enabled this property connection."

Cause

This is not a technical error - You have not enabled this property to your agent connection, however, the supplier has not enabled this property to your agent connection either.

Resolution

Confirm with the supplier if this property should be enabled for your agent connection. If yes, advise the supplier to enable the property to for your agent, then enable the property. If no, continute to not enable this property to your Inventory.

Quotes

"message": "Property has been deleted."

Cause

The supplier has deleted this property from its inventory.

Resolution

This is not a technical error - this is a message indicating that the property has been deleted - do not enable this property to your Inventory.

"message": "Property supplier has disabled this property for all agent connections."

Cause

The supplier has not enabled this property for any agent connections.

Resolution

This is not a technical error - Confirm with the supplier if this property should be enabled for your agent connection. If yes, advise the supplier to enable the property to for your agent, so you may enable the property as well to generate successful quotes. If no, ignore this unit in quotes.

"message": "Property supplier has not enabled this property connection."

Cause

The supplier has not enabled this property to your agent connection.

Resolution

This is not a technical error - Confirm with the supplier if this property should be enabled for your agent connection. If yes, advise the supplier to enable the property to for your agent, so you may enable the property as well to generate successful quotes. If no, ignore this unit in quotes.

"message": "Neither you or the supplier has enabled this property connection."

Cause

This is not a technical error - You have not enabled this property to your agent connection, however, the supplier has not enabled this property to your agent connection either.

Resolution

Confirm with the supplier if this property should be enabled for your agent connection. If yes, advise the supplier to enable the property to for your agent, so you may enable the property as well to generate successful quotes. If no, ignore this unit in quotes.

"message": "Unit rate set: {rate_set_id} does not have any configured rate bands."

Cause

The rate set associated with this unit exists, but there are no rate bands defined. A quote cannot be calculated without valid rate bands. This typically means the supplier created the rate set but didn’t configure pricing rules for dates or stay lengths.

Resolution

Confirm with the supplier whether this unit should be available for quoting. If yes, advise them to set up rate bands within the associated rate set in their pricing configuration.

"message": "Could not retrieve unit rental."

Cause

The system could not load the unit’s rental configuration. This usually means one or more required settings are missing or misconfigured.

Resolution

Confirm with the supplier whether this unit should be available for quoting. If yes, advise them to set up rate bands within the associated rate set in their pricing configuration.