CASHDESK API:Запрос получения полной информации о клиенте через API: различия между версиями

Материал из Касса
Перейти к навигации Перейти к поиску
Строка 36: Строка 36:
|title-right=
|title-right=
|content-left= <br>  
|content-left= <br>  
* apartment
* '''building''': Корпус
* '''building''': Корпус
* '''feeder''': Фидер
* '''feeder''': Фидер
* '''house''': Дом
* '''house''': Дом
* '''id''': ID клиента
* '''id''': ID клиента
* livingSpace
* '''name''': ФИО Клиента
* '''name''': ФИО Клиента
* numberOfRooms
* '''personalAccount''': Лицевой счет
* '''personalAccount''': Лицевой счет
* '''phoneNumber''': Номер телефона
* '''phoneNumber''': Номер телефона
* '''id''': ID клиента
* services
* '''id''': ID клиента
** accrual
* '''date''': Время в формате Unix Time
** balance
* '''id''': ID клиента
** beginningBalance
* '''meterId''': ID счетчика
** '''id''': ID клиента
* '''number''': Номер счетчика
** meters
* '''seal''': Номер пломбы
*** id
* '''serviceId''': ID услуги
*** indications
* '''type''': Тип (полное название)
**** '''date''': Время в формате Unix Time
* '''name''': Наименование услуги
**** '''id''': ID клиента
* '''status''': Статус отключен(0)/подключен(1)
**** '''meterId''': ID счетчика
**** value
*** '''number''': Номер счетчика
*** '''seal''': Номер пломбы
*** '''serviceId''': ID услуги
*** '''type''': Тип (полное название)
** '''name''': Наименование услуги
** payment
** recalculation
** '''status''': Статус отключен(0)/подключен(1)
* '''substation''': Подстанция
* '''substation''': Подстанция
* '''town''': Населенный пункт
* '''town''': Населенный пункт
Строка 60: Строка 72:
|content-right=
|content-right=
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
{
{
   "building": "string",                                    
  "apartment": 0,
   "feeder": "string",                                      
   "building": "string",
   "house": "string",                                      
   "feeder": "string",
   "id": <ID клиента>,                                      
   "house": "string",
   "name": "string",                                        
   "id": 0,
   "personalAccount": "string",                            
  "livingSpace": 0,
   "phoneNumber": "string",                                
   "name": "string",
  "numberOfRooms": 0,
   "personalAccount": "string",
   "phoneNumber": "string",
   "services": [
   "services": [
     {
     {
       "id": <ID клиента>,                                  
      "accrual": 0,
      "balance": 0,
      "beginningBalance": 0,
       "id": 0,
       "meters": [
       "meters": [
         {
         {
           "id": <ID клиента>,                          
           "id": 0,
           "indications": [
           "indications": [
             {
             {
               "date": <Время в формате Unix time>,        
               "date": 0,
               "id": <ID клиента>,                        
               "id": 0,
               "meterId": <ID счетчика>                   
               "meterId": 0,
              "value": 0
             }
             }
           ],
           ],
           "number": "string",                            
           "number": "string",
           "seal": "string",                              
           "seal": "string",
           "serviceId": <ID клиента>,                      
           "serviceId": 0,
           "type": "string"                                
           "type": "string"
         }
         }
       ],
       ],
       "name": "string",                                  
       "name": "string",
       "status": <Статус подключения клиента>             
      "payment": 0,
      "recalculation": 0,
       "status": 0
     }
     }
   ],
   ],
   "substation": "string",                                
   "substation": "string",
   "town": "string",                                      
   "town": "string",
   "transformer": "string"                                
   "transformer": "string"
}
}
</syntaxhighlight>
</syntaxhighlight>
|}}<br>
|}}<br>

Версия 12:09, 14 сентября 2022

Общие сведения

API (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - access_token. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.

Запрос получения информации о клиенте

Запрос GET

URL: https://<URL-адрес сервера>/communal/client/details		 
https://<URL-адрес сервера>/communal/client/details


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


Request Body KEY/VALUE

  • id: Id клиента
  • organization_id: Id организации
 
 "id": <id клиента>,                               
 "organization_id ": <id организации>



Response

  • apartment
  • building: Корпус
  • feeder: Фидер
  • house: Дом
  • id: ID клиента
  • livingSpace
  • name: ФИО Клиента
  • numberOfRooms
  • personalAccount: Лицевой счет
  • phoneNumber: Номер телефона
  • services
    • accrual
    • balance
    • beginningBalance
    • id: ID клиента
    • meters
      • id
      • indications
        • date: Время в формате Unix Time
        • id: ID клиента
        • meterId: ID счетчика
        • value
      • number: Номер счетчика
      • seal: Номер пломбы
      • serviceId: ID услуги
      • type: Тип (полное название)
    • name: Наименование услуги
    • payment
    • recalculation
    • status: Статус отключен(0)/подключен(1)
  • substation: Подстанция
  • town: Населенный пункт
  • transformer: ТП
 
{
  "apartment": 0,
  "building": "string",
  "feeder": "string",
  "house": "string",
  "id": 0,
  "livingSpace": 0,
  "name": "string",
  "numberOfRooms": 0,
  "personalAccount": "string",
  "phoneNumber": "string",
  "services": [
    {
      "accrual": 0,
      "balance": 0,
      "beginningBalance": 0,
      "id": 0,
      "meters": [
        {
          "id": 0,
          "indications": [
            {
              "date": 0,
              "id": 0,
              "meterId": 0,
              "value": 0
            }
          ],
          "number": "string",
          "seal": "string",
          "serviceId": 0,
          "type": "string"
        }
      ],
      "name": "string",
      "payment": 0,
      "recalculation": 0,
      "status": 0
    }
  ],
  "substation": "string",
  "town": "string",
  "transformer": "string"
}


Источник — http://kassa.bifit.com/wiki/index.php?title=CASHDESK_API:Запрос_получения_полной_информации_о_клиенте_через_API&oldid=33317