Получение данных по организации (ЖКХ): различия между версиями

Материал из Касса
Перейти к навигации Перейти к поиску
Строка 1: Строка 1:
{{ProductTable-2
|title-left='''Запрос'''
|title-right='''GET '''
|content-left= <br>URL: https://<URL-адрес сервера>/communal/organization/list/read
|content-right=
<syntaxhighlight>
https://<URL-адрес сервера>/communal/organization/list/read
</syntaxhighlight>
|}}<br>
{{Note|'''''Важно!'''''<br>
В '''HEADERS''' укажите значение '''access_token''' согласно:'''authorization''': Bearer <значение '''acces_token'''> .|800}}
{{ProductTable-2
|title-left= '''Response'''
|title-right=
|content-left= <br>
* '''address''': Адрес организации
* '''id''': ID организации
* '''inn''': ИНН организации
* '''kpp''': КПП Организации
* '''name''': Название организации
|content-right=
<syntaxhighlight lang="JSON">
[
  {
    "address": "string",
    "id": <ID организации>,
    "inn": "string",
    "kpp": "string",
    "name": "string"
  }
]
</syntaxhighlight>
|}}<br>
Для получения информации об организации подготовьте GET запрос следующего вида:
Для получения информации об организации подготовьте GET запрос следующего вида:



Версия 11:59, 1 июня 2022

Запрос GET

URL: https://<URL-адрес сервера>/communal/organization/list/read
https://<URL-адрес сервера>/communal/organization/list/read


Note.svg Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение acces_token> .


Response

  • address: Адрес организации
  • id: ID организации
  • inn: ИНН организации
  • kpp: КПП Организации
  • name: Название организации
 [
  {
    "address": "string",
    "id": <ID организации>,
    "inn": "string",
    "kpp": "string",
    "name": "string"
  }
 ]


Для получения информации об организации подготовьте GET запрос следующего вида:

base URL: https://<URL-адрес сервера>/communal/organization/list/read


В AUTHORIZATION укажите значение access_token согласно:

Bearer token : token <значение acces_token>


В PARAMS запроса укажите данные:

No parameters


Пример ответа на запрос

 [
  {
    "address": "string",                       // Адрес организации
    "id": 0,                                   // ID организации
    "inn": "string",                           // ИНН организации
    "kpp": "string",                           // КПП Организации
    "name": "string"                           // Название организации
  }
 ]