...
To send a start or stop signal, a simple simple
| Referencemacro | ||
|---|---|---|
|
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
| Referencemacro | ||
|---|---|---|
|
...
| Parameter | Description | ||
|---|---|---|---|
| cat | Signal category. For audio masking, this value is always 0x04. | ||
| type | The type of signal. Valid values for 0x04-categorysignals are:-
| ||
| objtype | The type of object that this signal relates to. This can be one of two values:-
| ||
| objid | The unique ID of the object type as specified by the objtypeparameter (above). This is used to locate the object in the Directory. The region of the Directory to the search in should be performed 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 | The region of the Directory the search should be performed is specified by the key parameter (below) and it is governed by the directory access 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.
...