You are here: Home / 2015 / Январь / 19 / MapSurfer — rest — dictionary

MapSurfer — rest — dictionary

19 января 2015 admin
назад
mapSurfer GS / Руководство разработчика REST / Справочники

Доступно только для пользователей с правами администратора

GET /dictionary/icons

Структура запроса:


GET /dictionary/icons?token=mbs90lon2a8

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


[{
    "id": 99,
    "name": "red",
    "width": 73,
    "ownerOrganizationId": null,
    "height": 72
},...]




// id справочника, целое число
// название справочника, строка
// ширина, целое число
// id организации, пользователь которой добавил справочник
// высота, целое число

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Доступно только для пользователей с правами администратора

GET /dictionary/icons/editable

Структура запроса:


GET /dictionary/icons/editable?token=mbs90lon2a8

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


[{
    "id": 99,
    "name": "red",
    "width": 73,
    "ownerOrganizationId": null,
    "height": 72
},...]




// id справочника, целое число
// название справочника, строка
// ширина, целое число
// id организации, пользователь которой добавил справочник
// высота, целое число

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Доступно только для пользователей с правами администратора

POST /dictionary/icons

Структура запроса:


POST /dictionary/icons?token=mbs90lon2a8

token: ключ доступа

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

Формат: json


{
    "name": "Справочник",
    "uuid": "p1996qif28t071sb22us1hd93lon.png"
}




// название справочника, строка
// uuid изображения, строка

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    "id": 51,
    "name": "Справочник",
    "width": 1258,
    "height": 750
}




// id справочника, целое число
// название справочника, строка
// ширина, целое число
// высота, целое число

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Доступно только для пользователей с правами администратора

PUT /dictionary/icons/{id}

Структура запроса:


PUT /dictionary/icons/51?token=mbs90lon2a8

id: id справочника

token: ключ доступа

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

Формат: json


{
    "id": 51,
    "name": "Новое название справочника",
    "uuid": "p1996qif28t071sb22us1hd93lon.png"
}




// id справочника, целое число
// название справочника, строка
// uuid изображения, строка

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    "id": 51,
    "name": "Новое название справочника",
    "width": 1258,
    "height": 750
}




// id справочника, целое число
// название справочника, строка
// ширина, целое число
// высота, целое число

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Доступно только для пользователей с правами администратора

DELETE /dictionary/icons/{id}

Структура запроса:


DELETE /dictionary/icons/51?token=mbs90lon2a88

id: id справочника

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    "delete": true
}

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

GET /dictionary/icons/{id}/view

Структура запроса:


GET /dictionary/icons/23/view?token=mbs90lon2a8

id: id справочника

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: image/jpeg и т.д.

Изображение выбранного справочника

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Posted in