get_notes

Retrieves the domain notes that detail the history of the domain, for
example, renewals and transfers.

Request parameters for get_notes

Standard parameters

action = get_notes
object = domain

Attributes

Parameters within the attributes associative array are described below.

Parameter name

Obligation

Definition/Value

domain

Required

The domain to query.

limit

Optional

Maximum number of notes to display on a page; the default is 40.

order_id

Optional

The ID number of the order.

page

Optional

Determines which page to retrieve, using the page
number. The page index starts at 1.

type

Required

Type of notes to display. Allowed values are
domain, order, and transfer.

Response parameters for get_notes

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

notes

Returned if is_success = true

The contents of the note.

  • timestamp—Date and time the note was
    recorded, in the format DD-MMM-YYYY
    hh:mm:ss.

  • note—Contents of the note

page

Optional

Page retrieved, using the page number. The page index starts at 1.

page_size

Returned if is_success = true

The maximum number of notes returned per page.

total

Returned if is_success = true

Total number of notes returned.

Examples for get_notes

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">get_notes</item>
                <item key="object">domain</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">example.com</item>
                        <item key="page">1</item>
                        <item key="order_id">123456</item>
                        <item key="type">order</item>
                        <item key="limit">100</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<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_text">Command successful</item>
                <item key="response_code">200</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="page_size">100</item>
                        <item key="page">1</item>
                        <item key="total">1</item>
                        <item key="notes">
                            <dt_array>
                                <item key="0">
                                    <dt_assoc>
                                        <item key="timestamp">15-OCT-2007
                                            16:23:04</item>
                                        <item key="note">Domain taken</item>
                                    </dt_assoc>
                                </item>
                            </dt_array>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>