CASHDESK API:Запрос получения полной информации о клиенте через API: различия между версиями
Перейти к навигации
Перейти к поиску
Merkulov (обсуждение | вклад) |
Merkulov (обсуждение | вклад) |
||
| Строка 36: | Строка 36: | ||
|title-right= | |title-right= | ||
|content-left= <br> | |content-left= <br> | ||
* apartment | * '''apartment''': Номер квартиры клиента | ||
* '''building''': Корпус | * '''building''': Корпус | ||
* '''feeder''': Фидер | * '''feeder''': Фидер | ||
* '''house''': Дом | * '''house''': Дом | ||
* '''id''': ID клиента | * '''id''': ID клиента | ||
* livingSpace | * '''livingSpace''': Жилая площадь квартиры клиента | ||
* '''name''': ФИО Клиента | * '''name''': ФИО Клиента | ||
* numberOfRooms | * '''numberOfRooms''': Количество комнат в квартире клиента | ||
* '''personalAccount''': Лицевой счет | * '''personalAccount''': Лицевой счет | ||
* '''phoneNumber''': Номер телефона | * '''phoneNumber''': Номер телефона | ||
* services | * services: | ||
** accrual | ** '''accrual''': Сумма начислений за текущий период | ||
** balance | ** '''balance''': Сальдо на конец периода | ||
** beginningBalance | ** '''beginningBalance''': Сальдо на начало текущего периода | ||
** '''id''': ID | ** '''id''': ID услуги в Расчетном центре (РЦ) | ||
** meters | ** '''meters''': ''Счетчики'' | ||
*** id | *** '''id''': ID счетчика в РЦ | ||
*** indications | *** '''indications''': ''Показания'' | ||
**** '''date''': | **** '''date''': Дата и время передачи показания в формате Unix Time | ||
**** '''id''': ID | **** '''id''': ID переданного показания в Расчетный центр (РЦ) | ||
**** '''meterId''': ID счетчика | **** '''meterId''': ID счетчика | ||
**** value | **** '''value''': Значение преданного показания | ||
*** '''number''': Номер счетчика | *** '''number''': Номер счетчика | ||
*** '''seal''': Номер пломбы | *** '''seal''': Номер пломбы | ||
*** '''serviceId''': ID услуги | *** '''serviceId''': ID услуги в Расчетном центре (РЦ) | ||
*** '''type''': | *** '''type''': Полное наименование счетчика | ||
** '''name''': Наименование услуги | ** '''name''': Наименование услуги в Расчетном центре (РЦ) | ||
** payment | ** '''payment''': Сумма оплаты за текущий период | ||
** recalculation | ** '''recalculation''': Перерасчет за текущий период | ||
** '''status''': Статус отключен(0)/подключен(1) | ** '''status''': Статус клиента отключен(0)/подключен(1) | ||
* '''substation''': | * '''substation''': Номер подстанции | ||
* '''town''': Населенный пункт | * '''town''': Населенный пункт клиента | ||
* '''transformer''': | * '''transformer''': Номер трансформатора | ||
|content-right= | |content-right= | ||
Версия 12:40, 14 сентября 2022
Общие сведения
API (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - access_token. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.
Запрос получения информации о клиенте
| Запрос | GET |
URL: https://<URL-адрес сервера>/communal/client/details |
https://<URL-адрес сервера>/communal/client/details |
Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение access_token> .
| Request Body | KEY/VALUE |
|
"id": <id клиента>,
"organization_id ": <id организации>
|
| Response | |
|
{
"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"
}
|