CASHDESK API:Запрос получения полной информации о клиенте через API: различия между версиями
Перейти к навигации
Перейти к поиску
Merkulov (обсуждение | вклад) |
Merkulov (обсуждение | вклад) |
||
(не показано 5 промежуточных версий этого же участника) | |||
Строка 15: | Строка 15: | ||
{{Note|'''''Важно!'''''<br> | {{Note|'''''Важно!'''''<br> | ||
В '''HEADERS''' укажите значение '''access_token''' согласно:'''authorization''': Bearer <значение ''' | В '''HEADERS''' укажите значение '''access_token''' согласно:'''authorization''': Bearer <значение '''access_token'''> .|800}} | ||
Строка 36: | Строка 36: | ||
|title-right= | |title-right= | ||
|content-left= <br> | |content-left= <br> | ||
* '''apartment''': Номер квартиры клиента | |||
* '''address''': Адрес клиента (населенный пункт, улица, дом) | |||
* '''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''': | ** '''balance''': Сальдо на конец периода | ||
* '''id''': ID | ** '''beginningBalance''': Сальдо на начало текущего периода | ||
* '''meterId''': ID счетчика | ** '''id''': ID услуги в Расчетном центре (РЦ) | ||
* '''number''': Номер счетчика | ** '''''meters''''': ''Счетчики'' | ||
* '''seal''': Номер пломбы | *** '''id''': ID счетчика в Расчетном центре (РЦ) | ||
* '''serviceId''': ID услуги | *** '''''indications''''': ''Показания'' | ||
* '''type''': | **** '''date''': Дата и время передачи показания в формате Unix Time | ||
* '''name''': Наименование услуги | **** '''id''': ID переданного показания в Расчетный центр (РЦ) | ||
* '''status''': Статус отключен(0)/подключен(1) | **** '''meterId''': ID счетчика | ||
* '''substation''': | **** '''value''': Значение преданного показания | ||
* '''town''': Населенный пункт | *** '''number''': Номер счетчика | ||
* '''transformer''': | *** '''seal''': Номер пломбы | ||
*** '''serviceId''': ID услуги в Расчетном центре (РЦ) | |||
*** '''type''': Полное наименование счетчика | |||
** '''name''': Наименование услуги в Расчетном центре (РЦ) | |||
** '''payment''': Сумма оплаты за текущий период | |||
** '''recalculation''': Перерасчет за текущий период | |||
** '''status''': Статус клиента отключен(0)/подключен(1) | |||
* '''substation''': Номер подстанции | |||
* '''town''': Населенный пункт клиента | |||
* '''transformer''': Номер трансформатора | |||
|content-right= | |content-right= | ||
<syntaxhighlight lang="JSON"> | <syntaxhighlight lang="JSON"> | ||
{ | |||
"building": "string", | "apartment": 0, | ||
"feeder": "string", | "address": "string", | ||
"house": "string", | "building": "string", | ||
"id": <ID клиента>, | "feeder": "string", | ||
"name": "string", | "house": "string", | ||
"personalAccount": "string", | "id": 0, <ID клиента в Расчетном центре (РЦ)> | ||
"phoneNumber": "string", | "livingSpace": 0, | ||
"name": "string", | |||
"numberOfRooms": 0, | |||
"personalAccount": "string", | |||
"phoneNumber": "string", | |||
"services": [ | "services": [ | ||
{ | { | ||
"id": <ID | "accrual": 0, | ||
"balance": 0, | |||
"beginningBalance": 0, | |||
"id": 0, <ID услуги в Расчетном центре (РЦ)> | |||
"meters": [ | "meters": [ | ||
{ | { | ||
"id": <ID | "id": 0, <ID счетчика в Расчетном центре (РЦ)> | ||
"indications": [ | "indications": [ | ||
{ | { | ||
"date": | "date": 0, | ||
"id": <ID | "id": 0, <ID переданного показания в Расчетный центр (РЦ)> | ||
" | "meterId": 0, | ||
"value": 0 | |||
} | } | ||
], | ], | ||
"number": "string", | "number": "string", | ||
"seal": "string", | "seal": "string", | ||
"serviceId": | "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> |
Текущая версия на 17:08, 21 сентября 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,
"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"
}
|