MediaPropertiesLayout API Errors

Status

Error Type

Description

400

Bad Request

Request parameter is invalid.

400

Finesse API error

API error, such as: object is stale, violation of database constraint, and so on.

400

Invalid Input

At least one of the parameters provided is not valid.

400

Parameter Missing

At least one of the required parameters was not provided.

400

Maximum Exceeded

The maximum number of items has been exceeded.

400

Invalid Input

The user has selected more than five call variables when configuring call pop-over for a layout.

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 that is not their own.

403

Forbidden

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

Configuration APIs cannot be run against the secondary Finesse server.

The default media properties layout may not be deleted.

404

Not Found

Could not find the call variables layout with the specified ID.

405

Method Not Allowed

Unsupported operation is performed against an API. For example, if a DELETE or POST is attempted on: https://<FQDN>/finesse/api/MediaPropertiesLayout/default (which only supports GET and PUT).

500

Internal Server Error

Any runtime exception is caught and responded with this error.