Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated using 4PSA automated script
Excerpt

This page describes the UnifiedAPI HTTP return codes.

Table of Contents
maxLevel2

Format

UnifiedAPI returns errors using a JSON format:

Code Block
{
"error": {
    "code":"access_denided",
    "message":"You are not authorized to use this request."
    }
}

Successful codes

The following successful return codes are common to all requests:

HTTP CodeDescription
200The object of the request is returned.
204There is no object to be returned.

Error codes

The following error can occur in all requests:

HTTP CodeCodeDescription
501request_not_implementedYou are not allowed to make the request because the operation is not implemented.
400user_invalidValue supplied in the URI-Fragment as userId is invalid. The parameter must reference the Id of an user or can be set to @owner, @me or @viewer.
401access_deniedYou are not authorized to use this request.
400extension_invalidValue supplied in the URI-Fragment as extension is invalid. The parameter must reference the number of an existing extension or can be set to @self.
500internal_server_error

An internal server error occurred. Please contact the administrator.

4psarelated
NameRelated Topics

Data Types

Quick Examples

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.