Error reasons
π Please note that the list of error reasons is ever-evolving. If you receive an error that is not listed below, let us know by creating a ticket through the Support Portal.
400 Bad Request Exceptions
A 400 Bad Request error occurs when the server cannot process the request due to invalid or malformed input from the client. This could be caused by incorrect or missing parameters, formatting errors, or data that doesn't meet the API's requirements. Essentially, it means that the request itself has an issue, and the client needs to fix it before retrying.
Common 400 Bad Request Exceptions:
InvalidChannelException: The channel provided is invalid or not supported.
BadPhoneException: The phone number format is incorrect or missing.
BadEmailException: The provided email address is invalid or formatted incorrectly.
ClientCreationException: Error occurs during client creation.
InvalidBookingTimeException: Selected booking slot is invalid (already taken or unavailable)
InvalidPasswordException: The provided password is incorrect. The password must respect pattern.
PropertyCreationException: Error occurs during client creation.
UserCreationException: Error occurs during client creation.
ApiAccountValidationException: The provided API account is invalid or does not meet the required to enable the google engine.
These errors indicate that the client should review the request's structure or the data provided and correct any issues before trying again.
403 Forbidden Exceptions
A 403 Forbidden error occurs when the server understands the request, but refuses to authorize it. This typically happens when the client doesn't have the necessary permissions to access the requested resource. It means that even though the request is valid, the server is denying access due to restrictions such as insufficient rights or the resource being restricted.
Common 403 Forbidden Exceptions:
ReservationForbiddenException: The client does not have permission to create, modify, or access the reservation.
TableForbiddenException: The requested table is restricted, and the client is not authorized to interact with it.
CalendarForbiddenException: The client is not authorized to view or modify the calendar for a given resource.
BannedCustomerException: The customer is banned from making reservations or accessing the service.
MaxRoomCapacityReachedException: The maximum capacity for a room or service has been reached, and further bookings are not allowed.
ProductCalendarOccupiedException: The product or service is unavailable at the requested time due to calendar restrictions or overbooking.
PropertyForbiddenException: The requested property is forbidden.
RoomForbiddenException: The requested room is forbidden.
UserAlreadyExistException: The given user is already exist in system.
WebhookSubscriptionAlreadyExistException: A webhook subscription with the specified configuration already exists. The client should verify if the subscription is already active or modify the request to avoid duplication.
These errors indicate that even though the request is properly formatted, the client lacks the necessary permissions or the requested resource is restricted for some reason.
404 Not Found Exceptions
A 404 Not Found error occurs when the server is unable to locate the requested resource. This typically happens when the resource (such as a room, reservation, user, or calendar) does not exist or cannot be found in the system. It means the server was unable to match the request to any available data, and the client should verify the resourceβs existence or try a different request.
Common 404 Not Found Exceptions:
PropertyNotFoundException: The requested property does not exist or cannot be found.
ReservationNotFoundException: The reservation with the specified ID cannot be found in the system.
RoomNotFoundException: The requested room ID is invalid or does not exist.
UserNotFoundException: The specified user ID cannot be found in the system.
ApiAccountNotFoundException: The requested API account does not exist or is incorrect.
ReservationCanceledException: The reservation has been canceled and is no longer available.
CalendarNotFoundException: The requested calendar could not be found in the system.
ClientNotFoundException: The requested client could not be found in the system.
TableNotFoundException: The requested table could not be found in the system.
VersionNotFoundException: The requested version could not be found in the system.
WebhookSubscriptionNotFoundException: The specified webhook subscription does not exist or could not be found in the system.
These errors indicate that the requested data or resource is missing, and the client should check the details (such as IDs or resource names) to ensure they are correct or to verify that the resource exists.
500 Internal Server Error Exceptions
A 500 Internal Server Error occurs when something goes wrong on the server side while processing the request. This error indicates that the server encountered an unexpected issue or exception that prevented it from fulfilling the request. It's a general error message indicating a problem that wasn't anticipated or handled properly by the system.
Common 500 Internal Server Error Exceptions:
FileIOException: An issue occurred while trying to read or write a file, such as a corrupted file or an inaccessible directory.
These errors are usually related to problems on the server, and often require server-side intervention to resolve. The client typically does not need to make changes to the request itself, but the server will need to be checked for internal issues.
503 Service Unavailable Exceptions
A 503 Service Unavailable error occurs when the server is temporarily unable to handle the request, often due to being overloaded, undergoing maintenance, or facing temporary issues. The server may be down for a short time, but will likely recover once the issue is resolved.
Common 503 Service Unavailable Exceptions:
ServiceNotAvailableException: The requested service is temporarily unavailable, possibly due to server overload, scheduled maintenance, or temporary disruptions.
These errors generally indicate a temporary issue with the server, and the client should try again later. It's a server-side issue that requires attention but typically resolves after some time.
Last updated