draft-ietf-weirds-json-response-00.txt   draft-ietf-weirds-json-response-01.txt 
Network Working Group A. Newton Network Working Group A. Newton
Internet-Draft ARIN Internet-Draft ARIN
Intended status: Standards Track S. Hollenbeck Intended status: Standards Track S. Hollenbeck
Expires: March 23, 2013 Verisign Labs Expires: June 5, 2013 Verisign Labs
September 19, 2012 December 2, 2012
JSON Responses for the Registy Data Access Protocol (RDAP) JSON Responses for the Registration Data Access Protocol (RDAP)
draft-ietf-weirds-json-response-00 draft-ietf-weirds-json-response-01
Abstract Abstract
This document describes responses in the JSON format to the Registry This document describes JSON data structures representing
Data Access Protocol (RDAP) queries described in registration information maintained by Regional Internet Registries
draft-ietf-weirds-rdap-query. (RIRs) and Domain Name Registries (DNRs). These data structures are
used to form Registration Data Access Protocol (RDAP) query
responses.
Status of this Memo Status of this Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on March 23, 2013. This Internet-Draft will expire on June 5, 2013.
Copyright Notice Copyright Notice
Copyright (c) 2012 IETF Trust and the persons identified as the Copyright (c) 2012 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Terminology and Definitions . . . . . . . . . . . . . . . . . 4 2. Terminology and Definitions . . . . . . . . . . . . . . . . . 5
3. Common Data Types . . . . . . . . . . . . . . . . . . . . . . 5 3. Common Data Types . . . . . . . . . . . . . . . . . . . . . . 6
4. The Entity Object Class . . . . . . . . . . . . . . . . . . . 6 4. Use of JSON . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.1. The RIR Entity Object Class . . . . . . . . . . . . . . . 7 4.1. Signaling . . . . . . . . . . . . . . . . . . . . . . . . 8
4.2. The DNR Entity Object Class . . . . . . . . . . . . . . . 9 4.2. Naming . . . . . . . . . . . . . . . . . . . . . . . . . . 8
5. The Nameserver Object Class . . . . . . . . . . . . . . . . . 11 5. Common Data Structures . . . . . . . . . . . . . . . . . . . . 10
6. The Domain Object Class . . . . . . . . . . . . . . . . . . . 13 5.1. RDAP Conformance . . . . . . . . . . . . . . . . . . . . . 10
6.1. The RIR Domain Object Class . . . . . . . . . . . . . . . 13 5.2. Notices . . . . . . . . . . . . . . . . . . . . . . . . . 10
6.2. The DNR Domain Object Class . . . . . . . . . . . . . . . 16 5.3. Language Identifier . . . . . . . . . . . . . . . . . . . 11
7. The IP Network Object Class . . . . . . . . . . . . . . . . . 20 5.4. An Example . . . . . . . . . . . . . . . . . . . . . . . . 12
8. Autonomous System Number Entity Object Class . . . . . . . . . 23 6. Object Class Links . . . . . . . . . . . . . . . . . . . . . . 13
9. Contributing Authors and Acknowledgements . . . . . . . . . . 26 7. The Entity Object Class . . . . . . . . . . . . . . . . . . . 14
10. References . . . . . . . . . . . . . . . . . . . . . . . . . . 27 7.1. The RIR Entity Object Class . . . . . . . . . . . . . . . 15
10.1. Normative References . . . . . . . . . . . . . . . . . . . 27 7.2. The DNR Entity Object Class . . . . . . . . . . . . . . . 16
10.2. Informative References . . . . . . . . . . . . . . . . . . 28 8. The Nameserver Object Class . . . . . . . . . . . . . . . . . 19
Appendix A. Suggested Values . . . . . . . . . . . . . . . . . . 29 9. The Domain Object Class . . . . . . . . . . . . . . . . . . . 21
A.1. Status . . . . . . . . . . . . . . . . . . . . . . . . . . 29 9.1. The RIR Domain Object Class . . . . . . . . . . . . . . . 21
A.2. Roles . . . . . . . . . . . . . . . . . . . . . . . . . . 29 9.2. The DNR Domain Object Class . . . . . . . . . . . . . . . 24
A.3. URI Types . . . . . . . . . . . . . . . . . . . . . . . . 30 10. The IP Network Object Class . . . . . . . . . . . . . . . . . 29
11. Autonomous System Number Entity Object Class . . . . . . . . . 32
12. Error Response Body . . . . . . . . . . . . . . . . . . . . . 35
13. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 36
14. Internationalization Considerations . . . . . . . . . . . . . 37
14.1. Character Encoding . . . . . . . . . . . . . . . . . . . . 37
14.2. URIs and IRIs . . . . . . . . . . . . . . . . . . . . . . 37
14.3. Language Tags . . . . . . . . . . . . . . . . . . . . . . 37
14.4. Internationalized Domain Names . . . . . . . . . . . . . . 37
15. Contributing Authors and Acknowledgements . . . . . . . . . . 38
16. References . . . . . . . . . . . . . . . . . . . . . . . . . . 39
16.1. Normative References . . . . . . . . . . . . . . . . . . . 39
16.2. Informative References . . . . . . . . . . . . . . . . . . 40
Appendix A. Suggested Values . . . . . . . . . . . . . . . . . . 41
A.1. Status . . . . . . . . . . . . . . . . . . . . . . . . . . 41
A.2. Roles . . . . . . . . . . . . . . . . . . . . . . . . . . 41
A.3. Variant Relations . . . . . . . . . . . . . . . . . . . . 42
Appendix B. Suggested Data Modeling with the Entity Object Appendix B. Suggested Data Modeling with the Entity Object
Class . . . . . . . . . . . . . . . . . . . . . . . . 31 Class . . . . . . . . . . . . . . . . . . . . . . . . 43
B.1. Registrants and Contacts . . . . . . . . . . . . . . . . . 31 B.1. Registrants and Contacts . . . . . . . . . . . . . . . . . 43
B.2. Registrars . . . . . . . . . . . . . . . . . . . . . . . . 32 B.2. Registrars . . . . . . . . . . . . . . . . . . . . . . . . 44
Appendix C. IDN Query and Response Model . . . . . . . . . . . . 34 Appendix C. IDN Query and Response Model . . . . . . . . . . . . 46
Appendix D. Postal Addresses vs Location . . . . . . . . . . . . 35 Appendix D. Postal Addresses vs Location . . . . . . . . . . . . 47
Appendix E. Changelog . . . . . . . . . . . . . . . . . . . . . . 36 Appendix E. Motivations for Using JSON . . . . . . . . . . . . . 48
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 37 Appendix F. Changelog . . . . . . . . . . . . . . . . . . . . . . 49
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 50
1. Introduction 1. Introduction
This document describes responses in the JSON [RFC4627] format for This document describes responses in the JSON [RFC4627] format for
the RESTful web queries as defined by UNIFIED-RDAP-QUERY the RESTful web queries as defined by UNIFIED-RDAP-QUERY
[I-D.ietf-weirds-rdap-query]. The signalling for JSON, JSON naming [I-D.ietf-weirds-rdap-query].
scheme, JSON namespace and extension mechanism and normalized
references to other specifications are documented in RDAP-HTTP
[I-D.ietf-weirds-using-http].
The data model for the responses consists of two major categories: The data model for the responses consists of two major categories:
responses returned by Regional Internet Registries (RIRs) for responses returned by Regional Internet Registries (RIRs) for
registrations data related to IP addresses, reverse DNS names, and registrations data related to IP addresses, reverse DNS names, and
Autonomous System numbers; and responses returned by Domain Name Autonomous System numbers; and responses returned by Domain Name
Registries (DNRs) for registration data related to forward DNS names. Registries (DNRs) for registration data related to forward DNS names.
Where overlap exists between RIR and DNR reponse object classes, the Where overlap exists between RIR and DNR response object classes, the
RIR object classes are a proper subset of the DNR object classes. RIR object classes are a proper subset of the DNR object classes.
The current division between RIR and DNR object classes is given to The current division between RIR and DNR object classes is given to
illustrate an expectation of what data may be expected from an RIR vs illustrate an expectation of what data may be expected from an RIR vs
a DNR. However, implementers should be aware that RIRs are not a DNR. However, implementers should be aware that RIRs are not
limited to the data in the RIR object classes (as an example, some limited to the data in the RIR object classes (as an example, some
RIRs have a notion of "status" for entities as defined in the DNR RIRs have a notion of "status" for entities as defined in the DNR
entity object class and may at some point start publishing that entity object class and may at some point start publishing that
data). data).
Object classes defined in this document do not represent the full Object classes defined in this document do not represent the full
range of data that any registry may wish to publish. RDAP-HTTP range of data that any registry may wish to publish. Section 4.2
[I-D.ietf-weirds-using-http] defines a JSON extension mechanism that defines a JSON extension mechanism that maybe used by registries to
maybe used by registries to insert registry specific data values. insert registry specific data values.
2. Terminology and Definitions 2. Terminology and Definitions
The following list describes terminology and definitions used The following list describes terminology and definitions used
throughout this document: throughout this document:
DNR: "Domain Name Registry". DNR: "Domain Name Registry".
member: data found with in an object as defined by JSON member: data found with in an object as defined by JSON
[RFC4627]. [RFC4627].
object: a data structure 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 object class: the definition of members that may be found in JSON
objects described in this document. objects described in this document.
object instance: an instantiation or specific instance of an object object instance: an instantiation or specific instance of an object
class. class.
RDAP: "Registry Data Access Protocol". RDAP: "Registration Data Access Protocol".
RIR: "Regional Internet Registry". RIR: "Regional Internet Registry".
3. Common Data Types 3. Common Data Types
JSON [RFC4627] defines the data types of a number, character string, JSON [RFC4627] defines the data types of a number, character string,
boolean, array, object and null. This section describes the boolean, array, object and null. This section describes the
semantics and/or syntax reference for data types used in this semantics and/or syntax reference for data types used in this
document derived from the JSON character string. document derived from the JSON character string.
'handle': DNRs and RIRs have registry-unique identifiers that may 'handle': DNRs and RIRs have registry-unique identifiers that may
be used to specifically reference an object instance. The be used to specifically reference an object instance. The
semantics of this data type as found in this document is to be a semantics of this data type as found in this document is to be a
registry-unique reference to the closest enclosing object where registry-unique reference to the closest enclosing object where
the value is found. The data type names 'registryId', 'roid', the value is found. The data type names 'registryId', 'roid',
'nic-handle', 'registrationNo', etc... are terms often synomous 'nic-handle', 'registrationNo', etc... are terms often synonymous
with this data type. In this document, the term 'handle' is used. with this data type. In this document, the term 'handle' is used.
The term exposed to users by clients is a presentation issue The term exposed to users by clients is a presentation issue
beyond the scope of this document. beyond the scope of this document.
IPv4 addresses: The representation of IPv4 addresses in this IPv4 addresses: The representation of IPv4 addresses in this
document uses the dotted-decimal notation described in [RFC1166]. document uses the dotted-decimal notation described in [RFC1166].
An example of this textual representation is '192.0.2.0'. An example of this textual representation is '192.0.2.0'.
IPv6 addresses: The representation of IPv6 addresses in this IPv6 addresses: The representation of IPv6 addresses in this
document follow the forms outlined in [RFC5952]. An example of document follow the forms outlined in [RFC5952]. An example of
skipping to change at page 6, line 5 skipping to change at page 6, line 51
email addresses: Textual representations of email addresses follow email addresses: Textual representations of email addresses follow
the syntax defined in [RFC5322]. the syntax defined in [RFC5322].
dates and times: The syntax for values denoting dates and times is dates and times: The syntax for values denoting dates and times is
defined in [RFC3339]. defined in [RFC3339].
URIs: The syntax for values denoting a Uniform Resource Identifier URIs: The syntax for values denoting a Uniform Resource Identifier
(URI) is defined by [RFC3986]. (URI) is defined by [RFC3986].
4. The Entity Object Class Many of the object classes defined in this document contain values
representing telephone numbers. Servers are encouraged to provide
those telephone numbers in [E164] format, however clients MUST be
prepared for telephone numbers that do not adhere to the [E164]
standard.
Postal addresses also appear in some of the object classes. This
document specifies no standard for postal addresses as many
registries would have to undergo severe data cleanup efforts to meet
such standards.
4. Use of JSON
4.1. Signaling
Clients may signal their desire for JSON using the "application/json"
media type or the more specific media type "application/rdap" as
specified in Section 13.
4.2. Naming
Clients processing JSON [RFC4627] responses SHOULD ignore values
associated with unrecognized names. Servers MAY insert values
signified by names into the JSON responses which are not specified in
this document. Insertion of 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. "handle" and
"remarks" are JSON names specified in this document.
{
"handle" : "ABC123",
"remarks" :
[
"she sells seas shells",
"down by the seashore"
]
}
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 occuring
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.
{
"handle" : "ABC123",
"lunarNic_beforeOneSmallStep" : "TRUE THAT!",
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"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.
5. Common Data Structures
This section defines three common data structures to be used in
respones. Each of these datatypes MAY appear within any object class
of a response, but the intended purpose is that they will be mostly
used in the top-most object class of a response.
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.
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 want 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. Notices
The second data structure is named "notices" and is an array of
objects. Each object contains a "title" string representing the
title of the notice object, an array of strings named "description"
for the purposes of conveying any descriptive text about the notice,
and an optional "links" object as described in Section 6.
An exmaple of the notices data structure.
"notices" :
[
{
"title" : "Terms of Use",
"description" :
[
"This service is subject to The Registry of the Moons",
"terms of service."
],
"links" :
[
{
"value" : "http://example.net/entity/XXXX"
"rel" : "alternate",
"type" : "text/html",
"href" : "http://www.example.com/terms_of_use.html"
}
]
}
]
Figure 5
5.3. Language Identifier
The third 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 6
5.4. An Example
This is an example response with both rdapConformance and notices
embedded.
{
"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" : 4,
"name": "NET-RTR-1",
"description" : [ "A network used for example documentation" ],
"parentHandle" : "YYYY-RIR",
"remarks" :
[
"she sells seas shells",
"down by the seashore"
]
}
Figure 7
6. Object Class Links
Each object class defined in this document may have 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 of object classes
{
"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"
}
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.
Within an object class, these structures are to be in an array named
"links".
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",
}
]
7. The Entity Object Class
The entity object class appears throughout this document and is an The entity object class appears throughout this document and is an
appropriate response for the /entity/XXXX query defined in UNIFIED- appropriate response for the /entity/XXXX query defined in UNIFIED-
RDAP-QUERY [I-D.ietf-weirds-rdap-query]. This object class RDAP-QUERY [I-D.ietf-weirds-rdap-query]. This object class
represents the information of organizations, corporations, represents the information of organizations, corporations,
governments, non-profits, clubs, individual persons, and informal governments, non-profits, clubs, individual persons, and informal
groups of people. All of these representations are so similar that groups of people. All of these representations are so similar that
it is best to represent them in JSON [RFC4627] with one construct, 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 the entity object class, to aid in the re-use of code by
implementers. implementers.
Many of the members of the entity object class are repeated in other Many of the members of the entity object class are repeated in other
object classes described later in this document. object classes described later in this document.
4.1. The RIR Entity Object Class 7.1. The RIR Entity Object Class
The following is an example of an RIR entity: The following is an example of an RIR entity:
{ {
"handle" : "XXXX", "handle" : "XXXX",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ], "entityNames": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"roles" : [ "registrant" ], "roles" : [ "registrant" ],
"postalAddress" : "postalAddress" :
[ [
"123 Maple Ave", "123 Maple Ave",
"Suite 90001", "Suite 90001",
"Vancouver", "Vancouver",
"BC", "BC",
"12393" "12393"
], ],
"emails" : [ "joe@bob.com", "bob@joe.com" ], "emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" : "phones" :
{ {
"office" : [ "999-999-999-99", "111-111-111-11" ], "office" : [ "1-958-555-4321", "1-958-555-4322" ],
"fax" : [ "222-222-222-22" ], "fax" : [ "1-958-555-4323" ],
"mobile" : [ "333-333-333-33" ] "mobile" : [ "1-958-555-4324" ]
}, },
"remarks" : "remarks" :
[ [
"she sells seas shells", "she sells seas shells",
"down by the seashore" "down by the seashore"
], ],
"uris" : "links" :
[ [
{ {
"type" : "source", "value" : "http://example.com/entity/XXXX",
"uri" : "http://whois-rws.net/contact/xxxx" "rel" : "self",
"href" : "http://example.com/entity/XXXX"
}, },
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
}
], ],
"registrationDate" : "1990-12-31T23:59:60Z", "registrationDate" : "1990-12-31T23:59:60Z",
"lastChangedDate" : "1990-12-31T23:59:60Z", "lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "joe@bob.com" "lastChangedBy" : "joe@bob.com"
} }
This object as the following members. This object as the following members.
o handle -- a string representing an registry unique identifier of o handle -- a string representing an registry unique identifier of
the entity the entity
o names -- an array of strings, each signifying the name of the o entityNames -- an array of strings, each signifying the name of
entity the entity
o roles -- an array of strings, each signifying the relationship an o roles -- an array of strings, each signifying the relationship an
object would have with its closest containing object. object would have with its closest containing object.
o postalAddress -- an array of string, each representing a line in a o postalAddress -- an array of string, each representing a line in a
postal address. postal address.
o emails -- an array of strings, each containing an email address o emails -- an array of strings, each containing an email address
for the entity for the entity
o phones -- an object containg telephone information associated with o phones -- an object containing telephone information associated
the entity, with the following members: with the entity, with the following members:
* office -- an array of strings, each being a telephone number * office -- an array of strings, each being a telephone number
* fax -- an array of strings, each being a telephone number * fax -- an array of strings, each being a telephone number
* mobile -- an array of strings, each being a telephone number * mobile -- an array of strings, each being a telephone number
o remarks -- an array of strings, each containing comments about the o remarks -- an array of strings, each containing comments about the
entity entity
o uris -- an array of objects, each object having the following o links -- see Section 6
members:
* type -- a string denoting the application type of the "uri"
value
* uri -- a string containing a URI [RFC3986]
o registrationDate -- a string containing the date the entity was o registrationDate -- a string containing the date the entity was
registered registered
o lastChangedDate -- a string containing the date of last change o lastChangedDate -- a string containing the date of last change
made to the entity made to the entity
o lastChangedBy -- a string containing an identifier of the party o lastChangedBy -- a string containing an identifier of the party
responsible for the last change made to the entity registration responsible for the last change made to the entity registration
4.2. The DNR Entity Object Class 7.2. The DNR Entity Object Class
The DNR entity object class is a superset of the RIR entity object The DNR entity object class is a superset of the RIR entity object
class (Section 4.1). It has the following additional members: class (Section 7.1). It has the following additional members:
o registrationBy -- a string containing an identifier of the party o registrationBy -- a string containing an identifier of the party
responsible for the registration of the entity responsible for the registration of the entity
o sponsoredBy -- a string containing an identifier of the party o sponsoredBy -- a string containing an identifier of the party
through which the registration was made, such as an IANA approved through which the registration was made, such as an IANA approved
registrar registrar
o resoldBy -- a string containing an identifier of the party o resoldBy -- a string containing an identifier of the party
originating the registration of the entity. originating the registration of the entity.
o status -- an array of strings indicating the state of the entity o status -- an array of strings indicating the state of the entity
o port43 -- a string containing the fully-qualified host name of the o port43 -- a string containing the fully-qualified host name of the
WHOIS [RFC3912] server where the object instance may be found. WHOIS [RFC3912] server where the object instance may be found.
The following is an example of a DNR entity: The following is an example of a DNR entity:
{ {
"handle" : "XXXX", "handle" : "XXXX",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ], "entityNames": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"status" : [ "validated", "locked" ], "status" : [ "validated", "locked" ],
"postalAddress" : "postalAddress" :
[ [
"123 Maple Ave", "123 Maple Ave",
"Suite 90001", "Suite 90001",
"Vancouver", "Vancouver",
"BC", "BC",
"12393" "12393"
], ],
"emails" : [ "joe@bob.com", "bob@joe.com" ], "emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" : "phones" :
{ {
"office" : [ "999-999-999-99", "111-111-111-11" ], "office" : [ "1-958-555-4321", "1-958-555-4322" ],
"fax" : [ "222-222-222-22" ], "fax" : [ "1-958-555-4323" ],
"mobile" : [ "333-333-333-33" ] "mobile" : [ "1-958-555-4324" ]
}, },
"remarks" : "remarks" :
[ [
"she sells seas shells", "she sells seas shells",
"down by the seashore" "down by the seashore"
], ],
"uris" : "links" :
[ [
{ {
"type" : "source", "value" : "http://example.com/entity/XXXX",
"uri" : "http://whois-rws.net/entity/xxxx" "rel" : "self",
"href" : "http://example.com/entity/XXXX"
}, },
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
}
], ],
"port43" : "whois.example.net", "port43" : "whois.example.net",
"registrationDate" : "1990-12-31T23:59:60Z", "registrationDate" : "1990-12-31T23:59:60Z",
"registrationBy" : "ABC123", "registrationBy" : "ABC123",
"lastChangedDate" : "1990-12-31T23:59:60Z", "lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "ABC123", "lastChangedBy" : "ABC123",
"sponsoredBy" : "SponsorXYZ", "sponsoredBy" : "SponsorXYZ",
"resoldBy" : "ResellerPDQ" "resoldBy" : "ResellerPDQ"
} }
5. The Nameserver Object Class 8. The Nameserver Object Class
The nameserver object class is used by both RIRs and DNRs. Unlike The nameserver object class is used by both RIRs and DNRs. Unlike
other object classes used by both registries where the RIR object other object classes used by both registries where the RIR object
class is a subset of the DNR object class, a clear delineation is not class is a subset of the DNR object class, a clear delineation is not
made with the nameserver object class because some DNRs have the same made with the nameserver object class because some DNRs have the same
or a similar registration model as the RIRs. RIRs and some DNRs or a similar registration model as the RIRs. RIRs and some DNRs
register or expose nameserver information as an attribute of a domain register or expose nameserver information as an attribute of a domain
name, while other DNRs model nameservers as "first class objects". name, while other DNRs model nameservers as "first class objects".
The nameserver object class accomodates both models and degrees of The nameserver object class accommodates both models and degrees of
variation in between. variation in between.
The following is an example of a nameserver object. The following is an example of a nameserver object.
{ {
"handle" : "XXXX", "handle" : "XXXX",
"name" : "ns1.example.com", "name" : "ns1.example.com",
"status" : "active", "status" : [ "active" ],
"ipAddresses" : [ "192.0.2.0", "192.0.2.1" ], "ipAddresses" : [ "192.0.2.1", "192.0.2.2" ],
"remarks" : "remarks" :
[ [
"she sells seas shells", "she sells seas shells",
"down by the seashore" "down by the seashore"
], ],
"uris" : "links" :
[ [
{ {
"type" : "source", "value" : "http://example.net/nameserver/xxxx",
"uri" : "http://example.net/nameserver/xxxx" "rel" : "self",
"href" : "http://example.net/nameserver/xxxx"
} }
], ],
"port43" : "whois.example.net", "port43" : "whois.example.net",
"registrationDate" : "1990-12-31T23:59:60Z", "registrationDate" : "1990-12-31T23:59:60Z",
"registrationBy" : "ABC123", "registrationBy" : "ABC123",
"lastChangedDate" : "1990-12-31T23:59:60Z", "lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "ABC123", "lastChangedBy" : "ABC123",
"sponsoredBy" : "SponsorXYZ", "sponsoredBy" : "SponsorXYZ",
"resoldBy" : "ResellerPDQ" "resoldBy" : "ResellerPDQ"
} }
Figure 1 Figure 8
Figure 1 is an example of a nameserver object with all values given. Figure 8 is an example of a nameserver object with all values given.
Registries using a first-class nameserver data model would embed this Registries using a first-class nameserver data model would embed this
in domain objects as well as allowing references to it with the in domain objects as well as allowing references to it with the
/nameserver query type (all depending on the registry operators /nameserver query type (all depending on the registry operators
policy). Other registries may pare back the information as needed. policy). Other registries may pare back the information as needed.
Figure 2 is an example of a nameserver object as would be found in Figure 9 is an example of a nameserver object as would be found in
RIRs and some DNRs, while Figure 3 is an example of a nameserver RIRs and some DNRs, while Figure 10 is an example of a nameserver
object as would be found in other DNRs. object as would be found in other DNRs.
The following is an example of the simplest nameserver object. The following is an example of the simplest nameserver object.
{ {
"name" : "ns1.example.com" "name" : "ns1.example.com"
} }
Figure 2 Figure 9
The following is an example of a simple nameserver object that might The following is an example of a simple nameserver object that might
be commonly used by DNRs. be commonly used by DNRs.
{ {
"name" : "ns1.example.com", "name" : "ns1.example.com",
"ipAddresses" : [ "192.0.2.0", "192.0.2.1" ] "ipAddresses" : [ "2001:db8::123", "2001:db8::124" ]
} }
Figure 3 Figure 10
The nameserver object class has the following members: The nameserver object class has the following members:
o handle -- a string representing an registry unique identifier of o handle -- a string representing an registry unique identifier of
the nameserver the nameserver
o name -- a string containing the DNS name of the nameserver o name -- a string containing the DNS name of the nameserver
o ipAddresses -- an array of strings containing IPv4 and/or IPv6 o ipAddresses -- an array of strings containing IPv4 and/or IPv6
addresses of the nameserver addresses of the nameserver
The members "status", "remarks", "uris", "port43", "sponsoredBy", The members "status", "remarks", "links", "port43", "sponsoredBy",
"resoldBy", "registrationBy", "registrationDate", "lastChangedDate", "resoldBy", "registrationBy", "registrationDate", "lastChangedDate",
and "lastChangedBy" take the same form of the members of the same and "lastChangedBy" take the same form of the members of the same
name of the entity object (Section 4). name of the entity object (Section 7).
6. The Domain Object Class 9. The Domain Object Class
The domain object class represents a DNS name and point of The domain object class represents a DNS name and point of
delegation. For RIRs these delegation points are in the reverse DNS delegation. For RIRs these delegation points are in the reverse DNS
tree, whereas for DNRs these delegation points are in the forward DNS tree, whereas for DNRs these delegation points are in the forward DNS
tree. The RIR domain object class is a subset of the DNR object tree. The RIR domain object class is a subset of the DNR object
class. class.
In both cases, the high level structure of the domain object class In both cases, the high level structure of the domain object class
consists of information about the domain registration, nameserver consists of information about the domain registration, nameserver
information related to the domain name, and entities related to the information related to the domain name, and entities related to the
skipping to change at page 13, line 36 skipping to change at page 21, line 36
[ [
... ...
], ],
... ...
"entities" : "entities" :
[ [
... ...
] ]
} }
6.1. The RIR Domain Object Class 9.1. The RIR Domain Object Class
The following is an example of a JSON object representing a reverse The following is an example of a JSON object representing a reverse
DNS delegation point or the RIR domain object class. DNS delegation point or the RIR domain object class.
{ {
"handle" : "XXXX", "handle" : "XXXX",
"name" : "192.in-addr.arpa", "name" : "192.in-addr.arpa",
"nameServers" : "nameServers" :
[ [
{ "name" : "ns1.rir.net" }, { "name" : "ns1.rir.net" },
skipping to change at page 14, line 18 skipping to change at page 22, line 18
"digest" : "E68C017BD813B9AE2F4DD28E61AD014F859ED44C", "digest" : "E68C017BD813B9AE2F4DD28E61AD014F859ED44C",
"digestType" : 1, "digestType" : 1,
"keyTag" : 53814 "keyTag" : 53814
} }
], ],
"remarks" : "remarks" :
[ [
"she sells seas shells", "she sells seas shells",
"down by the seashore" "down by the seashore"
], ],
"uris" : "links" :
[ [
{ {
"type" : "source", "value": "http://example.net/domain/XXXX",
"uri" : "http://whois-rws.net/network/xxxx" "rel" : "self",
}, "href" : "http://example.net/domain/XXXXX"
{
"type" : "parent",
"uri" : "http://whois-rws.net/network/yyyy"
},
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
} }
], ],
"registrationDate" : "1990-12-31T23:59:60Z", "registrationDate" : "1990-12-31T23:59:60Z",
"lastChangedDate" : "1990-12-31T23:59:60Z", "lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "joe@bob.com", "lastChangedBy" : "joe@bob.com",
"entities" : "entities" :
[ [
{ {
"handle" : "XXXX", "handle" : "XXXX",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ], "entityNames": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"roles" : [ "registrant" ], "roles" : [ "registrant" ],
"postalAddress" : "postalAddress" :
[ [
"123 Maple Ave", "123 Maple Ave",
"Suite 90001", "Suite 90001",
"Vancouver", "Vancouver",
"BC", "BC",
"12393" "12393"
], ],
"emails" : [ "joe@bob.com", "bob@joe.com" ], "emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" : "phones" :
{ {
"office" : [ "999-999-999-99", "111-111-111-11" ], "office" : [ "1-958-555-4321", "1-958-555-4322" ],
"fax" : [ "222-222-222-22" ], "fax" : [ "1-958-555-4323" ],
"mobile" : [ "333-333-333-33" ] "mobile" : [ "1-958-555-4324" ]
}, },
"remarks" : "remarks" :
[ [
"she sells seas shells", "she sells seas shells",
"down by the seashore" "down by the seashore"
], ],
"uris" : "links" :
[ [
{ {
"type" : "source", "value": "http://example.net/entity/xxxx"
"uri" : "http://whois-rws.net/entity/xxxx" "rel" : "self",
}, "href" : "http://example.net/entity/xxxx"
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
} }
], ],
"registrationDate" : "1990-12-31T23:59:60Z", "registrationDate" : "1990-12-31T23:59:60Z",
"lastChangedDate" : "1990-12-31T23:59:60Z", "lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "joe@bob.com" "lastChangedBy" : "joe@bob.com"
} }
] ]
} }
The following is a description of the members of this object: The following is a description of the members of this object:
o handle -- a string representing a registry unique identifier of o handle -- a string representing a registry unique identifier of
the domain object instance the domain object instance
o name -- a string denoting the DNS zone name, which is a domain o name -- a string denoting the DNS zone name, which is a domain
name name
o nameservers -- an array of nameserver objects as defined by o nameservers -- an array of nameserver objects as defined by
Section 5 Section 8
o delegationKeys -- an array of objects, each with the following o delegationKeys -- an array of objects, each with the following
members: members:
* algorithm -- an integer as specified by the algorithm field of * algorithm -- an integer as specified by the algorithm field of
a DNS DS record as specified by RFC 4034 [RFC4034] in a DNS DS record as specified by RFC 4034 [RFC4034] in
presentation format presentation format
* digest -- an string as specified by the digest field of a DNS * digest -- an string as specified by the digest field of a DNS
DS record as specified by RFC 4034 in presentation format DS record as specified by RFC 4034 in presentation format
* digestType -- an integer as specified by the digest type field * digestType -- an integer as specified by the digest type field
of a DNS DS record as specified by RFC 4034 in presetnation of a DNS DS record as specified by RFC 4034 in presentation
format format
* keyTag -- an integer as specified by the key tag field of a DNS * keyTag -- an integer as specified by the key tag field of a DNS
DS record as specified by RFC 4034 in presentation format DS record as specified by RFC 4034 in presentation format
o entities -- an array of entity objects as defined by Section 4.1. o entities -- an array of entity objects as defined by Section 7.1.
The members "remarks", "uris", "registrationDate", "lastChangedDate", The members "remarks", "links", "registrationDate",
and "lastChangedBy" take the same form of the members of the same "lastChangedDate", and "lastChangedBy" take the same form of the
name of the entity object (Section 4). members of the same name of the entity object (Section 7).
6.2. The DNR Domain Object Class 9.2. The DNR Domain Object Class
The DNR domain object class is a superset of the RIR domain object The DNR domain object class is a superset of the RIR domain object
class (Section 6.1) and has the following additional members. class (Section 9.1) and has the following additional members.
o variants -- an array of strings, each containing a domain name o variants -- an array of objects, each containing the following
that is a variant of this domain name object instance. values:
* relation -- an array of strings, with each string denoting the
relationship between the variants and the containing domain
object.
* variantNames -- an array of strings, each being a variant
domain of the containing domain object.
o expirationDate -- a string containing the date and time this o expirationDate -- a string containing the date and time this
domain name registration will expire domain name registration will expire
o registrationBy -- a string containing an identifier of the party o registrationBy -- a string containing an identifier of the party
responsible for the registration of the domain name responsible for the registration of the domain name
o sponsoredBy -- a string containing an identifier of the party o sponsoredBy -- a string containing an identifier of the party
through which the registration was made, such as an IANA approved through which the registration was made, such as an IANA approved
registrar registrar
skipping to change at page 17, line 6 skipping to change at page 25, line 6
o port43 -- a string containing the fully-qualified host name of the o port43 -- a string containing the fully-qualified host name of the
WHOIS [RFC3912] server where the object instance may be found. WHOIS [RFC3912] server where the object instance may be found.
The following is an example of a JSON object representing a forward The following is an example of a JSON object representing a forward
DNS delegation point or the DNR domain object class. DNS delegation point or the DNR domain object class.
{ {
"handle" : "XXXX", "handle" : "XXXX",
"name" : "blah.example.com", "name" : "blah.example.com",
"variants" : [ "blah2.example.com", "blah3.example.com" ], "variants" :
[
{
"relation" : [ "registered", "conjoined" ],
"variantNames" : [ "blah2.example.com", "blah3.example.com" ]
},
{
"relation" : [ "unregistered", "restrictedRegistration" ],
"variantNames" : [ "blah3.example.com", "blah4.example.com" ]
}
],
"status" : [ "locked", "transferProhibited" ], "status" : [ "locked", "transferProhibited" ],
"nameServers" : "nameServers" :
[ [
{ {
"handle" : "XXXX", "handle" : "XXXX",
"name" : "ns1.example.com", "name" : "ns1.example.com",
"status" : "active", "status" : [ "active" ],
"ipAddresses" : [ "192.0.2.0", "192.0.2.1" ], "ipAddresses" :
[
"2001:db8::123", "2001:db8::124",
"192.0.2.1", "192.0.2.2"
],
"remarks" : "remarks" :
[ [
"she sells seas shells", "she sells seas shells",
"down by the seashore" "down by the seashore"
], ],
"uris" : "links" :
[ [
{ {
"type" : "source", "value" : "http://example.net/nameserver/XXXX"
"uri" : "http://example.net/nameserver/xxxx" "rel" : "self",
"href" : "http://example.net/nameserver/XXXX"
} }
], ],
"registrationDate" : "1990-12-31T23:59:60Z", "registrationDate" : "1990-12-31T23:59:60Z",
"registrationBy" : "ABC123", "registrationBy" : "ABC123",
"lastChangedDate" : "1990-12-31T23:59:60Z", "lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "ABC123", "lastChangedBy" : "ABC123",
"sponsoredBy" : "SponsorXYZ", "sponsoredBy" : "SponsorXYZ",
"resoldBy" : "ResellerPDQ" "resoldBy" : "ResellerPDQ"
}, },
{ {
"handle" : "XXXX", "handle" : "XXXX",
"name" : "ns2.example.com", "name" : "ns2.example.com",
"status" : "active", "status" : [ "active" ],
"ipAddresses" : [ "192.0.2.2", "192.0.2.3" ], "ipAddresses" :
[
"2001:db8::125", "2001:db8::126",
"192.0.2.3", "192.0.2.4"
],
"remarks" : "remarks" :
[ [
"she sells seas shells", "she sells seas shells",
"down by the seashore" "down by the seashore"
], ],
"uris" : "links" :
[ [
{ {
"type" : "source", "value" : "http://example.net/nameserver/XXXX",
"uri" : "http://example.net/nameserver/xxxx" "rel" : "self",
"href" : "http://example.net/nameserver/XXXX"
} }
], ],
"registrationDate" : "1990-12-31T23:59:60Z", "registrationDate" : "1990-12-31T23:59:60Z",
"registrationBy" : "ABC123", "registrationBy" : "ABC123",
"lastChangedDate" : "1990-12-31T23:59:60Z", "lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "ABC123", "lastChangedBy" : "ABC123",
"sponsoredBy" : "SponsorXYZ", "sponsoredBy" : "SponsorXYZ",
"resoldBy" : "ResellerPDQ" "resoldBy" : "ResellerPDQ"
} }
] ]
skipping to change at page 18, line 25 skipping to change at page 26, line 45
"digest" : "E68C017BD813B9AE2F4DD28E61AD014F859ED44C", "digest" : "E68C017BD813B9AE2F4DD28E61AD014F859ED44C",
"digestType" : 1, "digestType" : 1,
"keyTag" : 53814 "keyTag" : 53814
} }
], ],
"remarks" : "remarks" :
[ [
"she sells seas shells", "she sells seas shells",
"down by the seashore" "down by the seashore"
], ],
"uris" : "links" :
[ [
{ {
"type" : "source", "value": "http://example.net/domain/XXXX",
"uri" : "http://example.net/domain/xxxx" "rel" : "self",
}, "href" : "http://example.net/domain/XXXX"
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
} }
], ],
"port43" : "whois.example.net", "port43" : "whois.example.net",
"registrationDate" : "1990-12-31T23:59:60Z", "registrationDate" : "1990-12-31T23:59:60Z",
"registrationBy" : "ABC123", "registrationBy" : "ABC123",
"lastChangedDate" : "1990-12-31T23:59:60Z", "lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "ABC123", "lastChangedBy" : "ABC123",
"sponsoredBy" : "SponsorXYZ", "sponsoredBy" : "SponsorXYZ",
"resoldBy" : "ResellerPDQ", "resoldBy" : "ResellerPDQ",
"expirationDate" : "2016-12-31T23:59:60Z", "expirationDate" : "2016-12-31T23:59:60Z",
"transferDate" : "1990-12-31T23:59:60Z", "transferDate" : "1990-12-31T23:59:60Z",
skipping to change at page 18, line 49 skipping to change at page 27, line 19
"lastChangedDate" : "1990-12-31T23:59:60Z", "lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "ABC123", "lastChangedBy" : "ABC123",
"sponsoredBy" : "SponsorXYZ", "sponsoredBy" : "SponsorXYZ",
"resoldBy" : "ResellerPDQ", "resoldBy" : "ResellerPDQ",
"expirationDate" : "2016-12-31T23:59:60Z", "expirationDate" : "2016-12-31T23:59:60Z",
"transferDate" : "1990-12-31T23:59:60Z", "transferDate" : "1990-12-31T23:59:60Z",
"entities" : "entities" :
[ [
{ {
"handle" : "XXXX", "handle" : "XXXX",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ], "entityNames": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"status" : [ "validated", "locked" ], "status" : [ "validated", "locked" ],
"postalAddress" : "postalAddress" :
[ [
"123 Maple Ave", "123 Maple Ave",
"Suite 90001", "Suite 90001",
"Vancouver", "Vancouver",
"BC", "BC",
"12393" "12393"
], ],
"emails" : [ "joe@bob.com", "bob@joe.com" ], "emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" : "phones" :
{ {
skipping to change at page 19, line 15 skipping to change at page 27, line 32
[ [
"123 Maple Ave", "123 Maple Ave",
"Suite 90001", "Suite 90001",
"Vancouver", "Vancouver",
"BC", "BC",
"12393" "12393"
], ],
"emails" : [ "joe@bob.com", "bob@joe.com" ], "emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" : "phones" :
{ {
"office" : [ "999-999-999-99", "111-111-111-11" ], "office" : [ "1-958-555-4321", "1-958-555-4322" ],
"fax" : [ "222-222-222-22" ], "fax" : [ "1-958-555-4323" ],
"mobile" : [ "333-333-333-33" ] "mobile" : [ "1-958-555-4324" ]
}, },
"remarks" : "remarks" :
[ [
"she sells seas shells", "she sells seas shells",
"down by the seashore" "down by the seashore"
], ],
"uris" : "links" :
[ [
{ {
"type" : "source", "value" : "http://example.net/entity/xxxx"
"uri" : "http://whois-rws.net/entity/xxxx" "rel" : "self",
}, "href" : "http://example.net/entity/xxxx"
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
} }
], ],
"registrationDate" : "1990-12-31T23:59:60Z", "registrationDate" : "1990-12-31T23:59:60Z",
"registrationBy" : "ABC123", "registrationBy" : "ABC123",
"lastChangedDate" : "1990-12-31T23:59:60Z", "lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "ABC123", "lastChangedBy" : "ABC123",
"sponsoredBy" : "SponsorXYZ", "sponsoredBy" : "SponsorXYZ",
"resoldBy" : "ResellerPDQ" "resoldBy" : "ResellerPDQ"
} }
] ]
} }
7. The IP Network Object Class 10. The IP Network Object Class
The IP Network object class models IP network registrations found in The IP Network object class models IP network registrations found in
RIRs and is the expected response for the /ip query as defined by 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 [I-D.ietf-weirds-rdap-query]. There is no equivalent object class
for DNRs. The high level structure of the IP network object class for DNRs. The high level structure of the IP network object class
consists of information about the network registration and entities consists of information about the network registration and entities
related to the IP network (e.g. registrant information, contacts, related to the IP network (e.g. registrant information, contacts,
etc...). etc...).
The following is an elided example of the IP network object type The following is an elided example of the IP network object type
skipping to change at page 20, line 32 skipping to change at page 29, line 32
[ [
... ...
] ]
} }
The following is an example of the JSON object for the network The following is an example of the JSON object for the network
registration information registration information
{ {
"handle" : "XXXX-RIR", "handle" : "XXXX-RIR",
"startAddress" : "10.0.0.0", "startAddress" : "2001:db8::0",
"endAddress" : "10.0.0.255", "endAddress" : "2001:db8::0:FFFF:FFFF:FFFF:FFFF:FFFF",
"ipVersion" : 4, "ipVersion" : 6,
"name": "NET-RTR-1", "name": "NET-RTR-1",
"description" : [ "A network used for routing" ], "description" : [ "A network used for routing" ],
"type" : "DIRECT ALLOCATION", "type" : "DIRECT ALLOCATION",
"country" : "AU", "country" : "AU",
"parentHandle" : "YYYY-RIR", "parentHandle" : "YYYY-RIR",
"remarks" : "remarks" :
[ [
"she sells seas shells", "she sells seas shells",
"down by the seashore" "down by the seashore"
], ],
"uris" : "links" :
[ [
{ {
"type" : "source", "value" : "http://example.ent/ip/2001:db8::/48",
"uri" : "http://whois-rws.net/network/xxxx" "rel" : "self",
"href" : "http://example.net/ip/2001:db8::/48"
}, },
{ {
"type" : "parent", "value" : "http://example.net/ip/2001:db8::/48",
"uri" : "http://whois-rws.net/network/yyyy" "rel" : "up",
"href" : "http://example.net/ip/2001:C00::/23"
}, },
], ],
"registrationDate" : "20110509", "registrationDate" : "20110509",
"lastChangedDate" : "20110509", "lastChangedDate" : "20110509",
"lastChangedBy" : "joe@bob.com", "lastChangedBy" : "joe@bob.com",
"entities" : "entities" :
[ [
{ {
"handle" : "XXXX", "handle" : "XXXX",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ], "entityNames": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"roles" : [ "registrant" ], "roles" : [ "registrant" ],
"postalAddress" : "postalAddress" :
[ [
"123 Maple Ave", "123 Maple Ave",
"Suite 90001", "Suite 90001",
"Vancouver", "Vancouver",
"BC", "BC",
"12393" "12393"
], ],
"emails" : [ "joe@bob.com", "bob@joe.com" ], "emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" : "phones" :
{ {
"office" : [ "999-999-999-99", "111-111-111-11" ], "office" : [ "1-958-555-4321", "1-958-555-4322" ],
"fax" : [ "222-222-222-22" ], "fax" : [ "1-958-555-4323" ],
"mobile" : [ "333-333-333-33" ] "mobile" : [ "1-958-555-4324" ]
}, },
"remarks" : "remarks" :
[ [
"she sells seas shells", "she sells seas shells",
"down by the seashore" "down by the seashore"
], ],
"uris" : "links" :
[ [
{ {
"type" : "source", "value" : "http://example.net/entity/xxxx",
"uri" : "http://whois-rws.net/contact/xxxx" "rel" : "self",
}, "href" : "http://example.net/entity/xxxx"
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
} }
], ],
"registrationDate" : "1990-12-31T23:59:60Z", "registrationDate" : "1990-12-31T23:59:60Z",
"lastChangedDate" : "1990-12-31T23:59:60Z", "lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "joe@bob.com" "lastChangedBy" : "joe@bob.com"
} }
] ]
} }
The following is a description of the members of this object: The following is a description of the members of this object:
o handle -- a string representing an RIR unique identifier of the o handle -- a string representing an RIR unique identifier of the
network registration network registration
o startAddress -- the starting IP address of the network, either o startAddress -- the starting IP address of the network, either
skipping to change at page 22, line 21 skipping to change at page 31, line 21
o handle -- a string representing an RIR unique identifier of the o handle -- a string representing an RIR unique identifier of the
network registration network registration
o startAddress -- the starting IP address of the network, either o startAddress -- the starting IP address of the network, either
IPv4 or IPv6 IPv4 or IPv6
o endAddress -- the ending IP address of the network, either IPv4 or o endAddress -- the ending IP address of the network, either IPv4 or
IPv6 IPv6
o ipVersion -- an integer signifying the IP protocol version of the o ipVersion -- an integer signifying the IP protocol version of the
network: 4 signifying an IPv4 network, 6 signifing an IPv6 network network: 4 signifying an IPv4 network, 6 signifying an IPv6
network
o name -- an identifier assigned to the network registration by the o name -- an identifier assigned to the network registration by the
registration holder registration holder
o description -- an array of strings containing descriptive text o description -- an array of strings containing descriptive text
about the network registration about the network registration
o type -- a string containing an RIR specific classification of the o type -- a string containing an RIR specific classification of the
network network
o country -- a string containing the name of the 2 character country o country -- a string containing the name of the 2 character country
code of the network code of the network
o parentHandle -- a string containing an RIR unique identifier of o parentHandle -- a string containing an RIR unique identifier of
the parent network of this network registration the parent network of this network registration
o entities -- an array of entity objects as defined by Section 4.1. o entities -- an array of entity objects as defined by Section 7.1.
The members "remarks", "uris", "registrationDate", "lastChangedDate", The members "remarks", "links", "registrationDate",
and "lastChangedBy" take the same form of the members of the same "lastChangedDate", and "lastChangedBy" take the same form of the
name of the entity object (Section 4.1). members of the same name of the entity object (Section 7.1).
8. Autonomous System Number Entity Object Class 11. Autonomous System Number Entity Object Class
The Autonomous System Number (autnum) object class models Autonomous The Autonomous System Number (autnum) object class models Autonomous
System Number registrations found in RIRs and represents the expected System Number registrations found in RIRs and represents the expected
response to an /autnum query as defined by response to an /autnum query as defined by
[I-D.ietf-weirds-rdap-query]. There is no equivalent object class [I-D.ietf-weirds-rdap-query]. There is no equivalent object class
for DNRs. The high level structure of the autnum object class for DNRs. The high level structure of the autnum object class
consists of information about the network registration and entities consists of information about the network registration and entities
related to the autnum registration (e.g. registrant information, related to the autnum registration (e.g. registrant information,
contacts, etc...), and is similar to the IP Network entity object contacts, etc...), and is similar to the IP Network entity object
class. class.
skipping to change at page 23, line 32 skipping to change at page 32, line 32
"endAutnum" : "15", "endAutnum" : "15",
"name": "AS-RTR-1", "name": "AS-RTR-1",
"description" : [ "AS for Exchange" ], "description" : [ "AS for Exchange" ],
"type" : "DIRECT ALLOCATION", "type" : "DIRECT ALLOCATION",
"country": "AU", "country": "AU",
"remarks" : "remarks" :
[ [
"she sells seas shells", "she sells seas shells",
"down by the seashore" "down by the seashore"
], ],
"uris" : "links" :
[ [
{ {
"type" : "source", "value" : "http://example.net/autnum/xxxx",
"uri" : "http://whois-rws.net/autnum/xxxx" "rel" : "self",
}, "href" : "http://example.net/autnum/xxxx"
{
"type" : "parent",
"uri" : "http://whois-rws.net/autnum/yyyy"
},
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
} }
], ],
"registrationDate" : "20110509", "registrationDate" : "20110509",
"lastChangedDate" : "20110509", "lastChangedDate" : "20110509",
"lastChangedBy" : "joe@bob.com", "lastChangedBy" : "joe@bob.com",
"entities" : "entities" :
[ [
{ {
"handle" : "XXXX", "handle" : "XXXX",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ], "entityNames": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"roles" : [ "registrant" ], "roles" : [ "registrant" ],
"postalAddress" : "postalAddress" :
[ [
"123 Maple Ave", "123 Maple Ave",
"Suite 90001", "Suite 90001",
"Vancouver", "Vancouver",
"BC", "BC",
"12393" "12393"
], ],
"emails" : [ "joe@bob.com", "bob@joe.com" ], "emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" : "phones" :
{ {
"office" : [ "999-999-999-99", "111-111-111-11" ], "office" : [ "1-958-555-4321", "1-958-555-4322" ],
"fax" : [ "222-222-222-22" ], "fax" : [ "1-958-555-4323" ],
"mobile" : [ "333-333-333-33" ] "mobile" : [ "1-958-555-4324" ]
}, },
"remarks" : "remarks" :
[ [
"she sells seas shells", "she sells seas shells",
"down by the seashore" "down by the seashore"
], ],
"uris" : "links" :
[ [
{ {
"type" : "source", "value" : "http://example.net/entity/XXXX",
"uri" : "http://whois-rws.net/autnum/xxxx" "rel" : "self",
"href" : "http://example.net/entity/XXXX"
} }
], ],
"registrationDate" : "1990-12-31T23:59:60Z", "registrationDate" : "1990-12-31T23:59:60Z",
"lastChangedDate" : "1990-12-31T23:59:60Z", "lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "joe@bob.com" "lastChangedBy" : "joe@bob.com"
} }
] ]
} }
The following is a description of the members of this object: The following is a description of the members of this object:
skipping to change at page 25, line 20 skipping to change at page 34, line 14
o description -- an array of strings containing descriptive text o description -- an array of strings containing descriptive text
about the autnum registration about the autnum registration
o type -- a string containing an RIR specific classification of the o type -- a string containing an RIR specific classification of the
autnum autnum
o country -- a string containing the name of the 2 character country o country -- a string containing the name of the 2 character country
code of the autnum code of the autnum
The members "remarks", "uris", "registrationDate", "lastChangedDate", The members "remarks", "links", "registrationDate",
and "lastChangedBy" take the same form of the members of the same "lastChangedDate", and "lastChangedBy" take the same form of the
name of the entity object (Section 4.1). members of the same name of the entity object (Section 7.1).
9. Contributing Authors and Acknowledgements 12. 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 11
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.
13. IANA Considerations
This specification registers the "application/rdap" media type.
Type name: application
Subtype name: rdap
Required parameters: n/a
Optional parameters: level
Encoding considerations: n/a
Security considerations: n/a
Interoperability considerations: n/a
Published specification: [[ this document ]]
Applications that use this media type: RDAP
Additional information: n/a
Person & email address to contact for further information: Andy
Newton &andy@hxr.us&
Intended usage: COMMON
Restrictions on usage: none
Author: Andy Newton
Change controller: IETF
14. Internationalization Considerations
14.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.
14.2. URIs and IRIs
[I-D.ietf-weirds-using-http] defines the use of URIs and IRIs in
RDAP.
14.3. Language Tags
Section 5.3 defines the use of language tags in the JSON responses
defined in this document.
14.4. Internationalized Domain Names
Appendix C illustrates the model for query and response regarding
internationalized domain names (IDNs).
15. Contributing Authors and Acknowledgements
This document is derived from original work on RIR response in JSON This document is derived from original work on RIR response in JSON
by Byron J. Ellacott of APNIC, Arturo L. Servin of LACNIC, Kaveh by Byron J. Ellacott of APNIC, Arturo L. Servin of LACNIC, Kaveh
Ranjbar of the RIPE NCC, and Andrew L. Newton of ARIN. Additionally, Ranjbar of the RIPE NCC, and Andrew L. Newton of ARIN. Additionally,
this document incorporates word on DNR responses in JSON by Ning this document incorporates word on DNR responses in JSON by Ning
Kong, Linlin Zhou, Jiagui Xie, and Sean Shen of CNNIC. Kong, Linlin Zhou, Jiagui Xie, and Sean Shen of CNNIC.
The components of the DNR object classes are derived from a The components of the DNR object classes are derived from a
categorization of WHOIS response formats created by Ning Kong, Linlin categorization of WHOIS response formats created by Ning Kong, Linlin
Zhou, and Guangqing Deng of CNNIC, Steve Sheng and Francisco Arias of Zhou, and Guangqing Deng of CNNIC, Steve Sheng and Francisco Arias of
ICANN, Ray Bellis of Nominet, and Frederico Neves of NIC.BR. ICANN, Ray Bellis of Nominet, and Frederico Neves of NIC.BR.
10. References 16. References
10.1. Normative References 16.1. Normative References
[RFC0791] Postel, J., "Internet Protocol", STD 5, RFC 791, [RFC0791] Postel, J., "Internet Protocol", STD 5, RFC 791,
September 1981. September 1981.
[RFC1166] Kirkpatrick, S., Stahl, M., and M. Recker, "Internet [RFC1166] Kirkpatrick, S., Stahl, M., and M. Recker, "Internet
numbers", RFC 1166, July 1990. numbers", RFC 1166, July 1990.
[RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999. Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
skipping to change at page 27, line 42 skipping to change at page 39, line 42
[RFC4627] Crockford, D., "The application/json Media Type for [RFC4627] Crockford, D., "The application/json Media Type for
JavaScript Object Notation (JSON)", RFC 4627, July 2006. JavaScript Object Notation (JSON)", RFC 4627, July 2006.
[RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322, [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322,
October 2008. October 2008.
[RFC5396] Huston, G. and G. Michaelson, "Textual Representation of [RFC5396] Huston, G. and G. Michaelson, "Textual Representation of
Autonomous System (AS) Numbers", RFC 5396, December 2008. Autonomous System (AS) Numbers", RFC 5396, December 2008.
[RFC5646] Phillips, A. and M. Davis, "Tags for Identifying
Languages", BCP 47, RFC 5646, September 2009.
[RFC5952] Kawamura, S. and M. Kawashima, "A Recommendation for IPv6 [RFC5952] Kawamura, S. and M. Kawashima, "A Recommendation for IPv6
Address Text Representation", RFC 5952, August 2010. Address Text Representation", RFC 5952, August 2010.
[RFC5988] Nottingham, M., "Web Linking", RFC 5988, October 2010.
[ISO.3166.1988] [ISO.3166.1988]
International Organization for Standardization, "Codes for International Organization for Standardization, "Codes for
the representation of names of countries, 3rd edition", the representation of names of countries, 3rd edition",
ISO Standard 3166, August 1988. ISO Standard 3166, August 1988.
[I-D.ietf-weirds-rdap-query] [I-D.ietf-weirds-rdap-query]
Newton, A. and S. Hollenbeck, "RDAP Query Format", Newton, A. and S. Hollenbeck, "RDAP Query Format",
draft-ietf-weirds-rdap-query-00 (work in progress), draft-ietf-weirds-rdap-query-00 (work in progress),
September 2011. September 2011.
[I-D.ietf-weirds-using-http] [I-D.ietf-weirds-using-http]
Newton, A., Ellacott, B., and N. Kong, "Using HTTP for Newton, A., Ellacott, B., and N. Kong, "Using HTTP for
RESTful Whois Services by Internet Registries", RESTful Whois Services by Internet Registries",
draft-ietf-weirds-using-http-01 (work in progress), draft-ietf-weirds-using-http-01 (work in progress),
May 2012. May 2012.
10.2. Informative References [E164] ITU-T, "The International Public Telecommunication Number
Plan", Recommendation E.164, May 1997.
16.2. Informative References
[RFC3912] Daigle, L., "WHOIS Protocol Specification", RFC 3912, [RFC3912] Daigle, L., "WHOIS Protocol Specification", RFC 3912,
September 2004. 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,
and Montana State University - Bozeman, "Comparison of
JSON and XML Data Interchange Formats: A Case Study",
2009.
Appendix A. Suggested Values Appendix A. Suggested Values
Due to the wide variation between the hundreds of registry operators Due to the wide variation between the hundreds of registry operators
and the on-going policy refinement by registry communities, values of and the on-going policy refinement by registry communities, values of
some data cannot be formally standardized. This section lists some data cannot be formally standardized. This section lists
suggested values for such data but is not nor will ever be a complete suggested values for such data but is not nor will ever be a complete
list of values and their meanings. list of values and their meanings.
A.1. Status A.1. Status
skipping to change at page 30, line 6 skipping to change at page 42, line 6
The following is a list of suggested values to use in the 'roles' The following is a list of suggested values to use in the 'roles'
array: array:
o 'registrant' -- The entity object instance is the registrant of o 'registrant' -- The entity object instance is the registrant of
the registration. the registration.
o 'tech' -- The entity object instance is a technical contact for o 'tech' -- The entity object instance is a technical contact for
the registration. the registration.
o 'admin' -- The entity object instance is an administrative contact o 'admin' -- The entity object instance is an administrative contact
for the registraton. for the registration.
o 'abuse' -- The entity object instance handles network abuse issues o 'abuse' -- The entity object instance handles network abuse issues
on behalf of the registrant of the registration. on behalf of the registrant of the registration.
o 'billing' -- The entity object instance handles payment and o 'billing' -- The entity object instance handles payment and
billing issues on behalf of the registrant of the registration. billing issues on behalf of the registrant of the registration.
o 'registrar' -- The entity object instance represents the authority o 'registrar' -- The entity object instance represents the authority
responsible for the registration in the registry. responsible for the registration in the registry.
A.3. URI Types A.3. Variant Relations
Many of the object classes have a member named 'uris', which is an
array of objects with each object containing a 'type' string and a
'uri' string. These URIs represent a location to find information
about the containing object. The following is a list of suggested
values to use as a 'type' string for an associated URI.
o 'self' -- Indicates the URI is a direct reference to the object
instance via an RDAP query.
o 'parent' -- Indicates a direct reference to an object instance's Section 9.2 describes a structure for noting variants of domain names
parent via an RDAP query. Such a reference might be used in an IP and the relationship those variants have with a registered domain
network to reference the next IP network up the tree of IP address name. The following is a list of suggested values to use as the
hierarchies. variant relation values:
o 'source' -- Signifies a direct reference to the registration in o 'registered' -- the variant names are registered in the registry.
another RESTful protocol. As an example, both ARIN and the RIPE
NCC have RESTful web services for WHOIS data that pre-exists RDAP.
This type of URI would be used to reference the same data in such
a system.
o 'web' -- Signifies the web site of the containing object instance. o 'unregistered' -- the variant names are not found in the registry.
The expectation is that a web browser would be needed to use this
URI.
o 'rdap' -- Signifies the RDAP service where RDAP queries can be o 'restrictedRegistration' -- registration of the variant names is
issued. restricted to certain parties or within certain rules.
o 'held' -- Signifies a HELD location service for the registered o 'openRegistration' -- registration of the variant names is
object. available to generally qualified registrants.
o 'geo' -- Signifies that the URI is a geo URI related to the o 'conjoined' -- registration of the variant names is conjoined with
location of the registration. the registration of the containing domain registration.
Appendix B. Suggested Data Modeling with the Entity Object Class Appendix B. Suggested Data Modeling with the Entity Object Class
B.1. Registrants and Contacts B.1. Registrants and Contacts
This document does not provide specific object classes for This document does not provide specific object classes for
registrants and contacts. Instead the entity object class may be registrants and contacts. Instead the entity object class may be
used to represent a registrant or contact. When the entity object is used to represent a registrant or contact. When the entity object is
embedded inside a containing object such as a domain name or IP embedded inside a containing object such as a domain name or IP
network, the 'roles' string array can be used to signify the network, the 'roles' string array can be used to signify the
skipping to change at page 31, line 26 skipping to change at page 43, line 26
The following is an example of an elided containing object with an The following is an example of an elided containing object with an
embedded entity that is both a registrant and admin contact: embedded entity that is both a registrant and admin contact:
{ {
... ...
"entities" : "entities" :
[ [
{ {
"handle" : "XXXX", "handle" : "XXXX",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ], "entityNames": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"roles" : [ "registrant", "admin" ], "roles" : [ "registrant", "admin" ],
"postalAddress" : "postalAddress" :
[ [
"123 Maple Ave", "123 Maple Ave",
"Suite 90001", "Suite 90001",
"Vancouver", "Vancouver",
"BC", "BC",
"12393" "12393"
], ],
"emails" : [ "joe@bob.com", "bob@joe.com" ], "emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" : "phones" :
{ {
"office" : [ "999-999-999-99", "111-111-111-11" ], "office" : [ "1-958-555-4321", "1-958-555-4322" ],
"fax" : [ "222-222-222-22" ], "fax" : [ "1-958-555-4323" ],
"mobile" : [ "333-333-333-33" ] "mobile" : [ "1-958-555-4324" ]
}, },
"remarks" : "remarks" :
[ [
"she sells seas shells", "she sells seas shells",
"down by the seashore" "down by the seashore"
], ],
"registrationDate" : "1990-12-31T23:59:60Z", "registrationDate" : "1990-12-31T23:59:60Z",
"lastChangedDate" : "1990-12-31T23:59:60Z", "lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "joe@bob.com" "lastChangedBy" : "joe@bob.com"
} }
] ]
} }
B.2. Registrars B.2. Registrars
This document does not provide a specific object class for This document does not provide a specific object class for
registrars, but like registrants and contacts (see Appendix B.1) the registrars, but like registrants and contacts (see Appendix B.1) the
'roles' string array maybe used. Additionally, a URI type can 'roles' string array maybe used.
signify the registrars point of service (see Appendix A.3).
The following is an example of an elided containing object with an The following is an example of an elided containing object with an
embedded entity that is a registrar: embedded entity that is a registrar:
{ {
... ...
"entities" : "entities" :
[ [
{ {
"handle" : "XXXX", "handle" : "XXXX",
skipping to change at page 33, line 27 skipping to change at page 45, line 27
[ [
"1212 Tulip Ave", "1212 Tulip Ave",
"Suite 1", "Suite 1",
"Marina Del Rey", "Marina Del Rey",
"CA", "CA",
"12393-2193" "12393-2193"
], ],
"emails" : [ "joe@bob.com", "bob@joe.com" ], "emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" : "phones" :
{ {
"office" : [ "999-999-999-99", "111-111-111-11" ], "office" : [ "1-958-555-4321", "1-958-555-4322" ],
"fax" : [ "222-222-222-22" ], "fax" : [ "1-958-555-4323" ],
"mobile" : [ "333-333-333-33" ] "mobile" : [ "1-958-555-4324" ]
}, },
"remarks" : "remarks" :
[ [
"we registrar for less!" "we registrar for less!"
], ],
"uris" : "links" :
[ [
{ {
"type" : "rdap", "value" : "http://example.net/entity/XXXX"
"uri" : "http://rdap.exmaple.com" "rel" : "alternate",
}, "type" : "text/html",
{ "href" : "http://www.example.com"
"type" : "web",
"uri" : "http://www.example.com"
} }
] ]
} }
] ]
} }
Appendix C. IDN Query and Response Model Appendix C. IDN Query and Response Model
Internationalized Domain Names (IDNs) differ from other types of Internationalized Domain Names (IDNs) differ from other types of
domain names because multiple domain names as would be represented by domain names because multiple domain names as would be represented by
a name in Master File format (see [RFC4343]) may be registered by a a name in Master File format (see [RFC4343]) may be registered by a
single IDN. IDNs are based on Unicode, and Unicode can have multiple single IDN. IDNs are based on Unicode, and Unicode can have multiple
means for encoding the same word depending on the character set and means for encoding the same word depending on the character set and
language being used. And the rules for determining which IDN language being used. And the rules for determining which IDN
encoding maps to a "wire-format" domain name vary from DNR to DNR. encoding maps to a "wire-format" domain name vary from DNR to DNR.
When an IDN maps to multiple domain names, the various mappings are When an IDN maps to multiple domain names, the various mappings are
called variants. The DNR Domain object class (Section 6.2) called variants. The DNR Domain object class (Section 9.2)
represents the variants using a string array. represents the variants using a string array.
The following is an example of an elided DNR domain object with The following is an example of an elided DNR domain object with
variants. variants.
{ {
"handle" : "XXXX", "handle" : "XXXX",
"name" : "blah.example.com", "name" : "blah.example.com",
"variants" : [ "blah2.example.com", "blah3.example.com" ], "variants" : [ "blah2.example.com", "blah3.example.com" ],
... ...
skipping to change at page 35, line 7 skipping to change at page 47, line 7
Because IDNs can have multiple targets in a mapping and due to the Because IDNs can have multiple targets in a mapping and due to the
variance in DNR mapping rules, it is up to the client to reduce an variance in DNR mapping rules, it is up to the client to reduce an
IDN to a domain name in Master File format so as to narrow the lookup IDN to a domain name in Master File format so as to narrow the lookup
of the domain name to the proper subset. A query of a DNR using the of the domain name to the proper subset. A query of a DNR using the
IDN itself might map across multiple registrations depending on the IDN itself might map across multiple registrations depending on the
mapping rules of the DNR. mapping rules of the DNR.
Appendix D. Postal Addresses vs Location Appendix D. Postal Addresses vs Location
The postal address data listed in the entity object class (Section 4) The postal address data listed in the entity object class (Section 7)
does not necessarily represent location. The intent of this does not necessarily represent location. The intent of this
information is to provide a means to send postal mail to an entity. information is to provide a means to send postal mail to an entity.
While in some cases it may also be the location of the entity, there While in some cases it may also be the location of the entity, there
is no gaurantee that the two are the same. Accurate representation is no guarantee that the two are the same.
of location is topic unto itself, and registries wishing to show
location of object instances should use the 'geo' or 'held' URI types
as meantioned in Appendix A.3.
Additionally, the postal address data represented in this document Additionally, the postal address data represented in this document
does not follow any specific standard for postal addresses because does not follow any specific standard for postal addresses because
many registries do not keep postal address data in an many registries do not keep postal address data in an
internationalized standard form. Publication of such data in a internationalized standard form. Publication of such data in a
format that suggests an internationalized standard form when such format that suggests an internationalized standard form when such
data is not known to be well-formed for that purpose would be data is not known to be well-formed for that purpose would be
misleading. misleading.
Appendix E. Changelog Appendix E. 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 enfluence
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
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 unversial 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 F. Changelog
Initial -00 Adopted as working group document 2012-September-18. 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 relationshipt 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.
Added the IANA Considerations section and the media type
registration.
Added 'lang' name/value.
Added internationalization considerations section.
Authors' Addresses Authors' Addresses
Andrew Lee Newton Andrew Lee Newton
American Registry for Internet Numbers American Registry for Internet Numbers
3635 Concorde Parkway 3635 Concorde Parkway
Chantilly, VA 20151 Chantilly, VA 20151
US US
Email: andy@arin.net Email: andy@arin.net
URI: http://www.arin.net URI: http://www.arin.net
 End of changes. 118 change blocks. 
266 lines changed or deleted 686 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/