Описание запросов объектов и статистик при взаимодействии через REST. СПИК

Обратите внимание

Ссылка на описание запросов к СПИК в интерфейсе Swagger

  1. Авторизация
  2. Запрос объектов доступных пользователю
  3. Запрос групп доступных пользователю
  4. Запрос статистик
1. Авторизация 
Обратите внимание

Request URL - адрес сервера на котором установлен плагин СПИК.
Если вы используете сервер СКАУТ, то адрес следует указывать следующий: http://login.scout-gps.ru:8081

Cинтаксис запроса: Request URL/spic/auth/rest/Login
Метод запроса: POST
Заголовки: 
Content-Type: application/json
Accept: json
Параметры передаваемые в запросе: 
{
"Login":"demo",
"Password":"demo",
"TimeStampUtc":"/Date(1583135092271)/",
"TimeZoneOlsonId":"Europe/Moscow",
"CultureName":"ru-ru",
"UiCultureName":"ru-ru"
}

Результат: токен авторизации Authorization Token (Session Id)

2. Запрос объектов доступных пользователю

Запрос количества доступных объектов
Синтаксис запроса: Request URL/spic/units/rest/
Метод запроса: GET
Заголовки: 
Content-Type: application/json
Accept: json
ScoutAuthorization: Session Id
Результат: получение количества доступных объектов

Запрос сведений по объектам с постраничной выгрузкой
Синтаксис запроса: Request URL/spic/units/rest/getAllUnitsPage
Метод запроса: POST
Заголовки: 
Content-Type: application/json
Accept: json
ScoutAuthorization: Session Id
Параметры передаваемые в запросе:

{
"Offset":0,
"Count":10
}

Результат запроса:
свойства каждого из доступных объектов 

Brand: "",
Color: "",
CompanyId: "",
Description: "",
GarageNumber: "",
Model: "",
Name: "",
OlsonId: "",
Owner: "",
Power: "",
Registration: "",
StateNumber: "",
UnitId: "",
UnitTypeId: "",
VinNumber: "",
Year: ""

Запрос сведений по одному объекту
Синтаксис запроса: Request URL/spic/units/rest/getUnit
Метод запроса: POST
Заголовки: 
Content-Type: application/json
Accept: json
ScoutAuthorization: Session Id
Параметры передаваемые в запросе: 

{"ObjectId":UnitId}

Результат запроса:
свойства одного запрошенного объекта 

Brand: "",
Color: "",
CompanyId: "",
Description: "",
GarageNumber: "",
Model: "",
Name: "",
OlsonId: "",
Owner: "",
Power: "",
Registration: "",
StateNumber: "",
UnitId: "",
UnitTypeId: "",
VinNumber: "",
Year: ""

Запрос UnitId всех доступных пользователю объектов
Синтаксис запроса: Request URL/spic/units/rest/unitIds
Метод запроса: GET
Заголовки: 
Content-Type: application/json
Accept: json
ScoutAuthorization: Session Id
Результат запроса: список всех UnitId

3. Запрос групп доступных пользователю

Синтаксис запроса: Request URL/spic/unitGroups/rest/
Метод запроса: GET
Заголовки: 
Content-Type: application/json
Accept: json
ScoutAuthorization: Session Id
Результат запроса: данные по всем группам доступным пользователю

4. Запрос статистик


Url (ServiceAddress) - адреса для различных сервисов и статистик. Соответствие сервисов и URL представлено в статье "Адреса сервисов в REST и SOAP. СПИК".  

Открытие сессии построения статистик
Синтаксис запроса: Request URL/spic/StatisticsController/rest/StartStatisticsSession
Метод запроса: POST
Заголовки: 
Content-Type: application/json
Accept: json
ScoutAuthorization: Session Id
Параметры передаваемые в запросе:

{
"Period":{"Begin":"/Date(1580554040369)/",
"End":"/Date(1583146040369)/"},
"TargetObject":{"ObjectTypeId":"0F1E3A4A-88F5-4166-9BE8-76033DD85D08",
"ObjectId":"51006"}
}

Результат запроса: StatisticsSessionId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

Добавление запроса на построение статистики к сессии.
Синтаксис запроса: Request URL/spic/Url (ServiceAddress)/rest/AddStatisticsRequest
Метод запроса: POST
Заголовки: 
Content-Type: application/json
Accept: json
ScoutAuthorization: Session Id
Параметры передаваемые в запросе:

{StatisticsSessionId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}

Результат запроса: Value: "Ok"

Запуск построения статистик

Синтаксис запроса: Request URL/spic/StatisticsController/rest/StartBuild
Метод запроса: POST
Заголовки: 
Content-Type: application/json
Accept: json
ScoutAuthorization: Session Id
Параметры передаваемые в запросе:

{StatisticsSessionId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}

Результат запроса: Value: "Ok"

Получение статистик
Синтаксис запроса: Request URL/spic/Url (ServiceAddress)/rest/GetStatistics

Метод запроса: POST
Заголовки: 
Content-Type: application/json
Accept: json
ScoutAuthorization: Session Id
Параметры передаваемые в запросе:

{StatisticsSessionId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}

Результат запроса:  запрошенные статистики

 


Номер материала: 3382
Отправлено: Mon, Mar 2, 2020
Последнее обновление: Tue, May 26, 2020
Отправлено: Анисимов Максим Михайлович [m.anisimov@scout-gps.ru]

Online URL: https://kb.scout-gps.ru/article/Описание-запросов-объектов-и-статистик-при-взаимодействии-через-rest-СПИК-3382.html