Implementation

HTTP request

To send a start or stop signal, a simple HTTP GET request must be sent to the TIM Enterprise web server.

Every request to the web server requires authentication, so ensure that the relevant HTTP authentication headers are sent with your request and that the username and password combination match an existing web user object in the Directory.

The response status code will indicate success or failure.

Request format

The request should be a GET request and take the following URL-encoded parameters, as per the following example:-

Valid parameters are described in the table below:-

Parameter	Description
cat	Signal category. For audio masking, this value is always 0x04
type	The type of signal. Valid values for 0x04-category signals are:- 0x01 Mute On 0x02 Mute Off
objtype	The type of object that this signal relates to. This can be one of two values:- user (a user object) channel (a channel object)
objid	The unique ID of the object type as specified by the objtype parameter (above). This is used to locate the object in the Directory. The region of the Directory to search in is specified by the key parameter (below) and governed by the access implied by the placement of the web user whose credentials are used to effect the web request.
key	Specifies the key relating to a container object in the directory (or blank, implying the whole directory) whereby a search on the object specified by objtype and objid is performed below.

Return values are specified as HTTP response status code. Although the body of some responses may contain informational text, you should not rely on this text to make any decisions as to whether the request was successful or not.

Valid status codes are as follows:-

Parameter	Description
200	The signal was received and stored successfully.
400	The request was not acceptable for one of the following reasons:- An invalid type parameter was specified. The type parameter is specific to the category specified by the cat parameter. Further, the type value (e.g. 0x01) can be used in multiple categories. The objid was missing. Specify the ID of the object you want the signal to relate to. The cat and type parameters (category and signal type, respectively) must be specified and cannot be zero. The version of TIM Enterprise you are running does not understand the signal.js script.
404	The object specified by the combination of the objtype and objid parameters (and optionally the key parameter) could not be found.
500	Internal Server Error prevented the signal from being stored successfully. This may be due to a badly-configured database, or the lack of a signals table in the TIM Enterprise database.