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 - 1258 + "vehicleId": , ~/~/ ID объекта 1259 1259 "parentId": "" , ~/~/ ID клиента 1260 1260 "name": "" , ~/~/ имя ТС 1261 1261 "imei": "" , ~/~/ IMEI ... ... @@ -1504,6 +1504,141 @@ 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, 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, 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-03T14:20:03.439Z", 1615 + "endDate": "2023-08-03T14:20:03.439Z", 1616 + "ids": [ 1617 + 0 1618 + ], 1619 + "byTime": 0, 1620 + "byDist": 0, 1621 + "filterByTime": 0, 1622 + "filterByHalfPerimeter": true 1623 +} 1624 + 1625 +Ответ: 1626 + 1627 +[ 1628 + { 1629 + "geozoneId": 0, 1630 + "geozoneName": "string", 1631 + "startDate": "2023-08-02T06:13:18.554Z", 1632 + "endDate": "2023-08-02T06:13:18.554Z", 1633 + "duration": 0, 1634 + "vehicleId": 0, 1635 + "vehicleName": "string" 1636 + } 1637 +] 1638 + 1639 + 1640 + 1641 + 1507 1507 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1508 1508 1509 1509 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == ... ... @@ -1827,7 +1827,10 @@ 1827 1827 1828 1828 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 1829 1829 1830 -POST /api/v3/Drivers/find 1965 +(% class="box infomessage" %) 1966 +((( 1967 +**POST /api/v3/Drivers/find** 1968 +))) 1831 1831 1832 1832 Передается параметр: parentId - ID клиента-родителя 1833 1833 ... ... @@ -1848,7 +1848,10 @@ 1848 1848 1849 1849 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 1850 1850 1851 -GET /api/v3/Drivers/{driverGuid} 1989 +(% class="box infomessage" %) 1990 +((( 1991 +**GET /api/v3/Drivers/{driverGuid}** 1992 +))) 1852 1852 1853 1853 Передается параметр: ID водителя 1854 1854 ... ... @@ -1867,7 +1867,10 @@ 1867 1867 1868 1868 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 1869 1869 1870 -POST /api/v3/Drivers 2011 +(% class="box successmessage" %) 2012 +((( 2013 +**POST /api/v3/Drivers** 2014 +))) 1871 1871 1872 1872 Запрос: 1873 1873 ... ... @@ -1898,7 +1898,10 @@ 1898 1898 1899 1899 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 1900 1900 1901 -PUT /api/v3/Drivers 2045 +(% class="box warningmessage" %) 2046 +((( 2047 +**PUT /api/v3/Drivers** 2048 +))) 1902 1902 1903 1903 Запрос: 1904 1904 ... ... @@ -1929,7 +1929,10 @@ 1929 1929 1930 1930 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 1931 1931 1932 -DELETE /api/v3/Drivers/{driverGuid} 2079 +(% class="box errormessage" %) 2080 +((( 2081 +**DELETE /api/v3/Drivers/{driverGuid}** 2082 +))) 1933 1933 1934 1934 Передается параметр: ID водителя 1935 1935 ... ... @@ -1944,7 +1944,10 @@ 1944 1944 1945 1945 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 1946 1946 1947 -POST /api/v3/DriversVehiclesAssignments/GetByDrivers 2097 +(% class="box infomessage" %) 2098 +((( 2099 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 2100 +))) 1948 1948 1949 1949 Запрос: 1950 1950 ... ... @@ -1972,7 +1972,10 @@ 1972 1972 1973 1973 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 1974 1974 1975 -POST /api/v3/DriversVehiclesAssignments/GetByVehicles 2128 +(% class="box infomessage" %) 2129 +((( 2130 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 2131 +))) 1976 1976 1977 1977 Запрос: 1978 1978 ... ... @@ -2000,7 +2000,10 @@ 2000 2000 2001 2001 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 2002 2002 2003 -POST /api/v3/DriversVehiclesAssignments 2159 +(% class="box successmessage" %) 2160 +((( 2161 +**POST /api/v3/DriversVehiclesAssignments** 2162 +))) 2004 2004 2005 2005 Передается массив назначений 2006 2006 ... ... @@ -2032,7 +2032,10 @@ 2032 2032 2033 2033 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 2034 2034 2035 -PUT /api/v3/DriversVehiclesAssignments 2194 +(% class="box warningmessage" %) 2195 +((( 2196 +**PUT /api/v3/DriversVehiclesAssignments** 2197 +))) 2036 2036 2037 2037 Запрос: 2038 2038 ... ... @@ -2063,33 +2063,20 @@ 2063 2063 2064 2064 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 2065 2065 2066 -DELETE /api/v3/DriversVehiclesAssignments 2228 +(% class="box errormessage" %) 2229 +((( 2230 +**DELETE /api/v3/DriversVehiclesAssignments** 2231 +))) 2067 2067 2068 2068 Запрос: 2069 2069 2070 2070 [ 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 - } 2236 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2079 2079 ] 2080 2080 2081 2081 Ответ: 2082 2082 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 -] 2241 +Success 2093 2093 2094 2094 2095 2095 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == ... ... @@ -2096,7 +2096,10 @@ 2096 2096 2097 2097 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 2098 2098 2099 -POST /api/v3/DriversRfidsAssignments/GetByDrivers 2248 +(% class="box infomessage" %) 2249 +((( 2250 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 2251 +))) 2100 2100 2101 2101 Запрос: 2102 2102 ... ... @@ -2123,7 +2123,10 @@ 2123 2123 2124 2124 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 2125 2125 2126 -POST /api/v3/DriversRfidsAssignments/GetByRfids 2278 +(% class="box infomessage" %) 2279 +((( 2280 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 2281 +))) 2127 2127 2128 2128 Запрос: 2129 2129 ... ... @@ -2150,7 +2150,10 @@ 2150 2150 2151 2151 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 2152 2152 2153 -POST /api/v3/DriversRfidsAssignments 2308 +(% class="box successmessage" %) 2309 +((( 2310 +**POST /api/v3/DriversRfidsAssignments** 2311 +))) 2154 2154 2155 2155 Запрос: 2156 2156 ... ... @@ -2178,7 +2178,10 @@ 2178 2178 2179 2179 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 2180 2180 2181 -PUT /api/v3/DriversRfidsAssignments 2339 +(% class="box warningmessage" %) 2340 +((( 2341 +**PUT /api/v3/DriversRfidsAssignments** 2342 +))) 2182 2182 2183 2183 Запрос: 2184 2184 ... ... @@ -2207,31 +2207,20 @@ 2207 2207 2208 2208 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 2209 2209 2210 -DELETE /api/v3/DriversRfidsAssignments 2371 +(% class="box errormessage" %) 2372 +((( 2373 +**DELETE /api/v3/DriversRfidsAssignments** 2374 +))) 2211 2211 2212 2212 Запрос: 2213 2213 2214 2214 [ 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 - } 2379 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2222 2222 ] 2223 2223 2224 2224 Ответ: 2225 2225 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 -] 2384 +Success 2235 2235 2236 2236 2237 2237 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == ... ... @@ -2238,7 +2238,10 @@ 2238 2238 2239 2239 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 2240 2240 2241 -POST /api/v3/DriversFuelCardsAssignments/GetByDrivers 2391 +(% class="box infomessage" %) 2392 +((( 2393 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 2394 +))) 2242 2242 2243 2243 Запрос: 2244 2244 ... ... @@ -2265,7 +2265,10 @@ 2265 2265 2266 2266 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 2267 2267 2268 -POST /api/v3/DriversFuelCardsAssignments/GetByCards 2421 +(% class="box infomessage" %) 2422 +((( 2423 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 2424 +))) 2269 2269 2270 2270 Запрос: 2271 2271 ... ... @@ -2292,7 +2292,10 @@ 2292 2292 2293 2293 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 2294 2294 2295 -POST /api/v3/DriversFuelCardsAssignments 2451 +(% class="box successmessage" %) 2452 +((( 2453 +**POST /api/v3/DriversFuelCardsAssignments** 2454 +))) 2296 2296 2297 2297 Запрос: 2298 2298 ... ... @@ -2320,7 +2320,10 @@ 2320 2320 2321 2321 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 2322 2322 2323 -PUT /api/v3/DriversFuelCardsAssignments 2482 +(% class="box warningmessage" %) 2483 +((( 2484 +**PUT /api/v3/DriversFuelCardsAssignments** 2485 +))) 2324 2324 2325 2325 Запрос: 2326 2326 ... ... @@ -2327,9 +2327,10 @@ 2327 2327 [ 2328 2328 { 2329 2329 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2492 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2330 2330 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2331 - "BeginTime": "2023-06-30T12:09:53.1 75Z",2332 - "EndTime": "2023-06-30T12:09:53.1 75Z"2494 + "BeginTime": "2023-06-30T12:09:53.201Z", 2495 + "EndTime": "2023-06-30T12:09:53.201Z" 2333 2333 } 2334 2334 ] 2335 2335 ... ... @@ -2348,30 +2348,20 @@ 2348 2348 2349 2349 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 2350 2350 2351 -DELETE /api/v3/DriversFuelCardsAssignments 2514 +(% class="box errormessage" %) 2515 +((( 2516 +**DELETE /api/v3/DriversFuelCardsAssignments** 2517 +))) 2352 2352 2353 2353 Запрос: 2354 2354 2355 2355 [ 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 - } 2522 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2362 2362 ] 2363 2363 2364 2364 Ответ: 2365 2365 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 -] 2527 +Success 2375 2375 2376 2376 2377 2377 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = ... ... @@ -2378,7 +2378,10 @@ 2378 2378 2379 2379 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 2380 2380 2381 -POST /api/v3/Rfids/find 2534 +(% class="box infomessage" %) 2535 +((( 2536 +**POST /api/v3/Rfids/find** 2537 +))) 2382 2382 2383 2383 Запрос: 2384 2384 ... ... @@ -2402,7 +2402,10 @@ 2402 2402 2403 2403 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2404 2404 2405 -GET /api/v3/Rfids/{rfidGuid} 2561 +(% class="box infomessage" %) 2562 +((( 2563 +**GET /api/v3/Rfids/{rfidGuid}** 2564 +))) 2406 2406 2407 2407 Передаем параметр rfidGuid - идентификатор карты-метки 2408 2408 ... ... @@ -2422,7 +2422,10 @@ 2422 2422 2423 2423 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2424 2424 2425 -POST /api/v3/Rfids 2584 +(% class="box successmessage" %) 2585 +((( 2586 +**POST /api/v3/Rfids** 2587 +))) 2426 2426 2427 2427 Запрос: 2428 2428 ... ... @@ -2448,7 +2448,10 @@ 2448 2448 2449 2449 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 2450 2450 2451 -PUT /api/v3/Rfids 2613 +(% class="box warningmessage" %) 2614 +((( 2615 +**PUT /api/v3/Rfids** 2616 +))) 2452 2452 2453 2453 Запрос: 2454 2454 ... ... @@ -2475,7 +2475,10 @@ 2475 2475 2476 2476 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 2477 2477 2643 +(% class="box errormessage" %) 2644 +((( 2478 2478 **DELETE /api/v3/Rfids/{rfidGuid}** 2646 +))) 2479 2479 2480 2480 Передаем параметр rfidGuid - идентификатор карты-метки 2481 2481