Получение списка объектов строительства застройщика

Песочница

GET https://sandbox.alfabank.ru/api/build-projects

Пром

GET https://baas.alfabank.ru/api/build-projects

Scope

escrow

Параметры запроса

HEADERS

Атрибут

Описание

Authorization

stringrequired

Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H

stringrequired

application/json

Пример запроса

Язык

1curl --location 'https://baas.alfabank.ru/api/build-projects' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'

Параметры ответа

Пример ответа 200 (OK)

1{
2  "buildingPermitNumber": "61-310-998601-2022",
3  "regionCode": "054",
4  "projectNumber": "162",
5  "settlement": "Новосибирск",
6  "commercialName": "ЖК ЗАПАДНЫЕ АЛЛЕИ",
7  "city": "Новосибирск",
8  "area": "ОКТЯБРЬСКИЙ",
9  "country": "RU",
10  "buildingPermitDate": "2021-10-01",
11  "phases": [
12    {
13      "index": 1,
14      "name": "поз. 4.1 - 9-этажный 4-х секц дом",
15      "street": "11-4 на земельном участке с к.н. 61:44:0073012:390",
16      "house": "4.1",
17      "building": "2",
18      "termEscrowOrder": "2022-03-22"
19    }
20  ]
21}

BODY

атрибут

описание

buildingPermitNumber

stringoptional

Номер РНС

regionCode

stringoptional

Код региона

projectNumber

stringoptional

Номер проекта строительства

settlement

stringoptional

Наименование населённого пункта

commercialName

stringoptional

Коммерческое обозначение объекта

city

stringoptional

Город

area

stringoptional

Наименование района

country

stringoptional

Код страны

buildingPermitDate

stringoptional

Дата РНС

array of objectsoptional

Этапы строительства

index

integeroptional

Порядковый номер этапа строительства в пределах проекта

name

stringoptional

Краткое наименование этапа строительства

street

stringoptional

Улица объекта недвижимости

house

stringoptional

Номер дома объекта строительства

building

stringoptional

Номер строения/корпуса

termEscrowOrder

stringoptional

Срок условного депонирования

Пример ответа 200 (OK)

1{
2  "buildingPermitNumber": "61-310-998601-2022",
3  "regionCode": "054",
4  "projectNumber": "162",
5  "settlement": "Новосибирск",
6  "commercialName": "ЖК ЗАПАДНЫЕ АЛЛЕИ",
7  "city": "Новосибирск",
8  "area": "ОКТЯБРЬСКИЙ",
9  "country": "RU",
10  "buildingPermitDate": "2021-10-01",
11  "phases": [
12    {
13      "index": 1,
14      "name": "поз. 4.1 - 9-этажный 4-х секц дом",
15      "street": "11-4 на земельном участке с к.н. 61:44:0073012:390",
16      "house": "4.1",
17      "building": "2",
18      "termEscrowOrder": "2022-03-22"
19    }
20  ]
21}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

invalid_request - неверные входные параметры запроса

error_description

stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)

1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_token. При отзыве токена необходимо заново пройти авторизацию

error_description

stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)

1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

insufficient_scope - при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметра prompt=consent;
•

access_denied - доступ к счёту запрещён

error_description

stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)

1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

unknown_endpoint - эндпоинт не найден или неактивен

error_description

stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)

1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}

Нет тела ответа

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

internal_error - внутренняя ошибка сервиса при выполнении обработки запроса

error_description

stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)

1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}

Нет тела ответа

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.