GET /certificate-forms

Метод позволяет получить список форм на выпуск сертификата, которые соответствуют критериям поиска.

В результатах поиска список форм будет отсортирован по дате создания в порядке убывания. Первой в списке будет последняя созданная форма.

Параметры

Название Тип Формат Описание
externalId string ^\w{1,256}$ Клиентский идентификатор формы
personId string Guid Идентификатор субъекта физического лица
organizationId string Guid Индентификатор субъекта юридического лица

Если в запросе будет передан personId, то в результатах будут содержаться:

  • формы на физическое лицо, владельцем которых явлется указанное физическое лицо;
  • формы на юридическое лицо, где указанный субъект, является представителем.

Если в запросе будет передан organizationId, то в результатах будут содержаться формы, владельцем которых явлется указанное юридическое лицо.

Если ни один из параметров не будет передан, то в ответе будет содержаться 30 последних созданных форм.

Заголовки

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

Пример

GET /realty/crypto/v2/certificate-forms?personId=70f78249-dc69-450f-ab38-19974a310020
Authorization: ReestroAuth auth.sid=717726209B543848879C33F2BDDAB9F8561EFAC465A5DC439193062C700FAFDA&portal.orgid=1269f58a-3d40-42e1-91ad-a4251566419c

Ответы

200

Поиск прошел успешно. В теле ответа содержится:

Название Тип Описание
items CertificateForms[] Список форм на выпуск сертификата, которые удовлетворяют критериям поиска

Если по результатам поиска не было найдено ни одной формы, удовлетворяющей заданным параметрам, то объект items будет содержать пустой массив.

Заголовки ответа

Название Описание
Content-Type Тип содержимого

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

  HTTP 200
  Content-Type: Application/json
  {
    "items":
    [
      {
        "formId": "c8fbe843-3ae2-4266-8fb7-7bf24bfd0704",
        "person":
        {
          "subject" :
          {
            "subjectId": "70f78249-dc69-450f-ab38-19974a310020",
            "person": {
              "name": "Анастасия",
              "surname": "Тарасова",
              "patronymic": "Константиновна",
              "dateBirth": "2018-01-01",
              "birthPlace": "Где то",
              "snils": "000-000-000 55",
              "inn": "121212121212",
              "email": "imya@yandex.ru",
              "phone": "79699999999",
              "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": "д"
                  }
                }
              }
            }
          }
        },
        "state": "Created",
        "creationDate": "2019-05-21T14:58:37.613+03:00"
      }
    ]
  }

400

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

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

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

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

401

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

403

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