POST api/EasyFace/ListFaces

Request Information

URI Parameters

None.

Body Parameters

FacesRequest
NameDescriptionTypeAdditional information
CollectionId

string

None.

CollectionsId

Collection of string

None.

FaceId

string

None.

ImageBase64

string

None.

UserId

string

None.

Source

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CollectionId": "sample string 1",
  "CollectionsId": [
    "sample string 1",
    "sample string 2"
  ],
  "FaceId": "sample string 2",
  "ImageBase64": "sample string 3",
  "UserId": "sample string 4",
  "Source": "sample string 5"
}

application/xml, text/xml

Sample:
<FacesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ReconocimientoFacial.Models">
  <CollectionId>sample string 1</CollectionId>
  <CollectionsId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CollectionsId>
  <FaceId>sample string 2</FaceId>
  <ImageBase64>sample string 3</ImageBase64>
  <Source>sample string 5</Source>
  <UserId>sample string 4</UserId>
</FacesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ListFacesResponse
NameDescriptionTypeAdditional information
FaceModelVersion

string

None.

Faces

Collection of Face

None.

NextToken

string

None.

ResponseMetadata

ResponseMetadata

None.

ContentLength

integer

None.

HttpStatusCode

HttpStatusCode

None.

Response Formats

application/json, text/json

Sample:
{
  "FaceModelVersion": "sample string 1",
  "Faces": [
    {
      "BoundingBox": {
        "Height": 1.1,
        "Left": 2.1,
        "Top": 3.1,
        "Width": 4.1
      },
      "Confidence": 1.1,
      "ExternalImageId": "sample string 2",
      "FaceId": "sample string 3",
      "ImageId": "sample string 4"
    },
    {
      "BoundingBox": {
        "Height": 1.1,
        "Left": 2.1,
        "Top": 3.1,
        "Width": 4.1
      },
      "Confidence": 1.1,
      "ExternalImageId": "sample string 2",
      "FaceId": "sample string 3",
      "ImageId": "sample string 4"
    }
  ],
  "NextToken": "sample string 2",
  "ResponseMetadata": {
    "requestIdField": "sample string 1",
    "_metadata": null
  },
  "ContentLength": 3,
  "HttpStatusCode": 100
}

application/xml, text/xml

Sample:
<ListFacesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Amazon.Rekognition.Model">
  <contentLength xmlns="http://schemas.datacontract.org/2004/07/Amazon.Runtime">3</contentLength>
  <httpStatusCode xmlns="http://schemas.datacontract.org/2004/07/Amazon.Runtime">Continue</httpStatusCode>
  <responseMetadataField xmlns="http://schemas.datacontract.org/2004/07/Amazon.Runtime">
    <_metadata xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <requestIdField>sample string 1</requestIdField>
  </responseMetadataField>
  <FaceModelVersion>sample string 1</FaceModelVersion>
  <Faces>
    <Face>
      <BoundingBox>
        <Height>1.1</Height>
        <Left>2.1</Left>
        <Top>3.1</Top>
        <Width>4.1</Width>
      </BoundingBox>
      <Confidence>1.1</Confidence>
      <ExternalImageId>sample string 2</ExternalImageId>
      <FaceId>sample string 3</FaceId>
      <ImageId>sample string 4</ImageId>
    </Face>
    <Face>
      <BoundingBox>
        <Height>1.1</Height>
        <Left>2.1</Left>
        <Top>3.1</Top>
        <Width>4.1</Width>
      </BoundingBox>
      <Confidence>1.1</Confidence>
      <ExternalImageId>sample string 2</ExternalImageId>
      <FaceId>sample string 3</FaceId>
      <ImageId>sample string 4</ImageId>
    </Face>
  </Faces>
  <NextToken>sample string 2</NextToken>
</ListFacesResponse>