Set

Данный метод позволяет установить связь между заданной фотографией и конкретным person_id.

Запрос

Авторизационные данные передаются в строке запроса:


ПараметрТипЗначение
oauth_tokenstringOAuth2 access token (required non-empty)
oauth_providerstringпровайдер OAuth2 (required non-empty)

Поддерживаемые провайдеры OAuth2:


ПровайдерЗначение oauth_providerПолучение токена
Mail.Rumcs

Смотрите в статье


Параметры запроса передаются в формате JSON в теле запроса с name="meta":


ПараметрТипЗначение
spacestringчисловой идентификатор, используемый для избежания пересечений по персонам (required non-empty)
images[]image_metaметаданные передаваемых изображений (required non-empty)

Параметр space используется для избежания пересечений по person. Таким образом, person1 из space 0 и person1 из space 1 разные. Для приложений, решающих различные задачи, имеет смысл использовать различные значения space.

Клиент может иметь до 10 различных spaceзначения space изменяются от "0" до "9" В случае превышения лимита вернется ошибка.

image_meta


ПараметрТипЗначение
name
stringчисловой идентификатор, используемый для избежания пересечений по персонам для разных приложений (required non-empty)
person_id
intметаданные передаваемых изображений (required non-empty)

Изображения передаются в теле запроса, значения поля name должны соответствовать переданным в images. Максимальное количество изображений в одном запросе равняется 100. Максимальный размер каждого изображения не должен превышать 4МБ.

Пример запроса:


POST /api/v1/persons/set?oauth_provider=mcs&oauth_token=123 HTTP/1.1

Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryfCqTBHeLZlsicvMp

------WebKitFormBoundaryfCqTBHeLZlsicvMp
Content-Disposition: form-data; name="file_0"; filename=""
Content-Type: image/jpeg



000000000000000000000000000
000000000000000000000000000
000000000000000000000000000

------WebKitFormBoundaryfCqTBHeLZlsicvMp
Content-Disposition: form-data; name="file_1"; filename=""
Content-Type: image/jpeg

111111111111111111111111111
111111111111111111111111111
111111111111111111111111111
------WebKitFormBoundaryfCqTBHeLZlsicvMp
Content-Disposition: form-data; name="meta"

{"space":"0", "images":[{"name":"file_0", "person_id":1},{"name":"file_1", "person_id":2}]}
------WebKitFormBoundaryfCqTBHeLZlsicvMp--


Ответ

ПараметрТипЗначение
statusint

200 в случае успеха, иначе описание ошибки будет в body

bodystring | response 

тело ответа

response

ПараметрТипЗначение
objects

[]object

массив ответов для каждого файла

object

ПараметрТипЗначение
status

enum

результат выполнения


error

string

текстовое описание ошибки (optional)

name

string

имя файла для сопоставления файлов в запросе и ответе

status

ПараметрЗначение
0

успешно

1

перманентная ошибка

2

временная ошибка

Пример ответа:


{

"status":200,

"body":{

"objects":[

   {

   "status":0,

   "name":"file_0"

   },

   {

   "status":1,

   "name":"file_1",

   "error":"The memory contains data of an unknown image type"

   }

   ]

},

"htmlencoded":false,

"last_modified":0

}