Automap — rest — users( before delete /all)

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

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

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

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

GET /users

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


GET /users?token=mbs90lon2a8

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

Ответ:

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

Формат: json

[{
	"id": 1,
	"login": "user_login",
	"fio": "ФИО пользователя",
	"email": "user@user.com",
	"phone": "5699654",
	"monitor": false,
	"visible": false,
	"enabled": true,
	"groupId": 4,
	"organizationId": 10
},...]


// id пользователя, целое число
// логин пользователя, строка
// имя пользователя, строка
// электронная почта, строка
// телефон, строка

// видим на старте, булевое поле

// id группы, целое число
// id организации, целое число

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

Формат: text/plain

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

Добавление пользователя

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

POST /users

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


POST /users?token=mbs90lon2a8

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

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

Формат: json

{
	"email": "user@user.com",
	"fio": "ФИО пользователя",
	"groupId": "103",
	"login": "newuser",
	"organizationId": "122",
	"password": "newuser",
	"phone": "+79655141423",
	"visible": true
}


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

Ответ:

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

Формат: json

{
	"id": 264,
	"login": "newuser",
	"fio": "ФИО пользователя",
	"email": "user@user.com",
	"phone": "+79655141423",
	"monitor": false,
	"visible": true,
	"enabled": true,
	"groupId": 103,
	"organizationId": 122
}





// id пользователя, целое число
// логин, строка
// имя пользователя, строка
// электронная почта, строка
// телефон, строка

// видим на старте, булевое поле

// id группы, целое число
// id организации, целое число

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

Формат: text/plain

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

Редактирование пользователя

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

PUT /users/{id}

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


PUT /users/24?token=mbs90lon2a8

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

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

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

Формат: json

{
	"email": "user@user.com",
	"enabled": true,
	"fio": "ФИО пользователя",
	"groupId": "133",
	"id": 24,
	"login": "newuser",
	"monitor": false,
	"organizationId": "37",
	"password": "newuser",
	"phone": "+79655141423",
	"visible": true
}


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

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

Ответ:

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

Формат: json

{
	"id": 24,
	"login": "newuser",
	"fio": "ФИО пользователя",
	"email": "user@user.com",
	"phone": "+79655141423",
	"monitor": false,
	"visible": true,
	"enabled": true,
	"groupId": 1383,
	"organizationId": 3791
}


// id пользователя, целое число
// логин, строка
// имя пользователя, строка
// электронная почта, строка
// телефон, строка

// видим на старте, булевое поле

// id группы, целое число
// id организации, целое число

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

Формат: text/plain

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

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

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

DELETE /users/{id}

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


DELETE /users/24?token=mbs90lon2a8

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

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

Ответ:

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

Формат: json

{
    "delete": true
}

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

Формат: text/plain

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

Экспорт пользователей

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

GET /users.xlsx

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


GET /users.xlsx?token=mbs90lon2a8

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

Ответ:

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

Формат: json

Возвращает бинарный файл

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

Формат: text/plain

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

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

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

GET /users/current

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


GET /users/current?token=mbs90lon2a8

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

Ответ:

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

Формат: json

{
	"id": 1,
	"login": "admin",
	"fio": "admin",
	"email": null,
	"organization": {
		"id": 1,
		"name": "ГрадоСервис ООО",
		"mapExtent": "57.008, 56.638, 49.262, 48.578",
		"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": "57.008, 56.638, 49.262, 48.578",
			"mapRoadProvider": "MAPKZN",
			"mapAerialProvider": "MICROSOFT_AERIAL",
			"toDelete": false,
			"info": {
				"orgId": 1,
				"address": "казань",
				"phone": "",
				"inn": "",
				"kpp": "",
				"email": "",
				"homepage": ""
			}
		},
		"usersCount": 5
	},
	"phone": "",
	"monitor": false,
	"visible": false,
	"enabled": true,
	"groupId": 1,
	"organizationId": 1,
	"currentOrgId": 0
}


// id пользователя, целое число
// логин пользователя, строка
// имя пользователя, строка
// электронная почта, строка
// информация об организации
// id организации, целое число
// название организации, строка
// положение на карте, строка
// провайдер, строка
// провайдер, строка

// информация о пользователе
// id организации, целое число
// адрес организации, строка
// телефон, строка
// ИНН, целое число
// КПП, целое число
// электронный адрес, строка
// веб-страница, строка


// права пользователя
// id права, целое число
// название права, строка
// всевидящий пользователь, булевое поле
// администратор, булевое поле
// информация об организации
// id организации, целое число
// название, строка
// положение на карте, строка
// провайдер, строка
// провайдер, строка
// удаление, булевое поле
// дополнительная информация
// id организации, целое число
// адрес, строка
// телефон, строка
// ИНН, целое число
// КПП, целое число
// электронная почта, строка
// веб-страница, строка


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

// телефон пользователя, строка

// видим на старте, булевое поле

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

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

Формат: text/plain

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

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

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

GET /users/count

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


GET /users/count?token=mbs90lon2a8

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

Ответ:

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

Формат: json

233

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

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

Формат: text/plain

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