Element and Attribute definitions

Timestamp and DateRange fields

A TimeStamp includes date and time details

Name Note
Day valid 1-2 digit number
Month valid  1-2 digit number
Year valid  4 digit  number
Hour valid  1-2 digit number
Minute valid  1-2 digit number
Second
  • default is "0"
  • valid  1-2 digit number
TimeZoneOffset
  • "if omitted, NZ local time is assumed
  • format: +/-HH:MM"

Example DateRange field:

<RegisteredDateRange>
  <From Day="1" Hour="12" Minute="22" Month="1" Second="23" Year="2006"/>
  <To Day="1" Hour="12" Minute="00" Month="1" Second="00" Year="2007"/>
</RegisteredDateRange>

Example timestamp:

<FeTimeStamp Day="27" Hour="16" Minute="04" Month="01" Second="36" TimeZoneOffset="+13:00" Year="2015"/>

Transaction Elements and Attributes

Name Transaction Note
ActionID
Required in all writable transactions:
A unique identifier of a transaction provided with a SRS request - mandatory in transactions attempting to add or modify data in the SRS
<AuditDetails> Returned in SRS response An element that contains the registrar and action identifiers of actions for system auditing purposes. May also contain details of the time of the action in the AuditTime element and a text description in an AuditText element"
<AuditText>
Optional in all writable transactions:
Optional request reference that can be populated by registrar text field
<AuditTime> Returned in SRS response Part of AuditDetails element. Shows time when transaction was processed in timestamp format
FullResult
Boolean value
  • if "0" response will return in Whois response only the availability status of domain name in and in DomainUpdate the updated fields
  • if "1" all for the transaction available domain name details are returned in response
RegistrarId Part of a SRS Request and SRS Response Registrar's unique identifier assigned by NZRS when registrar is setup
VerMajor Part of a SRS Request and SRS Response Major version number of client (request) or SRS (response)
VerMinor Part of a SRS Request and SRS Response Minor version number of client (request) or SRS (response)

Domain Information

Name Note
DomainName
  • maximum length for 3rd level: 63 characters
  • only ascii characters (0-9, a-z, ""-"")
  • if IDN, needs to be the punycode version of DomainNameUnicode value
DomainNameUnicode
  • unicode version DomainName
  • needs to be specified in a DomainCreate if domain name is an IDN
  • if exists for domain object field is returned by DomainDetailsQry and Whois
DomainNameUnicodeHex
DomainNameLanguage
  • language/script table to be used to interprete the DomainNameUnicode
  • if IDN may be specified in DomainCreate
  • if IDN field is returned by DomainDetailsQry and Whois
HandleId
  • server-unique contact object identifier that can be associated with one or more domain names
  • length: between 3 - 16 characters
  • if server generated it begins with nzrs_auto* (this namespace is reserved for server generated contact objects, registrars cannot create contacts starting like this)
UDAI
Unique Domain Authorisation ID
  • server generated
  • generated with DomainCreate
  • updated by sending a DomainUpdate NewUDAI="1"
  • required for domain name transfer
  • length: 8 characters
Delegate
  • boolean value
  • shows delegation status of domain name, if Delegate = ""0"" domain name is not in .NZ DNS zone file even if name servers are provided
  • can be updated with DomainUpdate transaction
Term Registration (billing) period, can be between 1- 120 months
RegistrantRef Reference that may be assigned to the registrant by the registrar
Status Status of domain name which can be either Active or PendingRelease

NameServers SubElement

Name Note
<Server>  
FQDN Fully Qualified Domain Name
IP4Addr Required if the name server is 'self-serving' (domain name = host name) AND no IPv6 address is provided
IP6Addr Required if the name server is 'self-serving' (domain name = host name) AND no IPv4 address is provided

Example NameServers block:

<NameServers>
  <Server FQDN="ns1.test.net.nz" IP4Addr="192.168.1.1" IP6Addr="::1" />
  <Server FQDN="ns2.dns.co.nz"/>
</NameServers>

Note

Up to 10 <server> elements per domain name are allowed

Contact Information

Name Note
<RegistrantContact>, <AdminContact> or <TechnicalContact>  
Name Minimum 2 characters
Email  

PostalAddress SubElement

Name Required Note
Address1 yes Minimum 2 characters
Address2 no  
City yes Minimum 2 characters
Province no Minimum 2 characters if provided
CountryCode yes 2 letter country code (ISO 3166-1)
PostalCode no  

Phone SubElement

Name Required Note
CountryCode yes  
AreaCode no  
LocalNumber yes  

Fax SubElement

Name Required Note
CountryCode yes  
AreaCode no  
LocalNumber yes  

Query Transaction Elements and Attributes

Name Required Description Note
MaxResults no Control the number of distinct results returned by query (see example below) The system is restricted to a maximum of 1500 results to be returned per response even if the value of MaxResults is higher
SkipResults no Controls the number of distinct results skipped by query (see example below)  
CountResults no Returns a count based on the field in the transaction May only be set if the MaxResults and SkipResults parameter are not set
MoreRowsAvailable   Returned in a response with value "1" if more results for a query are available than returned in response (see example below) i.e. if number of results for search criteria is bigger than MaxResults value SRS response only - not to be used in SRS request

The MaxResults and the SkipResults parameters control the number of distinct results skipped and returned by the query. For example a response to a query produces 500 results. Due to high amount of data per result the response may exceed the actual response size limit. Therefore the result cannot be returned in a single response but produces an error. To retrieve the complete result set it needs to be split up and retrieved in several smaller chunks.

To return 100 results at a time MaxResults="100" can be set. The parameter MoreRowsAvailable="1" is returned with the first response to indicate that the query actually produced more results then the 100 that have been returned.

To get the next 100 results an identical request needs to be sent to the SRS with the SkipResults parameter set to the amount of results that have already been returned by the SRS. The second request has the parameter SkipResults="100", the next one 200 and so on until all responses are returned and the MoreRowsAvailable parameter is no longer returned.