Archives by date

You are browsing the site archives by date.

Automap — rest —service

20 ноября 2013 admin

Automap / Руководство разработчика REST /Техническое Обслуживание

Техническое обслуживание

Информация о тех.обслуживании ТС

GET /cars/{id}/service

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


GET /cars/4059/service?token=bw3ty3h46yth

id: id транспортного средства

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

Ответ:

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

Формат: json

{
	"id": {
		"carId": 4059,
		"dataFrom": 1421836494752
	},
	"reasonId": 2,
	"comments": "",
	"dataTill": null
}


// информация о ТС, объект
// id ТС, целое число
// время постановки на ТО, timestamp

// id причины, целое число
// комментарии, строка
// время окончания ТО, timestamp

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

Формат: text/plain

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

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

Формат: text/plain

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

Постановка ТС на ТО

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

POST /cars/{id}/service

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


POST /cars/4339/service?token=bw3ty3h46yth

id: id транспортного средства

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

Формат: json

{
	"comments": "Комментарий",
	"reasonId": 2
}


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

Ответ:

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

Формат: json

{
	"id": {
		"carId": 134375,
		"dataFrom": 1422277972999
	},
	"reasonId": 2,
	"comments": "Комментарии",
	"dataTill": null
}


// информация о ТС, объект
// id ТС, целое число
// дата постановки на ТО, timestamp

// id причины, целое число
// комментарии, строка
// дата окончания ТО, timestamp

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

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

Формат: text/plain

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

Редактирование данных о ТО

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

PUT /cars/{id}/service

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


PUT /cars/4339/service?token=bw3ty3h46yth

id: id ТС

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

Формат: json

{
	"comments": "Новый комментарий к ТО",
	"reasonId": 2
}


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

Ответ:

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

Формат: json

{
	"id": {
		"carId": 4339,
		"dataFrom": 1422277972999
	},
	"reasonId": 2,
	"comments": "Новый комментарий к ТО",
	"dataTill": null
}


// информация о ТС, объект
// id ТС, целое число
// дата постановки на ТО, timestamp

// id причины, целое число
// комментарии, строка
// дата окончания ТО, timestamp

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Снятие ТС с ТО

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

DELETE /cars/{id}/service

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


DELETE /cars/31/service?token=bw3ty3h46yth

id: id ТС

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

Ответ:

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Automap — rest —Tags

20 ноября 2013 admin

Automap / Руководство разработчика REST / Метки

Список меток

GET /cars/tags

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


GET /cars/tags?token=bw3ty3h46yth

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

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

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

color: получение списка меток по цвету

Ответ:

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

Формат: json

[{
		"id": 1,
		"name": "Название метки",
		"color": "ff0000"
},...]


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

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

Формат: text/plain

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

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

Формат: text/plain

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

Создание метки

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

POST /cars/tags

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


POST /cars/tags?token=bw3ty3h46yth

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

Формат: json

{
	"color": "ffb833",
	"name": "Метка" 
}


// цвет метки, строка
// название метки, строка

Ответ:

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

Формат: json

{
	"id": 128,
	"color": "ffb833",
	"name": "Метка" 
}


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

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

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

Формат: text/plain

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

Получение метки по id

GET /cars/tags/{id}

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


GET /cars/tags/15?token=bw3ty3h46yth

id: id метки

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

Ответ:

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

Формат: json

{
		"id": 15,
		"name": "Название метки",
		"color": "ff0000"
}


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

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

Формат: text/plain

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

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

Формат: text/plain

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

Редактирование метки

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

PUT /cars/tags/{id}

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


PUT /cars/tags/15?token=bw3ty3h46yth

id id метки

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

Формат: json

{
		"id": 15,
		"name": "Название метки",
		"color": "ff0000"
}


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

Ответ:

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

Формат: json

{
		"id": 15,
		"name": "Название метки",
		"color": "ff0000"
}


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

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Удаление метки

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

DELETE /cars/tags/{id}

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


DELETE /cars/tags/6?token=bw3ty3h46yth

id: id метки

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

Ответ:

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Количество меток

GET /cars/tags/count

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


GET /cars/tags/count?token=bw3ty3h46yth

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

Ответ:

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

Формат: text

107

// количество меток

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

Формат: text/plain

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

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

Формат: text/plain

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