Response Messages

Possible response codes and messages are provided in this section. Messages can be either about successful performing of operations or about errors.

Success Messages

Reason and Description Standard response for successful HTTP requests. The actual response will depend on the request method used. In GET request the response will contain an entity corresponding to the requested resource. In POST request the response will contain an entity describing or containing the result of the action.

Status CodeReason and Description
200 OK

Standard response for successful HTTP requests. The actual response will depend on the request method used. In GET request the response will contain an entity corresponding to the requested resource. In POST request the response will contain an entity describing or containing the result of the action.

201

Created

The request has been fulfilled, resulting in the creation of a new resource

202 Accepted The request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs.
204 No Content The server successfully processed the request and is not returning any content

Error Messages

Standard Error Messages

These messages can be displayed in all methods.

 Response Body example (Error 400)
{ "error": "InvalidAccountProgram", "error_description": "Unable to process request for account program 'partner'." }

Status CodeReason and DescriptionComments

400

Bad request The request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs.
 
401 Unauthorized

Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. For example, the user does not have the necessary credentials.

 
500 Internal Server Error A generic error message, given when an unexpected condition was encountered and no more specific message is suitable  
501 Not Implemented The server either does not recognize the request method or it lacks the ability to fulfill the request. Usually, this implies future availability (e.g., a new feature of a web-service API).  

Specific Error Messages

The variants of messages depend on methods and situations (see the description below).

Response Body example (Error 403 (3))
{ "error": "AccountAccessDenied", "error_description": "Access to account '7c5284fa20674dc5a15335b512320560' is denied." }

Status CodeReasonMethods
403 Forbidden The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource.

1

The access to partner or account is denied

  1. Account Billing Plans Service
  2. Account Company (billing address) Information Service
  3. Account Contacts Service
  4. Account Management Service
  5. Account Payment Information Service

2

The access to partner or account is denied. The access to partner contact or account contact is denied.

Account Contacts Service

3

The access to account is denied
  1. Account Billing Plans Service
  2. Account limits (user accounts, to enforce prepaid billing model) Service
  3. Account Management Service
  4. Account Master Service Agreement Service
  5. Account State (enabled/disabled) Service

4

The access to partner or account is denied. The access to partner contact or account contact is denied. Change of {AG_PRIVATELABELPUBLICAPI} access role is not allowed.

Account Contacts Service

5

The access to partner is denied

Partner Account Usage Report (billing integration and reconciliation) Service

404 Not Found The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible.

1

The partner or account was not found
  1. Account Billing Plans Service
  2. Account Company (billing address) Information Service
  3. Account Contacts Service
  4. Account Management Service
  5. Account Payment Information Service

2

The partner or account was not found. The partner contact or account contact was not found.

Account Contacts Service

3

The account was not found. The specified plan name could not be found.

Account Billing Plans Service

4

The account was not found
  1. Account Limits (user accounts, to enforce prepaid billing model) Service
  2. Account Management Service
  3. Account Master Service Agreement Service
  4. Account State (enabled/disabled) Service

5

The account was not found. The account limit was not found.

Account Limits (user accounts, to enforce prepaid billing model) Service

6

The account was not found. The limit is not configured on the specified account.

Account Limits (user accounts, to enforce prepaid billing model) Service

7

API responds with Not Found code when we were unable to look up at least one identity from the list provided

Identitiy Translation (for migration purposes) Service

8

API responds with Not Found code when we were unable to look up at least one login from the list provided

Identitiy Translation (for migration purposes) Service

9

The partner was not found

Partner Account Usage Report (billing integration and reconciliation) Service

409 Conflict Indicates that the request could not be processed because of conflict in the request, such as an edit conflict between multiple simultaneous updates

1

Specified contact login is already used for another contact. Please use PUT method to link an existing contact to the account. Account Contacts Service

2

The account is already using the specified plan

Account Billing Plans Service

3

The contact is already assigned to the account. Use PUT method to update the relationship.

Account Contacts Service

4

The limit already exists for the specified account. Please use PUT method to update the limit.

Account Limits (user accounts, to enforce prepaid billing model) Service

5

The partner or account could not be created because the user name provided is not available Account Management Service

6

The account MSA has already been accepted. One cannot step into the same river twice.

Account Master Service Agreement Service

7

The account state is already set or the account is in state change transition Account State (enabled/disabled) Service