Documentation for C-Werk 2.0.

Previous page Search request  Search completion Next page

GET http://IP-Address:port/search/{auto|face|vmda|stranger|heatmap}/{GUID}/result

The /search/(auto|face|vmda)/GUID part is a result of the POST command (see Search request).

ParameterRequiredDescription
limitNoMaximum number of events returned by the request. uint32_t::max() by default.
offsetNoResults offset by the specified number. For example, if a query with offset=0 returned 100 results, then in order to get the next results, it is necessary to run a query with offset=100. If the second query returned 250 results, then in order to get the next results, it is necessary to run a query with offset=350, etc.

Sample request:

http://127.0.0.1:80/search/face/49ded146-3912-4a2f-8e70-6ecfbcdacdea/result?offset=0&limit=10

Returned result depends on the search type.

The request can return two successful statuses:

StatusDescription
206Search is not over. Repeat search results requests until status code 200 is returned. Set delays between repeated requests in order to reduce computational burden.
200Search is over.

Error codes:

ErrorDescription
400Incorrect request.
404The offset value is greater than current quantity of results or requested search ID (GUID) not found.
  • No labels