Automap — rest — carGroups

GET /cars/groups

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


GET /cars/groups?token=bw3ty3h46yth

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

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


GET /cars/groups?organizations=1162,1&name=группа

name: поиск группы по названию

organizations: получение списка групп, принадлежащих хотя бы одной из заданных организаций

notes: поиск группы по записям

Ответ:

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

Формат: json


[
	{
		id: 703,
		name: "003",
		notes: null,
		extGroup: null,
		view: true,
		organizationId: 1
	}
]


// массив объектов с информацией по группе

// id группы, целое число
// название группы, строка
// описание группы, строка
 
// видима ли 
// id организации

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

Формат: text/plain

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

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

Формат: text/plain

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

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

PUT /cars/groups/{id}

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


PUT   /cars/groups/{id}?token=bw3ty3h46yth

{id}: id группы

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

Формат: json

{
	extGroup: null,
	id: 4901,
	name: "name",
	notes: "",
	organizationId: "1143",
	view: true
}


// id группы
// название группы
// описание группы
// id организации
// видима ли

Ответ:

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

Формат: json

{
	extGroup: null,
	id: 4901,
	name: "name",
	notes: "",
	organizationId: "1143",
	view: true
}


// id группы
// название группы
// описание группы
// id организации
// видима ли

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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

POST /cars/groups

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


POST     /cars/groups?token=bw3ty3h46yth

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

Формат: json


{
	name: "name",
	organizationId: "10"
}



// название группы
// id организации

Ответ:

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

Формат: json

{
	extGroup: null,
	id: 4901,
	name: "name",
	notes: "",
	organizationId: "1143",
	view: true
}


// id группы
// название группы
// описание группы
// id организации
// видима ли

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

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

Формат: text/plain

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

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

DELETE /cars/groups/{groupId}

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


DELETE /cars/groups/{groupId}?token=bw3ty3h46yth

{groupId}: id группы

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

Ответ:

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

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

Формат: text/plain

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

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

Формат: text/plain

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

GET /cars/groups.xlsx

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


GET /cars/groups.xlsx?token=bw3ty3h46yth

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

Ответ:

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

Формат: application/vnd.ms-excel

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

Формат: text/plain

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

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

Формат: text/plain

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

GET /cars/groups/{groupId}/cars

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


GET     /cars/groups/{groupId}/cars?token=bw3ty3h46yth

{groupId}: id группы

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

Ответ:

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

Формат: json


[
	{
		id: 4158,
		name: "testDrivers",
		glonassId: 354235,
		view: true,
		lastUpdate: null,
		projectPoints: false,
		onService: false,
		iconStandard: true,
		iconIndex: 223,
		toDelete: false,
		markId: 150,
		modelId: 1621,
		groupId: 702,
		speed: 0,
		direction: 0,
		lat: 0,
		lon: 0,
		carNo: "235235",
		isStopped: false,
		tagsIds: [ ],
		organizationId: 1
	}
]


// массив машин группы

// id машины
// название
// ГЛОНАСС id
// видима ли
// последнее обновление

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

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

Формат: text/plain

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

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

Формат: text/plain

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

GET /cars/groups/count

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


GET /cars/groups/count?token=bw3ty3h46yth

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

Ответ:

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

Формат:text


10


// количество доступных групп

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

Формат: text/plain

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

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

Формат: text/plain

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