В заголовке запроса необходимо указать значения request:order и operation:search (см. описание формата заголовка запроса).
После заголовка запроса следует блок order, в котором следует задать данные для поиска. Поиск осуществляется с логикой "и" для перечисленных полей. Блок начинается заголовком, указанным в квадратных скобках в отдельной строке.
Блок [order] может состоять из следующих полей:
- order_id
Идентификатор заказа в базе данных (идентификаторы принятых заказов выдаются в ответ на запросы по созданию заказов). Необязательное поле. Однострочное поле.
- submitted
Дата приема заказа в формате DD.MM.YYYY (цифры). Необязательное поле. Однострочное поле.
- total
Суммарная стоимость заказа в у.е. без учета налогов. Целое число от 1 до 100000. Необязательное поле. Однострочное поле.
- state
Статус заказа. Однострочное поле. Необязательное поле. Одно из фиксированных значений, приведенных в таблице:
state
|
Статус заказа
|
waiting
|
Ожидает подписания договора или оплаты
|
running
|
В обработке
|
completed
|
Выполнен (успешно или неуспешно)
|
deleted
|
Отозван клиентом (партнером)
|
- domain
Имя домена, услуги для которого заказаны. Можно использовать шаблон *, заменяющий произвольную группу символов (0 и более). Название домена следует указывать в верхнем регистре. Доменное имя на национальном языке должно быть указано в виде XN--***.SU. Необязательное поле (в случае указания производится поиск всех тех заказов, один из пунктов которых содержит услугу по указанному домену). Однострочное поле.
- service
Тип заказанной услуги в соответствии с таблицей типов услуг. Обязательное поле. Однострочное поле.
Примечание: При поиске заказов по доменам .COM, .NET, .ORG, .BIZ, .INFO в поле service указывается:
- в заказах, поступивших до 15 августа 2011, значение domain_rrp;
- в заказах поступивших после 15 августа 2011значение, соответствующее расширению домена, а именно:
- domain_epp_com для доменов .COM,
- domain_epp_net для доменов .NET,
- domain_epp_org для доменов .ORG,
- domain_epp_biz для доменов .BIZ,
- domain_epp_info для доменов .INFO.
- orders-limit
Количество блоков с данными о заказах, выдаваемых в ответе. В случае, если вы печатаете результаты ответа на странице, то значение этого поля можно установить например в 10 - база данных будет выдавать по 10 заказов, и на странице вашего интерфейса будет отображаться по 10 строк. Поле может содержать число от 1 до 64000. Необязательное поле (по умолчанию его значение равно 10). Однострочное поле.
- orders-first
Порядковый номер блока с данными о заказах, начиная с которого (из числа найденных в базе данных) блоки будут выдаваться в ответе. Для постраничной выдачи заказов в вашем интерфейсе, если на каждой странице отображается по 10 заказов, для первой страницы это поле нужно устанавливать равным 1, для второй - 11, для третей - 21, и так далее. Поле может содержать число от 1 до 64000. Необязательное поле (по умолчанию его значение равно 1). Однострочное поле.
Порядок следования полей в запросе произвольный в пределах каждого блока. Многострочные поля записываются в несколько строк, при этом в начале каждой строки присутствует название поля и разделитель (двоеточие). Для однострочных полей повторение не допускается. Необязательные поля могут либо отсутствовать в блоке, либо их значение может быть пустым (состоящим из пробельных символов).
Ответ содержит заголовок (см. формат заголовка ответа) и тело ответа, которое отделяется от заголовка пустой строкой.
В случае успешного выполнения запроса (код 200) в теле ответа содержится блок orders-list, содержащий служебную информацию о результатах поиска, а также блоки order c данными по найденным заказам.
Блок [orders-list] содержит следующие поля:
- orders-found
Количество заказов, найденных по запросу в базе данных.
- orders-limit
Количество заказов, выданных по запросу. Соответствует затребованному количеству выдаваемых заказов.
- orders-first
Порядковый номер заказа, начиная с которой (из числа найденных в базе данных) осуществляется выдача. Соответствует затребованному порядковому номеру начального заказа.
В блоках [order] содержатся следующие поля:
- subject-contract
Номер анкеты клиента, для которого была заказана услуга.
- order_id
Идентификатор заказа в базе данных.
- state
Статус заказа в соответствии с таблицей:
state
|
Статус заказа
|
waiting
|
Ожидает подписания договора или оплаты
|
running
|
В обработке
|
completed
|
Выполнен (успешно или неуспешно)
|
deleted
|
Отозван клиентом (партнером)
|
- submitted
Дата и время приема заказа в формате DD.MM.YYYY HH:MM:SS.
- order-items
Пункты заказа. Каждый пункт заказа соответствует одной заказанной услуге. Пункты заказа записывается отдельными строками. Каждая строка содержит через пробел идентификатор пункта заказа, тип заказанной услуги (поле service), домен для которого заказана услуга, тип заказа (поле action) и статус пункта заказа.