AZazure

Changed on

List all persons in a large person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person).

get/largepersongroups/{largePersonGroupId}/persons

Request

  • Base URL
    {Endpoint}/face/v1.0
  • URL
    {Endpoint}/face/v1.0/largepersongroups/{largePersonGroupId}/persons
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Path parameters

largePersonGroupIdstring required

Id referencing a particular large person group.

Query parameters

startstring

Starting person id to return (used to list a range of persons).

topinteger

Number of persons to return starting with the person id indicated by the 'start' parameter.

Response

A successful call returns an array of person information that belong to the large person group.

namestring

User defined name, maximum length is 128.

userDatastring

User specified data. Length should not exceed 16KB.

Changes