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

Материал из Касса
Версия от 17:08, 21 сентября 2022; Merkulov (обсуждение | вклад)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)
Перейти к навигации Перейти к поиску

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

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: Номер квартиры клиента
  • address: Адрес клиента (населенный пункт, улица, дом)
  • building: Корпус
  • feeder: Фидер
  • house: Дом
  • id: ID клиента в Расчетном центре (РЦ)
  • livingSpace: Жилая площадь квартиры клиента
  • name: ФИО Клиента
  • numberOfRooms: Количество комнат в квартире клиента
  • personalAccount: Лицевой счет
  • phoneNumber: Номер телефона
  • services:
    • accrual: Сумма начислений за текущий период
    • balance: Сальдо на конец периода
    • beginningBalance: Сальдо на начало текущего периода
    • id: ID услуги в Расчетном центре (РЦ)
    • meters: Счетчики
      • id: 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,
  "address": "string",
  "building": "string",
  "feeder": "string",
  "house": "string",
  "id": 0, <ID клиента в Расчетном центре (РЦ)>
  "livingSpace": 0,
  "name": "string",
  "numberOfRooms": 0,
  "personalAccount": "string",
  "phoneNumber": "string",
  "services": [
    {
      "accrual": 0,
      "balance": 0,
      "beginningBalance": 0,
      "id": 0, <ID услуги в Расчетном центре (РЦ)>
      "meters": [
        {
          "id": 0, <ID счетчика в Расчетном центре (РЦ)>
          "indications": [
            {
              "date": 0,
              "id": 0, <ID переданного показания в Расчетный центр (РЦ)>
              "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"
}