query_queued_request

Queries the status of a queued request.

Request parameters for query_queued_request

Standard parameters

  • action = query_queued_request
  • object = domain

Attributes

Parameters within the attributes associative array are described below.

Parameter name

Obligation

Definition/Value

request_id

Required

The ID of the queued request; the queue_request_id is returned when an order is queued.

Response parameters for query_queued_request

Standard parameters action = reply

  • object = domain
  • is_success = a Boolean is returned, indicating success or failure of the
    request
  • response_code = response code indicating outcome of the request
  • response_text = message describing the outcome of the request

Attributes

If the request is successful, the attributes associative array may include the following:

Parameter name

Obligation

Definition/Value

queue_date

Returned if is_success = true

The date the order was queued, in the format DD-MMM-YYYY hh:mm:ss.

request_data

Returned if is_success = true

The content of the original queued request. All data is returned in a single variable.

Examples for query_queued_request

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">query_queued_request</item>
                <item key="object">domain</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="request_id">1782</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Command completed successfully</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="queue_date">04-MAR-2004 10:27:01</item>
                        <item key="request_data">
                            <dt_assoc>
                                <item key="ip">10.0.11.121</item>
                                <item key="username">purple</item>
                                <item key="action">SW_REGISTER</item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>