FailureResponse

{
    "type": "object",
    "properties": {
        "timestamp": {
            "type": "string",
            "format": "date-time"
        },
        "error": {
            "type": "string"
        },
        "violations": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/Violation"
            }
        }
    }
}
              

Violation

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}
              

EncodedDto

{
    "title": "Данные о заявлении в виде base64",
    "required": [
        "applicationEncoded",
        "bin"
    ],
    "type": "object",
    "properties": {
        "applicationEncoded": {
            "title": "XML заявление в виде base64",
            "type": "string",
            "description": "XML заявление в виде base64"
        },
        "bin": {
            "type": "string"
        }
    }
}
              

EncodedResponse

{
    "title": "Данные о заявлении в виде base64",
    "required": [
        "applicationEncoded"
    ],
    "type": "object",
    "properties": {
        "applicationEncoded": {
            "title": "XML заявление в виде base64",
            "type": "string",
            "description": "XML заявление в виде base64"
        }
    }
}
              

PersonDto

{
    "title": "Сведения о физлице",
    "required": [
        "cellPhone",
        "countryCode",
        "iinLeader",
        "nationalityRelationCode"
    ],
    "type": "object",
    "properties": {
        "iinLeader": {
            "title": "ИИН",
            "type": "string"
        },
        "surname": {
            "title": "Фамилия",
            "type": "string"
        },
        "name": {
            "title": "Имя",
            "type": "string"
        },
        "middlename": {
            "title": "Отчество",
            "type": "string"
        },
        "identityDocument": {
            "$ref": "#\/definitions\/IdentityDocumentDto"
        },
        "nationalityRelationCode": {
            "title": "Код отношения гражданства",
            "type": "string"
        },
        "residenceCountryCode": {
            "title": "Код страны проживания",
            "type": "string"
        },
        "countryCode": {
            "title": "Код страны",
            "type": "string"
        },
        "cellPhone": {
            "title": "Мобильный телефон",
            "type": "string"
        },
        "faxNumber": {
            "title": "Факс",
            "type": "string"
        },
        "email": {
            "title": "Электронная почта",
            "type": "string"
        }
    }
}
              

IdentityDocumentDto

{
    "title": "Сведения о документе, удостоверяющем личность",
    "required": [
        "documentNumber",
        "documentTypeCode",
        "issueDate",
        "issuerCode"
    ],
    "type": "object",
    "properties": {
        "documentTypeCode": {
            "title": "Код типа документа",
            "type": "string"
        },
        "documentNumber": {
            "title": "Номер документа",
            "type": "string"
        },
        "issueDate": {
            "title": "Дата выдачи",
            "type": "string",
            "format": "date-time"
        },
        "issuerCode": {
            "title": "Код учреждения, выдавшего документ",
            "type": "string"
        }
    }
}
              

DataResponseMessageDto

{
    "title": "Ответ на запрос",
    "type": "object",
    "properties": {
        "messageId": {
            "title": "Идентификатор сообщения",
            "type": "string"
        },
        "correlationId": {
            "title": "Кросс-системный идентификатор сообщений",
            "type": "string"
        },
        "statusCode": {
            "title": "Статус",
            "type": "string"
        },
        "statusMessage": {
            "title": "Сообщение",
            "type": "string"
        },
        "sessionId": {
            "title": "Идентификатор сессии",
            "type": "string"
        }
    }
}
              

StatusResponse

{
    "properties": {
        "correlationId": {
            "type": "string",
            "description": "Идентификатор корреляции"
        },
        "messageType": {
            "type": "string",
            "description": "Тип сообщения: (NOTIFICATION | RESPONSE)"
        },
        "rawData": {
            "type": "string",
            "description": "XML ответ от ГО"
        },
        "data": {
            "type": "string",
            "description": "JSON ответ в зависимости от сервиса"
        },
        "status": {
            "type": "string",
            "description": "Статус ответа (SUCCESS | FAILURE)"
        },
        "statusMessage": {
            "type": "string",
            "description": "описание статуса ответа"
        }
    }
}
              

AppointmentDto

{
    "type": "object",
    "title": "Данные о назначении руководителя",
    "required": [
        "person",
        "positionCode"
    ],
    "properties": {
        "person": {
            "$ref": "#\/definitions\/PersonDto"
        },
        "positionCode": {
            "type": "string",
            "title": "ИИН"
        },
        "dateStart": {
            "type": "string",
            "format": "date-time",
            "title": "Дата начала"
        }
    }
}
              

DocumentDto

{
    "type": "object",
    "title": "Сведения о документе заявления",
    "required": [
        "documentId",
        "documentTypeCode",
        "fileName"
    ],
    "properties": {
        "documentTypeCode": {
            "type": "string",
            "title": "Тип документа"
        },
        "fileName": {
            "type": "string",
            "title": "Название файла с расширением"
        },
        "documentId": {
            "type": "string",
            "title": "Идентификатор документа в ИС ХЭД для скачивания"
        }
    }
}
              

DocumentsDto

{
    "type": "object",
    "title": "Сведения о документах заявления",
    "required": [
        "document"
    ],
    "properties": {
        "document": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/DocumentDto"
            },
            "title": "Документы"
        }
    }
}
              

RemovalDto

{
    "type": "object",
    "title": "Данные об отстранении руководителя",
    "required": [
        "iinLeader"
    ],
    "properties": {
        "iinLeader": {
            "type": "string",
            "title": "ИИН"
        }
    }
}
              

MemberDto

{
    "type": "object",
    "title": "Сведения о члене совета дома",
    "required": [
        "memberIIN"
    ],
    "properties": {
        "memberIIN": {
            "type": "string",
            "title": "ИИН"
        }
    }
}
              

MembersDto

{
    "type": "object",
    "title": "Сведения о членах совета дома",
    "required": [
        "member"
    ],
    "properties": {
        "member": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/MemberDto"
            },
            "title": "Члены"
        }
    }
}
              

RequestMessageDto

{
    "type": "object",
    "title": "Тип описывающий запрос",
    "required": [
        "bin",
        "competentAuthorityCode",
        "dateOfOrder",
        "numOfOrder",
        "requestNumber",
        "typeServiceCode"
    ],
    "properties": {
        "requestNumber": {
            "type": "string",
            "title": "Номер запроса"
        },
        "typeServiceCode": {
            "type": "string",
            "title": "Код услуги"
        },
        "bin": {
            "type": "string",
            "title": "БИН"
        },
        "numOfOrder": {
            "type": "string",
            "title": "Номер приказа"
        },
        "dateOfOrder": {
            "type": "string",
            "format": "date-time",
            "title": "Дата приказа"
        },
        "competentAuthorityCode": {
            "type": "string",
            "title": "Код компетентного органа"
        },
        "iinChairman": {
            "type": "string",
            "title": "ИИН председателя"
        },
        "iinSecretary": {
            "type": "string",
            "title": "ИИН секретаря"
        },
        "notaryLicenseNumber": {
            "type": "string",
            "title": "Номер лицензии нотариуса"
        },
        "appointment": {
            "$ref": "#\/definitions\/AppointmentDto"
        },
        "removal": {
            "$ref": "#\/definitions\/RemovalDto"
        },
        "documents": {
            "$ref": "#\/definitions\/DocumentsDto"
        },
        "members": {
            "$ref": "#\/definitions\/MembersDto"
        },
        "isQuorum": {
            "type": "boolean",
            "title": "Наличие кворума"
        },
        "agreement": {
            "type": "boolean",
            "title": "Согласие"
        }
    }
}