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 |
Важно!
В 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"
}
|