Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -1255,7 +1255,7 @@ 1255 1255 (% style="color:#000000" %)Параметры в теле запроса (JSON): 1256 1256 1257 1257 (% style="color:#000000" %){ 1258 - "vehicleId": , ~/~/ ID объекта1258 + 1259 1259 "parentId": "" , ~/~/ ID клиента 1260 1260 "name": "" , ~/~/ имя ТС 1261 1261 "imei": "" , ~/~/ IMEI ... ... @@ -1504,136 +1504,6 @@ 1504 1504 (% style="text-align:left" %) 1505 1505 (% style="color:#000000" %)} 1506 1506 1507 - 1508 -(% style="text-align:left" %) 1509 -(% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов** 1510 - 1511 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 1512 - 1513 -(% class="box infomessage" %) 1514 -((( 1515 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 1516 -))) 1517 - 1518 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 1519 - 1520 -(% style="color:#000000" %)Метод запроса: **POST** 1521 - 1522 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find 1523 - 1524 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1525 - 1526 -(% style="text-align:left" %) 1527 -Тело запроса: 1528 - 1529 -(% style="text-align:left" %) 1530 -{ 1531 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 1532 -} 1533 - 1534 -(% style="text-align:left" %) 1535 -Ответ: 1536 - 1537 -[ 1538 - { 1539 - "id": 0, ~/~/ Идентификатор объекта геозоны 1540 - "name": "string", ~/~/ Название объекта геозоны 1541 - "type": 0, ~/~/ Тип объекта геозоны 1542 - "fname": "string", ~/~/ Имя файла 1543 - "parentId": "string", ~/~/ Идентификатор клиента 1544 - "radius": 0, ~/~/ Радиус геообъекта 1545 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 1546 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 1547 - "description": "string", ~/~/ Описание 1548 - "area": 0, ~/~/ Площадь, м^^2^^ 1549 - "perimetr": 0, ~/~/ Периметр, м 1550 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 1551 - } 1552 -] 1553 - 1554 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 1555 - 1556 -(% class="box infomessage" %) 1557 -((( 1558 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 1559 -))) 1560 - 1561 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 1562 - 1563 -(% style="color:#000000" %)Метод запроса: **POST** 1564 - 1565 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 1566 - 1567 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1568 - 1569 -(% style="text-align:left" %) 1570 -Тело запроса: 1571 - 1572 -{ 1573 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 1574 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 1575 - "ids": [ ], ~/~/ Массив id объектов 1576 - "byTime": 0, ~/~/ Объединение событий по времени 1577 - "byDist": 0, ~/~/ Объединение событий по расстоянию 1578 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 1579 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 1580 -} 1581 - 1582 -Ответ: 1583 -[ 1584 - { 1585 - "geozoneId": 0, ~/~/ ID геообъекта 1586 - "geozoneName": "string", ~/~/ Название геообъекта 1587 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 1588 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 1589 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 1590 - "vehicleId": 0, ~/~/ ID объекта 1591 - "vehicleName": "string" ~/~/ Имя объекта 1592 - } 1593 -] 1594 - 1595 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 1596 - 1597 -(% class="box infomessage" %) 1598 -((( 1599 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 1600 -))) 1601 - 1602 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 1603 - 1604 -(% style="color:#000000" %)Метод запроса: **POST** 1605 - 1606 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 1607 - 1608 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1609 - 1610 -(% style="text-align:left" %) 1611 -Тело запроса: 1612 - 1613 -{ 1614 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 1615 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 1616 - "ids": [ ], ~/~/ Массив id геообъектов 1617 - "byTime": 0, ~/~/ Объединение событий по времени 1618 - "byDist": 0, ~/~/ Объединение событий по расстоянию 1619 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 1620 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 1621 -} 1622 - 1623 -Ответ: 1624 - 1625 -[ 1626 - { 1627 - "geozoneId": 0, ~/~/ ID геообъекта 1628 - "geozoneName": "string", ~/~/ Название геообъекта 1629 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 1630 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 1631 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 1632 - "vehicleId": 0, ~/~/ ID объекта 1633 - "vehicleName": "string" ~/~/ Имя объекта 1634 - } 1635 -] 1636 - 1637 1637 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1638 1638 1639 1639 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == ... ... @@ -1957,10 +1957,7 @@ 1957 1957 1958 1958 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 1959 1959 1960 -(% class="box infomessage" %) 1961 -((( 1962 -**POST /api/v3/Drivers/find** 1963 -))) 1830 +POST /api/v3/Drivers/find 1964 1964 1965 1965 Передается параметр: parentId - ID клиента-родителя 1966 1966 ... ... @@ -1981,10 +1981,7 @@ 1981 1981 1982 1982 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 1983 1983 1984 -(% class="box infomessage" %) 1985 -((( 1986 -**GET /api/v3/Drivers/{driverGuid}** 1987 -))) 1851 +GET /api/v3/Drivers/{driverGuid} 1988 1988 1989 1989 Передается параметр: ID водителя 1990 1990 ... ... @@ -2003,10 +2003,7 @@ 2003 2003 2004 2004 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 2005 2005 2006 -(% class="box successmessage" %) 2007 -((( 2008 -**POST /api/v3/Drivers** 2009 -))) 1870 +POST /api/v3/Drivers 2010 2010 2011 2011 Запрос: 2012 2012 ... ... @@ -2037,10 +2037,7 @@ 2037 2037 2038 2038 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 2039 2039 2040 -(% class="box warningmessage" %) 2041 -((( 2042 -**PUT /api/v3/Drivers** 2043 -))) 1901 +PUT /api/v3/Drivers 2044 2044 2045 2045 Запрос: 2046 2046 ... ... @@ -2071,10 +2071,7 @@ 2071 2071 2072 2072 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 2073 2073 2074 -(% class="box errormessage" %) 2075 -((( 2076 -**DELETE /api/v3/Drivers/{driverGuid}** 2077 -))) 1932 +DELETE /api/v3/Drivers/{driverGuid} 2078 2078 2079 2079 Передается параметр: ID водителя 2080 2080 ... ... @@ -2089,10 +2089,7 @@ 2089 2089 2090 2090 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 2091 2091 2092 -(% class="box infomessage" %) 2093 -((( 2094 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 2095 -))) 1947 +POST /api/v3/DriversVehiclesAssignments/GetByDrivers 2096 2096 2097 2097 Запрос: 2098 2098 ... ... @@ -2120,10 +2120,7 @@ 2120 2120 2121 2121 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 2122 2122 2123 -(% class="box infomessage" %) 2124 -((( 2125 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 2126 -))) 1975 +POST /api/v3/DriversVehiclesAssignments/GetByVehicles 2127 2127 2128 2128 Запрос: 2129 2129 ... ... @@ -2151,10 +2151,7 @@ 2151 2151 2152 2152 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 2153 2153 2154 -(% class="box successmessage" %) 2155 -((( 2156 -**POST /api/v3/DriversVehiclesAssignments** 2157 -))) 2003 +POST /api/v3/DriversVehiclesAssignments 2158 2158 2159 2159 Передается массив назначений 2160 2160 ... ... @@ -2186,10 +2186,7 @@ 2186 2186 2187 2187 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 2188 2188 2189 -(% class="box warningmessage" %) 2190 -((( 2191 -**PUT /api/v3/DriversVehiclesAssignments** 2192 -))) 2035 +PUT /api/v3/DriversVehiclesAssignments 2193 2193 2194 2194 Запрос: 2195 2195 ... ... @@ -2220,20 +2220,33 @@ 2220 2220 2221 2221 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 2222 2222 2223 -(% class="box errormessage" %) 2224 -((( 2225 -**DELETE /api/v3/DriversVehiclesAssignments** 2226 -))) 2066 +DELETE /api/v3/DriversVehiclesAssignments 2227 2227 2228 2228 Запрос: 2229 2229 2230 2230 [ 2231 - "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2071 + { 2072 + "VehicleId": 0, 2073 + "CreateTime": "2023-06-30T11:16:08.341Z", 2074 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2075 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2076 + "BeginTime": "2023-06-30T11:16:08.342Z", 2077 + "EndTime": "2023-06-30T11:16:08.342Z" 2078 + } 2232 2232 ] 2233 2233 2234 2234 Ответ: 2235 2235 2236 -Success 2083 +[ 2084 + { 2085 + "VehicleId": 0, 2086 + "CreateTime": "2023-06-30T11:16:08.344Z", 2087 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2088 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2089 + "BeginTime": "2023-06-30T11:16:08.344Z", 2090 + "EndTime": "2023-06-30T11:16:08.344Z" 2091 + } 2092 +] 2237 2237 2238 2238 2239 2239 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == ... ... @@ -2240,10 +2240,7 @@ 2240 2240 2241 2241 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 2242 2242 2243 -(% class="box infomessage" %) 2244 -((( 2245 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 2246 -))) 2099 +POST /api/v3/DriversRfidsAssignments/GetByDrivers 2247 2247 2248 2248 Запрос: 2249 2249 ... ... @@ -2270,10 +2270,7 @@ 2270 2270 2271 2271 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 2272 2272 2273 -(% class="box infomessage" %) 2274 -((( 2275 -**POST /api/v3/DriversRfidsAssignments/GetByRfids** 2276 -))) 2126 +POST /api/v3/DriversRfidsAssignments/GetByRfids 2277 2277 2278 2278 Запрос: 2279 2279 ... ... @@ -2300,10 +2300,7 @@ 2300 2300 2301 2301 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 2302 2302 2303 -(% class="box successmessage" %) 2304 -((( 2305 -**POST /api/v3/DriversRfidsAssignments** 2306 -))) 2153 +POST /api/v3/DriversRfidsAssignments 2307 2307 2308 2308 Запрос: 2309 2309 ... ... @@ -2331,10 +2331,7 @@ 2331 2331 2332 2332 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 2333 2333 2334 -(% class="box warningmessage" %) 2335 -((( 2336 -**PUT /api/v3/DriversRfidsAssignments** 2337 -))) 2181 +PUT /api/v3/DriversRfidsAssignments 2338 2338 2339 2339 Запрос: 2340 2340 ... ... @@ -2363,20 +2363,31 @@ 2363 2363 2364 2364 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 2365 2365 2366 -(% class="box errormessage" %) 2367 -((( 2368 -**DELETE /api/v3/DriversRfidsAssignments** 2369 -))) 2210 +DELETE /api/v3/DriversRfidsAssignments 2370 2370 2371 2371 Запрос: 2372 2372 2373 2373 [ 2374 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2215 + { 2216 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2217 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2218 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2219 + "BeginTime": "2023-06-30T11:28:43.330Z", 2220 + "EndTime": "2023-06-30T11:28:43.330Z" 2221 + } 2375 2375 ] 2376 2376 2377 2377 Ответ: 2378 2378 2379 -Success 2226 +[ 2227 + { 2228 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2229 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2230 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2231 + "BeginTime": "2023-06-30T11:28:43.331Z", 2232 + "EndTime": "2023-06-30T11:28:43.331Z" 2233 + } 2234 +] 2380 2380 2381 2381 2382 2382 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == ... ... @@ -2383,10 +2383,7 @@ 2383 2383 2384 2384 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 2385 2385 2386 -(% class="box infomessage" %) 2387 -((( 2388 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 2389 -))) 2241 +POST /api/v3/DriversFuelCardsAssignments/GetByDrivers 2390 2390 2391 2391 Запрос: 2392 2392 ... ... @@ -2413,10 +2413,7 @@ 2413 2413 2414 2414 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 2415 2415 2416 -(% class="box infomessage" %) 2417 -((( 2418 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 2419 -))) 2268 +POST /api/v3/DriversFuelCardsAssignments/GetByCards 2420 2420 2421 2421 Запрос: 2422 2422 ... ... @@ -2443,10 +2443,7 @@ 2443 2443 2444 2444 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 2445 2445 2446 -(% class="box successmessage" %) 2447 -((( 2448 -**POST /api/v3/DriversFuelCardsAssignments** 2449 -))) 2295 +POST /api/v3/DriversFuelCardsAssignments 2450 2450 2451 2451 Запрос: 2452 2452 ... ... @@ -2474,10 +2474,7 @@ 2474 2474 2475 2475 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 2476 2476 2477 -(% class="box warningmessage" %) 2478 -((( 2479 -**PUT /api/v3/DriversFuelCardsAssignments** 2480 -))) 2323 +PUT /api/v3/DriversFuelCardsAssignments 2481 2481 2482 2482 Запрос: 2483 2483 ... ... @@ -2484,10 +2484,9 @@ 2484 2484 [ 2485 2485 { 2486 2486 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2487 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2488 2488 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2489 - "BeginTime": "2023-06-30T12:09:53. 201Z",2490 - "EndTime": "2023-06-30T12:09:53. 201Z"2331 + "BeginTime": "2023-06-30T12:09:53.175Z", 2332 + "EndTime": "2023-06-30T12:09:53.175Z" 2491 2491 } 2492 2492 ] 2493 2493 ... ... @@ -2506,20 +2506,30 @@ 2506 2506 2507 2507 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 2508 2508 2509 -(% class="box errormessage" %) 2510 -((( 2511 -**DELETE /api/v3/DriversFuelCardsAssignments** 2512 -))) 2351 +DELETE /api/v3/DriversFuelCardsAssignments 2513 2513 2514 2514 Запрос: 2515 2515 2516 2516 [ 2517 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2356 + { 2357 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2358 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2359 + "BeginTime": "2023-06-30T12:09:53.175Z", 2360 + "EndTime": "2023-06-30T12:09:53.175Z" 2361 + } 2518 2518 ] 2519 2519 2520 2520 Ответ: 2521 2521 2522 -Success 2366 +[ 2367 + { 2368 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2369 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2370 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2371 + "BeginTime": "2023-06-30T12:09:53.201Z", 2372 + "EndTime": "2023-06-30T12:09:53.201Z" 2373 + } 2374 +] 2523 2523 2524 2524 2525 2525 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = ... ... @@ -2526,10 +2526,7 @@ 2526 2526 2527 2527 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 2528 2528 2529 -(% class="box infomessage" %) 2530 -((( 2531 -**POST /api/v3/Rfids/find** 2532 -))) 2381 +POST /api/v3/Rfids/find 2533 2533 2534 2534 Запрос: 2535 2535 ... ... @@ -2553,10 +2553,7 @@ 2553 2553 2554 2554 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2555 2555 2556 -(% class="box infomessage" %) 2557 -((( 2558 -**GET /api/v3/Rfids/{rfidGuid}** 2559 -))) 2405 +GET /api/v3/Rfids/{rfidGuid} 2560 2560 2561 2561 Передаем параметр rfidGuid - идентификатор карты-метки 2562 2562 ... ... @@ -2576,10 +2576,7 @@ 2576 2576 2577 2577 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2578 2578 2579 -(% class="box successmessage" %) 2580 -((( 2581 -**POST /api/v3/Rfids** 2582 -))) 2425 +POST /api/v3/Rfids 2583 2583 2584 2584 Запрос: 2585 2585 ... ... @@ -2605,10 +2605,7 @@ 2605 2605 2606 2606 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 2607 2607 2608 -(% class="box warningmessage" %) 2609 -((( 2610 -**PUT /api/v3/Rfids** 2611 -))) 2451 +PUT /api/v3/Rfids 2612 2612 2613 2613 Запрос: 2614 2614 ... ... @@ -2635,10 +2635,7 @@ 2635 2635 2636 2636 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 2637 2637 2638 -(% class="box errormessage" %) 2639 -((( 2640 2640 **DELETE /api/v3/Rfids/{rfidGuid}** 2641 -))) 2642 2642 2643 2643 Передаем параметр rfidGuid - идентификатор карты-метки 2644 2644