Namespace OverKizApi.Exceptions
Classes
- AccessDeniedToGatewayException
Raised when the authenticated user does not have permission to control the target gateway. This may occur when the gateway belongs to a different account.
- ActionGroupSetupNotFoundException
Raised when an action group setup cannot be resolved for the target gateway. This may indicate a configuration issue on the gateway side.
- ApplicationNotAllowedException
Raised when the client application is not permitted to access this setup. This typically occurs when the setup's reseller has restricted API access to specific apps.
- BadCredentialsException
Raised when the username or password supplied to the API is incorrect. Check credentials and retry; do not loop automatically.
- BaseOverkizException
Raised for structured Overkiz API error responses (HTTP 4xx/5xx with a JSON error body). The Message property contains the
errorfield from the response.
- CozyTouchBadCredentialsException
Raised when the credentials supplied to the Atlantic CozyTouch OAuth endpoint are invalid.
- CozyTouchServiceException
Raised when an unexpected error occurs while communicating with the CozyTouch identity API.
- DuplicateActionOnDeviceException
Raised when an execution is submitted for a device that already has a pending action. Wait for the existing action to complete or cancel it before retrying.
- ExecutionQueueFullException
Raised when the gateway's execution queue is completely full and cannot accept new requests.
- InvalidCommandException
Raised when a command sent to a device is not recognised by the gateway or device. Verify the command name and parameters against the device's Definition.
- InvalidEventListenerIdException
Raised when the event listener ID supplied to a fetch or unregister call is not recognised by the server. Re-register by calling RegisterEventListener().
- InvalidTokenException
Raised when a bearer token supplied to the API is malformed or has been revoked.
- MaintenanceException
Raised when the server returns a 503 response that indicates a scheduled maintenance window. Inherits from ServiceUnavailableException.
- MissingAPIKeyException
Raised when the API requires an API key that was not provided.
- MissingAuthorizationTokenException
Raised when the request is missing the required authorization token header. Ensure a valid bearer token or session cookie is attached to the request.
- NexityBadCredentialsException
Raised when the credentials supplied to Nexity's AWS Cognito authentication endpoint are invalid.
- NexityServiceException
Raised when an unexpected error occurs while communicating with the Nexity identity API.
- NoGatewaySelectedException
Raised when a Rexel request requires a selected gateway but no gateway has been chosen.
- NoRegisteredEventListenerException
Raised when a fetch or unregister call is made but no event listener has been registered for this session. Call RegisterEventListener() first.
- NoSuchResourceException
Raised when the requested resource (device, scenario, token, etc.) does not exist.
- NotAuthenticatedException
Raised when the API returns "Not authenticated". The session cookie or bearer token has expired; call Login(bool) again to obtain a new session.
- NotSuchTokenException
Raised when no local token exists for the specified UUID.
- OverkizException
Base class for all exceptions thrown by the Overkiz API client library. Catch this type to handle any API-related error in a single handler.
- ResourceAccessDeniedException
Raised when the authenticated user does not have permission to access the requested resource.
- ServiceUnavailableException
Raised when the Overkiz server returns HTTP 503 Service Unavailable. Retry after a delay; the service may be temporarily overloaded.
- SessionAndBearerInSameRequestException
Raised when a request attempts to use both a JSESSIONID cookie and a Bearer token simultaneously, which is not supported by the API.
- SomfyBadCredentialsException
Raised when the credentials supplied to the Somfy OAuth 2.0 token endpoint are invalid.
- SomfyServiceException
Raised when an unexpected error occurs while communicating with the Somfy identity API.
- TooManyAttemptsBannedException
Raised when the account is temporarily banned after too many failed authentication attempts. Wait before retrying; do not loop automatically.
- TooManyConcurrentRequestsException
Raised when the server rejects the request because too many calls are in-flight simultaneously. Reduce concurrency and retry.
- TooManyExecutionsException
Raised when the gateway reports that its execution queue is saturated. Reduce the rate of execution submissions and retry with back-off.
- TooManyRequestsException
Raised when the HTTP 429 Too Many Requests status is returned by the API. Back off and retry after a delay.
- UnknownObjectException
Raised when the API cannot find the requested object (device, gateway, etc.).
- UnknownUserException
Raised when the specified user account does not exist in the Overkiz system.