You are here: Home / 2015 / Январь / 19 / MapSurfer — rest — users

MapSurfer — rest — users

19 января 2015 admin
назад
mapSurfer GS / Руководство разработчика REST / Пользователи

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

GET /users

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


GET /users?token=mbs90lon2a8

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

Ответ:

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

Формат: json


[{
    "id": 1,
    "login": "login",
    "name": "ФИО пользователя",
    "info": {
        "id": 1,
        "address": "Страна, город, улица",
        "phone": "+79173633639",
        "fax": "",
        "email": "user@user.com",
        "inn": 6547822145,
        "kpp": 0,
        "passport": "",
        "bank": "",
        "bankKpp": 55547852,
        "bankBik": 04466851752,
        "bankSchet": ""
    },
    "organizationId": 9,
    "roleId": 2
},...]




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

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

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

Формат: text/plain

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

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

GET /users/count

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


GET /users/count?token=mbs90lon2a8

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

Ответ:

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

Формат: json


{
    233
}




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

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

Формат: text/plain

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

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

GET /users/{id}/info

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


GET /users/12/info?token=mbs90lon2a8

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

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

Ответ:

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

Формат: json


{
    "id": 12,
    "address": "Адрес",
    "phone": "+79655904447",
    "fax": "2156847",
    "email": "email@email.com",
    "inn": 362124752,
    "kpp": 0,
    "passport": "",
    "bank": "",
    "bankKpp": 0,
    "bankBik": 0,
    "bankSchet": ""
}




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

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

Формат: text/plain

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

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

GET /users/roles

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


GET /users/roles?token=mbs90lon2a8

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

Ответ:

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

Формат: json


[
    {
        "title": "Заказчик",
        "id": 1
    },
    {
        "title": "Администратор ведомств",
        "id": 2
    },...
]





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


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

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

Формат: text/plain

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

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

POST /users

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


POST /users?token=mbs90lon2a8

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

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

Формат: json


{
    "info": {
        "address": "Город, улица, дом",
        "email": "email",
        "fax": "",
        "inn": "325365602014",
        "passport": "",
        "phone": "+79600802229"
    },
    "login": "adminvedomstv",
    "name": "ФИО пользователя",
    "password": "123456",
    "roleId": 2
}




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

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

Ответ:

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

Формат: json


{
    "id": 172,
    "login": "adminvedomstv",
    "name": "ФИО пользователя",
    "info": {
        "id": 172,
        "address": "Город, улица, дом",
        "phone": "+79600802229",
        "fax": "",
        "email": "",
        "inn": 325365602014,
        "kpp": 0,
        "passport": "",
        "bank": "",
        "bankKpp": 0,
        "bankBik": 0,
        "bankSchet": ""
    },
    "organizationId": null,
    "roleId": 2
}




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

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

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

Формат: text/plain

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

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

PUT /users/{id}

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


PUT /users/24?token=mbs90lon2a8

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

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

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

Формат: json


{
    "id": 24,
    "info": {
        "address": "Город, улица, дом",
        "email": "",
        "fax": "",
        "inn": 325365602014,
        "passport": "",
        "phone": "+79600802229"
    },
    "login": "adminvedomstv",
    "name": "ФИО пользователя",
    "password": "123456",
    "roleId": 2
}




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

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

Ответ:

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

Формат: json


{
    "id": 24,
    "login": "adminvedomstv",
    "name": "ФИО пользователя",
    "info": {
        "id": 24,
        "address": "Новый адрес",
        "phone": "+79600802229",
        "fax": "",
        "email": "new email",
        "inn": 325365602014,
        "kpp": 0,
        "passport": "Новые паспортные данные",
        "bank": "",
        "bankKpp": 0,
        "bankBik": 0,
        "bankSchet": ""
    },
    "organizationId": null,
    "roleId": 8
}




// id пользователя, целое число
// логин пользователя, строка
// имя пользователя, строка
// информация о пользователе, объект
// 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/groups

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


GET /users/groups?token=mbs90lon2a8

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

Ответ:

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

Формат: json


{
	"groups": [{
		"id": 1,
		"name": "Название группы",
		"order": 10
	},...]
}




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

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

Формат: text/plain

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

Posted in