Retrieving Order Information

Request example:

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

[order]
order_id:4519


The request header must contain the values request:order and operation:get (see the description of the request header format).

The header is followed by an order block containing the search criteria. Search is performed using AND logic for all specified fields. The block begins with a header enclosed in square brackets on a separate line.

The [order] block may contain the following fields:

  • order_id

Order identifier in the database. Integer from 0 to 1,000,000. Required field.  Single-line field.

The order of fields within each block is arbitrary. Multi-line fields are written across several lines, with each line beginning with the field name and a separator (colon).  Single-line fields may not be repeated. Optional fields may either be omitted from the block or contain an empty value (consisting only of whitespace characters).

Response example:

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


The response consists of a header (see the response header format) and a response body, separated by a blank line.
If the request is processed successfully (status code 200), the response body contains an [order] block with general information about the order, and one or more [order-item] blocks containing information about the order items found. Each order item corresponds to a single service included in the order.

The [order] block contains the following fields:

  • order_id

Order identifier in the database.

  • state

Status of the order according to the table below:

state

Order Status

waiting

Awaiting execution of the agreement or payment

running

Being processed

completed

Completed (successfully or unsuccessfully)

deleted

 Cancelled by the client (partner)

  • submitted

Date and time the order was accepted, in the format DD.MM.YYYY HH:MM.

The [order-item] blocks contain the following fields:

  • subject-contract
    The number of the client profile for which the service was ordered.
  • oi_id
    The order item identifier in the database.
  • oi_num
    The sequential number of the order item.
  • action
    The order type (the value of the action field specified when submitting the order).
  • service
    The type of service ordered (the value of the service field in responses).
  • states
    The status of the order item according to the table below:

state

Status of order item

waiting

Awaiting execution of the agreement or payment

running

Being processed

ok

Order item completed successfully

failed

Processing completed; the order item was not fulfilled

deleted

Order cancelled by the client (partner)

  •  domain
    The domain name for which the service was ordered under the given order item.

In addition to the fields listed above, the [order-item] block may contain service-specific data applicable to the particular type of service.

Any other fields that may appear in responses to this request are either not used or are intended for internal system purposes.
 

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