Дополнительные API методы

< Основная страница с API запросами 

• • Управление подразделениями
    • Поиск подразделения
    • Добавление подразделения
    • Редактирование подразделения
    • Удаление подразделения
  • Управление группами
    • Получить информацию группы по идентификатору группы
    • Удалить группу
    • Получить информацию группы по идентификатору клиента
    • Создать группу
    • Изменить группу

Управление подразделениями

Поиск подразделения

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID подразделения 
  "name": "string", // Наименование подразделения 
  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификатор клиента-родителя
}

Пример ответа:

[
  {
    "name": "string", // Наименование подразделения 
    "description": "string", // Дополнительное описание
    "color": "string", // Цвет 
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID подразделения 
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор клиента-родителя
    "deleted": true // Признак удаления 
  }

Добавление подразделения

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID
  "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid владельца
  "name": "string", // Наименование
  "description": "string", // Дополнительное описание
  "color": "string", // Цвет
  "extId": "string" // extId
}

Пример ответа: 

{
  "name": "string", // Наименование
  "description": "string", // Дополнительное описание
  "color": "string", // Цвет
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID подразделения 
  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя
  "deleted": true // Признак удаления 
}

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

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID подразделения 
  "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid владельца
  "name": "string", // Наименование
  "description": "string", // Дополнительное описание
  "color": "string", // Цвет
  "extId": "string" // extId
}

Пример ответа: 

{
  "name": "string", // Наименование
  "description": "string", // Дополнительное описание
  "color": "string", // Цвет
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID
  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя
  "deleted": true // Признак удаления
}

Удаление подразделения

unitId - Guid подразделения 

Пример ответа: 

200 // Success

Управление группами

Получить информацию группы по идентификатору группы

groupId - Идентификатор группы 

Пример ответа: 

{ 
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор группы.
  "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор владельца.
  "Name": "string", // Наименование группы
  "VehiclesIds": [ 
    "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы объектов группы. 
  ],
  "ModelsIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы моделей объектов группы.
  ],
  "Type": 0 // Тип группировки: 0 - по объектам, 1 - по моделям объектов
}

Удалить группу

groupId - Идентификатор группы

Пример ответа: 

200 // Success

Получить информацию группы по идентификатору клиента

agentId - Идентификатор клиента

Пример ответа: 

[
  {
    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор группы.
    "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор владельца.
    "Name": "string", // Наименование группы.
    "VehiclesIds": [ 
      "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы объектов группы.
    ],
    "ModelsIds": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы моделей объектов группы.
    ],
    "Type": 0 // Тип группировки: 0 - по объектам, 1 - по моделям объектов
  }
]

Создать группу

Пример запроса: 
{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор группы.
  "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор владельца.
  "Name": "string", // Наименование группы.
  "VehiclesIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы объектов группы.
  ],
  "ModelsIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы моделей объектов группы.
  ],
  "Type": 0 // Тип группировки: 0 - по объектам, 1 - по моделям объектов
}

Пример ответа: 

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор группы.
  "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор владельца.
  "Name": "string", // Наименование группы.
  "VehiclesIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы объектов группы.
  ],
  "ModelsIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы моделей объектов группы.
  ],
  "Type": 0 // Тип группировки: 0 - по объектам, 1 - по моделям объектов
}

Изменить группу

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

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор группы.
  "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор владельца.
  "Name": "string", // Наименование группы.
  "VehiclesIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы объектов группы.
  ],
  "ModelsIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы моделей объектов группы.
  ],
  "Type": 0 // Тип группировки: 0 - по объектам, 1 - по моделям объектов
}

Пример ответа: 

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор группы.
  "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор владельца.
  "Name": "string", // Наименование группы.
  "VehiclesIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы объектов группы.
  ],
  "ModelsIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы моделей объектов группы.
  ],
  "Type": 0 // Тип группировки: 0 - по объектам, 1 - по моделям объектов
}