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