Получение информации о заказе

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

lang: ru
login:123/NIC-REG/adm
password:QWERTY
request:order
operation:get
request-id:20011220103455.12345@nic.ru

[order]
order_id:4519

В заголовке запроса необходимо указать значения request:order и operation:get (см. описание формата заголовка запроса).

После заголовка запроса следует блок order, в котором следует задать данные для поиска. Поиск осуществляется с логикой "и" для перечисленных полей. Блок начинается заголовком, указанным в квадратных скобках в отдельной строке.

Блок [order] может состоять из следующих полей:

  • order_id
    Идентификатор заказа в базе данных. Целое число в диапазоне от 0 до 1 млн. Обязательное поле. Однострочное поле.

Порядок следования полей в запросе произвольный в пределах каждого блока. Многострочные поля записываются в несколько строк, при этом в начале каждой строки присутствует название поля и разделитель (двоеточие). Для однострочных полей повторение не допускается. Необязательные поля могут либо отсутствовать в блоке, либо их значение может быть пустым (состоящим из пробельных символов).

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

State: 200 OK
request-id:20011220103455.12345@nic.ru

[order]
subject-contract:12345/NIC-D
order_id:4519
state:completed
submitted:06.12.2001 20:41:20
remote-addr:195.19.26.220

[order-item]
oi_id:5386
oi_num:1
action:new
service:mforwarding
state:failed
domain:TEST.RU
switch:ON
forward-to:* *@nic.ru

Ответ содержит заголовок (см. формат заголовка ответа) и тело ответа, которое отделяется от заголовка пустой строкой.

В случае успешного выполнения запроса (код 200) в теле ответа содержится блок order, содержащий общую информацию о заказе, а также блоки order-item c данными по найденным пунктам заказа. Каждый пункт заказа соответствует одной заказанной услуге.

Блок [order] содержит следующие поля:

  • order_id
    Идентификатор заказа в базе данных.
  • state
    Статус заказа в соответствии с таблицей:

    state

    Статус заказа

    waiting

    Ожидает подписания договора или оплаты

    running

    В обработке

    completed

    Выполнен (успешно или неуспешно)

    deleted

    Отозван клиентом (партнером)

  • submitted
    Дата и время приема заказа в формате DD.MM.YYYY HH:MM:SS.

В блоках [order-item] содержатся следующие поля:

  • subject-contract
    Номер анкеты клиента, для которого была заказана услуга.
  • oi_id
    Идентификатор пункта заказа в базе данных.
  • oi_num
    Порядковый номер пункта заказа.
  • action
    Тип заказа (значение поля action, установленного при отправке заказа).
  • service
    Тип заказанной услуги (значение поля service в ответах).
  • states
    Статус пункта заказа в соответствии с таблицей:

    state

    Статус пункта заказа

    waiting

    Ожидает подписания договора или оплаты

    running

    В обработке

    ok

    Пункт заказа выполнен успешно

    failed

    Выполнение завершено, пункт заказа не выполнен

    deleted

    Заказ отозван клиентом (партнером)

  • domain
    Название домена, для которого была заказана услуга в данном пункте.

Кроме перечисленных полей, блок [order-item] может содержать индивидуальные данные об услуге, специфичные для услуг этого типа.

Остальные поля в ответах на этот запрос не используются, либо являются служебными.

Всё ещё остались вопросы?