Request parameters for cancel_order

Description

action = cancel_order
object = trust_service

Attributes

Parameters within the attributes associative array are described below.

Parameter name	Obligation	Definition/Value
order_id	Required	The ID of the order.

Response parameters for cancel_order

Standard parameters

action = reply
object = trust_service
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
domain	Returned if is_success = true	The domain with which the SSL Service order is associated.
order_id	Returned if is_success = true	The ID of the order.
state	Returned if is_success = true	The state of the order. Allowed values are: approver-confirmed—Owner has confirmed the domain vetted certificate. awaiting-approval—Order processed successfully; waiting for supplier approval. cancelled—Pending order was cancelled. completed—Order is complete. declined—Order cancelled after it was processed or declined by the supplier. in-progress—Order is in progress. pending—Order saved as pending.

Parameter name

Obligation

Definition/Value

domain

Returned if is_success = true

The domain with which the SSL Service order is associated.

order_id

Returned if is_success =
true

The ID of the order.

state

Returned if is_success =
true

The state of the order. Allowed values are:

approver-confirmed—Owner has confirmed the domain vetted certificate.
awaiting-approval—Order processed
successfully; waiting for supplier approval.
cancelled—Pending order was cancelled.
completed—Order is complete.
declined—Order cancelled after it was
processed or declined by the supplier.
in-progress—Order is in progress.
pending—Order saved as pending.

Examples for cancel_order

Request

<?xml version='1.0' encoding='UTF-8'?>
<!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">cancel_order</item>
                <item key="object">trust_service</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="order_id">578</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">TRUST_SERVICE</item>
                <item key="response_text">Command completed
                    successfully.</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">example.org</item>
                        <item key="order_id">578</item>
                        <item key="state">declined</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>