GET /subjects/{subjectId}

Метод позволяет получить описание субъекта по указанному идентификатору. Чтобы запросить описание нужного субъекта, необходимо подставить его идентификатор вместо параметра.

Параметры

Название Тип Формат Описание
subjectId string Guid Идентификатор субъекта

Заголовки

Название Описание
Authorization Заголовок авторизации

Пример

  GET /realty/entity/v1/subjects/subjects/3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e
  Content-Type: Application/json
  Authorization: ReestroAuth auth.sid=717726209B543848879C33F2BDDAB9F8561EFAC465A5DC439193062C700FAFDA&portal.orgid=1269f58a-3d40-42e1-91ad-a4251566419c

Ответы

200

Субъект успешно получен. В теле ответа содержится описание субъекта Subject.

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

  HTTP 200
  Content-Type: Application/json
{
  "subjectId": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
  "person":
  {
    "name": "Анастасия",
    "surname": "Тарасова",
    "patronymic": "Константиновна",
    "dateBirth": "2018-01-01",
    "birthPlace": "Где то",
    "snils": "000-000-000 55",
    "gender": "Female",
    "identityDocument":
    {
      "documentType": "008001001000",
      "number": "123456",
      "series": "1111",
      "issueDate": "2018-12-12",
      "issuer":
      {
        "issuerCode": "123-123",
        "issuerName": "кем-то"
      }
    },
    "citizenship": "848000000643",
    "address":
    {
      "structuralAddress":
      {
        "region": "54",
        "city":
        {
          "name": "Новосибирск",
          "abbreviation": "г"
        },
        "street":
        {
          "name": "Челюскинцев",
          "abbreviation": "ул"
        },
        "house":
        {
          "name": "14",
          "abbreviation": "д"
        }
      }
    }
  }
}

400

Ошибки валидации запроса. В теле ответа содержится описание ошибки Error. Для данного метода возможны следующие ошибки:

Код ошибки Описание
WrongFieldValue Значение поля не соответствует требуемому формату. Поле, формат которого не соответствует, указано в описании ошибки в message

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

    HTTP 400
    Content-Type Application/json
    {
      "code": "validation",
      "message": "Failed to validate input request",
      "target": "api",
      "errors":
      [
        {
          "code": "WrongFieldValue",
          "message": "subjectId should be guid",
          "target": "EntityApi"
        }
      ]
    }

401

Ошибка авторизации: пользователь не авторизован

403

Ошибка аутентификации: пользователь не имеет доступа к ресурсам организации, которая указана в заголовке авторизации

404

Субъект с указанным идентификатором не найден.