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

Материал из Касса
Перейти к навигации Перейти к поиску

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

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