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

Summary

Details

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

Меню

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