Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -682,6 +682,218 @@ 682 682 (% style="text-align:left" %) 683 683 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 684 684 685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 686 + 687 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 688 + 689 +(% class="box infomessage" %) 690 +((( 691 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 692 +))) 693 + 694 +Метод возвращает полную информацию о модели объекта. 695 + 696 +(% style="color:#000000" %)Метод запроса: **GET** 697 + 698 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 699 + 700 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 701 + 702 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 703 + 704 +(% style="color:#000000" %)Ответ: 705 + 706 +(% style="color:#000000" %){ 707 + "parentName": "string", 708 + "name": "string", 709 + "picture": "string", 710 + "minspeed": 0, 711 + "maxspeed": 0, 712 + "width": 0, 713 + "imbeddedtrailer": true, 714 + "fueloutlay": 0, 715 + "hoppercapacity": 0, 716 + "hopperdischargespeed": 0, 717 + "modelType": 0, 718 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 719 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 720 + "deleted": true 721 +} 722 + 723 +|(% style="width:215px" %)Параметр|(% style="width:861px" %)Описание 724 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 725 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 726 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 727 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 728 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 729 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 730 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 731 +|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)- 732 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 733 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 734 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 735 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 736 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 737 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 738 + 739 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 740 + 741 +(% class="box successmessage" %) 742 +((( 743 +(% lang="en-US" %)**POST /api/v3/models/find** 744 +))) 745 + 746 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 747 + 748 +(% style="color:#000000" %)Метод запроса: **POST** 749 + 750 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 751 + 752 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 753 + 754 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 755 + 756 +(% style="color:#000000" %){ 757 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 758 +} 759 + 760 +(% style="color:#000000" %)Ответ: 761 + 762 +(% style="color:#000000" %)[ 763 + { 764 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 765 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 766 + "parentName": "string", 767 + "name": "string", 768 + "modelType": 0 769 + } 770 +] 771 + 772 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 773 + 774 +(% class="box successmessage" %) 775 +((( 776 +(% lang="en-US" %)**POST /api/v3/models** 777 +))) 778 + 779 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 780 + 781 +(% style="color:#000000" %)Метод запроса: **POST** 782 + 783 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 784 + 785 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 786 + 787 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 788 + 789 +{ 790 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 791 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 792 + "deleted": true, 793 + "extId": "string", 794 + "name": "string", 795 + "picture": "string", 796 + "minspeed": 0, 797 + "maxspeed": 0, 798 + "width": 0, 799 + "imbeddedtrailer": true, 800 + "fueloutlay": 0, 801 + "hoppercapacity": 0, 802 + "hopperdischargespeed": 0, 803 + "modelType": 0 804 +} 805 + 806 +Ответ: 807 + 808 +{ 809 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 810 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 811 + "deleted": true, 812 + "extId": "string", 813 + "name": "string", 814 + "picture": "string", 815 + "minspeed": 0, 816 + "maxspeed": 0, 817 + "width": 0, 818 + "imbeddedtrailer": true, 819 + "fueloutlay": 0, 820 + "hoppercapacity": 0, 821 + "hopperdischargespeed": 0, 822 + "modelType": 0 823 +} 824 + 825 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 826 + 827 +(% class="box warningmessage" %) 828 +((( 829 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 830 +))) 831 + 832 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 833 + 834 +(% style="color:#000000" %)Метод запроса: **PUT** 835 + 836 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 837 + 838 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 839 + 840 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 841 + 842 +{ 843 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 844 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 845 + "deleted": true, 846 + "extId": "string", 847 + "name": "string", 848 + "picture": "string", 849 + "minspeed": 0, 850 + "maxspeed": 0, 851 + "width": 0, 852 + "imbeddedtrailer": true, 853 + "fueloutlay": 0, 854 + "hoppercapacity": 0, 855 + "hopperdischargespeed": 0, 856 + "modelType": 0 857 +} 858 + 859 +Ответ: 860 + 861 +{ 862 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 863 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 864 + "deleted": true, 865 + "extId": "string", 866 + "name": "string", 867 + "picture": "string", 868 + "minspeed": 0, 869 + "maxspeed": 0, 870 + "width": 0, 871 + "imbeddedtrailer": true, 872 + "fueloutlay": 0, 873 + "hoppercapacity": 0, 874 + "hopperdischargespeed": 0, 875 + "modelType": 0 876 +} 877 + 878 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 879 + 880 +(% class="box errormessage" %) 881 +((( 882 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 883 +))) 884 + 885 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 886 + 887 +(% style="color:#000000" %)Метод запроса: **DELETE** 888 + 889 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 890 + 891 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 892 + 893 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 894 + 895 +Ответ: В случае успеха **Success 200** 896 + 685 685 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 686 686 687 687 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == ... ... @@ -1622,8 +1622,63 @@ 1622 1622 } 1623 1623 ] 1624 1624 1625 -= (% style="color:#000000; font-size:1 8.6667px" %)Раздел:**Запросданныхоъекте за период**(%%) =1837 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 1626 1626 1839 +(% class="box infomessage" %) 1840 +((( 1841 +**POST /api/v3/vehicles/export/history** 1842 +))) 1843 + 1844 +Метод возвращает список сообщений терминала объекта за выбранный период. 1845 + 1846 +(% style="text-align: left;" %) 1847 +Метод запроса **POST** 1848 + 1849 +(% style="text-align: left;" %) 1850 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1851 + 1852 +(% style="text-align: left;" %) 1853 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1854 + 1855 +{ 1856 + "vehicleId": 0, ~/~/ ID объекта 1857 + "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1858 + "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1859 + "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1860 +} 1861 + 1862 +Ответ: 1863 + 1864 +Получаете файл. Сообщение: Code 200/Success 1865 + 1866 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1867 + 1868 +(% class="box infomessage" %) 1869 +((( 1870 +**GET /api/v3/vehicles/export/history/status** 1871 +))) 1872 + 1873 +Метод возвращает список сообщений терминала объекта за выбранный период. 1874 + 1875 +(% style="text-align: left;" %) 1876 +Метод запроса **GET** 1877 + 1878 +(% style="text-align: left;" %) 1879 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1880 + 1881 +(% style="text-align: left;" %) 1882 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1883 + 1884 +Ответ: 1885 + 1886 +{ 1887 + "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1888 + "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1889 + "message": "string" ~/~/ текст описывающий статус. 1890 +} 1891 + 1892 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1893 + 1627 1627 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 1628 1628 1629 1629 (% class="box infomessage" %) ... ... @@ -1768,7 +1768,7 @@ 1768 1768 1769 1769 (% style="color:#000000" %)Метод запроса: **POST** 1770 1770 1771 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ users/api/v3/gis/find2038 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 1772 1772 1773 1773 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1774 1774