JSON Responses for the Registration Data Access Protocol (RDAP)
draft-ietf-weirds-json-response-03
The information below is for an old version of the document.
| Document | Type |
This is an older version of an Internet-Draft that was ultimately published as RFC 7483.
|
|
|---|---|---|---|
| Authors | Andy Newton , Scott Hollenbeck | ||
| Last updated | 2013-04-08 | ||
| Replaces | draft-newton-weirds-unified-json-response | ||
| RFC stream | Internet Engineering Task Force (IETF) | ||
| Formats | |||
| Reviews | |||
| Additional resources | Mailing list discussion | ||
| Stream | WG state | WG Document | |
| Document shepherd | (None) | ||
| IESG | IESG state | Became RFC 7483 (Proposed Standard) | |
| Consensus boilerplate | Unknown | ||
| Telechat date | (None) | ||
| Responsible AD | (None) | ||
| Send notices to | (None) |
draft-ietf-weirds-json-response-03
Network Working Group A.L. Newton
Internet-Draft ARIN
Intended status: Standards Track S. Hollenbeck
Expires: October 11, 2013 Verisign Labs
April 09, 2013
JSON Responses for the Registration Data Access Protocol (RDAP)
draft-ietf-weirds-json-response-03
Abstract
This document describes JSON data structures representing
registration information maintained by Regional Internet Registries
(RIRs) and Domain Name Registries (DNRs). These data structures are
used to form Registration Data Access Protocol (RDAP) query
responses.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on October 11, 2013.
Copyright Notice
Copyright (c) 2013 IETF Trust and the persons identified as the
document authors. All rights reserved.
Newton & Hollenbeck Expires October 11, 2013 [Page 1]
Internet-Draft RDAP JSON RESPONSES April 2013
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
1. Introduction
This document describes responses in the JSON [RFC4627] format for
the RESTful web queries as defined by the Registration Data Access
Protocol Lookup Format [I-D.ietf-weirds-rdap-query].
The data model for JSON responses is specified in four sections:
1. simple data types conveyed in JSON strings
2. data structures specified as JSON arrays or objects that are used
repeatedly when building up larger objects
3. object classes representing structured data corresponding to a
given query
4. the response to an error
The object classes represent responses for two major categories of
data: responses returned by Regional Internet Registries (RIRs) for
registrations data related to IP addresses, reverse DNS names, and
Autonomous System numbers; and responses returned by Domain Name
Registries (DNRs) for registration data related to forward DNS names.
The following object classes are served by both RIRs and DNRs:
1. domains
2. nameservers
3. entities
The information served by both RIRs and DNRs for these object classes
overlap extensively and are given in this document as a unified model
for both classes of service.
In addition to the object classes listed above, RIRs also serve the
following object classes:
Newton & Hollenbeck Expires October 11, 2013 [Page 2]
Internet-Draft RDAP JSON RESPONSES April 2013
1. IP networks
2. Autonomous System numbers
Object classes defined in this document represent a minimal set of
what a compliant client/server MUST understand to function correctly,
however some deployments may want to include additional object
classes to suit individual needs. Anticipating this need for
extension, Section 3.2 of this document defines a mechanism for
extending the JSON objects that are described in this document.
2. Terminology and Definitions
The following list describes terminology and definitions used
throughout this document:
DNR: "Domain Name Registry".
LDH: "Letters, Digits, Hyphen".
member: data found with in an object as defined by JSON
[RFC4627].
object: a data structure as defined by JSON [RFC4627].
object class: the definition of members that may be found in JSON
objects described in this document.
object instance: an instantiation or specific instance of an object
class.
RDAP: "Registration Data Access Protocol".
RIR: "Regional Internet Registry".
3. Use of JSON
3.1. Signaling
Media type signaling for the JSON data specified in this document is
specified in [I-D.ietf-weirds-using-http].
3.2. Naming
Clients processing JSON [RFC4627] responses are under no obligation
to process unrecognized JSON attributes but SHOULD NOT treat them as
an error. Servers MAY insert values signified by names into the JSON
responses which are not specified in this document. Insertion of
Newton & Hollenbeck Expires October 11, 2013 [Page 3]
Internet-Draft RDAP JSON RESPONSES April 2013
unspecified values into JSON responses SHOULD have names prefixed
with a short identifier followed by an underscore followed by a
meaningful name. The full JSON name, the prefix plus the underscore
plus the meaningful name, SHOULD adhere to the character and name
limitations of the prefix registry described in
[I-D.ietf-weirds-using-http].
Consider the following JSON response with JSON names. some of which
are not specified in this document.
{
"handle" : "ABC123",
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
]
}
Figure 1
If The Registry of the Moon desires to express information not found
in this specification, it might select "lunarNic" as its identifying
prefix and insert, as an example, the name
"lunarNic_beforeOneSmallStep" to signify registrations occurring
before the first moon landing and the name
"lunarNic_harshMistressNotes" containing other descriptive text.
Consider the following JSON response with JSON names, some of which
should be ignored by clients without knowledge of their meaning.
Newton & Hollenbeck Expires October 11, 2013 [Page 4]
Internet-Draft RDAP JSON RESPONSES April 2013
{
"handle" : "ABC123",
"lunarNic_beforeOneSmallStep" : "TRUE THAT!",
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"lunarNic_harshMistressNotes" :
[
"In space,",
"nobody can hear you scream."
]
}
Figure 2
Insertion of unrecognized names ignored by clients may also be used
for future revisions to this specification.
Clients processing JSON responses MUST be prepared for values
specified in this document to be absent from a response as no JSON
value listed is required to appear in a response. In other words,
servers MAY remove values as is needed by the policies of the server
operator.
Finally, all JSON names specified in this document are case
sensitive. Both servers and clients MUST transmit and process them
using the specified character case.
4. Common Data Types
JSON [RFC4627] defines the data types of a number, character string,
boolean, array, object and null. This section describes the
semantics and/or syntax reference for data types used in this
document derived from the JSON character string.
'handle': DNRs and RIRs have registry-unique identifiers that
may be used to specifically reference an object
instance. The semantics of this data type as found
in this document is to be a registry-unique
reference to the closest enclosing object where the
value is found. The data type names 'registryId',
Newton & Hollenbeck Expires October 11, 2013 [Page 5]
Internet-Draft RDAP JSON RESPONSES April 2013
'roid', 'nic-handle', 'registrationNo', etc. are
terms often synonymous with this data type. In
this document, the term 'handle' is used. The term
exposed to users by clients is a presentation issue
beyond the scope of this document.
IPv4 addresses: The representation of IPv4 addresses in this
document uses the dotted-decimal notation described
in [RFC1166]. An example of this textual
representation is '192.0.2.0'.
IPv6 addresses: The representation of IPv6 addresses in this
document follow the forms outlined in [RFC5952].
An example of this textual representation is
'2001:db8::1:0:0:1'.
country codes: Where the identity of a geopolitical nation or
country is needed, these identities are represented
with the alpha-2 or 2 character country code
designation as defined in [ISO.3166.1988]. The
alpha-2 representation is used because it is freely
available whereas the alpha-3 and numeric-3
standards are not.
LDH names: Textual representations of DNS names where the
labels of the domain are all "letters, digits,
hyphen" labels as described by [RFC5890]. Trailing
periods are optional.
Unicode names: Textual representations of DNS names were one or
more of the labels are u-labels as described by
[RFC5890]. Trailing periods are optional.
dates and times: The syntax for values denoting dates and times is
defined in [RFC3339].
URIs: The syntax for values denoting a Uniform Resource
Identifier (URI) is defined by [RFC3986].
Contact information is defined using JSON vCards as described in
[I-D.kewisch-vcard-in-json]
5. Common Data Structures
This section defines common data structures to be used in response.
Each of these structures MAY appear within any object class of a
response.
Newton & Hollenbeck Expires October 11, 2013 [Page 6]
Internet-Draft RDAP JSON RESPONSES April 2013
5.1. RDAP Conformance
The first data structure is named "rdapConformance" and is simply an
array of strings, each providing a hint as to the specifications used
in the construction of the response. This data structure appears
only in the top most object of a response.
An example rdapConformance data structure:
"rdapConformance" :
[
"rdap_level_0"
]
Figure 3
The string literal "rdap_level_0" signifies conformance with this
specification. When custom JSON values are inserted into responses,
conformance to those custom specifications should use a string
prefixed with the appropriate identifier from the IANA prefix
identifier registry specified in [I-D.ietf-weirds-using-http]. For
example, if the fictional Registry of the Moon wants to signify that
their JSON responses are conformant with their registered extensions,
the string used might be "lunarNIC_level_0".
Example rdapConformance structure with custom extensions noted:
"rdapConformance" :
[
"rdap_level_0",
"lunarNic_level_0"
]
Figure 4
5.2. Links
The "links" array is found in data structures to signify links to
other resources on the Internet. The relationship of these links is
defined by the IANA registry described by [RFC5988].
The following is an example of the link structure:
Newton & Hollenbeck Expires October 11, 2013 [Page 7]
Internet-Draft RDAP JSON RESPONSES April 2013
{
"value" : "http://example.com/context_uri",
"rel" : "self",
"href" : "http://example.com/target_uri",
"hreflang" : [ "en", "ch" ],
"title" : [ "title1", "title2" ],
"media" : "screen",
"type" : "application/json"
}
Figure 5
The JSON name/values of "rel", "href", "hreflang", "title", "media",
and "type" correspond to values found in Section 5 of [RFC5988]. The
"value" JSON value is the context URI as described by [RFC5988]. The
"value", "rel", and "href" JSON values MUST be specified. All other
JSON values are optional.
This is an example of the "links" array as it might be found in an
object class:
"links" :
[
{
"value" : "http://example.com/ip/2001:db8::123",
"rel" : "self",
"href" : "http://example.com/ip/2001:db8::123"
},
{
"value" : "http://example.com/ip/2001:db8::123",
"rel" : "up",
"href" : "http://example.com/ip/2001:db8::/48"
}
]
5.3. Notices And Remarks
The "notices" and "remarks" data structures take the same form. The
"notices" structure denotes information about the service providing
RDAP information, whereas the "remarks" structure denotes information
about the object class it is contained within (see Section 6
regarding object classes).
Both are an array of objects. Each object contains an optional
"title" string representing the title of the object, an array of
strings named "description" for the purposes of conveying any
Newton & Hollenbeck Expires October 11, 2013 [Page 8]
Internet-Draft RDAP JSON RESPONSES April 2013
descriptive text, and an optional "links" array as described in
Section 5.2.
An example of the notices data structure:
"notices" :
[
{
"title" : "Terms of Use",
"description" :
[
"Service subject to The Registry of the Moon's TOS.",
"Copyright (c) 2020 LunarNIC"
],
"links" :
[
{
"value" : "http://example.net/entity/XXXX",
"rel" : "alternate",
"type" : "text/html",
"href" : "http://www.example.com/terms_of_use.html"
}
]
}
]
Figure 6
It is the job of the clients to determine line breaks, spacing and
display issues for sentences within the character strings of the
"description" array. Servers SHOULD NOT split sentences across
multiple strings of this array. Each string is to represent a
semantic division in the descriptive text.
An example of the remarks data structure:
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
]
Figure 7
Newton & Hollenbeck Expires October 11, 2013 [Page 9]
Internet-Draft RDAP JSON RESPONSES April 2013
Note that objects in the "remarks" array may also have a "links"
array.
While the "remarks" array will appear in many object classes in a
response, the "notices" array appears only in the top most object of
a response.
5.4. Language Identifier
This data structure is a simple JSON name/value of "lang" with a
string containing a language identifier as described by [RFC5646].
"lang" : "mn-Cyrl-MN"
Figure 8
The 'lang' attribute may appear anywhere in an object class or data
structure.
5.5. Events
This data structure represents events that have occurred on an
instance of an object class (see Section 6 regarding object classes).
This is an example of an "events" array.
"events" :
[
{
"eventAction" : "registration",
"eventActor" : "SOMEID-LUNARNIC",
"eventDate" : "1990-12-31T23:59:60Z"
},
{
"eventAction" : "last changed",
"eventActor" : "OTHERID-LUNARNIC",
"eventDate" : "1991-12-31T23:59:60Z"
}
]
Figure 9
The "events" array consists of objects, each with the following
members:
o 'eventAction' -- a string denoting the reason for the event
Newton & Hollenbeck Expires October 11, 2013 [Page 10]
Internet-Draft RDAP JSON RESPONSES April 2013
o 'eventActor' -- an optional identifier denoting the actor
responsible for the event
o 'eventDate' -- a string containing the time and date the event
occurred.
Events can be future dated. One use case for future dating of events
is to denote when an object expires from a registry.
See Appendix A.2 for a list of suggested values for the 'eventAction'
string. See Appendix C regarding the various ways events can be
modeled.
5.6. Status
This data structure, named 'status', is an array of strings
indicating the state of a registered object (see Appendix A.1 for
suggested values).
5.7. Port 43 Whois Server
This data stricture, named 'port43', is a simple string containing
the fully-qualified host name of the WHOIS [RFC3912] server where the
containing object instance may be found. Note that this is not a
URI, as there is not Whois URI scheme.
5.8. An Example
This is an example response with both rdapConformance and notices
embedded:
Newton & Hollenbeck Expires October 11, 2013 [Page 11]
Internet-Draft RDAP JSON RESPONSES April 2013
{
"rdapConformance" :
[
"rdap_level_0"
],
"notices" :
[
{
"title" : "Content Redacted",
"description" :
[
"Without full authorization, content has been redacted.",
"Sorry, dude!"
],
"links" :
[
{
"value" : "http://example.net/ip/192.0.2.0/24",
"rel" : "alternate",
"type" : "text/html",
"href" : "http://www.example.com/redaction_policy.html"
}
]
}
],
"lang" : "en",
"startAddress" : "192.0.2.0",
"endAddress" : "192.0.2.255",
"handle" : "XXXX-RIR",
"ipVersion" : "v4",
"name": "NET-RTR-1",
"description" : [ "A network used for example documentation" ],
"parentHandle" : "YYYY-RIR",
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
]
}
Figure 10
Newton & Hollenbeck Expires October 11, 2013 [Page 12]
Internet-Draft RDAP JSON RESPONSES April 2013
6. Object Classes
Object classes represent structures appropriate for a response from
the queries specified in [I-D.ietf-weirds-rdap-query].
Each object class contains a "links" array as specified in
Section 5.2. For every object class in a response, whether the
object class is directly representing the response to a query or is
embedded in other object classes, servers SHOULD provide a link
representing a URI for that object class using the "self"
relationship as specified in the IANA registry specified by
[RFC5988]. As explained in Section 6.2, this may be not always be
possible for name server data. Clients MUST be able to process
object instances without a "self" link. When present, clients MAY
use the self link for caching data. Servers MAY provide more than
one "self" link for any given object instance.
This is an example of the "links" array with a self link to an object
class:
"links" :
[
{
"value" : "http://example.com/ip/2001:db8::123",
"rel" : "self",
"href" : "http://example.com/ip/2001:db8::123"
}
]
6.1. The Entity Object Class
The entity object class appears throughout this document and is an
appropriate response for the /entity/XXXX query defined in
Registration Data Access Protocol Lookup Format
[I-D.ietf-weirds-rdap-query]. This object class represents the
information of organizations, corporations, governments, non-profits,
clubs, individual persons, and informal groups of people. All of
these representations are so similar that it is best to represent
them in JSON [RFC4627] with one construct, the entity object class,
to aid in the re-use of code by implementers.
Some of the members of the entity object class are repeated in other
object classes described later in this document.
The entity object is served by both RIRs and DNRs. The following is
an example of an entity that might be served by an RIR:
Newton & Hollenbeck Expires October 11, 2013 [Page 13]
Internet-Draft RDAP JSON RESPONSES April 2013
{
"handle" : "XXXX",
"vCard" :
[
[ "version", {}, "text", "4.0" ],
[ "fn", {}, "text", "Joe Bob, Inc." ],
[ "fn", {}, "text", "Bobby Joe Shopping" ],
[ "label", {}, "text", "123 Maple Ave\n",
"Suite 90001\n",
"Vancouver\n",
"BC\n",
"1239\n" ],
[ "email", {}, "text", "joe at bob.com" ],
[ "email", {}, "text", "bob at joe.com" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4321" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4322" ],
[ "tel", { "type": "fax" }, "uri", "tel:+1-958-555-4323" ],
[ "tel", { "type": "cell" }, "uri", "tel:+1-958-555-4324" ],
],
"roles" : [ "registrant" ],
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"links" :
[
{
"value" : "http://example.com/entity/XXXX",
"rel" : "self",
"href" : "http://example.com/entity/XXXX"
}
],
"events" :
[
{
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
}
],
"asEventActor" :
[
{
Newton & Hollenbeck Expires October 11, 2013 [Page 14]
Internet-Draft RDAP JSON RESPONSES April 2013
"eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z"
}
]
}
This object has the following members:
o handle -- a string representing an registry unique identifier of
the entity
o vCard -- a JSON vCard with the entity's contact information
o roles -- an array of strings, each signifying the relationship an
object would have with its closest containing object (see
Appendix A.3 for suggested values)
o remarks -- see Section 5.3
o links -- see Section 5.2
o events -- see Section 5.5
o asEventActor -- this data structure takes the same form as the
'events' data structure (see Section 5.5), but each object in the
array MUST NOT have an 'eventActor' member. These objects denote
that the entity is an event actor for the given events. See
Appendix C regarding the various ways events can be modeled.
o status -- see Section 5.6
o port43 -- see Section 5.7
The following is an example of a entity that might be served by a
DNR:
{
"handle" : "XXXX",
"vCard" :
[
[ "version", {}, "text", "4.0" ],
[ "fn", {}, "text", "Joe Bob, Inc." ],
[ "fn", {}, "text", "Bobby Joe Shopping" ],
[ "label", {}, "text", "123 Maple Ave\n",
"Suite 90001\n",
Newton & Hollenbeck Expires October 11, 2013 [Page 15]
Internet-Draft RDAP JSON RESPONSES April 2013
"Vancouver\n",
"BC\n",
"1239\n" ],
[ "email", {}, "text", "joe at bob.com" ],
[ "email", {}, "text", "bob at joe.com" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4321" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4322" ],
[ "tel", { "type": "fax" }, "uri", "tel:+1-958-555-4323" ],
[ "tel", { "type": "cell" }, "uri", "tel:+1-958-555-4324" ],
],
"status" : [ "validated", "locked" ],
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"links" :
[
{
"value" : "http://example.com/entity/XXXX",
"rel" : "self",
"href" : "http://example.com/entity/XXXX"
}
],
"port43" : "whois.example.net",
"events" :
[
{
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
},
{
"eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z",
"eventActor" : "joe@bob.com"
}
]
}
6.2. The Nameserver Object Class
Newton & Hollenbeck Expires October 11, 2013 [Page 16]
Internet-Draft RDAP JSON RESPONSES April 2013
The nameserver object class represents information regarding DNS name
servers used in both forward and reverse DNS. RIRs and some DNRs
register or expose nameserver information as an attribute of a domain
name, while other DNRs model nameservers as "first class objects".
The nameserver object class accommodates both models and degrees of
variation in between.
The following is an example of a nameserver object.
Newton & Hollenbeck Expires October 11, 2013 [Page 17]
Internet-Draft RDAP JSON RESPONSES April 2013
{
"handle" : "XXXX",
"ldhName" : "ns1.xn--fo-5ja.example",
"unicodeName" : "foo.example",
"status" : [ "active" ],
"ipAddresses" :
{
"v4": [ "192.0.2.1", "192.0.2.2" ],
"v6": [ "2001:db8::123" ]
},
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"links" :
[
{
"value" : "http://example.net/nameserver/xxxx",
"rel" : "self",
"href" : "http://example.net/nameserver/xxxx"
}
],
"port43" : "whois.example.net",
"events" :
[
{
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
},
{
"eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z",
"eventActor" : "joe@bob.com"
}
]
}
Figure 11
Figure 11 is an example of a nameserver object with all values given.
Registries using a first-class nameserver data model would embed this
Newton & Hollenbeck Expires October 11, 2013 [Page 18]
Internet-Draft RDAP JSON RESPONSES April 2013
in domain objects as well as allowing references to it with the "/
nameserver" query type (all depending on the registry operators
policy). Other registries may pare back the information as needed.
Figure 12 is an example of a nameserver object as would be found in
RIRs and some DNRs, while Figure 13 is an example of a nameserver
object as would be found in other DNRs.
The following is an example of the simplest nameserver object:
{
"ldhName" : "ns1.example.com"
}
Figure 12
The following is an example of a simple nameserver object that might
be commonly used by DNRs:
{
"ldhName" : "ns1.example.com",
"ipAddresses" : { "v6" : [ "2001:db8::123", "2001:db8::124" ] }
}
Figure 13
The nameserver object class has the following members:
o handle -- a string representing an registry unique identifier of
the nameserver
o ldhName -- a string containing the LDH name of the nameserver (see
Section 4)
o unicodeName -- a string containing a DNS unicode name of the
nameserver (see Section 4)
o ipAddresses -- an object containing the following members:
* v6 -- an array of strings containing IPv6 addresses of the
nameserver
* v4 -- an array of strings containing IPv4 addresses of the
nameserver
Newton & Hollenbeck Expires October 11, 2013 [Page 19]
Internet-Draft RDAP JSON RESPONSES April 2013
o status - see Section 5.6
o remarks - see Section 5.3
o links - see Section 5.2
o port43 - see Section 5.7
o events - see Section 5.5
6.3. The Domain Object Class
The domain object class represents a DNS name and point of
delegation. For RIRs these delegation points are in the reverse DNS
tree, whereas for DNRs these delegation points are in the forward DNS
tree.
In both cases, the high level structure of the domain object class
consists of information about the domain registration, nameserver
information related to the domain name, and entities related to the
domain name (e.g. registrant information, contacts, etc.).
The following is an elided example of the domain object showing the
high level structure:
{
"handle" : "XXX",
"ldhName" : "blah.example.com",
...
"nameServers" :
[
...
],
...
"entities" :
[
...
]
}
The following is a description of the members of this object:
o handle -- a string representing a registry unique identifier of
the domain object instance
Newton & Hollenbeck Expires October 11, 2013 [Page 20]
Internet-Draft RDAP JSON RESPONSES April 2013
o ldhName -- a string describing an domain name in LDH form as
described in Section 4
o unicodeName -- a string containing a domain name with u-labels as
described in Section 4
o variants -- an array of objects, each containing the following
values:
* relation -- an array of strings, with each string denoting the
relationship between the variants and the containing domain
object (see Appendix A.4 for a list of suggested variant
relations).
* variantNames -- an array of objects, with each object
containing an "ldhName" member and a "unicodeName" member (see
Section 4).
o nameservers -- an array of nameserver objects as defined by
Section 6.2
o delegationKeys -- an array of objects, each with the following
members:
* algorithm -- an integer as specified by the algorithm field of
a DNS DS record as specified by RFC 4034 [RFC4034] in
presentation format
* digest -- an string as specified by the digest field of a DNS
DS record as specified by RFC 4034 in presentation format
* digestType -- an integer as specified by the digest type field
of a DNS DS record as specified by RFC 4034 in presentation
format
* keyTag -- an integer as specified by the key tag field of a DNS
DS record as specified by RFC 4034 in presentation format
o entities -- an array of entity objects as defined by Section 6.1.
o status - see Section 5.6
o remarks - see Section 5.3
o links - see Section 5.2
o port43 - see Section 5.7
Newton & Hollenbeck Expires October 11, 2013 [Page 21]
Internet-Draft RDAP JSON RESPONSES April 2013
o events - see Section 5.5
The following is an example of a JSON domain object representing a
reverse DNS delegation point that might be served by an RIR:
{
"handle" : "XXXX",
"ldhName" : "192.in-addr.arpa",
"nameServers" :
[
{ "ldhName" : "ns1.rir.example" },
{ "ldhName" : "ns2.rir.example" }
],
"delegationKeys" :
[
{
"algorithm": 7,
"digest" : "E68C017BD813B9AE2F4DD28E61AD014F859ED44C",
"digestType" : 1,
"keyTag" : 53814
}
],
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"links" :
[
{
"value": "http://example.net/domain/XXXX",
"rel" : "self",
"href" : "http://example.net/domain/XXXXX"
}
],
"events" :
[
{
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
},
{
Newton & Hollenbeck Expires October 11, 2013 [Page 22]
Internet-Draft RDAP JSON RESPONSES April 2013
"eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z",
"eventActor" : "joe@bob.com"
}
],
"entities" :
[
{
"handle" : "XXXX",
"vCard" :
[
[ "version", {}, "text", "4.0" ],
[ "fn", {}, "text", "Joe Bob, Inc." ],
[ "fn", {}, "text", "Bobby Joe Shopping" ],
[ "label", {}, "text", "123 Maple Ave\n",
"Suite 90001\n",
"Vancouver\n",
"BC\n",
"1239\n" ],
[ "email", {}, "text", "joe at bob.com" ],
[ "email", {}, "text", "bob at joe.com" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4321" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4322" ],
[ "tel", { "type": "fax" }, "uri", "tel:+1-958-555-4323" ],
[ "tel", { "type": "cell" }, "uri", "tel:+1-958-555-4324" ],
],
"roles" : [ "registrant" ],
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"links" :
[
{
"value": "http://example.net/entity/xxxx",
"rel" : "self",
"href" : "http://example.net/entity/xxxx"
}
],
"events" :
[
{
Newton & Hollenbeck Expires October 11, 2013 [Page 23]
Internet-Draft RDAP JSON RESPONSES April 2013
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
},
{
"eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z",
"eventActor" : "joe@bob.com"
}
]
}
]
}
The following is an example of a JSON domain object representing a
forward DNS delegation point that might be served by a DNR:
{
"handle" : "XXXX",
"ldhName" : "xn--fo-5ja.example",
"unicodeName" : "foo.example",
"variants" :
[
{
"relation" : [ "registered", "conjoined" ],
"variantNames" :
[
{
"ldhName" : "xn--fo-cka.example",
"unicodeName" : "foo.example"
},
{
"ldhName" : "xn--fo-fka.example",
"unicodeName" : "foeo.example"
}
]
},
{
"relation" : [ "unregistered", "restricted registration" ],
"variantNames" :
[
{
"ldhName": "xn--fo-8ja.example",
"unicodeName" : "foo.example"
}
]
Newton & Hollenbeck Expires October 11, 2013 [Page 24]
Internet-Draft RDAP JSON RESPONSES April 2013
}
],
"status" : [ "locked", "transferProhibited" ],
"nameServers" :
[
{
"handle" : "XXXX",
"ldhName" : "ns1.example.com",
"status" : [ "active" ],
"ipAddresses" :
{
"v6": [ "2001:db8::123", "2001:db8::124" ],
"v4": [ "192.0.2.1", "192.0.2.2" ]
},
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"links" :
[
{
"value" : "http://example.net/nameserver/XXXX",
"rel" : "self",
"href" : "http://example.net/nameserver/XXXX"
}
],
"events" :
[
{
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
},
{
"eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z"
}
]
},
{
"handle" : "XXXX",
"ldhName" : "ns2.example.com",
"status" : [ "active" ],
Newton & Hollenbeck Expires October 11, 2013 [Page 25]
Internet-Draft RDAP JSON RESPONSES April 2013
"ipAddresses" :
{
"v6" : [ "2001:db8::125", "2001:db8::126" ],
"v4" : [ "192.0.2.3", "192.0.2.4" ]
},
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"links" :
[
{
"value" : "http://example.net/nameserver/XXXX",
"rel" : "self",
"href" : "http://example.net/nameserver/XXXX"
}
],
"events" :
[
{
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
},
{
"eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z"
}
]
}
],
"delegationKeys" :
[
{
"algorithm": 7,
"digest" : "E68C017BD813B9AE2F4DD28E61AD014F859ED44C",
"digestType" : 1,
"keyTag" : 53814
}
],
"remarks" :
[
{
Newton & Hollenbeck Expires October 11, 2013 [Page 26]
Internet-Draft RDAP JSON RESPONSES April 2013
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"links" :
[
{
"value": "http://example.net/domain/XXXX",
"rel" : "self",
"href" : "http://example.net/domain/XXXX"
}
],
"port43" : "whois.example.net",
"events" :
[
{
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
},
{
"eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z",
"eventActor" : "joe@bob.com"
},
{
"eventAction" : "transfer",
"eventDate" : "1991-12-31T23:59:60Z",
"eventActor" : "joe@bob.com"
},
{
"eventAction" : "expiration",
"eventDate" : "2016-12-31T23:59:60Z",
"eventActor" : "joe@bob.com"
}
],
"entities" :
[
{
"handle" : "XXXX",
"vCard" :
[
[ "version", {}, "text", "4.0" ],
[ "fn", {}, "text", "Joe Bob, Inc." ],
[ "fn", {}, "text", "Bobby Joe Shopping" ],
[ "label", {}, "text", "123 Maple Ave\n",
Newton & Hollenbeck Expires October 11, 2013 [Page 27]
Internet-Draft RDAP JSON RESPONSES April 2013
"Suite 90001\n",
"Vancouver\n",
"BC\n",
"1239\n" ],
[ "email", {}, "text", "joe at bob.com" ],
[ "email", {}, "text", "bob at joe.com" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4321" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4322" ],
[ "tel", { "type": "fax" }, "uri", "tel:+1-958-555-4323" ],
[ "tel", { "type": "cell" }, "uri", "tel:+1-958-555-4324" ],
],
"status" : [ "validated", "locked" ],
"roles" : [ "registrant" ],
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"links" :
[
{
"value" : "http://example.net/entity/xxxx",
"rel" : "self",
"href" : "http://example.net/entity/xxxx"
}
],
"events" :
[
{
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
},
{
"eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z"
}
]
}
]
}
Newton & Hollenbeck Expires October 11, 2013 [Page 28]
Internet-Draft RDAP JSON RESPONSES April 2013
6.4. The IP Network Object Class
The IP Network object class models IP network registrations found in
RIRs and is the expected response for the "/ip" query as defined by
[I-D.ietf-weirds-rdap-query]. There is no equivalent object class
for DNRs. The high level structure of the IP network object class
consists of information about the network registration and entities
related to the IP network (e.g. registrant information, contacts,
etc...).
The following is an elided example of the IP network object type
showing the high level structure:
{
"handle" : "XXX",
...
"entities" :
[
...
]
}
The following is an example of the JSON object for the network
registration information
{
"handle" : "XXXX-RIR",
"startAddress" : "2001:db8::0",
"endAddress" : "2001:db8::0:FFFF:FFFF:FFFF:FFFF:FFFF",
"ipVersion" : "v6",
"name": "NET-RTR-1",
"description" : [ "A network used for routing" ],
"type" : "DIRECT ALLOCATION",
"country" : "AU",
"parentHandle" : "YYYY-RIR",
"status" : [ "allocated" ],
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
Newton & Hollenbeck Expires October 11, 2013 [Page 29]
Internet-Draft RDAP JSON RESPONSES April 2013
}
],
"links" :
[
{
"value" : "http://example.ent/ip/2001:db8::/48",
"rel" : "self",
"href" : "http://example.net/ip/2001:db8::/48"
},
{
"value" : "http://example.net/ip/2001:db8::/48",
"rel" : "up",
"href" : "http://example.net/ip/2001:C00::/23"
}
],
"events" :
[
{
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
},
{
"eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z"
}
],
"entities" :
[
{
"handle" : "XXXX",
"vCard" :
[
[ "version", {}, "text", "4.0" ],
[ "fn", {}, "text", "Joe Bob, Inc." ],
[ "fn", {}, "text", "Bobby Joe Shopping" ],
[ "label", {}, "text", "123 Maple Ave\n",
"Suite 90001\n",
"Vancouver\n",
"BC\n",
"1239\n" ],
[ "email", {}, "text", "joe at bob.com" ],
[ "email", {}, "text", "bob at joe.com" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4321" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4322" ],
[ "tel", { "type": "fax" }, "uri", "tel:+1-958-555-4323" ],
[ "tel", { "type": "cell" }, "uri", "tel:+1-958-555-4324" ],
],
"roles" : [ "registrant" ],
Newton & Hollenbeck Expires October 11, 2013 [Page 30]
Internet-Draft RDAP JSON RESPONSES April 2013
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"links" :
[
{
"value" : "http://example.net/entity/xxxx",
"rel" : "self",
"href" : "http://example.net/entity/xxxx"
}
],
"events" :
[
{
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
},
{
"eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z"
}
]
}
]
}
The following is a description of the members of this object:
o handle -- a string representing an RIR unique identifier of the
network registration
o startAddress -- the starting IP address of the network, either
IPv4 or IPv6
o endAddress -- the ending IP address of the network, either IPv4 or
IPv6
Newton & Hollenbeck Expires October 11, 2013 [Page 31]
Internet-Draft RDAP JSON RESPONSES April 2013
o ipVersion -- an string signifying the IP protocol version of the
network: "v4" signifying an IPv4 network, "v6" signifying an IPv6
network
o name -- an identifier assigned to the network registration by the
registration holder
o description -- an array of strings containing descriptive text
about the network registration
o type -- a string containing an RIR-specific classification of the
network
o country -- a string containing the name of the 2 character country
code of the network
o parentHandle -- a string containing an RIR-unique identifier of
the parent network of this network registration
o status -- an array of strings indicating the state of the IP
network
o entities -- an array of entity objects as defined by Section 6.1.
o remarks - see Section 5.3
o links - see Section 5.2
o events - see Section 5.5
6.5. Autonomous System Number Entity Object Class
The Autonomous System Number (autnum) object class models Autonomous
System Number registrations found in RIRs and represents the expected
response to an "/autnum" query as defined by
[I-D.ietf-weirds-rdap-query]. There is no equivalent object class
for DNRs. The high level structure of the autnum object class
consists of information about the network registration and entities
related to the autnum registration (e.g. registrant information,
contacts, etc.), and is similar to the IP Network entity object
class.
The following is an example of a JSON object representing an autnum.
{
"handle" : "XXXX-RIR",
"startAutnum" : "10",
Newton & Hollenbeck Expires October 11, 2013 [Page 32]
Internet-Draft RDAP JSON RESPONSES April 2013
"endAutnum" : "15",
"name": "AS-RTR-1",
"description" : [ "AS for Exchange" ],
"type" : "DIRECT ALLOCATION",
"country": "AU",
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"links" :
[
{
"value" : "http://example.net/autnum/xxxx",
"rel" : "self",
"href" : "http://example.net/autnum/xxxx"
}
],
"events" :
[
{
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
},
{
"eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z"
}
],
"entities" :
[
{
"handle" : "XXXX",
"vCard" :
[
[ "version", {}, "text", "4.0" ],
[ "fn", {}, "text", "Joe Bob, Inc." ],
[ "fn", {}, "text", "Bobby Joe Shopping" ],
[ "label", {}, "text", "123 Maple Ave\n",
"Suite 90001\n",
"Vancouver\n",
"BC\n",
"1239\n" ],
Newton & Hollenbeck Expires October 11, 2013 [Page 33]
Internet-Draft RDAP JSON RESPONSES April 2013
[ "email", {}, "text", "joe at bob.com" ],
[ "email", {}, "text", "bob at joe.com" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4321" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4322" ],
[ "tel", { "type": "fax" }, "uri", "tel:+1-958-555-4323" ],
[ "tel", { "type": "cell" }, "uri", "tel:+1-958-555-4324" ],
],
"roles" : [ "registrant" ],
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"links" :
[
{
"value" : "http://example.net/entity/XXXX",
"rel" : "self",
"href" : "http://example.net/entity/XXXX"
}
],
"events" :
[
{
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
},
{
"eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z"
}
]
}
]
}
The following is a description of the members of this object:
o handle -- a string representing an RIR-unique identifier of the
autnum registration
Newton & Hollenbeck Expires October 11, 2013 [Page 34]
Internet-Draft RDAP JSON RESPONSES April 2013
o startAutnum -- the starting number [RFC5396] in the block of
autonomous system numbers
o endAutnum -- the ending number [RFC5396] in the block of
autonomous system numbers
o name -- an identifier assigned to the autnum registration by the
registration holder
o description -- an array of strings containing descriptive text
about the autnum registration
o type -- a string containing an RIR-specific classification of the
autnum
o country -- a string containing the name of the 2 character country
code of the autnum
o remarks - see Section 5.3
o links - see Section 5.2
o events - see Section 5.5
7. Error Response Body
Some non-answer responses may return entity bodies with information
that could be more descriptive.
The basic structure of that response is an object class containing an
error code number (corresponding to the HTTP response code) followed
by a string named "title" followed by an array of strings named
"description".
This is an example of the JSON version of the common response body:
{
"errorCode": 418,
"title": "Your beverage choice is not available",
"description":
[
"I know coffee has more ummppphhh.",
"But I cannot provide."
]
}
Figure 14
Newton & Hollenbeck Expires October 11, 2013 [Page 35]
Internet-Draft RDAP JSON RESPONSES April 2013
A client MAY simply use the HTTP response code as the server is not
required to include error data in the response body. However, if a
client wishes to parse the error data, it SHOULD first check that the
Content-Type header contains the appropriate media type.
8. IANA Considerations
None.
9. Security Considerations
This specification models information serialized in JSON format. As
JSON is a subset of Javascript, implementations are advised to follow
the security considerations outlined in Section 6 of [RFC4627] to
prevent code injection.
10. Internationalization Considerations
10.1. Character Encoding
The default text encoding for JSON and XML responses in RDAP is
UTF-8, and all servers and clients MUST support UTF-8. Servers and
clients MAY optionally support other character encodings.
10.2. URIs and IRIs
[I-D.ietf-weirds-using-http] defines the use of URIs and IRIs in
RDAP.
10.3. Language Tags
Section 5.4 defines the use of language tags in the JSON responses
defined in this document.
10.4. Internationalized Domain Names
Internationalized Domain Names (IDNs) are denoted in this
specification by the separation of DNS names in LDH form and Unicode
form (see Section 4). Representation of IDNs in registries is
described by the "variants" object in Section 6.3 and the suggested
values listed in Appendix A.4.
11. Privacy Considerations
Newton & Hollenbeck Expires October 11, 2013 [Page 36]
Internet-Draft RDAP JSON RESPONSES April 2013
This specification suggests status values to denote contact and
registrant information that has been marked as private and/or has
been redacted or obscured. See Appendix A.1 for the list of status
values. See Appendix B.1 on guidance to apply those values to
contacts and registrants.
12. Contributing Authors and Acknowledgements
This document is derived from original work on RIR responses in JSON
by Byron J. Ellacott, Arturo L. Servin, Kaveh Ranjbar, and Andrew
L. Newton. Additionally, this document incorporates word on DNR
responses in JSON by Ning Kong, Linlin Zhou, Jiagui Xie, and Sean
Shen.
The components of the DNR object classes are derived from a
categorization of WHOIS response formats created by Ning Kong, Linlin
Zhou, and Guangqing Deng, Steve Sheng and Francisco Arias, Ray
Bellis, and Frederico Neves.
Ed Lewis contributed significant review comments and provided
clarifying text. James Mitchel provided text regarding the
processing of unknown JSON attributes and identified issues leading
to the remodeling of events. Ernie Dainow and Francisco Obispo
provided concrete suggestions that led to a better variant model for
domain names.
The switch to and incorporation of JSON vCard was performed by Simon
Perreault.
13. References
13.1. Normative References
[RFC0791] Postel, J., "Internet Protocol", STD 5, RFC 791, September
1981.
[RFC1166] Kirkpatrick, S., Stahl, M., and M. Recker, "Internet
numbers", RFC 1166, July 1990.
[RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
[RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the
Internet: Timestamps", RFC 3339, July 2002.
Newton & Hollenbeck Expires October 11, 2013 [Page 37]
Internet-Draft RDAP JSON RESPONSES April 2013
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66, RFC
3986, January 2005.
[RFC4034] Arends, R., Austein, R., Larson, M., Massey, D., and S.
Rose, "Resource Records for the DNS Security Extensions",
RFC 4034, March 2005.
[RFC4343] Eastlake, D., "Domain Name System (DNS) Case Insensitivity
Clarification", RFC 4343, January 2006.
[RFC4627] Crockford, D., "The application/json Media Type for
JavaScript Object Notation (JSON)", RFC 4627, July 2006.
[RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322,
October 2008.
[RFC5396] Huston, G. and G. Michaelson, "Textual Representation of
Autonomous System (AS) Numbers", RFC 5396, December 2008.
[RFC5646] Phillips, A. and M. Davis, "Tags for Identifying
Languages", BCP 47, RFC 5646, September 2009.
[RFC5890] Klensin, J., "Internationalized Domain Names for
Applications (IDNA): Definitions and Document Framework",
RFC 5890, August 2010.
[RFC5952] Kawamura, S. and M. Kawashima, "A Recommendation for IPv6
Address Text Representation", RFC 5952, August 2010.
[RFC5988] Nottingham, M., "Web Linking", RFC 5988, October 2010.
[I-D.kewisch-vcard-in-json]
Kewisch, P., "jCard: The JSON format for vCard", draft-
kewisch-vcard-in-json-01 (work in progress), March 2013.
[ISO.3166.1988]
International Organization for Standardization, "Codes for
the representation of names of countries, 3rd edition",
ISO Standard 3166, August 1988.
[I-D.ietf-weirds-rdap-query]
Newton, A. and S. Hollenbeck, "RDAP Query Format", draft-
ietf-weirds-rdap-query-00 (work in progress), September
2011.
[I-D.ietf-weirds-using-http]
Newton & Hollenbeck Expires October 11, 2013 [Page 38]
Internet-Draft RDAP JSON RESPONSES April 2013
Newton, A., Ellacott, B., and N. Kong, "Using HTTP for
RESTful Whois Services by Internet Registries", draft-
ietf-weirds-using-http-01 (work in progress), May 2012.
13.2. Informative References
[RFC3912] Daigle, L., "WHOIS Protocol Specification", RFC 3912,
September 2004.
[RFC3730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)",
RFC 3730, March 2004.
[JSON_acendancy]
MacVittie, , "The Stealthy Ascendancy of JSON", 04 2011.
[JSON_performance_study]
Montana State University - Bozeman, Montana State
University - Bozeman, Montana State University - Bozeman,
Montana State University - Bozeman, "Comparison of JSON
and XML Data Interchange Formats: A Case Study", 2009.
Appendix A. Suggested Values
Due to the wide variation between the hundreds of registry operators
and the on-going policy refinement by registry communities, values of
some data cannot be formally standardized. This section lists
suggested values for such data but is not nor will ever be a complete
list of values and their meanings.
A.1. Status
Many of the object classes have a member named 'status'. This member
is an array of strings, with each string denoting a status associated
with the containing object. The following is a list of suggested
values to use in the 'status' array:
o 'validated' -- Signifies that the data of the object instance has
been found to be accurate. This type of status is usually found
on entity object instances to note the validity of identifying
contact information.
o 'update prohibited' -- Updates to the object instance are
forbidden.
o 'transfer prohibited' -- Transfers of the registration from one
registrar to another are forbidden. This type of status normally
applies to DNR domain names.
Newton & Hollenbeck Expires October 11, 2013 [Page 39]
Internet-Draft RDAP JSON RESPONSES April 2013
o 'delete prohibited' -- Deletion of the registration of the object
instance is forbidden. This type of status normally applies to
DNR domain names.
o 'proxy' -- The registration of the object instance has been
performed by a third party. This is most commonly applied to
entities.
o 'private' -- The information of the object instance is not
designated for public consumption. This is most commonly applied
to entities.
o 'redacted' -- Some of the information of the object instance has
not been made available. This is most commonly applied to
entities.
o 'obscured' -- Some of the information of the object instance has
been altered for the purposes of not readily revealing the actual
information of the object instance. This is most commonly applied
to entities.
A.2. Event Actions
Section 5.5 describes a data structure for denoting events against
object classes. Each event can have an event action, which is a
string. The following is a list of suggested values to use for event
actions:
o 'registration' -- the object instance was initially registered
o 'reregistration' -- the object instance was registered
subsequently to initial registration
o 'last changed' -- when the information in the object instance was
last changed
o 'expiration' -- the object instance has been removed or will be
removed at a pre-determined date and time from the registry
o 'deletion' -- the object instance was removed from the registry at
a point in time that was not pre-determined
o 'reinstantation' -- the object instance was reregistered after
having been removed from the registry
o 'transfer' -- the object instance was transfered from one
registrant to another
Newton & Hollenbeck Expires October 11, 2013 [Page 40]
Internet-Draft RDAP JSON RESPONSES April 2013
A.3. Roles
Entity object classes have a member named 'roles'. This member is an
array of strings, with each string indicating the role or
relationship the entity object instance has with a containing object,
such as a domain name or IP network. An entity object instance can
have more than one type of relationship with a containing object.
The following is a list of suggested values to use in the 'roles'
array:
o 'registrant' -- The entity object instance is the registrant of
the registration.
o 'tech' -- The entity object instance is a technical contact for
the registration.
o 'admin' -- The entity object instance is an administrative contact
for the registration.
o 'abuse' -- The entity object instance handles network abuse issues
on behalf of the registrant of the registration.
o 'billing' -- The entity object instance handles payment and
billing issues on behalf of the registrant of the registration.
o 'registrar' -- The entity object instance represents the authority
responsible for the registration in the registry.
o 'reseller' -- The entity object instance represents a third party
through which the registration was conducted (i.e. not the
registry or registrar).
o 'sponsor' -- The entity object instance represents a domain policy
sponsor, such as an ICANN approved sponsor
A.4. Variant Relations
Section 6.3 describes a structure for noting variants of domain names
and the relationship those variants have with a registered domain
name. The following is a list of suggested values to use as the
variant relation values:
o 'registered' -- the variant names are registered in the registry.
o 'unregistered' -- the variant names are not found in the registry.
o 'restricted registration' -- registration of the variant names is
restricted to certain parties or within certain rules.
Newton & Hollenbeck Expires October 11, 2013 [Page 41]
Internet-Draft RDAP JSON RESPONSES April 2013
o 'open registration' -- registration of the variant names is
available to generally qualified registrants.
o 'conjoined' -- registration of the variant names is occurs
automatically with the registration of the containing domain
registration.
Appendix B. Suggested Data Modeling with the Entity Object Class
B.1. Registrants and Contacts
This document does not provide specific object classes for
registrants and contacts. Instead the entity object class may be
used to represent a registrant or contact. When the entity object is
embedded inside a containing object such as a domain name or IP
network, the 'roles' string array can be used to signify the
relationship. It is recommended that the values from Appendix A.3 be
used.
The following is an example of an elided containing object with an
embedded entity that is both a registrant and admin contact:
{
...
"entities" :
[
{
"handle" : "XXXX",
"vCard" :
[
[ "version", {}, "text", "4.0" ],
[ "fn", {}, "text", "Joe Bob, Inc." ],
[ "fn", {}, "text", "Bobby Joe Shopping" ],
[ "label", {}, "text", "123 Maple Ave\n",
"Suite 90001\n",
"Vancouver\n",
"BC\n",
"1239\n" ],
[ "email", {}, "text", "joe at bob.com" ],
[ "email", {}, "text", "bob at joe.com" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4321" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4322" ],
[ "tel", { "type": "fax" }, "uri", "tel:+1-958-555-4323" ],
[ "tel", { "type": "cell" }, "uri", "tel:+1-958-555-4324" ],
],
"roles" : [ "registrant", "admin" ],
"remarks" :
Newton & Hollenbeck Expires October 11, 2013 [Page 42]
Internet-Draft RDAP JSON RESPONSES April 2013
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"events" :
[
{
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
},
{
"eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z"
}
]
}
]
}
In many use cases, it is necessary to hide or obscure the information
of a registrant or contact due to policy or other operational
matters. Registries can denote these situations with 'status' values
(see Appendix A.1).
Newton & Hollenbeck Expires October 11, 2013 [Page 43]
Internet-Draft RDAP JSON RESPONSES April 2013
The following is an elided example of a registrant with information
changed to reflect that of a third party.
{
...
"entities" :
[
{
"handle" : "XXXX",
...
"roles" : [ "registrant", "admin" ],
"status" : [ "proxy", "private", "obscured" ]
}
]
}
B.2. Registrars
This document does not provide a specific object class for
registrars, but like registrants and contacts (see Appendix B.1) the
'roles' string array maybe used.
The following is an example of an elided containing object with an
embedded entity that is a registrar:
Newton & Hollenbeck Expires October 11, 2013 [Page 44]
Internet-Draft RDAP JSON RESPONSES April 2013
{
...
"entities" :
[
{
"handle" : "XXXX",
"vCard" :
[
[ "version", {}, "text", "4.0" ],
[ "fn", {}, "text", "RegistrarsRUS" ],
[ "label", {}, "text", "1212 Tulip Ave\n",
"Suite 1\n",
"Marina Del Rey\n",
"CA\n",
"12393-2193" ],
[ "email", {}, "text", "joe at bob.com" ],
[ "email", {}, "text", "bob at joe.com" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4321" ],
[ "tel", { "type": "work" }, "uri", "tel:+1-958-555-4322" ],
[ "tel", { "type": "fax" }, "uri", "tel:+1-958-555-4323" ],
[ "tel", { "type": "cell" }, "uri", "tel:+1-958-555-4324" ],
],
"roles" : [ "registrar" ],
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
],
"links" :
[
{
"value" : "http://example.net/entity/XXXX",
"rel" : "alternate",
"type" : "text/html",
"href" : "http://www.example.com"
}
]
}
]
}
Newton & Hollenbeck Expires October 11, 2013 [Page 45]
Internet-Draft RDAP JSON RESPONSES April 2013
Appendix C. Modeling Events
Events represent actions that have taken place against a registered
object at a certain date and time. Events have three properties: the
action, the actor, and the date and time of the event (which is
sometimes in the future). In some cases the identity of the actor is
not captured.
Events can be modeled in three ways:
1. events with no designated actor
2. events where the actor is only designated by an identifier
3. events where the actor can be modeled as an entity
For the first use case, the 'events' data structure (Section 5.5) is
used without the 'eventActor' object member.
This is an example of an "events" array without the 'eventActor'.
"events" :
[
{
"eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z"
}
]
Figure 15
For the second use case, the 'events' data structure (Section 5.5) is
used with the 'eventActor' object member.
This is an example of an "events" array with the 'eventActor'.
"events" :
[
{
"eventAction" : "registration",
"eventActor" : "XYZ-NIC",
"eventDate" : "1990-12-31T23:59:60Z"
}
]
Figure 16
Newton & Hollenbeck Expires October 11, 2013 [Page 46]
Internet-Draft RDAP JSON RESPONSES April 2013
For the third use case, the 'asEventActor' array is used when an
entity (Section 6.1) is embedded into another object class. The
'asEventActor' array follows the same structure as the 'events' array
but does not have 'eventActor' attributes.
The following is an elided example of a domain object with an entity
as an event actor.
{
"handle" : "XXXX",
"ldhName" : "foo.example",
"status" : [ "locked", "transfer Prohibited" ],
...
"entities" :
[
{
"handle" : "XXXX",
...
"asEventActor" :
[
{
"eventAction" : "last changed",
"eventDate" : "1990-12-31T23:59:60Z"
}
]
}
]
}
Appendix D. Motivations for Using JSON
This section addresses a common question regarding the use of JSON
over other data formats, most notably XML.
It is often pointed out that many DNRs and one RIR support the EPP
[RFC3730] standard, which is an XML serialized protocol. The logic
is that since EPP is a common protocol in the industry it follows
that XML would be a more natural choice. While EPP does influence
this specification quite a bit, EPP serves a different purpose which
is the provisioning of Internet resources between registries and
accredited registrars and serves a much narrower audience than that
envisioned for RDAP.
By contrast, RDAP has a broader audience and is designed for public
consumption of data. Experience from RIRs with first generation
Newton & Hollenbeck Expires October 11, 2013 [Page 47]
Internet-Draft RDAP JSON RESPONSES April 2013
RESTful web services for Whois indicate a large percentage of clients
operate within browsers and other platforms where full-blown XML
stacks are not readily available and where JSON is a better fit.
Additionally, while EPP is used in much of the DNR community it is
not a universal constant in that industry. And finally, EPP's use of
XML predates the specification of JSON. If EPP had been defined
today, it may very well have used JSON instead of XML.
Beyond the specific DNR and RIR communities, the trend in the broader
Internet industry is also switching to JSON over XML, especially in
the area of RESTful web services (see [JSON_acendancy]). Studies
have also found that JSON is generally less bulky and consequently
faster to parse (see [JSON_performance_study]).
Appendix E. Changelog
Initial -00 Adopted as working group document 2012-September-18.
-01
Minor spelling corrections. Changed "Registry Data" to
"Registration Data" for the sake of consistency.
Transitioned to RFC 5988 links and relationship types from our
own custom "uris" structure.
Some examples had 'status' as a string. Those have been
corrected as 'status' is always an array of strings.
Domain variants can now have a multi-valued relationship with
domain registrations.
"names" in the entity object class was changed to
"entityNames".
Some IP address examples change to IPv6.
Change phone number examples and added reference to E.164.
Added section on motivations for using JSON.
Added error response body section.
Added JSON naming section.
Added common data structures section.
Newton & Hollenbeck Expires October 11, 2013 [Page 48]
Internet-Draft RDAP JSON RESPONSES April 2013
Added the IANA Considerations section and the media type
registration.
Added 'lang' name/value.
Added internationalization considerations section.
-02
Removed level from media type registration.
Textual changes as given by Ed Lewis.
Fixed object class linking example noted by Francisco Obispo
Fixed a lot of other examples called out by Alex Sergeyev
Added a note that JSON names are case sensitive
Added 'status' to IP networks as suggested by Alex Sergeyev
-03
Added jCard verbiage and examples and deleted overlapping
contact information and the appendix on postal addresses
Removed the IANA considerations as they have been moved to
another document
Changed the remarks structure to be like notices
Reordering and rewording some of the sections so they flow
better
Added note about object class "self" links
Changed ipAddresses in nameserver object class to separate out
v6 from v4
Changed IP network version identifier from integer to string to
be more consistent with ipAddresses identifier in nameserver
object classes
Changed DNS names to LDH names and Unicode names
Modified the definition of 'conjoined' variant relationship so
it was circular
Newton & Hollenbeck Expires October 11, 2013 [Page 49]
Internet-Draft RDAP JSON RESPONSES April 2013
Added 'proxy', 'private', 'redacted', and 'obscured' status
values (most useful for entities).
Added a privacy considerations section
Added a security considerations section
Added 'reseller' and 'sponsor' to the list of entity roles
Added the 'events' common data structure
Added 'asEventActor' to entities
Added appendix on event modeling
Removed the subclasses/superclassing between RIRs/DNRs for
entity and domain object classes
Change suggested status/relation/etc values to be case/spacing
consistent
Normalized some of the definitions of object class members
Modifying the JSON signaling section to reference the guidance
in draft-ietf-weirds-using-http
Changed the text regarding the process of unknown JSON
attributes
Authors' Addresses
Andrew Lee Newton
American Registry for Internet Numbers
3635 Concorde Parkway
Chantilly, VA 20151
US
Email: andy@arin.net
URI: http://www.arin.net
Newton & Hollenbeck Expires October 11, 2013 [Page 50]
Internet-Draft RDAP JSON RESPONSES April 2013
Scott Hollenbeck
Verisign Labs
12061 Bluemont Way
Reston, VA 20190
US
Email: shollenbeck@verisign.com
URI: http://www.verisignlabs.com/
Newton & Hollenbeck Expires October 11, 2013 [Page 51]