User Guide

status 215
status
Description
A status code returned by the Breeze server whenever an API is called. This section provides
information about all the status codes and subcodes that Breeze can return.
Attributes
code
The status of the API. The following values are possible for this attribute:
subcode Sometimes used to provide more detail of the status of the API. For example, subcode
values are used to differentiate between different situations in which
code is set to no-access.
The following values are possible for this attribute:
Value Description
invalid
Indicates that a call is invalid in some way. If the code attribute is set to
"invalid", the status tag contains an invalid tag that provides more
detail about what’s wrong.
no-access
Indicates that you don’t have permission to perform the API. This can happen
in several situations; the value of the subcode attribute provides more details.
If you provide an invalid access key, there is no subcode value.
no-data
Indicates that there is no data available (in response to an API that would
normally result in returning data). Usually indicates that there is no item with
the ID you specified. To resolve the error, change the specified ID to that of an
item that exists.
ok
Indicates that the API has completed successfully.
too-much-data
Indicates that the API should have returned a single result but is actually
returning multiple results. For example, if there are multiple users with the
same user name and password, and you call the login API using that user
name and password as parameters, the system cannot determine which user
to log you in as, so it returns a "too-much-data" error.
Value Description
account-expired
The customer account has expired.
denied
Based on the supplied credentials, you don’t have permission to call the API.
no-login
You haven’t logged in. To resolve the error, log in (using the login API)
before you call the API. For more information, see the login API.
no-quota
The account limits have been reached or exceeded.
not-available
The required resource is unavailable.
not-secure
You must use SSL to call this API.
pending-activation
The account has not yet been activated.
pending-license
The account’s license agreement has not been settled.
sco-expired
The course or tracking content has expired.
sco-not-started
The meeting or course has not started.