get_notes

Retrieves the domain notes that detail the history of the domain.

Request parameters

Standard request parameters

action = get_notes
object = domain

Request attributes

Parameter	Obligation	Definition/Value
domain	Required	The domain name to query.
type	Required	Type of notes to display. Allowed values are: domain order transfer
order_id	Required if type=order	The ID number of the order.
transfer_id	Required if type=transfer	The ID number of the transfer.
limit	Optional	Maximum number of notes to display on a page
page	Optional	Determines which page to retrieve, using the page number, using the page number. The page index starts at 1 and the default is 1 if not specified.

Response parameters

Standard response parameters

action = reply
object = domain
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:

Parameter	Obligation	Definition/Value
notes	Always returned	An associative array listing note contents, parameters in the associative array are: timestamp—Date and time the note was recorded, in the format: DD-MMM-YYYY hh:mm:ss note—Contents of the note
transaction_id	Always returned	The ID number of the current request.
page	Always returned	The number of the page retrieved.
page_size	Always returned	The maximum number of notes returned per page.
total	Always returned	The total number of notes returned.

Example

<?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="object">DOMAIN</item>
        <item key="action">GET_NOTES</item>
        <item key="attributes">
          <dt_assoc>
            <item key="domain">example.com</item>
            <item key="type">domain</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="object">DOMAIN</item>
        <item key="action">REPLY</item>
        <item key="is_success">1</item>
        <item key="transaction_id">2022-11-07 14:50:31 1967 101</item>
        <item key="attributes">
          <dt_assoc>
            <item key="total">1</item>
            <item key="page">1</item>
            <item key="page_size">40</item>
            <item key="notes">
              <dt_array>
                <item key="0">
                  <dt_assoc>
                    <item key="timestamp">03-NOV-2022 10:14:13</item>
                    <item key="note">Registrant's [email|first_name last_name] was updated from [[email protected]|FirstName LastName] to [[email protected]|FirstName2 LastName2]</item>
                  </dt_assoc>
                </item>
              </dt_array>
            </item>
          </dt_assoc>
        </item>
        <item key="response_code">200</item>
        <item key="response_text">Command successful</item>
      </dt_assoc>
    </data_block>
  </body>
</OPS_envelope>

Updated over 1 year ago