Документация-вспомогательные

Cerebellum_Crud-rest-custom-fields

Cerebellum-Issue-type-groups

Cerebellum_Type-sorting

Cerebellum-Fast-issues-and-points

Cerebellum_Фильтрация_задач_по_custom-полям

cerebellum-rest-auth

Авторизация и регистрация

[gt] POST /registration

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

// IN --->
{
    "login": "login", //логин
    "paswd": "12345", //пароль
    "email" : "test@gradoservice.ru", //email
    "status": 2, //правовой статус: 1 - юридическое лицо, 2 - физическое лицо
    "fio": "Иванов И.И.", //ФИО физического лица или представителя юридического лица
    "phone": "8432000555", //телефон физического лица, необязательный параметр 
    "address": "г.Казань, ул.Назарбаева, д.25, кв.125", //адрес физического лица, необязательный параметр
    "fax": "8432000555", //факс физического лица, необязательный параметр
    "inn": 161111111111, //ИНН физического лица, необязательный параметр
    "passport": "9212 111111", //паспортные данные физического лица, необязательный параметр
    "ur_fio": "ООО Градосервис", //название организации (юридического лица), необязательный параметр 
    "ur_address": "г.Казань, ул.Назарбаева, д.27, офис 6-12", //адрес организации (юридического лица), необязательный параметр
    "ur_phone": "8432000555", //телефон организации (юридического лица), необязательный параметр
    "ur_fax": "8432000555", //факс организации (юридического лица), необязательный параметр
    "ur_inn": 1611111111, //ИНН организации (юридического лица), необязательный параметр
    "ur_kpp": 160011111, //КПП организации (юридического лица), необязательный параметр
    "bank": "Сбербанк", //наименование, реквизиты банка организации (юридического лица), необязательный параметр
    "bank_kpp": 775003035, //КПП организации (юридического лица), необязательный параметр
    "bank_bik": 044525225, //БИК организации (юридического лица), необязательный параметр
    "bank_schet": "12345678901234567890", //номер счета в банке (юридического лица), необязательный параметр
    "department_id": 1 //id организации, необязательный параметр   
}

// OUT <---
{
  "res": 1,
  "resText": "",
  "id": "6923", //id пользователя
  "login": "login", //логин пользователя
  "fio": "ООО Градосервис", //ФИО физического лица или название организации (юридического лица)
  "uvd_department_id": "62", //id ведомства, задания которого будут отображаться в интерфейсе map3d_mcs для AРМ Губернатора
  "users_site_type": "2", //принадлежность пользователя ведомству ("1") или организации ("2")
  "satellites_view": "t", "t", //видимость спутников в АРМ Губернатора: "t" или "f" 
  "email": "kzn.alina@gmail.com", //email
  "role_id": "10",
  "matrix": "(-0.756602,0.653875,0.00069758),(0.21426,0.246913,0.945054),(0.617775,0.715179,-0.326914),(2.34475e+06,2.7075e+06,5.26909e+06)", 
  //матрица перелета для АРМ Губернатора
  "department_id": "514" //id ведомства/организации
}

[gt] POST /registration/checklogin

Проверка логина на существование в системе.
Проверка доступности логина для использования.

// IN <---
{
    "login":"user_test" //логин пользователя
}
// OUT --->
{
    "res": 1,
    "resText": "",
    "check": "f" //true - логин не существует в системе, и он доступен для использования; false - логин существует в системе, и он не доступен для использования;
}

[gt] GET /registration/form

Список полей регистрационной формы.

// OUT --->
{
    "res": 1,
    "resText": "",
    "fields": { //поля
        "general": [ //общие поля
            {
                "values": "", //значения, которые может принимать поле
                "name": "login",  //английское название параметра
                "rusName": "Логин", //русское название параметра
                "required": "t" //обязательное поле или нет: true, false
            },
            {
                "values": "",
                "name": "paswd",
                "rusName": "Пароль",
                "required": "t" 
            },
            {
                "values": "",
                "name": "email",
                "rusName": "E-mail",
                "required": "t" 
            },
            {
                "values": [
                    {
                        "value": "1",
                        "rusName": "Юридическое лицо" 
                    },
                    {
                        "value": "2",
                        "rusName": "Физическое лицо" 
                    }
                ],
                "name": "status",
                "rusName": "Правовой статус",
                "required": "t" 
            }
        ],
        "physical_person": [ //поля для физических лиц
            {
                "values": "",
                "name": "fio",
                "rusName": "ФИО",
                "required": "t" 
            },
            {
                "values": "",
                "name": "address",
                "rusName": "Почтовый адрес",
                "required": "t" 
            },
            {
                "values": "",
                "name": "phone",
                "rusName": "Телефон",
                "required": "f" 
            },
            {
                "values": "",
                "name": "fax",
                "rusName": "Факс",
                "required": "f" 
            },
            {
                "values": "",
                "name": "inn",
                "rusName": "ИНН",
                "required": "f" 
            },
            {
                "values": "",
                "name": "passport",
                "rusName": "Паспортные данные",
                "required": "f" 
            }
        ],
        "legal_person": [ //поля для юридических лиц
            {
                "values": "",
                "name": "ur_fio",
                "rusName": "Полное наименование организации с указанием организационно-правовой формы",
                "required": "t" 
            },
            {
                "values": "",
                "name": "ur_address",
                "rusName": "Почтовый адрес",
                "required": "t" 
            },
            {
                "values": "",
                "name": "ur_phone",
                "rusName": "Телефон",
                "required": "f" 
            },
            {
                "values": "",
                "name": "ur_fax",
                "rusName": "Факс",
                "required": "f" 
            },
            {
                "values": "",
                "name": "ur_inn",
                "rusName": "ИНН",
                "required": "f" 
            },
            {
                "values": "",
                "name": "kpp",
                "rusName": "КПП",
                "required": "f" 
            },
            {
                "values": "",
                "name": "bank",
                "rusName": "Название банка",
                "required": "f" 
            },
            {
                "values": "",
                "name": "bank_kpp",
                "rusName": "КПП банка",
                "required": "f" 
            },
            {
                "values": "",
                "name": "kpp",
                "rusName": "КПП",
                "required": "f" 
            },
            {
                "values": "",
                "name": "bank_bik",
                "rusName": "БИК банка",
                "required": "f" 
            },
            {
                "values": "",
                "name": "bank_schet",
                "rusName": "Расчетный счет",
                "required": "f" 
            }
        ]
    },
    "url": "/rest/registration" //URL для отправки полей на регистрацию
}

[A] POST /users

Служебный запрос. Упрощенная схема регистрации пользователей для тестов.

// IN --->
{
    "login": "login", //логин
    "paswd": "12345", //пароль
    "email" : "test@gradoservice.ru", //email, необязательный параметр
    "phone": "8432000555", //телефон, необязательный параметр 
    "ur_fio": "Иванов и КО", //название юр.лица, , необязательный параметр
    "ur_address": "Казань", //адрес юр.лица, необязательный параметр
    "status": 2, //правовой статус: "1" - юридическое лицо, "2" - физическое лицо, необязательный параметр
    "organization_id": 1, //id организации, необязательный параметр
    "role_id": 7, //id роли пользователя, необязательный параметр: "6", "7" - обычный пользователь, "10" - админ ведомства, "8" - администратор всех ведомств
    "fio": "Иванов И.И." //ФИО пользователя, необязательный параметр
}
// OUT <---
{
    "res": 1,
    "resText": "",
    "user": {
        "id": "6391",
        "login": "login",
        "fio": "Иванов И.И.",
        "uvd_department_id": "62", //id ведомства, задания которого будут отображаться в интерфейсе map3d_mcs для AРМ Губернатора
        "users_site_type": "2", //принадлежность пользователя ведомству ("1") или организации ("2")
        "satellites_view": "t", //видимость спутников в АРМ Губернатора: "t" или "f" 
        "role_id": "7", //id роли пользователя: "6", "7" - обычный пользователь, "10" - админ ведомства, "8" - администратор всех ведомств
        "matrix": "(-0.756602,0.653875,0.00069758),(0.21426,0.246913,0.945054),(0.617775,0.715179,-0.326914),(2.34475e+06,2.7075e+06,5.26909e+06)",
        //матрица перелета для АРМ Губернатора
        "department_id": "1" //id ведомства/организации
    }
}

[A] DELETE /users/:id

Удаление пользователя (логическое удаление).

// OUT <---
{
  "res": 1,
  "resText": "" 
}

[A] DELETE /users/:id/hard

Удаление пользователя (физическое удаление для тестов).

// OUT <---
{
  "res": 1,
  "resText": "" 
}

[t] POST /mobile/register

Запрос на регистрацию для получения PUSH-сообщений. Запрос поступает с мобильного устройства.

// IN --->
{   //уникальный адрес устройства для получения PUSH-сообщений, генерируется при установке приложения
    "regId":"APA91bGmD0VObEd-KKuJ9J826c4o4VaxKL9VhvBQaecj3bY0RmrSp2aVmpsujTRPvYRDTvZDhVB9kxke4Q0pcivIM61PsPDd_Eh3k-0DUVdSSpXmgFAM4lsvxpuW1Re9dfQ2mSWMLiCr", 
    //полное имя приложения
    "fqn":"android://ru.gs.mapmobile" 

}
// OUT <---
{
    "res": 1,
    "resText": "" 
}

[t] POST /mobile/unregister

Запрос на отмену регистрации для получения PUSH-сообщений. Запрос поступает с мобильного устройства.

// IN --->
{    //уникальный адрес устройства для получения PUSH-сообщений, генерируется при установке приложения
    "regId":"APA91bGmD0VObEd-KKuJ9J826c4o4VaxKL9VhvBQaecj3bY0RmrSp2aVmpsujTRPvYRDTvZDhVB9kxke4Q0pcivIM61PsPDd_Eh3k-0DUVdSSpXmgFAM4lsvxpuW1Re9dfQ2mSWMLiCr",
     //полное имя приложения 
    "fqn":"android://ru.gs.mapmobile" 

}
// OUT <---
{
    "res": 1,
    "resText": "" 
}

[gt] POST /authentication

Запрос на авторизацию.

// IN --->
{
    "action": "post", //необходимо явно указать тип запроса "post" для соответствия с MapAdmin
    "login": "login", //логин
    "password": "password", //пароль
    "rememberme": "1" //настройка сохранения параметров авторизации: "1" - сохранить, "0" - не сохранять
}
// OUT <---
{
    "res": 1,
    "resText": "",
    "id":"6", //id пользователя
    "login":"login", //логин пользователя
    "fio":"ФИО", //имя пользователя
    "uvd_department_id":"62", //id ведомства, задачи которого будут отображаться в интерфейсе map3d_mcs для AРМ Губернатора
    "users_site_type":"2", //принадлежность пользователя ведомству ("1") или организации ("2")
    "satellites_view":"t", //видимость спутников в АРМ Губернатора: "t" или "f" 
    "role_id":"8", //id роли пользователя
    "email": "test@gmail.com", //email пользователя 
    "matrix":"(-0.756602,0.653875,0.00069758),(0.21426,0.246913,0.945054),(0.617775,0.715179,-0.326914),(2.34475e+06,2.7075e+06,5.26909e+06)", 
    //матрица перелета для АРМ Губернатора
    "department_id":null, //id ведомства
    "map_extent": [ //координаты положения карты: ["min lon","min lat","max lon","max lat"]
        "46.0927078887718",
        "53.9919087034184",
        "55.2997131017069",
        "56.6837870890742" 
    ],
    "token":"87e3d7ae036b752cc90bd093bbfa1634" //token
}

cerebellum-rest-requests

cerebellum-rest-configuration

cerebellum-rest-version

cerebellum-rest-geo4me