В заголовке запроса необходимо указать значения request:contract и operation:search (см. описание формата заголовка запроса).
После заголовка запроса следует блок contract. Блок начинается заголовком, указанным в квадратных скобках в отдельной строке.
Блок [contract] может состоять следующих полей:
Общие поля для поиска информации
- contracts-limit
Количество блоков с данными по анкетам клиентов, выдаваемых в ответе. В случае, если вы печатаете результаты ответа на странице, то значение этого поля можно установить, например, равным 10. База данных будет выдавать по 10 анкет. Поле может содержать число от 1 до 64000. Необязательное поле (по умолчанию его значение равно 10). Однострочное поле.
- contracts-first
Порядковый номер блока с данными из анкет клиентов, начиная с которого (из числа найденных в базе) блоки будут выдаваться в ответе. Для постраничной выдачи услуг в вашем интерфейсе, если на каждой странице отображается по 10 анкет, для первой страницы это поле нужно устанавливать равным 1, для второй - 11, для третей - 21, и так далее. Поле может содержать число от 1 до 64000. Необязательное поле (по умолчанию его значение равно 1). Однострочное поле.
- contract-num
Номер договора. Содержит порядковый номер (число), и идентификатор типа договора NIC-D через дробь. Необязательное поле. Однострочное поле.
- e-mail
Адреса электронной почты клиента по договору. На эти адреса высылается административный пароль в том случае, если клиент его забудет. Эти адреса указываются при выводе информации о доменах клиента через Whois service. Каждый адрес должен записываться в отдельной строке. Максимальная длина - 256 символов. Необязательное поле. Многострочное поле.
- domain
Название домена. Если это поле заполнено, то производится поиск анкеты администратора указанного домена, а также пользователей услуг Primary, Secondary, Web-forwarding и Mail-forwarding для этого домена. Необязательное поле. Однострочное поле.
- identity
Статус идентификации клиента. Возможные значения в поиске: identified / not-identified
- is-resident
Флаг: для юридического лица - наличие регистрации на территории РФ; для физического лица - наличие гражданства РФ. Возможные значения: YES или NO. Необязательное поле. Однострочное поле.
Поля для поиска данных по организациям и ИП
- org
Название организации клиента на английском языке. Может содержать латинские буквы, цифры, знаки препинания и пробелы. Минимальная длина - два слова, максимальная длина - 256 символов. Необязательное поле. Многострочное поле.
- org-r
Название организации клиента на русском языке. Может содержать русские и латинские буквы, цифры, знаки препинания и пробелы. Минимальная длина - два слова, максимальная длина - 256 символов. Необязательное поле. Многострочное поле.
- code
ИНН организации клиента. Поле должно содержать десятизначное число (последняя цифра - контрольная). Необязательное поле. Однострочное поле.
Поля для поиска данных по физическим лицам
- person
Имя, первая буква отчества и фамилия клиента на английском языке. Поле может содержать латинские буквы, цифры, знаки препинания и пробелы. Максимальная длина - 64 символа. Необязательное поле. Многострочное поле.
- person-r
Фамилия, имя и отчество клиента на русском языке. Поле может содержать русские и латинские буквы, цифры, знаки препинания и пробелы. Максимальная длина - 64 символа. Необязательное поле. Многострочное поле.
- passport
Паспортные данные клиента. Поле заполняется по-русски. Может содержать русские и латинские буквы, цифры, знаки препинания и пробелы. Минимальная длина - два слова, максимальная длина - 256 символов. Необязательное поле. Многострочное поле.
Поиск осуществляется по следующей формуле:
(contract-num AND e-mail AND org AND org-r AND code) OR (contract-num AND e-mail AND person AND person-r AND passport)
В случае если какое-либо из полей присутствует, но не заполнено, или отсутствует в запросе, то ищутся все его значения. При отправке запроса без указания полей выводится полный список анкет клиентов.
Порядок следования полей в запросе произвольный в пределах каждого блока. Многострочные поля записываются в несколько строк, при этом в начале каждой строки присутствует название поля и разделитель (двоеточие). Для однострочных полей повторение не допускается. Необязательные поля могут либо отсутствовать в блоке, либо их значение может быть пустым (состоящим из пробельных символов).
Ответ содержит заголовок (см. формат заголовка ответа) и тело ответа, которое отделяется от заголовка пустой строкой.
В случае успешного выполнения запроса (код 200) в теле ответа содержится блок contracts-list, содержащий служебную информацию о результатах поиска, а также блоки contract c данными по найденным анкетам клиентов.
Если в форме договора обнаружены ошибки, выдается ответ с кодом 402, и в теле ответа содержится блок errors с описанием ошибок на языке, указанном в запросе в поле lang.
Блок [contracts-list] содержит следующие поля:
- contracts-found
Количество услуг, найденных по запросу в базе данных.
- contracts-limit
Количество услуг, выданных по запросу. Соответствует затребованному количеству выдаваемых услуг.
- contracts-first
Порядковый номер услуги, начиная с которой (из числа найденных в базе данных) осуществляется выдача. Соответствует затребованному порядковому номеру начальной услуги.
Блок [contracts] содержит следующие поля:
Для анкеты клиента-организации и ИП
- contract-num
Номер договора. Содержит порядковый номер (число), и идентификатор договора NIC-D через дробь. Однострочное поле.
- org
Название организации клиента на английском языке. Может содержать латинские буквы, цифры, знаки препинания и пробелы. Многострочное поле.
- org-r
Название организации клиента на русском языке. Может содержать русские и латинские буквы, цифры, знаки препинания и пробелы. Многострочное поле.
- code
ИНН организации клиента. Поле содержит десятизначное число (последняя цифра - контрольная). Однострочное поле.
- e-mail
Адреса электронной почты клиента по договору. На эти адреса высылается административный пароль в том случае, если клиент его забудет. Эти адреса указываются при выводе информации о доменах клиента через Whois service. Каждый адрес должен записываться в отдельной строке. Максимальная длина - 256 символов. Многострочное поле.
- state
Статус идентификации клиента. Возможные значения:
- not-identified - клиент не идентифицирован; документы не присланы;
- in-queue - клиент не идентифицирован; документы присланы;
- in-process - осуществляется проверка;
- docs-manual-failed – отказ по ручной проверке;
- identified - клиент идентифицирован.
- esia-state
Статус идентификации клиента через Госуслуги. Возможные значения:
- not-identified - клиент не проходил или не прошел идентификацию через Госуслуги;
- not-confirmed – учетная запись на Госуслугах, под которой произошла попытка идентификации, не подтверждена;
- in-process-auto - автоматическая сверка;
- auto-failed - сверка не пройдена;
- in-process-manual - ручная проверка;
- manual-failed - отказ по ручной проверке;
- identified - клиент идентифицирован.
- is-resident
Флаг - наличие регистрации на территории РФ. Возможные значения: YES или NO.
Для анкеты клиента-физического лица
- contract-num
Номер договора. Содержит порядковый номер (число), и идентификатор договора NIC-D через дробь. Однострочное поле.
- person
Имя, первая буква отчества и фамилия клиента на английском языке. Поле может содержать латинские буквы, цифры, знаки препинания и пробелы. Многострочное поле.
- person-r
Фамилия, имя и отчество клиента на русском языке. Поле может содержать русские и латинские буквы, цифры, знаки препинания и пробелы. Многострочное поле.
- passport
Паспортные данные клиента. Поле заполняется по-русски. Может содержать русские и латинские буквы, цифры, знаки препинания и пробелы. Многострочное поле.
- e-mail
Адреса электронной почты клиента по договору. На эти адреса высылается административный пароль в том случае, если клиент его забудет. Эти адреса указываются при выводе информации о доменах клиента через Whois service. Каждый адрес должен записываться в отдельной строке. Максимальная длина - 256 символов. Многострочное поле.
- state
Статус идентификации клиента. Возможные значения:
- not-identified - клиент не идентифицирован; документы не присланы;
- in-queue - клиент не идентифицирован; документы присланы;
- in-process - осуществляется проверка;
- docs-manual-failed – отказ по ручной проверке;
- identified - клиент идентифицирован.
- esia-state
Статус идентификации клиента через Госуслуги. Возможные значения:
- not-identified - клиент не проходил или не прошел идентификацию через Госуслуги;
- not-confirmed – учетная запись на Госуслугах, под которой произошла попытка идентификации, не подтверждена;
- in-process-auto - автоматическая сверка;
- auto-failed - сверка не пройдена;
- in-process-manual - ручная проверка;
- manual-failed - отказ по ручной проверке;
- identified - клиент идентифицирован.
- is-resident
Флаг - наличие гражданства РФ. Возможные значения: YES или NO.