You are here: Home / 2013 / Ноябрь / 21 / Automap — rest — icons

Automap — rest — icons

21 ноября 2013 admin
назад
Automap / Руководство разработчика REST / Иконки

GET /cars/icons

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


GET /cars/icons?token=bw3ty3h46yth

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

Параметры фильтрации


GET /cars/icons?name=iconName&rotate=true

name: получение списка иконок по названию

rotate: получение списка иконок, у которых состояние поворота соответствует заданному булевому значению

Ответ:

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

Формат: json


[
	{
		"id": 222,
		"name": "Автобус 3D",
		"width": 384,
		"height": 48,
		"initialRotation": 0,
		"rotate": true,
		"type": 1,
		"src0": "/cars/icons/222/0",
		"src1": "/cars/icons/222/1",
		"src2": "/cars/icons/222/2"
	}
]



// массив иконок

// id иконки, целое число
// название иконки, строка
// ширина, целое число
// высота, целое число
// первоначальный поворот, целое число
// если true, поворачиваемая, булевое поле
// тип иконки, целое число
// неактивное ТС, строка
// активное ТС, строка
// выделенное ТС, строка

Статус: 404 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

GET /cars/icons/{id}/{status}

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


GET  /cars/icons/25/2?token=bw3ty3h46yth

id: id иконки

status: статус иконки

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

Ответ:

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

Статус: 404 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

GET /cars/icons/count

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


GET /cars/icons/count?token=bw3ty3h46yth

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

Ответ:

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

Формат: text


{
     24
}




// Количество иконок

Статус: 404 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

POST /cars/icons

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


POST /cars/icons?token=bw3ty3h46yth

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

Формат: json


{
        "initialRotation": "",
        "name": "тест",
        "rotate": false,
        "src0": "p18duadbq31lgi1pp3591k5r14rh2d.png",
        "src1": "p18duadfjf11opguk1ckb3fle8n2f.png",
        "src2": "p18duadlpt1u2i18i5bms1l8ni0m2h.png",
        "type": 0
}




// первоначальный поворот, целое число
// название иконки, строка
// если true поворачиваемая, булевое поле
// новая иконка в неактивном состоянии, строка
// новая иконка в активном состоянии, строка
// новая иконка в выделенном состоянии, строка
// тип иконки, целое число

Ответ:

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

Формат: json


{
	"height": 3,
	"id": 135,
	"initialRotation": 0,
	"name": "тест",
	"rotate": false,
	"src0": "/cars/icons/135/0",
	"src1": "/cars/icons/135/1",
	"src2": "/cars/icons/135/2",
	"type": 0,
	"width": 30
}




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

Статус: 400 — ошибка в запросе

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

Формат: text/plain

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

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

PUT /cars/icons/{id}

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


PUT /cars/icons/55?token=bw3ty3h46yth

id: id иконки ТС

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

Формат: json


{
	"height": 19,
	"id": 55,
	"initialRotation": "13",
	"name": "lambo",
	"rotate": false,
	"src0": null,
	"src1": "p189slg9l9vms1qg94mu1ldd140c7.jpg",
	"src2": null,
	"type": 0,
	"width": 30
}




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

Ответ:

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

Формат: json


{
	"height": 19,
	"id": 55,
	"initialRotation": 13,
	"name": "lambo",
	"rotate": false,
	"src0": "/cars/icons/55/0",
	"src1": "/cars/icons/55/1",
	"src2": "/cars/icons/55/2",
	"type": 0,
	"width": 30
}




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

Статус: 400 — ошибка в запросе

Статус: 404 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

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

DELETE /cars/icons/{id}

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


DELETE /cars/icons/59?token=bw3ty3h46yth

id: id иконки

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

Ответ:

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

Статус: 404 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

GET /cars/icons/{id}/{status}/preview/

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


GET /cars/icons/34/0/preview?token=bw3ty3h46yth

id: id иконки

status: 0 — неактивное ТС, 1 — активное ТС, 2 — выделенное ТС

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

Ответ:

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

Формат: image/png

Статус: 404 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

GET /cars/icons/{src}/{type}/preview

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


GET /cars/icons/"/cars/icons/25/0"/1/preview?token=bw3ty3h46yth

src: src загруженной иконки

type: 0 — сжатая иконка, 1 — вторая из восьми частей, в несжатом виде

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

Ответ:

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

Формат: image/png

Статус: 404 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

GET /cars/icons/{id}/{state}/preview/{type}

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


GET /cars/icons/94/1/preview/0?token=bw3ty3h46yth

id: id иконки

state: состояние иконки

type: 0 — сжатая иконка, 1 — вторая из восьми частей, в несжатом виде

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

Ответ:

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

Формат: image/png

Статус: 404 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

Posted in