Person Group Person - Get

Service:

Azure AI Services

API Version:

1.0

Retrieve a person's information, including registered persisted faces, name and userData.

GET {Endpoint}/face/v1.0/persongroups/{personGroupId}/persons/{personId}

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
personGroupId	path	True	string maxLength: 64 pattern: ^[a-z0-9-_]+$	Id referencing a particular person group.
personId	path	True	string (uuid)	Id referencing a particular person.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string

Responses

Name	Type	Description
200 OK	Person	A successful call returns the person's information.
Other Status Codes	APIError	Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Get person example

Sample request

HTTP

GET {Endpoint}/face/v1.0/persongroups/abc/persons/25985303-c537-4467-b41d-bdb45cd95ca1

Sample response

Status code:

200

{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
  "persistedFaceIds": [
    "015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
    "fce92aed-d578-4d2e-8114-068f8af4492e",
    "b64d5e15-8257-4af2-b20a-5a750f8940e7"
  ],
  "name": "Ryan",
  "userData": "User-provided data attached to the person."
}

Definitions

Name	Description
APIError	Error information returned by the API
Error	Error body.
Person	Person object.

APIError

Object

Error information returned by the API

Name	Type	Description
error	Error	Error body.

Error

Object

Error body.

Name	Type	Description
code	string
message	string

Person

Object

Person object.

Name	Type	Description
name	string maxLength: 128	User defined name, maximum length is 128.
persistedFaceIds	string[] (uuid)	PersistedFaceIds of registered faces in the person. These persistedFaceIds are returned from Person - Add a Person Face, and will not expire.
personId	string (uuid)	PersonId of the target face list.
userData	string maxLength: 16384	User specified data. Length should not exceed 16KB.