Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

HTTP Web server NGP responds to method calls in the form of JSON format.

Info
titleNote

Configuring the web serverWeb-Server.

By The default the Web - server port is 80 (Windows), 8000 (Lunix), the prefix is / (empty).

Authorization

Authorization is needed for requests.  Supported authorization type is basic.Two types of authorization are supported: Basic and Bearer.

With the Basic authorization type, it is necessary to add user data to all HTTP requests in the following formAuthorization is required in each HTTP request as follows:

Code Block
http://[username]:[password]@[IP-address]:[port]/[prefix]

With the Bearer authorization type, the token received from the web server is used (see Bearer authorization).

POST requests must have JSON body.

Time format in requests

In all requests, the time is specified in the YYYYMMDDTHHMMSS format in the time zone UTC+0.

Time interval is specified in some requests, for example:

GET http://IP-address:port/prefix/archive/contents/intervals/{VIDEOSOURCEID}/{ENDTIME}/{BEGINTIME}

These requests return data starting at BEGINTIME and ending at ENDTIME.

If BEGINTIME is not specified, infinite future is considered. If ENDTIME is also not specified, infinite past is considered. Instead of BEGINTIME and ENDTIME, the words "past" and "future" can be used to set infinite past and infinite future respectively.

Interval sequence corresponds to the ratio between the specified BEGINTIME and ENDTIME (in ascending order if BEGINTIME<ENDTIME, and in descending order if ENDTIME<BEGINTIME). The start and end points of the interval are returned in the sequential order, i.e. the interval start time is less than the interval end time or equal to it.

Requests limit

The number of active requests and requests in queue is limited.

...