Status and error codes

The Face-to-Face Interaction Recorder API generates the following HTTP status responses.

Status

Explanation

200: OK

Standard response for a successful HTTP request.

As a response to the checkService operation, it means that the API is available and responded successfully, and it does not return content besides the message.

As a response to the getRecordingStatus operation, it means that the status of the currently active recording is available, and is returned in the response.

201: Created

The request has been fulfilled and a new resource has been created. The location of the resource is included in the response headers.

400: Bad Request

The server cannot or will not process the request because something is perceived to be a client error, such as malformed request syntax, invalid request message framing, or deceptive request routing.

As a response to the tagRecording operation, it means that the tagged_by_component parameter was not provided in the request, or that no tag request was provided.

404: Not Found

The requested resource could not be found but may be available again in the future. Subsequent requests by the client are allowed.

409: Conflict

The request caused a conflict in the system. The response contains a more specific message.

As a response to the startRecording operation, it means that a recording was already in progress at the time the request was made.

As a response to the stopRecording, pauseRecording, resumeRecording, or tagRecording operation, it means that a recording was not in progress when the request was made.

If provided in the operation, tag data is not tagged to the recording when this error response is received.

500: Internal Server Error

A generic error message, returned when an unexpected condition was encountered, and no more specific message is suitable.