JSON Responses for the Registration Data Access Protocol (RDAP)
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".
Show full document text