Http Api Transaction - Brickcom WFB-100A User Manual

HTTP API Transaction

An HTTP API transaction is always started with a request from a client application, which
is received by the Web server on the IP Camera device and processed by the IP Camera
and finally ends with a response sent back to the requesting client.
The client HTTP request takes in either one of the two forms:
HTTP GET: Normally used to retrieve the settings or status of the IP Camera
HTTP POST: Normally used to configure the settings of the IP Camera
If the request is successfully received by the IP Camera, the response will contain a HTTP
header with a 200 OK response code and the HTTP body with the actual response data or
other value if error occurs. An example is provided for each request type below:
Illustration 1, Get the network setting from the IP Camera
Client request
GET http://<IP Camera address>/network.cgi HTTP/1.0
...
Server response
HTTP/1.0 200 OK
Content-Type: text/plain
IPAddress=192.168.1.1
SubnetMask=255.255.255.0
...
Illustration 2, Set the network setting from the IP Camera
Client request
POST http://<IP Camera address>/network.cgi HTTP/1.0
IPAddress=192.168.1.1
SubnetMask=255.255.255.0
Server response
HTTP/1.0 200 OK
...
Error Response
If the IP Camera is unable to handle the client HTTP API request due to certain conditions
such as system busy, incorrect parameters, or any other reason, an appropriate HTTP
status code 400 Bad Request is returned accompanied with an error code and error
string that explains the failure.
58