delete (surname)

Deletes the Personal Names domain. This call can delete only one domain at a time.

Request parameters for delete (surname)

Standard parameters

  • action = delete
  • object = surname

Attributes

Parameters within the attributes associative array are described below.

Parameter name

Obligation

Definition/Value

domain

Required

Personal Names domain to be deleted.

Response parameters for delete (surname)

Standard parameters

  • action = reply
  • object = surname
  • 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

Examples for delete (surname)

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">DELETE</item>
                <item key="object">SURNAME</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">steven.smith.net</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="object">SURNAME</item>
                <item key="response_text">In progress. Request successfully submitted and placed in the queue</item>
                <item key="action">DELETE:REPLY</item>
                <item key="response_code">250</item>
                <item key="is_success">1</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="object">SURNAME</item>
                <item key="response_text">Domain not found or in unacceptable state for this action</item>
                <item key="action">DELETE:REPLY</item>
                <item key="response_code">424</item>
                <item key="is_success">0</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>