Set
Данный метод позволяет установить связь между заданной фотографией и конкретным person_id.
Запрос
Авторизационные данные передаются в строке запроса:
Параметр | Тип | Значение |
oauth_token | string | OAuth2 access token (required non-empty) |
oauth_provider | string | провайдер OAuth2 (required non-empty) |
Поддерживаемые провайдеры OAuth2:
Провайдер | Значение oauth_provider | Получение токена |
Mail.Ru | mcs | Смотрите в статье |
Параметры запроса передаются в формате JSON в теле запроса с name="meta":
Параметр | Тип | Значение |
space | string | числовой идентификатор, используемый для избежания пересечений по персонам (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 000000000000000000000000000 ------WebKitFormBoundaryfCqTBHeLZlsicvMp |
Ответ
Параметр | Тип | Значение |
status | int | 200 в случае успеха, иначе описание ошибки будет в body |
body | string | 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 } |