Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 48.1 >
edited by Илья Крайнов
on 2022/11/21 10:34
To version < 56.1 >
edited by Илья Крайнов
on 2022/11/24 11:27
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,13 +1,11 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  == Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 -== ==
5 5  
6 -[[ (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**>>Авторизация — POST /api/v3/auth/login||anchor="Авторизация — POST /api/v3/auth/login"]]
5 +{{toc/}}
7 7  
8 8  
9 9  
10 -
11 11  (% class="box" style="text-align: center;" %)
12 12  (((
13 13  (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
... ... @@ -116,6 +116,148 @@
116 116  }
117 117  
118 118  
117 +(% class="box successmessage" %)
118 +(((
119 +**Добавление клиента — POST /api/v3/agents **
120 +)))
121 +
122 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
123 +
124 +Метод запроса: **POST**
125 +
126 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
127 +
128 +В заголовках запроса: X-Auth: Токен авторизации
129 +
130 +Параметры в теле запроса (JSON):
131 +
132 +{
133 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
134 + "name": "string", ~/~/ имя
135 + "fullName": "string", ~/~/ полное наименование
136 + "isForeign": true, ~/~/ иностранный контрагент
137 + "district": "string", ~/~/ округ
138 + "region": "string", ~/~/ регион
139 + "city": "string", ~/~/ город
140 + "inn": "string", ~/~/ ИНН
141 + "kpp": "string", ~/~/ КПП
142 + "address": "string", ~/~/ юридический адрес
143 + "addressFact": "string", ~/~/ фактический адрес
144 + "email": "string", ~/~/ email
145 + "director": "string", ~/~/ ФИО руководителя
146 + "bankName": "string", ~/~/ банк
147 + "bankBIK": "string", ~/~/ БИК
148 + "bankRS": "string", ~/~/ номер счёта
149 + "bankKS": "string" ~/~/ корр. счёт
150 +}
151 +
152 +
153 +Ответ:
154 +
155 +{
156 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
157 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
158 + "name": "string", ~/~/ имя
159 + "fullName": "string", ~/~/ полное наименование
160 + "isForeign": true, ~/~/ иностранный контрагент
161 + "district": "string", ~/~/ округ
162 + "region": "string", ~/~/ регион
163 + "city": "string", ~/~/ город
164 + "inn": "string", ~/~/ ИНН
165 + "kpp": "string", ~/~/ КПП
166 + "address": "string", ~/~/ юридический адрес
167 + "addressFact": "string", ~/~/ фактический адрес
168 + "email": "string", ~/~/ email
169 + "director": "string", ~/~/ ФИО руководителя
170 + "bankName": "string", ~/~/ банк
171 + "bankBIK": "string", ~/~/ БИК
172 + "bankRS": "string", ~/~/ номер счёта
173 + "bankKS": "string" ~/~/ корр. счёт
174 +}
175 +
176 +
177 +(% class="box warningmessage" %)
178 +(((
179 +**Редактирование клиента — PUT /api/v3/agents**
180 +)))
181 +
182 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
183 +
184 +Метод запроса: **PUT**
185 +
186 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
187 +
188 +В заголовках запроса: X-Auth: Токен авторизации
189 +
190 +
191 +Параметры в теле запроса (JSON):
192 +
193 +{
194 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
195 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
196 + "name": "string", ~/~/ имя
197 + "fullName": "string", ~/~/ полное наименование
198 + "isForeign": true, ~/~/ иностранный контрагент
199 + "district": "string", ~/~/ округ
200 + "region": "string", ~/~/ регион
201 + "city": "string", ~/~/ город
202 + "inn": "string", ~/~/ ИНН
203 + "kpp": "string", ~/~/ КПП
204 + "address": "string", ~/~/ юридический адрес
205 + "addressFact": "string", ~/~/ фактический адрес
206 + "email": "string", ~/~/ email
207 + "director": "string", ~/~/ ФИО руководителя
208 + "bankName": "string", ~/~/ банк
209 + "bankBIK": "string", ~/~/ БИК
210 + "bankRS": "string", ~/~/ номер счёта
211 + "bankKS": "string" ~/~/ корр. счёт
212 +}
213 +
214 +
215 +Ответ:
216 +
217 +{
218 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
219 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
220 + "name": "string", ~/~/ имя
221 + "fullName": "string", ~/~/ полное наименование
222 + "isForeign": true, ~/~/ иностранный контрагент
223 + "district": "string", ~/~/ округ
224 + "region": "string", ~/~/ регион
225 + "city": "string", ~/~/ город
226 + "inn": "string", ~/~/ ИНН
227 + "kpp": "string", ~/~/ КПП
228 + "address": "string", ~/~/ юридический адрес
229 + "addressFact": "string", ~/~/ фактический адрес
230 + "email": "string", ~/~/ email
231 + "director": "string", ~/~/ ФИО руководителя
232 + "bankName": "string", ~/~/ банк
233 + "bankBIK": "string", ~/~/ БИК
234 + "bankRS": "string", ~/~/ номер счёта
235 + "bankKS": "string" ~/~/ корр. счёт
236 +}
237 +
238 +
239 +(% class="box errormessage" %)
240 +(((
241 +**Удаление клиента — DELETE /api/v3/agents/{clientId}**
242 +)))
243 +
244 +
245 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
246 +
247 +Метод запроса: **DELETE**
248 +
249 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
250 +
251 +Параметр запроса: **{clientId}** - Guid пользователя
252 +
253 +В заголовках запроса: X-Auth: Токен авторизации
254 +
255 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
256 +
257 +
258 +
119 119  (% class="box" style="text-align: center;" %)
120 120  (((
121 121  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -717,7 +717,16 @@
717 717   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
718 718   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
719 719   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
720 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
860 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
861 + "customFields": [ 
862 + {
863 + "id": "", ~/~/ идентификатор произвольного поля
864 + "name": "", ~/~/ имя произвольного поля
865 + "value": "", ~/~/ значение произвольного поля
866 + "forClient": true, ~/~/ право на отображение у клиента
867 + "forTooltip": false, ~/~/ право на отображение в подсказке
868 + "forReport": false ~/~/ право на отображение в отчетах
869 + }(%%)
721 721  (% style="color:#000000" %)}
722 722  
723 723  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

Меню

ГЛОНАССSoft wiki - 2024 г.