Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Справочник Роли содержит информацию о ролях клиента (имя) системы TrackControl Web 2, доступных для назначения их пользователям и настройкой на них прав.

...

Получение данных

Чтобы получить список всех ролей, необходимо отправить GET запрос на адрес https://teletrack.ua/api/usersrolesv2/getAll<token>/<token>usersroles/, где


token
Токен получен при авторизации *

 * - обязательный параметр


В случае успешного выполнения запроса, должен прийти ответ со списком ролей следующего формата:

Code Block
themeEclipse
{
  "data": [
    {
      "DepartId": null,
      "Departs": [
        {
          "Department": {
            "id": null,
            "name": null
          },
          "MainOrganization": {
            "id": 341,
            "name": "Агро ТОВ (упр)"
          },
          "Organization": {
            "id": null,
            "name": null
          }
        }
      ],
      "Description": "Администратор",
      "Id": 84,
      "IsReadOnly": false,
      "Name": "Admin

...

",
      "OrganizationId": null,
      "mainorganizationid": 341
    },
...
...
    {
      "DepartId": 106,
      "Departs": [
        {
          "Department": {
            "id": 16,
            "name": "Інженерний відділ"
          },
          "MainOrganization": {
            "

...

id": 

...

2605,
            "

...

name": "

...

Управляющая организация"
          },
          "Organization": {
            

...

"id": 70,
            "name": "

...

Организация 

...

ТОВ"
          }
        }
      ],
      "Description": "демо",
      "Id": 

...

1057,
      "IsReadOnly": false,
      "Name": 

...

"Переглядач",
      "OrganizationId": 70,
      "mainorganizationid": 2605
    }
  ],
  

...

"err": null,
  

...

"status": true
}


Создание новой записи

...

Для создания новой записи (новой роли), необходимо отправить GET POST запрос на адрес https://teletrack.ua/api/usersrolesv2/save<token>/<token>/?id=0&name=Test%20name&descr=Test%20desc , где

...

usersroles/ c параметрами в формате JSON


Code Block
themeEclipse
{

    "Name":"test",

    "Descr":"test_role",

    "IsReadOnly":false,

    "Departs":

      [

          {"Department":{"id":176},"MainOrganization":{"id":319},"Organization":{"id":320}},

          {"Department":{"id":null},"MainOrganization":{"id":51},"Organization":{"id":19}},

          {"Department":{"id":null},"MainOrganization":{"id":18},"Organization":{"id":null}}

      ]

}


, где


token
Токен получен при авторизации *
Name
Название роли *
Descr
Описание роли *
IsReadOnly
Роль только для чтения - true / false *
DepartsСписок организаций, к которым предоставляется доступ *
MainOrganizationID управляющей организации в БД *
Organization
ID организации в БД; null, если отсутствует *
Department
ID департамента в БД; null, если отсутствует *

 * - обязательный параметр


В случае успешного выполнения запроса, должен прийти ответ следующего вида:

Code Block
themeEclipse
{
  "data": {
    "Id": 

...

19
  }, 
  "err": null, 
  "status": true
}


IdID новой записи в БД

Редактирование записи (роли)

...


Code Block
themeEclipse
{

    "Name":"test",

    "Descr":"test_role",

    "IsReadOnly":false,

    "Departs":

      [

          {"Department":{"id":176},"MainOrganization":{"id":319},"Organization":{"id":320}},

          {"Department":{"id":null},"MainOrganization":{"id":51},"Organization":{"id":19}},

          {"Department":{"id":null},"MainOrganization":{"id":18},"Organization":{"id":null}}

      ]

}


, где


token
Токен получен при авторизации *
IdId роли в БД *
Name
Название роли *
Descr
Описание роли *
IsReadOnly
Роль только для чтения - true / false *
DepartsСписок организаций, к которым предоставляется доступ *
MainOrganizationID управляющей организации в БД *
Organization
ID организации в БД; null, если отсутствует *
Department
ID департамента в БД; null, если отсутствует *

 * - обязательный параметр



В случае успешного выполнения запроса, должен прийти ответ следующего вида:

Code Block
themeEclipse
{
  "data": null, 
  "err": null, 
  "status": true
}

Удаление записи (роли)

Для удаления существующей записи нужно отправить  GET запрос на адрес отправить  DELETE запрос на адрес  https://teletrack.ua/api/usersrolesv2/deleteById<token>/<token>/?id=183 гдеusersroles/<Id>, где

tokenТокен получен при авторизации *
IdID записи (роли) в БД которою нужно удалить *

 * - обязательный параметр


В случае успешного выполнения запроса, должен прийти ответ следующего вида:

Code Block
themeEclipse
{
  "data": null, 
  "err": null, 
  "status": true
}