Home
/
API reference
/
API documentation (JSON/XML)
/
Objects
/
XML specific objects

Notify Object

API reference (XML/JSON) · Updated 2023-10-25

Description

The Notify object represents the notification in a system reponse. Depending on the notification type, it contains objects with the required data. It is used only for XML.

Information about asynchronous notifications you find here.

Notification Types:

transfer_start = A transfer was started.
transfer_autoack = The domain transfer was automatically confirmed (AutoAck). Only for gTLDs.
transfer_autonack = The domain transfer was automatically rejected (AutoNack).
transfer_reminder = Reminder of an ongoing transfer.
transfer_autonack_pending = The transfer with AutoAck is still pending.
transfer_autonack_success = The transfer with AutoNack was successful.
transfer_autonack_failed = The transfer with AutoNack failed.
transfer_autoack_success = The transfer with AutoAck was successful.
transfer_autoack_failed = The transfer with AutoAck failed.
domain_away = The domain was deleted from the inventory, e.g. for transfers without involving the registrar.
domain_expire = The registration period of the domain has expired.
domain_expire_warning = The domain's registration period is about to expire.
domain_registrar_status_update = The status has been updated at the registrar.
domain_deactivation_warning = The domain will be deactivated soon.
authinfo_deleted = The AuthInfo has been deleted.
authinfo_delete = The AuthInfo deletion was started.
tmch_status_update_success = The marker update was successful.
tmch_status_update_failed = The marker update failed.
tmch_status_update = The update of the marker was started.
tmch_claim_notice_reminder = Reminder of pending confirmation for a trademark domain.
domain_prereg_failed = Domain preregistration failed.
domain_prereg_decline = Pre-egistration of the domain has been rejected.
domain_prereg_accept = The preregistration of the domain was accepted.
domain_prereg_sent = The preregistration of the domain was sent.
autoupdate_dns_success = The update to the name server was successful.
autoupdate_dns_error = The update to the name server failed.
autoupdate_deferred_success = The domain update was successful.
autoupdate_deferred_error = The update to the domain data failed.
contact_deleted = The contact was deleted.
user_activated = The user was activated.
ocval_start = The verification was started.
ocval_confirmed = The verification was confirmed.
zone_delete = The zone has been deleted.

Structure

Keyword XML	Occurs	Type	Format	Description
type	1	string		Notification type (see list above)
domain	0 - 1	object	Domain	Domain object
zone	0 - n	object	Zone	Zone object
user	0 - 1	object	User	User object
handle	0 - 1	object	Contact	Domain contact object
handle_verification	0 - 1	object	ContactVerification	Domain contact verification object
domain_prereg	0 - 1	object	Domain_Prereg	Preregistration object
transfer	0 - 1	object	Transfer	Extended information on transfers or ownerchanges.
answer	0 - 1	enum	Transfer_Type	Contains the response to the transfer, the confirmation or rejection. Can only occur if a transfer object also exists, but does not have to.
reason	0 - 1	string		Depends on the notification type: domain_deactivation_warning = reason for domain deactivation. domain_registrar_status_update = reason for domain update.
deactivation	0 - 1	string	datetime	Point of time when the domain will be deactivated. Only for domain_deactivation_warning notification type.
registrar_status	0 - 1	enum	RegistryStatusConstants	New status of the domain at the registrar. Only for domain_registrar_status_update notification type.
msg	0 - 1	object	Msg	Contains other message objects that occurred during processing.
status	1	object	Status	Status object

XML Example

<notify>
	<domain>
		<name>exampledomain.aq</name>
		<ownerc>23252437</ownerc>
		<adminc>23252437</adminc>
		<techc>23252437</techc>
		<zonec>23252437</zonec>
		<nic_member_label>AQ-TEST</nic_member_label>
		<registry_status>ACTIVE</registry_status>
		<nserver>
			<name>ns1.examplenameserver.com</name>
		</nserver>
		<nserver>
			<name>ns2.examplenameserver.com</name>
		</nserver>
		<ip>1.2.3.4</ip>
		<period>1</period>
		<action>AUTOUPDATE_DEFERRED</action>
		<autorenew>true</autorenew>
		<registrar_status>ACTIVE</registrar_status>
		<rdds_opt_in>NOT_SET</rdds_opt_in>
		<owner>
			<user>normal_user</user>
			<context>4</context>
		</owner>
		<updater>
			<user>normal_user</user>
			<context>4</context>
		</updater>
		                   
		<created>2021-05-07 15:38:31</created>
	</domain>
	<type>autoupdate_deferred_error</type>
	<status>
		<code>E0102</code>
		<type>error</type>
	</status>
	<stid>20210507-app2-dev-19938</stid>
	<created>2021-05-07 15:39:13</created>
</notify>