cancel_order

Cancel a SSL Service order.

Request parameters

Standard request parameters

  • action = cancel_order
  • object = trust_service

Request attributes

Parameters within the attributes associative array are described below:

ParameterObligationDefinition/Value
order_idRequiredThe ID number of the order.

Response parameters

Standard response parameters

  • action = reply
  • object = trust_service
  • is_success = Boolean 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.

Response attributes

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

ParameterObligationDefinition/Value
domainAlways returnedThe associated domain name for the SSL order.
order_idAlways returnedThe ID number of the order.
stateAlways returnedThe state of the order. Allowed values are:

approver-confirmed—Owner has confirmed the DV certificate.
awaiting-approval—Waiting for supplier approval.
cancelled—Pending order was cancelled.
completed—Order is complete.
declined—Order declined by the supplier.
in-progress—Order is in progress.
pending—Order saved as pending.

Example

<?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>
<?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>