Automap — rest

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

Пользователи

Текущий пользователь

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

GET /users/current

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


GET /users/current?token=bw3ty3h46yth

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

Ответ:

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

Формат: json

{
	id: 373,
	login: "admin",
	fio: "admin",
	organization: {
		id: 1,
		name: "ГрадоСервис ООО",
		mapExtent: "63.39152, -66.79, 94.921875, -80.15625",
		order: 100,
		mapRoadProvider: "MAPKZN",
		mapAerialProvider: "MICROSOFT_AERIAL",
		toDelete: false,
		info: {
			orgId: 1,
			address: "",
			phone: "",
			inn: "",
			kpp: "",
			email: "",
			homepage: ""
		}
	},
	right: {
		id: 1,
		name: "Градосервис",
		wheel: true,
		admin: true,
		organization: {
			id: 1,
			name: "ГрадоСервис ООО",
			mapExtent: "63.39152, -66.79, 94.921875, -80.15625",
			order: 100,
			mapRoadProvider: "MAPKZN",
			mapAerialProvider: "MICROSOFT_AERIAL",
			toDelete: false,
			info: {
				orgId: 1,
				address: "",
				phone: "",
				inn: "",
				kpp: "",
				email: "",
				homepage: ""
			}
		},
		usersCount: 11
	},
	phone: "",
	monitor: false,
	visible: false,
	modTravelorder: "standard",
	modAutoe: "standard",
	enabled: true,
	groupId: 1,
	identifier: "373",
	organizationId: 1,
	currentOrgId: 1
}





// id текущего пользователя
// логин
// ФИО
// информация об организации
// id организации
// название организации
// видимая часть карты(координаты левой нижней и правой верхней точек)
// порядок организации
// провайдер схем дорог

// в процессе удаления

// id организации
// адрес
// телефон
// ИНН
// КПП
// email
// домашняя страница


// права
// id
// название
// всевидящий
// администрирование
// информация об организации
// id организации
// название организации
// видимая часть карты(координаты левой нижней и правой верхней точек)
// порядок организации
// провайдер схем дорог

// в процессе удаления

// id организации
// адрес
// телефон
// ИНН
// КПП
// email
// домашняя страница


// количество пользователей

// телефон

// виден при старте


// включен
// id группы
// идентификатор
// id организации
// id текущей организации

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

Формат: text/plain

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

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

Формат: text/plain

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

Список пользователей

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

GET /users

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


GET /users?token=bw3ty3h46yth

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

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


GET /users?fio=name?organizations=1,12

fio: поиск пользователей по имени

email: поиск пользователей по email

login: поиск пользователей по login

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

phone: поиск пользователей по номеру телефона

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

rights: поиск пользователей, имеющих хотя бы одно из заданных прав

Ответ:

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

Формат: json

[
	{
		id: 22,
		login: "sid",
		fio: "Шушарин Иван Иванович",
		phone: "960055555",
		monitor: false,
		visible: true,
		modTravelorder: "standard",
		modAutoe: "standard",
		enabled: true,
		groupId: 3,
		identifier: "22",
		organizationId: 2
	}
]




// массив объектов пользователей

// id пользователя
// логин
// имя
// телефон

// виден при старте


// включен
// id групы пользователя
// идентификатор
// id организации

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

Формат: text/plain

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

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

Формат: text/plain

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

Изменение пользователя

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

PUT /users/{id}

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


PUT /users/{id}?token=bw3ty3h46yth

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

{id}: id пользователя

Формат: json

{
	enabled: true,
	fio: "fio1",
	groupId: "1103",
	id: 1305,
	identifier: "1305",
	login: "login1",
	modAutoe: "standard",
	modTravelorder: "standard",
	monitor: false,
	organizationId: "1162",
	password: "123452",
	phone: "1234567345",
	visible: false
}





// включен
// фио
// id группы
// id пользователя
// идентификатор
// логин



// id организации
// пароль
// телефон
// виден при старте

Ответ:

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

Формат: json

{
	enabled: true,
	fio: "fio1",
	groupId: 1103,
	id: 1305,
	identifier: "1305",
	login: "login1",
	modAutoe: "standard",
	modTravelorder: "standard",
	monitor: false,
	organizationId: 1162,
	phone: "1234567345",
	visible: false
}





// включен
// фио
// id группы
// id пользователя
// идентификатор
// логин



// id организации
// телефон
// виден при старте

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Создание пользователя

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

POST /users

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


POST /users?token=bw3ty3h46yth

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

Формат: json

{		
	fio: "имя пользователя",
	groupId: "1103",
	login: "login",
	organizationId: "1162",
	password: "пароль",
	phone: "89630453323",
	visible: true
}





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

Ответ:

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

Формат: json

{		
	enabled: true,
	fio: "имя пользователя",
	groupId: 1103,
	id: 1305,
	identifier: "1305",
	login: "login",
	modAutoe: "standard",
	modTravelorder: "standard",
	monitor: false,
	organizationId: 1162,
	phone: "89630453323",
	visible: true
}





// включюен
// фио
// id группы
// id пользователя
// идентификатор
// логин



// id организации
// телефон
// виден при старте

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

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

Формат: text/plain

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

Удаление пользователя

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

DELETE /users/{id}

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


DELETE          /users/{id}

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

{id}: id пользователя

Ответ:

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Список пользователей в xlsx файле

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

GET /users.xlsx

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


GET /users.xlsx?token=bw3ty3h46yth

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

Ответ:

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

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Количество пользователей

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

GET /users/count

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


GET /users/count?token=bw3ty3h46yth

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

Ответ:

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

Формат: text

224

// Количество пользователей

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

Формат: text/plain

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

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

Формат: text/plain

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

Automap — rest — users

Пользователи

Текущий пользователь

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

GET /users/current

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

Ответ:

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

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

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

Список пользователей

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

GET /users

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

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

Ответ:

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

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

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

Изменение пользователя

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

PUT /users/{id}

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

Ответ:

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

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

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

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

Создание пользователя

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

POST /users

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

Ответ:

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

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

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

Удаление пользователя

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

DELETE /users/{id}

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

Ответ:

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

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

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

Список пользователей в xlsx файле

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

GET /users.xlsx

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

Ответ:

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

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

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

Количество пользователей

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

GET /users/count

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

Ответ:

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

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

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