Sign in

List all existing large person groups’ largePersonGroupId, name, userData and recognitionModel.<br />

  • Large person groups are stored in alphabetical order of largePersonGroupId.
  • "start" parameter (string, optional) is a user-provided largePersonGroupId value that returned entries have larger ids by string comparison. "start" set to empty to indicate return from the first item.
  • "top" parameter (int, optional) specifies the number of entries to return. A maximal of 1000 entries can be returned in one call. To fetch more, you can specify "start" with the last returned entry’s Id of the current call. <br />

For example, total 5 large person groups: "group1", ..., "group5". <br /> "start=&top=" will return all 5 groups. <br /> "start=&top=2" will return "group1", "group2". <br /> "start=group2&top=3" will return "group3", "group4", "group5".

get/largepersongroups

Query parameters

startstring

List large person groups from the least largePersonGroupId greater than the "start".

topinteger

The number of large person groups to list.

returnRecognitionModelboolean

A value indicating whether the operation should return 'recognitionModel' in response.

Response

A successful call returns an array of large person groups and their information.

namestring required

User defined name, maximum length is 128.

userDatastring

User specified data. Length should not exceed 16KB.

Changes