5. マイポケット API
5.22. 人物変更 API
変更する人物IDと変更後の人物情報（人物名、人物を表すファイルID、顔位置情報）を指定して、
人物情報を変更します。
リクエスト URI
HTTP
メソッド： PUT 文字コード： UTF-8
https://cocoa.ntt.com/rest/recognition/v1/face/{faceId}
No キー 型 必須 説明 サンプル値
1 faceId string ◯
変更する人物ID
人物一覧取得APIで取得した人物IDを指定 半角数字
リクエストヘッダ
No キー 型 必須 説明 サンプル値
1 Authorization string ◯ 「1.2 トークン認証」参照
2 X-Authorization string ◯ 「1.2 トークン認証」参照 3 Content-Type string ◯ 「application/json」を指定
4 Content-length string ◯ リクエストボディの長さ(byte)を指定 82
リクエストボディ
No キー 型 必須 説明 サンプル値
1 faceName string
変更する人物名(※1)
全半角文字(半角カタカナ、半角カンマ、全 角カンマを除く)
登録済みの人物名はエラー
EEE
2
faceFileCoordina
teList array 変更する人物を表すファイルIDと顔位置情
報のリスト
1 faceFileId string 人物を表すファイルID 12345678907
101 2 faceCoordina
tes
string
顔位置情報
半角数字およびマイナス記号「-」 顔位置の各XY座標を指定
左上X_左上Y_右上X_右上Y_左下X_左下Y_
右下X_右下Yの順に「_」区切りで記述
109_126_380_131_
104_397_375_402
3 passphraseSetup string
変更する人物に設定するパスフレーズ設定 モード
0：設定されているパスフレーズを削除 1：パスフレーズを新規発行
0指定時にパスフレーズが設定されていない 場合、1指定時にパスフレーズが設定されて いる場合はエラー
1
※1バックスラッシュエスケープシーケンスを行う。
レスポンスヘッダ
No キー 型 必須 説明 サンプル値
1 Content-Type string ◯ コンテンツタイプ application/json
レスポンスボディ
No キー 型 必須 説明 サンプル値
1 faceName string ◯
変更した人物名 (※1)
全半角文字(半角カタカナ、半角カンマ、全角カ ンマを除く)
AAA
2
faceFileCoordinat
eList array ◯
変更した人物を表すファイルIDと顔位置情 報のリスト
ファイルがない場合はnullを返却
1 faceFileId string
人物を表すファイルID 半角数字
格納する型：string
12345678907
2 faceCoordinat
es string
顔位置情報
半角数字およびマイナス記号「-」 格納する型：string
顔位置の各XY座標を指定
左上X_左上Y_右上X_右上Y_左下X_左下Y_
右下X_右下Yの順に「_」区切りで記述
109_126_380_131_
104_397_375_402
102
3 passphrase string 人物に設定されているパスフレーズ
全角ひらがな6文字 あかさたな
4 password string
人物に設定されているパスフレーズに対応 するパスワード
全角ひらがな6文字
いきしちに
5 modified string ◯ 変更した人物の更新日時
yyyy-MM-dd'T'HH:mm:ss+09:00 形式 (※2)
2013-08-09T12:00:
00+09:00
※1バックスラッシュエスケープシーケンスを行う。
※2 [ISO-8601]に準拠した日付の形式
リクエストサンプル
PUT https://cocoa.ntt.com/rest/recognition/v1/face/100000 Authorization: Bearer accesstoken
X-Authorization: AccessKey=”accesskey”
Content-Type:application/json Content-Length:52
正常に変更ができる場合、passphraseSetup指定なしの場合 {
"faceName":"EEE",
"faceFileCoordinateList":[
{ "faceFileId": "12345678907", "faceCoordinates": "109_126_380_131_104_397_375_402" }, { "faceFileId": "13579864207", "faceCoordinates":"54_62_190_65_52_198_180_201"}
] }
変更した結果、人物を表すファイルIDと顔位置情報が削除される場合 {
"faceName":"EEE",
"faceFileCoordinateList":[
{ "faceFileId": "", "faceCoordinates": ""}
] }
変更した結果、人物名のみ変更される場合① {
"faceName":"EEE"
}
変更した結果、人物名のみ変更される場合②③④ {
"faceName":"EEE",
"faceFileCoordinateList": "" または "faceFileCoordinateList":[] または "faceFileCoordinateList":[{}]
}
103
レスポンスサンプル
HTTP/1.1 200 OK
Content-Type: application/json
passphraseSetup=0の場合
パスフレーズが設定されていない状態でpassphraseSetup指定なしの場合 {
"faceName":"EEE",
"faceFileCoordinateList":[
{ "faceFileId": "12345678907", "faceCoordinates": "109_126_380_131_104_397_375_402" }, { "faceFileId": "13579864207", "faceCoordinates":"54_62_190_65_52_198_180_201"}
],
"modified":"2013-08-19T11:00:00+09:00"
}
passphraseSetup=1の場合
パスフレーズが設定されている状態でpassphraseSetup指定なしの場合 {
"faceName":"EEE",
"faceFileCoordinateList":[
{ "faceFileId": "12345678907", "faceCoordinates": "109_126_380_131_104_397_375_402" }, { "faceFileId": "13579864207", "faceCoordinates":"54_62_190_65_52_198_180_201"}
],
"passphrase":"あかさたなは",
"password":"いきしちにひ",
"modified":"2013-08-19T11:00:00+09:00"
}
正常に変更ができる場合、passphraseSetup=0の場合 {
"faceName":"EEE",
"faceFileCoordinateList":[
{ "faceFileId": "12345678907", "faceCoordinates": "109_126_380_131_104_397_375_402" }, { "faceFileId": "13579864207", "faceCoordinates":"54_62_190_65_52_198_180_201"}
],
"passphraseSetup":"0"
}
正常に変更ができる場合、passphraseSetup=1の場合 {
"faceName":"EEE",
"faceFileCoordinateList":[
{ "faceFileId": "12345678907", "faceCoordinates": "109_126_380_131_104_397_375_402" }, { "faceFileId": "13579864207", "faceCoordinates":"54_62_190_65_52_198_180_201"}
],
"passphraseSetup":"1"
}
104