getPersonFacesInfoオペレーションを呼び出して、顔画像のIDや顔画像のURLなど、個人の顔情報をクエリできます。
リクエスト構文
POST /green/sface/faces HTTPS|HTTP
リクエストヘッダー
このオペレーションでは、共通のリクエストヘッダーのみを使用します。 詳細については、「共通リクエストヘッダー」をご参照ください。
リクエストパラメーター
パラメーター | タイプ | 必須 | 例 | 説明 |
clientInfo | JSONObject | いいえ | {"userId":"120234234","userNick":"Mike","userType":"others"} | JSON形式でClientInfo構造体からシリアル化されたクライアント情報。 情報には、クライアントのUMID(Unique Machine Identifier)とIMEI(International Mobile Equipment Identity)が含まれます。 詳細については、「ClientInfo」をご参照ください。 |
リクエストボディ
クエリ対象の個人情報を指定するには、リクエストボディにも次のパラメーターを入力する必要があります。
パラメーター | タイプ | 必須 | 例 | 説明 |
personId | String | はい | person1 | クエリ対象の個人のID。 |
faceIds | Array | ノードロールの配列。 | ["11111","2222"] | 顔画像のID。 説明 このパラメーターを入力しない場合、指定された個人IDの顔画像のIDが返されます。 |
レスポンスパラメーター
すべてのリクエストに対してJSON形式のデータが返されます。 共通レスポンスパラメーターの詳細については、「共通レスポンスパラメーター」をご参照ください。 レスポンスの data パラメーターは、ビジネス関連データを返すために使用されます。 通常、このパラメーターの値はJSON構造体または配列です。
説明
エラーが発生した場合、data パラメーターは空になる場合があります。
次の表は、data フィールドで返されるパラメーターについて説明しています。
パラメーター | タイプ | 例 | 説明 |
code | Integer | 200 | 返された HTTP ステータスコード。 詳細については、「共通エラーコード」をご参照ください。 |
faceImageItems | JSONArray | person1 | 指定された個人の顔オブジェクトのリスト。 配列の各要素は構造体です。 |
success | Boolean | true | 顔情報が正常にクエリされたかどうかを示します。 有効な値:
|
faceId | Long | 2****************6 | 顔画像のID。 |
url | String | http://www.xxx.cn/aaa.jpg | 顔画像の URL。 |
例
サンプルリクエスト
POST /green/sface/faces HTTP/1.1
Common request headers // 共通リクエストヘッダー
{
"personId": "person1",
"faceIds":["1111","22222"]
}
サンプルの成功レスポンス
{
"code":200,
"requestId":"82E9202A-183F-4DDE-A45E-D554F8FA8D7B",
"data":{
"code":200,
"faceImageItems":[
{
"success":true,
"faceId":2****************6,
"url":"http://www.aliyundoc.com/aaa.jpg"
}
]
}
}
エラーコード
エラーコードの一覧については、サービスエラーコード を参照してください。