PhoneBook API Errors

Status

Error Type

Description

400

Finesse API Error

API error such as the object is stale or does not exist.

400

Invalid Input

One of the input parameters exceeded constraints.

Contacts could not be imported because the data was invalid. The file may be empty or may not contain any valid lines. If the ErrorData field contains no lines, there may not be data to import. The multipart mime message may have been improperly formatted or did not contain a file.

The multipart mime message may have been improperly formatted or did not contain a file. In this case, the existing records are overwritten.

400

In Use

The phone book is assiged to a team. You cannot change a team phone book to a global phone book if it is use. You cannot delete a phone book if it is use.

400

Maximum Exceeded

The maximum number of phone books or contacts has been exceeded.

400

Parameter Missing

A required parameter was not present in the request.

401

Authorization Failure

Unauthorized (for example, the user is not yet authenticated in the Web Session).

The user is not authorized to use the API (the user is not an administrator).

401

Invalid Authorization User Specified

The authenticated user tried to use the identity of another user.

403

Forbidden

The user attempted to run the API against the secondary Finesse server.

Configuration APIs cannot be run against the secondary Finesse server.

404

Not Found

The specified resource cannot be found.

500

Internal Server Error

Any runtime exception is caught and responded with this error.