File: rfc7483.html

package info (click to toggle)
doc-rfc 20230121-1
links: PTS, VCS
area: non-free
in suites: bookworm, forky, sid, trixie
size: 1,609,944 kB
file content (4365 lines) | stat: -rw-r--r-- 155,818 bytes
parent folder | download | duplicates (2)
<pre>Internet Engineering Task Force (IETF)                         A. Newton
Request for Comments: 7483                                          ARIN
Category: Standards Track                                  S. Hollenbeck
ISSN: 2070-1721                                            Verisign Labs
                                                              March 2015


    <span class="h1">JSON Responses for the Registration Data Access Protocol (RDAP)</span>

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 is an Internet Standards Track document.

   This document is a product of the Internet Engineering Task Force
   (IETF).  It represents the consensus of the IETF community.  It has
   received public review and has been approved for publication by the
   Internet Engineering Steering Group (IESG).  Further information on
   Internet Standards is available in <a href="./rfc5741#section-2">Section&nbsp;2 of RFC 5741</a>.

   Information about the current status of this document, any errata,
   and how to provide feedback on it may be obtained at
   <a href="http://www.rfc-editor.org/info/rfc7483">http://www.rfc-editor.org/info/rfc7483</a>.

Copyright Notice

   Copyright (c) 2015 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) 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.






<span class="grey">Newton &amp; Hollenbeck          Standards Track                    [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


Table of Contents

   <a href="#section-1">1</a>.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   <a href="#page-3">3</a>
     <a href="#section-1.1">1.1</a>.  Terminology and Definitions . . . . . . . . . . . . . . .   <a href="#page-3">3</a>
     <a href="#section-1.2">1.2</a>.  Data Model  . . . . . . . . . . . . . . . . . . . . . . .   <a href="#page-4">4</a>
   <a href="#section-2">2</a>.  Use of JSON . . . . . . . . . . . . . . . . . . . . . . . . .   <a href="#page-5">5</a>
     <a href="#section-2.1">2.1</a>.  Naming  . . . . . . . . . . . . . . . . . . . . . . . . .   <a href="#page-5">5</a>
   <a href="#section-3">3</a>.  Common Data Types . . . . . . . . . . . . . . . . . . . . . .   <a href="#page-7">7</a>
   <a href="#section-4">4</a>.  Common Data Structures  . . . . . . . . . . . . . . . . . . .   <a href="#page-8">8</a>
     <a href="#section-4.1">4.1</a>.  RDAP Conformance  . . . . . . . . . . . . . . . . . . . .   <a href="#page-8">8</a>
     <a href="#section-4.2">4.2</a>.  Links . . . . . . . . . . . . . . . . . . . . . . . . . .   <a href="#page-9">9</a>
     <a href="#section-4.3">4.3</a>.  Notices and Remarks . . . . . . . . . . . . . . . . . . .  <a href="#page-10">10</a>
     <a href="#section-4.4">4.4</a>.  Language Identifier . . . . . . . . . . . . . . . . . . .  <a href="#page-11">11</a>
     <a href="#section-4.5">4.5</a>.  Events  . . . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-11">11</a>
     <a href="#section-4.6">4.6</a>.  Status  . . . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-13">13</a>
     <a href="#section-4.7">4.7</a>.  Port 43 WHOIS Server  . . . . . . . . . . . . . . . . . .  <a href="#page-13">13</a>
     <a href="#section-4.8">4.8</a>.  Public IDs  . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-13">13</a>
     <a href="#section-4.9">4.9</a>.  Object Class Name . . . . . . . . . . . . . . . . . . . .  <a href="#page-14">14</a>
     <a href="#section-4.10">4.10</a>. An Example  . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-14">14</a>
   <a href="#section-5">5</a>.  Object Classes  . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-15">15</a>
     <a href="#section-5.1">5.1</a>.  The Entity Object Class . . . . . . . . . . . . . . . . .  <a href="#page-16">16</a>
     <a href="#section-5.2">5.2</a>.  The Nameserver Object Class . . . . . . . . . . . . . . .  <a href="#page-22">22</a>
     <a href="#section-5.3">5.3</a>.  The Domain Object Class . . . . . . . . . . . . . . . . .  <a href="#page-26">26</a>
     <a href="#section-5.4">5.4</a>.  The IP Network Object Class . . . . . . . . . . . . . . .  <a href="#page-38">38</a>
     <a href="#section-5.5">5.5</a>.  Autonomous System Number Entity Object Class  . . . . . .  <a href="#page-42">42</a>
   <a href="#section-6">6</a>.  Error Response Body . . . . . . . . . . . . . . . . . . . . .  <a href="#page-45">45</a>
   <a href="#section-7">7</a>.  Responding to Help Queries  . . . . . . . . . . . . . . . . .  <a href="#page-48">48</a>
   <a href="#section-8">8</a>.  Responding To Searches  . . . . . . . . . . . . . . . . . . .  <a href="#page-48">48</a>
   <a href="#section-9">9</a>.  Indicating Truncated Responses  . . . . . . . . . . . . . . .  <a href="#page-49">49</a>
   <a href="#section-10">10</a>. IANA Considerations . . . . . . . . . . . . . . . . . . . . .  <a href="#page-52">52</a>
     <a href="#section-10.1">10.1</a>.  RDAP JSON Media Type Registration  . . . . . . . . . . .  <a href="#page-52">52</a>
     <a href="#section-10.2">10.2</a>.  JSON Values Registry . . . . . . . . . . . . . . . . . .  <a href="#page-53">53</a>
       <a href="#section-10.2.1">10.2.1</a>.  Notice and Remark Types  . . . . . . . . . . . . . .  <a href="#page-54">54</a>
       <a href="#section-10.2.2">10.2.2</a>.  Status . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-56">56</a>
       <a href="#section-10.2.3">10.2.3</a>.  Event Actions  . . . . . . . . . . . . . . . . . . .  <a href="#page-49">49</a>
       <a href="#section-10.2.4">10.2.4</a>.  Roles  . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-61">61</a>
       <a href="#section-10.2.5">10.2.5</a>.  Variant Relations  . . . . . . . . . . . . . . . . .  <a href="#page-63">63</a>
   <a href="#section-11">11</a>. Security Considerations . . . . . . . . . . . . . . . . . . .  <a href="#page-64">64</a>
   <a href="#section-12">12</a>. Internationalization Considerations . . . . . . . . . . . . .  <a href="#page-64">64</a>
     <a href="#section-12.1">12.1</a>.  Character Encoding . . . . . . . . . . . . . . . . . . .  <a href="#page-64">64</a>
     <a href="#section-12.2">12.2</a>.  URIs and IRIs  . . . . . . . . . . . . . . . . . . . . .  <a href="#page-64">64</a>
     <a href="#section-12.3">12.3</a>.  Language Tags  . . . . . . . . . . . . . . . . . . . . .  <a href="#page-64">64</a>
     <a href="#section-12.4">12.4</a>.  Internationalized Domain Names . . . . . . . . . . . . .  <a href="#page-65">65</a>
   <a href="#section-13">13</a>. Privacy Considerations  . . . . . . . . . . . . . . . . . . .  <a href="#page-65">65</a>
   <a href="#section-14">14</a>. References  . . . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-65">65</a>
     <a href="#section-14.1">14.1</a>.  Normative References . . . . . . . . . . . . . . . . . .  <a href="#page-65">65</a>
     <a href="#section-14.2">14.2</a>.  Informative References . . . . . . . . . . . . . . . . .  <a href="#page-67">67</a>




<span class="grey">Newton &amp; Hollenbeck          Standards Track                    [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   <a href="#appendix-A">Appendix A</a>.  Suggested Data Modeling with the Entity Object Class  68
     <a href="#appendix-A.1">A.1</a>.  Registrants and Contacts  . . . . . . . . . . . . . . . .  <a href="#page-68">68</a>
     <a href="#appendix-A.2">A.2</a>.  Registrars  . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-70">70</a>
   <a href="#appendix-B">Appendix B</a>.  Modeling Events  . . . . . . . . . . . . . . . . . .  <a href="#page-72">72</a>
   <a href="#appendix-C">Appendix C</a>.  Structured vs. Unstructured Addresses  . . . . . . .  <a href="#page-74">74</a>
   <a href="#appendix-D">Appendix D</a>.  Secure DNS . . . . . . . . . . . . . . . . . . . . .  <a href="#page-76">76</a>
   <a href="#appendix-E">Appendix E</a>.  Motivations for Using JSON . . . . . . . . . . . . .  <a href="#page-77">77</a>
   Acknowledgements  . . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-77">77</a>
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-78">78</a>

<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>.  Introduction</span>

   This document describes responses in the JSON [<a href="./rfc7159" title="&quot;The JavaScript Object Notation (JSON) Data Interchange Format&quot;">RFC7159</a>] format for
   the queries as defined by the Registration Data Access Protocol Query
   Format [<a href="./rfc7482" title="&quot;Registration Data Access Protocol (RDAP) Query Format&quot;">RFC7482</a>].  A communication protocol for exchanging queries
   and responses is described in [<a href="./rfc7480" title="&quot;HTTP Usage in the Registration Data Access Protocol (RDAP)&quot;">RFC7480</a>].

<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>.  Terminology and Definitions</span>

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
   document are to be interpreted as described in [<a href="./rfc2119" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">RFC2119</a>] when
   specified in their uppercase forms.

   The following list describes terminology and definitions used
   throughout this document:

   DNR:              Domain Name Registry

   LDH:              letters, digits, hyphen

   member:           data found within an object as defined by JSON
                     [<a href="./rfc7159" title="&quot;The JavaScript Object Notation (JSON) Data Interchange Format&quot;">RFC7159</a>].

   object:           a data structure as defined by JSON [<a href="./rfc7159" title="&quot;The JavaScript Object Notation (JSON) Data Interchange Format&quot;">RFC7159</a>].

   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






<span class="grey">Newton &amp; Hollenbeck          Standards Track                    [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a>.  Data Model</span>

   The data model for JSON responses is specified in five 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
       lookup of a single object

   4.  arrays of objects representing structured data corresponding to a
       search for multiple objects

   5.  the response to an error

   The object classes represent responses for two major categories of
   data: responses returned by RIRs for registration data related to IP
   addresses, reverse DNS names, and Autonomous System numbers and
   responses returned by DNRs for registration data related to forward
   DNS names.  The following object classes are returned 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:

   1.  IP networks

   2.  Autonomous System numbers

   Object classes defined in this document represent a minimal set of
   what a compliant client/server needs to understand to function
   correctly; however, some deployments may want to include additional
   object classes to suit individual needs.  Anticipating this need for
   extension, <a href="#section-2.1">Section 2.1</a> of this document defines a mechanism for
   extending the JSON objects that are described in this document.




<span class="grey">Newton &amp; Hollenbeck          Standards Track                    [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   Positive responses take two forms.  A response to a lookup of a
   single object in the registration system yields a JSON object, which
   is the subject of the lookup.  A response to a search for multiple
   objects yields a JSON object that contains an array of JSON objects
   that are the subject of the search.  In each type of response, other
   data structures are present within the topmost JSON object.

<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>.  Use of JSON</span>

<span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>.  Naming</span>

   Clients of these JSON responses SHOULD ignore unrecognized JSON
   members in responses.  Servers can insert members into the JSON
   responses, which are not specified in this document, but that does
   not constitute an error in the response.  Servers that insert such
   unspecified members into JSON responses SHOULD have member names
   prefixed with a short identifier followed by an underscore followed
   by a meaningful name.  It has been observed that these short
   identifiers aid software implementers with identifying the
   specification of the JSON member, and failure to use one could cause
   an implementer to assume the server is erroneously using a name from
   this specification.  This allowance does not apply to jCard [<a href="./rfc7095" title="&quot;jCard: The JSON Format for vCard&quot;">RFC7095</a>]
   objects.  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 [<a href="./rfc7480" title="&quot;HTTP Usage in the Registration Data Access Protocol (RDAP)&quot;">RFC7480</a>].  Failure to use these
   limitations could result in slower adoption as these limitations have
   been observed to aid some client programming models.

   Consider the following JSON response with JSON members, all of which
   are specified in this document.

   {
     "handle" : "ABC123",
     "remarks" :
     [
       {
         "description" :
         [
           "She sells sea shells down by the sea shore.",
           "Originally written by Terry Sullivan."
         ]
       }
     ]
   }

                                 Figure 1





<span class="grey">Newton &amp; Hollenbeck          Standards Track                    [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   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 member named
   "lunarNic_beforeOneSmallStep" to signify registrations occurring
   before the first moon landing and the member named
   "lunarNic_harshMistressNotes" that contains 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" :
     [
       {
         "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 members ignored by clients may also be used
   for future revisions to this specification.

   Clients processing JSON responses need to be prepared for members
   representing registration data specified in this document to be
   absent from a response.  In other words, servers are free to not
   include JSON members containing registration data based on their own
   policies.

   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.







<span class="grey">Newton &amp; Hollenbeck          Standards Track                    [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>.  Common Data Types</span>

   JSON [<a href="./rfc7159" title="&quot;The JavaScript Object Notation (JSON) Data Interchange Format&quot;">RFC7159</a>] defines the data types of a number, character string,
   boolean, array, object, and null.  This section describes the
   semantics and/or syntax reference for common, JSON character strings
   used in this document.

   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 are to be a registry-unique
                     reference to the closest enclosing object where the
                     value is found.  The data type names "registryId",
                     "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.  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 [<a href="./rfc5952" title="&quot;A Recommendation for IPv6 Address Text Representation&quot;">RFC5952</a>].
                     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 two-character country code
                     designation as defined in [<a href="#ref-ISO.3166.1988">ISO.3166.1988</a>].  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 [<a href="./rfc5890" title="&quot;Internationalized Domain Names for Applications (IDNA): Definitions and Document Framework&quot;">RFC5890</a>].  Trailing
                     periods are optional.

   Unicode names:    Textual representations of DNS names where one or
                     more of the labels are U-labels as described by
                     [<a href="./rfc5890" title="&quot;Internationalized Domain Names for Applications (IDNA): Definitions and Document Framework&quot;">RFC5890</a>].  Trailing periods are optional.

   dates and times:  The syntax for values denoting dates and times is
                     defined in [<a href="./rfc3339" title="&quot;Date and Time on the Internet: Timestamps&quot;">RFC3339</a>].



<span class="grey">Newton &amp; Hollenbeck          Standards Track                    [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   URIs:             The syntax for values denoting a Uniform Resource
                     Identifier (URI) is defined by [<a href="./rfc3986" title="&quot;Uniform Resource Identifier (URI): Generic Syntax&quot;">RFC3986</a>].

   Contact information is defined using jCards as described in
   [<a href="./rfc7095" title="&quot;jCard: The JSON Format for vCard&quot;">RFC7095</a>].

<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>.  Common Data Structures</span>

   This section defines common data structures used in responses and
   object classes.

<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>.  RDAP Conformance</span>

   The data structure named "rdapConformance" is 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 topmost JSON 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 MUST use a string prefixed
   with the appropriate identifier from the IANA RDAP Extensions
   registry specified in [<a href="./rfc7480" title="&quot;HTTP Usage in the Registration Data Access Protocol (RDAP)&quot;">RFC7480</a>].  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".  These prefixes aid the identification of
   specifications for software implementers, and failure to use them
   could result in slower adoption of extensions.

   Example rdapConformance structure with custom extensions noted:

   "rdapConformance" :
   [
     "rdap_level_0",
     "lunarNic_level_0"
   ]

                                 Figure 4




<span class="grey">Newton &amp; Hollenbeck          Standards Track                    [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>.  Links</span>

   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 [<a href="./rfc5988" title="&quot;Web Linking&quot;">RFC5988</a>].

   The following is an example of the link structure:

       {
         "value" : "http://example.com/context_uri",
         "rel" : "self",
         "href" : "http://example.com/target_uri",
         "hreflang" : [ "en", "ch" ],
         "title" : "title",
         "media" : "screen",
         "type" : "application/json"
       }

                                 Figure 5

   The JSON name/values of "rel", "href", "hreflang", "title", "media",
   and "type" correspond to values found in <a href="./rfc5988#section-5">Section&nbsp;5 of [RFC5988]</a>.  The
   "value" JSON value is the context URI as described by [<a href="./rfc5988" title="&quot;Web Linking&quot;">RFC5988</a>].  The
   "href" JSON value 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",
             "type" : "application/rdap+json"
           },
           {
             "value" : "http://example.com/ip/2001:db8::123",
             "rel" : "up",
             "href" : "http://example.com/ip/2001:db8::/48",
             "type" : "application/rdap+json"
           }

       ]

                                 Figure 6




<span class="grey">Newton &amp; Hollenbeck          Standards Track                    [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a>.  Notices and Remarks</span>

   The "notices" and "remarks" data structures take the same form.  The
   notices structure denotes information about the service providing
   RDAP information and/or information about the entire response,
   whereas the remarks structure denotes information about the object
   class that contains it (see <a href="#section-5">Section 5</a> regarding object classes).

   Both are arrays of objects.  Each object contains an optional "title"
   string representing the title of the object, an optional "type"
   string denoting a registered type of remark or notice (see
   <a href="#section-10.2.1">Section 10.2.1</a>), an array of strings named "description" for the
   purposes of conveying any descriptive text, and an optional "links"
   array as described in <a href="#section-4.2">Section 4.2</a>.

   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 7

   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.  Each string in the "description" array contains
   a single complete division of human-readable text indicating to
   clients where there are semantic breaks.






<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   An example of the remarks data structure:

   "remarks" :
   [
     {
       "description" :
       [
         "She sells sea shells down by the sea shore.",
         "Originally written by Terry Sullivan."
       ]
     }
   ]

                                 Figure 8

   Note that objects in the "remarks" array may also have a "links"
   array.

   While the "title" and "description" fields are intended primarily for
   human consumption, the "type" string contains a well-known value to
   be registered with IANA (see <a href="#section-10.2.1">Section 10.2.1</a>) for programmatic use.

   An example of the remarks data structure:

   "remarks" :
   [
     {
       "type" : "object truncated due to authorization",
       "description" :
       [
         "Some registration data may not have been given.",
         "Use proper authorization credentials to see all of it."
       ]
     }
   ]

                                 Figure 9

   While the "remarks" array will appear in many object classes in a
   response, the "notices" array appears only in the topmost object of a
   response.










<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h3"><a class="selflink" id="section-4.4" href="#section-4.4">4.4</a>.  Language Identifier</span>

   This data structure consists solely of a name/value pair, where the
   name is "lang" and the value is a string containing a language
   identifier as described in [<a href="./rfc5646" title="&quot;Tags for Identifying Languages&quot;">RFC5646</a>].

   "lang" : "mn-Cyrl-MN"

                                 Figure 10

   The "lang" attribute may appear anywhere in an object class or data
   structure except for in jCard objects.

<span class="h3"><a class="selflink" id="section-4.5" href="#section-4.5">4.5</a>.  Events</span>

   This data structure represents events that have occurred on an
   instance of an object class (see <a href="#section-5">Section 5</a> regarding object classes).

   This is an example of an "events" array.

   "events" :
   [
     {
       "eventAction" : "registration",
       "eventActor" : "SOMEID-LUNARNIC",
       "eventDate" : "1990-12-31T23:59:59Z"
     },
     {
       "eventAction" : "last changed",
       "eventActor" : "OTHERID-LUNARNIC",
       "eventDate" : "1991-12-31T23:59:59Z"
     }
   ]

                                 Figure 11

   The "events" array consists of objects, each with the following
   members:

   o  "eventAction" -- a string denoting the reason for the event

   o  "eventActor" -- an optional identifier denoting the actor
      responsible for the event

   o  "eventDate" -- a string containing the time and date the event
      occurred.

   o  "links" -- see <a href="#section-4.2">Section 4.2</a>



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   Events can be future dated.  One use case for future dating of events
   is to denote when an object expires from a registry.

   The "links" array in this data structure is provided for references
   to the event actor.  In order to reference an RDAP entity, a "rel" of
   "related" and a "type" of "application/rdap+json" is used in the link
   reference.

   See <a href="#section-10.2.3">Section 10.2.3</a> for a list of values for the "eventAction" string.
   See <a href="#appendix-B">Appendix B</a> regarding the various ways events can be modeled.

<span class="h3"><a class="selflink" id="section-4.6" href="#section-4.6">4.6</a>.  Status</span>

   This data structure, named "status", is an array of strings
   indicating the state of a registered object (see <a href="#section-10.2.2">Section 10.2.2</a> for a
   list of values).

<span class="h3"><a class="selflink" id="section-4.7" href="#section-4.7">4.7</a>.  Port 43 WHOIS Server</span>

   This data structure, a member named "port43", is a simple string
   containing the fully qualified host name or IP address of the WHOIS
   [<a href="./rfc3912" title="&quot;WHOIS Protocol Specification&quot;">RFC3912</a>] server where the containing object instance may be found.
   Note that this is not a URI, as there is no WHOIS URI scheme.

<span class="h3"><a class="selflink" id="section-4.8" href="#section-4.8">4.8</a>.  Public IDs</span>

   This data structure maps a public identifier to an object class.  It
   is named "publicIds" and is an array of objects, with each object
   containing the following members:

   o  type -- a string denoting the type of public identifier

   o  identifier -- a public identifier of the type denoted by "type"

   The following is an example of a publicIds structure.

   "publicIds":
   [
     {
       "type":"IANA Registrar ID",
       "identifier":"1"
     }
   ]

                                 Figure 12






<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h3"><a class="selflink" id="section-4.9" href="#section-4.9">4.9</a>.  Object Class Name</span>

   This data structure, a member named "objectClassName", gives the
   object class name of a particular object as a string.  This
   identifies the type of object being processed.  An objectClassName is
   REQUIRED in all RDAP response objects so that the type of the object
   can be interpreted.

<span class="h3"><a class="selflink" id="section-4.10" href="#section-4.10">4.10</a>.  An Example</span>

   This is an example response with both rdapConformance and notices
   embedded:

   {
     "rdapConformance" :
     [
       "rdap_level_0"
     ],
     "notices" :
     [
       {
         "title" : "Content Removed",
         "description" :
         [
           "Without full authorization, content has been removed.",
           "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",
     "objectClassName" : "ip network",
     "startAddress" : "192.0.2.0",
     "endAddress" : "192.0.2.255",
     "handle" : "XXXX-RIR",
     "ipVersion" : "v4",
     "name": "NET-RTR-1",
     "parentHandle" : "YYYY-RIR",
     "remarks" :
     [



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


       {
         "description" :
         [
           "She sells sea shells down by the sea shore.",
           "Originally written by Terry Sullivan."
         ]
       }
     ]
   }

                                 Figure 13

<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>.  Object Classes</span>

   Object classes represent structures appropriate for a response from
   the queries specified in [<a href="./rfc7482" title="&quot;Registration Data Access Protocol (RDAP) Query Format&quot;">RFC7482</a>].

   Each object class contains a "links" array as specified in
   <a href="#section-4.2">Section 4.2</a>.  For every object class instance in a response, whether
   the object class instance is directly representing the response to a
   query or is embedded in other object class instances or is an item in
   a search result set, servers SHOULD provide a link representing a URI
   for that object class instance using the "self" relationship as
   described in the IANA registry specified by [<a href="./rfc5988" title="&quot;Web Linking&quot;">RFC5988</a>].  As explained
   in <a href="#section-5.2">Section 5.2</a>, this may be not always be possible for nameserver
   data.  Clients MUST be able to process object instances without a
   self link.  When present, clients can use the self link for caching
   data.  Servers MAY provide more than one self link for any given
   object instance.  Failure to provide any self link by a server may
   result in clients being unable to cache object class instances.

   Clients using self links for caching SHOULD not cache any object
   class instances where the authority of the self link is different
   than the authority of the server returning the data.  Failing to do
   so might result in cache poisoning.

   Self links MUST contain a "type" element containing the "application/
   rdap+json" media type when referencing RDAP object instances as
   defined by this document.












<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   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",
             "type" : "application/rdap+json"
           }
       ]

                                 Figure 14

<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>.  The Entity Object Class</span>

   The entity object class appears throughout this document and is an
   appropriate response for the /entity/XXXX query defined in
   "Registration Data Access Protocol (RDAP) Query Format" [<a href="./rfc7482" title="&quot;Registration Data Access Protocol (RDAP) Query Format&quot;">RFC7482</a>].
   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 [<a href="./rfc7159" title="&quot;The JavaScript Object Notation (JSON) Data Interchange Format&quot;">RFC7159</a>] with one
   construct, the entity object class, to aid in the reuse of code by
   implementers.

   The entity object class uses jCard [<a href="./rfc7095" title="&quot;jCard: The JSON Format for vCard&quot;">RFC7095</a>] to represent contact
   information, such as postal addresses, email addresses, phone numbers
   and names of organizations and individuals.  Many of the types of
   information that can be represented with jCard have no use in RDAP,
   such as birthdays, anniversaries, and gender.

   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.

   {
     "objectClassName" : "entity",
     "handle":"XXXX",
     "vcardArray":[
       "vcard",
       [
         ["version", {}, "text", "4.0"],
         ["fn", {}, "text", "Joe User"],
         ["n", {}, "text",
           ["User", "Joe", "", "", ["ing. jr", "M.Sc."]]
         ],
         ["kind", {}, "text", "individual"],



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


         ["lang", {
           "pref":"1"
         }, "language-tag", "fr"],
         ["lang", {
           "pref":"2"
         }, "language-tag", "en"],
         ["org", {
           "type":"work"
         }, "text", "Example"],
         ["title", {}, "text", "Research Scientist"],
         ["role", {}, "text", "Project Lead"],
         ["adr",
           { "type":"work" },
           "text",
           [
             "",
             "Suite 1234",
             "4321 Rue Somewhere",
             "Quebec",
             "QC",
             "G1V 2M2",
             "Canada"
           ]
         ],
         ["adr",
           {
             "type":"home",
             "label":"123 Maple Ave\nSuite 90001\nVancouver\nBC\n1239\n"
           },
           "text",
           [
             "", "", "", "", "", "", ""
           ]
         ],
         ["tel",
           {
             "type":["work", "voice"],
             "pref":"1"
           },
           "uri",
           "tel:+1-555-555-1234;ext=102"
         ],
         ["tel",
           { "type":["work", "cell", "voice", "video", "text"] },
           "uri",
           "tel:+1-555-555-4321"
         ],
         ["email",



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


           { "type":"work" },
           "text",
           "joe.user@example.com"
         ],
         ["geo", {
           "type":"work"
         }, "uri", "geo:46.772673,-71.282945"],
         ["key",
           { "type":"work" },
           "uri",
           "http://www.example.com/joe.user/joe.asc"
         ],
         ["tz", {},
           "utc-offset", "-05:00"],
         ["url", { "type":"home" },
           "uri", "http://example.org"]
       ]
     ],
     "roles":[ "registrar" ],
     "publicIds":[
       {
         "type":"IANA Registrar ID",
         "identifier":"1"
       }
     ],
     "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",
         "type" : "application/rdap+json"
       }
     ],
     "events":[
       {
         "eventAction":"registration",
         "eventDate":"1990-12-31T23:59:59Z"
       }
     ],
     "asEventActor":[



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


       {
         "eventAction":"last changed",
         "eventDate":"1991-12-31T23:59:59Z"
       }
     ]
   }

                                 Figure 15

   The entity object class can contain the following members:

   o  objectClassName -- the string "entity"

   o  handle -- a string representing a registry unique identifier of
      the entity

   o  vcardArray -- a jCard 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
      <a href="#section-10.2.4">Section 10.2.4</a> for a list of values)

   o  publicIds -- see <a href="#section-4.8">Section 4.8</a>

   o  entities -- an array of entity objects as defined by this section

   o  remarks -- see <a href="#section-4.3">Section 4.3</a>

   o  links -- see <a href="#section-4.2">Section 4.2</a>

   o  events -- see <a href="#section-4.5">Section 4.5</a>

   o  asEventActor -- this data structure takes the same form as the
      events data structure (see <a href="#section-4.5">Section 4.5</a>), 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
      <a href="#appendix-B">Appendix B</a> regarding the various ways events can be modeled.

   o  status -- see <a href="#section-4.6">Section 4.6</a>

   o  port43 -- see <a href="#section-4.7">Section 4.7</a>

   o  networks -- an array of IP network objects as defined in
      <a href="#section-5.4">Section 5.4</a>

   o  autnums -- an array of autnum objects as defined in <a href="#section-5.5">Section 5.5</a>





<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   Entities may also have other entities embedded with them in an array.
   This can be used to model an organization with specific individuals
   fulfilling designated roles of responsibility.

   The following is an elided example of an entity with embedded
   entities.

   {
     "objectClassName" : "entity",
     "handle" : "ANENTITY",
     "roles" : [ "registrar" ],
     ...
     "entities" :
     [
       {
         "objectClassName" : "entity",
         "handle": "ANEMBEDDEDENTITY",
         "roles" : [ "technical" ],
         ...
       },
       ...
     ],
     ...
   }

                                 Figure 16

   The following is an example of an entity that might be served by a
   DNR.

   {
     "objectClassName" : "entity",
     "handle":"XXXX",
     "vcardArray":[
       "vcard",
       [
         ["version", {}, "text", "4.0"],
         ["fn", {}, "text", "Joe User"],
         ["kind", {}, "text", "individual"],
         ["lang", {
           "pref":"1"
         }, "language-tag", "fr"],
         ["lang", {
           "pref":"2"
         }, "language-tag", "en"],
         ["org", {
           "type":"work"
         }, "text", "Example"],



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


         ["title", {}, "text", "Research Scientist"],
         ["role", {}, "text", "Project Lead"],
         ["adr",
           { "type":"work" },
           "text",
           [
             "",
             "Suite 1234",
             "4321 Rue Somewhere",
             "Quebec",
             "QC",
             "G1V 2M2",
             "Canada"
           ]
         ],
         ["tel",
           { "type":["work", "voice"], "pref":"1" },
           "uri", "tel:+1-555-555-1234;ext=102"
         ],
         ["email",
           { "type":"work" },
           "text", "joe.user@example.com"
         ]
       ]
     ],
     "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",
         "type":"application/rdap+json"
       }
     ],
     "port43":"whois.example.net",
     "events":[
       {
         "eventAction":"registration",
         "eventDate":"1990-12-31T23:59:59Z"
       },



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


       {
         "eventAction":"last changed",
         "eventDate":"1991-12-31T23:59:59Z",
         "eventActor":"joe@example.com"
       }
     ]
   }

                                 Figure 17

   See <a href="#appendix-A">Appendix A</a> for use of the entity object class to model various
   types of entities found in both RIRs and DNRs.  See <a href="#appendix-C">Appendix C</a>
   regarding structured vs.  unstructured postal addresses in entities.

<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>.  The Nameserver Object Class</span>

   The nameserver object class represents information regarding DNS
   nameservers 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.


























<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


     {
       "objectClassName" : "nameserver",
       "handle" : "XXXX",
       "ldhName" : "ns1.xn--fo-5ja.example",
       "unicodeName" : "ns1.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",
           "type" : "application/rdap+json"
         }
       ],
       "port43" : "whois.example.net",
       "events" :
       [
         {
           "eventAction" : "registration",
           "eventDate" : "1990-12-31T23:59:59Z"
         },
         {
           "eventAction" : "last changed",
           "eventDate" : "1991-12-31T23:59:59Z",
           "eventActor" : "joe@example.com"
         }
       ]
     }


                                 Figure 18




<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   Figure 18 is an example of a nameserver object with all values given.
   Registries using a first-class nameserver data model would embed this
   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 19 is an example of a nameserver object as would be found in
   RIRs and some DNRs, while Figure 20 is an example of a nameserver
   object as would be found in other DNRs.

   The following is an example of the simplest nameserver object:

     {
       "objectClassName" : "nameserver",
       "ldhName" : "ns1.example.com"
     }

                                 Figure 19

   The following is an example of a simple nameserver object that might
   be commonly used by DNRs:

     {
       "objectClassName" : "nameserver",
       "ldhName" : "ns1.example.com",
       "ipAddresses" : { "v6" : [ "2001:db8::123", "2001:db8::124" ] }
     }

                                 Figure 20

   As nameservers can be modeled by some registries to be first-class
   objects, they may also have an array of entities (<a href="#section-5.1">Section 5.1</a>)
   embedded to signify parties responsible for the maintenance,
   registrations, etc., of the nameservers.

   The following is an elided example of a nameserver with embedded
   entities.















<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   {
     "objectClassName" : "nameserver",
     "handle" : "XXXX",
     "ldhName" : "ns1.xn--fo-5ja.example",
     ...
     "entities" :
     [
       ...
     ],
     ...
   }

                                 Figure 21

   The nameserver object class can contain the following members:

   o  objectClassName -- the string "nameserver"

   o  handle -- a string representing a registry unique identifier of
      the nameserver

   o  ldhName -- a string containing the LDH name of the nameserver (see
      <a href="#section-3">Section 3</a>)

   o  unicodeName -- a string containing a DNS Unicode name of the
      nameserver (see <a href="#section-3">Section 3</a>)

   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

   o  entities -- an array of entity objects as defined by <a href="#section-5.1">Section 5.1</a>

   o  status -- see <a href="#section-4.6">Section 4.6</a>

   o  remarks -- see <a href="#section-4.3">Section 4.3</a>

   o  links -- see <a href="#section-4.2">Section 4.2</a>

   o  port43 -- see <a href="#section-4.7">Section 4.7</a>

   o  events -- see <a href="#section-4.5">Section 4.5</a>





<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>.  The Domain Object Class</span>

   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:

   {
     "objectClassName" : "domain",
     "handle" : "XXX",
     "ldhName" : "blah.example.com",
     ...
     "nameservers" :
     [
       ...
     ],
     ...
     "entities" :
     [
       ...
     ]
   }

                                 Figure 22

   The domain object class can contain the following members:

   o  objectClassName -- the string "domain"

   o  handle -- a string representing a registry unique identifier of
      the domain object instance

   o  ldhName -- a string describing a domain name in LDH form as
      described in <a href="#section-3">Section 3</a>

   o  unicodeName -- a string containing a domain name with U-labels as
      described in <a href="#section-3">Section 3</a>






<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   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 <a href="#section-10.2.5">Section 10.2.5</a> for a list of suggested variant
         relations).

      *  idnTable -- the name of the Internationalized Domain Name (IDN)
         table of codepoints, such as one listed with the IANA (see IDN
         tables [<a href="#ref-IANA_IDNTABLES">IANA_IDNTABLES</a>]).

      *  variantNames -- an array of objects, with each object
         containing an "ldhName" member and a "unicodeName" member (see
         <a href="#section-3">Section 3</a>).

   o  nameservers -- an array of nameserver objects as defined by
      <a href="#section-5.2">Section 5.2</a>

   o  secureDNS -- an object with the following members:

      *  zoneSigned -- true if the zone has been signed, false
         otherwise.

      *  delegationSigned -- boolean true if there are DS records in the
         parent, false otherwise.

      *  maxSigLife -- an integer representing the signature lifetime in
         seconds to be used when creating the RRSIG DS record in the
         parent zone [<a href="./rfc5910" title="&quot;Domain Name System (DNS) Security Extensions Mapping for the Extensible Provisioning Protocol (EPP)&quot;">RFC5910</a>].

      *  dsData -- an array of objects, each with the following members:

         +  keyTag -- an integer as specified by the key tag field of a
            DNS DS record as specified by [<a href="./rfc4034" title="&quot;Resource Records for the DNS Security Extensions&quot;">RFC4034</a>] in presentation
            format

         +  algorithm -- an integer as specified by the algorithm field
            of a DNS DS record as described by <a href="./rfc4034">RFC 4034</a> in presentation
            format

         +  digest -- a string as specified by the digest field of a DNS
            DS record as specified by <a href="./rfc4034">RFC 4034</a> in presentation format

         +  digestType -- an integer as specified by the digest type
            field of a DNS DS record as specified by <a href="./rfc4034">RFC 4034</a> in
            presentation format




<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


         +  events -- see <a href="#section-4.5">Section 4.5</a>

         +  links -- see <a href="#section-4.2">Section 4.2</a>

      *  keyData -- an array of objects, each with the following
         members:

         +  flags -- an integer representing the flags field value in
            the DNSKEY record [<a href="./rfc4034" title="&quot;Resource Records for the DNS Security Extensions&quot;">RFC4034</a>] in presentation format

         +  protocol -- an integer representation of the protocol field
            value of the DNSKEY record [<a href="./rfc4034" title="&quot;Resource Records for the DNS Security Extensions&quot;">RFC4034</a>] in presentation format

         +  publicKey -- a string representation of the public key in
            the DNSKEY record [<a href="./rfc4034" title="&quot;Resource Records for the DNS Security Extensions&quot;">RFC4034</a>] in presentation format

         +  algorithm -- an integer as specified by the algorithm field
            of a DNSKEY record as specified by [<a href="./rfc4034" title="&quot;Resource Records for the DNS Security Extensions&quot;">RFC4034</a>] in presentation
            format

         +  events -- see <a href="#section-4.5">Section 4.5</a>

         +  links -- see <a href="#section-4.2">Section 4.2</a>

      See <a href="#appendix-D">Appendix D</a> for background information on these objects.

   o  entities -- an array of entity objects as defined by <a href="#section-5.1">Section 5.1</a>

   o  status -- see <a href="#section-4.6">Section 4.6</a>

   o  publicIds -- see <a href="#section-4.8">Section 4.8</a>

   o  remarks -- see <a href="#section-4.3">Section 4.3</a>

   o  links -- see <a href="#section-4.2">Section 4.2</a>

   o  port43 -- see <a href="#section-4.7">Section 4.7</a>

   o  events -- see <a href="#section-4.5">Section 4.5</a>

   o  network -- represents the IP network for which a reverse DNS
      domain is referenced.  See <a href="#section-5.4">Section 5.4</a>









<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   The following is an example of a JSON domain object representing a
   reverse DNS delegation point that might be served by an RIR.

   {
     "objectClassName" : "domain",
     "handle" : "XXXX",
     "ldhName" : "0.2.192.in-addr.arpa",
     "nameservers" :
     [
       {
         "objectClassName" : "nameserver",
         "ldhName" : "ns1.rir.example"
       },
       {
         "objectClassName" : "nameserver",
         "ldhName" : "ns2.rir.example"
       }
     ],
     "secureDNS":
     {
       "delegationSigned": true,
       "dsData":
       [
         {
           "keyTag": 12345,
           "algorithm": 3,
           "digestType": 1,
           "digest": "49FD46E6C4B45C55D4AC"
         }
       ]
     },
     "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",
         "type" : "application/rdap+json"



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


       }
     ],
     "events" :
     [
       {
         "eventAction" : "registration",
         "eventDate" : "1990-12-31T23:59:59Z"
       },
       {
         "eventAction" : "last changed",
         "eventDate" : "1991-12-31T23:59:59Z",
         "eventActor" : "joe@example.com"
       }
     ],
     "entities" :
     [
       {
         "objectClassName" : "entity",
         "handle" : "XXXX",
         "vcardArray":[
           "vcard",
           [
             ["version", {}, "text", "4.0"],
             ["fn", {}, "text", "Joe User"],
             ["kind", {}, "text", "individual"],
             ["lang", {
               "pref":"1"
             }, "language-tag", "fr"],
             ["lang", {
               "pref":"2"
             }, "language-tag", "en"],
             ["org", {
               "type":"work"
             }, "text", "Example"],
             ["title", {}, "text", "Research Scientist"],
             ["role", {}, "text", "Project Lead"],
             ["adr",
               { "type":"work" },
               "text",
               [
                 "",
                 "Suite 1234",
                 "4321 Rue Somewhere",
                 "Quebec",
                 "QC",
                 "G1V 2M2",
                 "Canada"
               ]



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 30]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


             ],
             ["tel",
               { "type":["work", "voice"], "pref":"1" },
               "uri", "tel:+1-555-555-1234;ext=102"
             ],
             ["email",
               { "type":"work" },
               "text", "joe.user@example.com"
             ]
           ]
         ],
         "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",
             "type" : "application/rdap+json"
           }
         ],
         "events" :
         [
           {
             "eventAction" : "registration",
             "eventDate" : "1990-12-31T23:59:59Z"
           },
           {
             "eventAction" : "last changed",
             "eventDate" : "1991-12-31T23:59:59Z",
             "eventActor" : "joe@example.com"
           }
         ]
       }
     ],
     "network" :
     {
       "objectClassName" : "ip network",



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 31]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


       "handle" : "XXXX-RIR",
       "startAddress" : "192.0.2.0",
       "endAddress" : "192.0.2.255",
       "ipVersion" : "v6",
       "name": "NET-RTR-1",
       "type" : "DIRECT ALLOCATION",
       "country" : "AU",
       "parentHandle" : "YYYY-RIR",
       "status" : [ "active" ]
     }
   }

                                 Figure 23

   The following is an example of a JSON domain object representing a
   forward DNS delegation point that might be served by a DNR.

   {
     "objectClassName" : "domain",
     "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" : "foo.example"
           }
         ]
       },
       {
         "relation" : [ "unregistered", "registration restricted" ],
         "idnTable": ".EXAMPLE Swedish",
         "variantNames" :
         [
           {
             "ldhName": "xn--fo-8ja.example",
             "unicodeName" : "foo.example"
           }
         ]



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 32]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


       }
     ],
     "status" : [ "locked", "transfer prohibited" ],
     "publicIds":[
       {
         "type":"ENS_Auth ID",
         "identifier":"1234567890"
       }
     ],
     "nameservers" :
     [
       {
         "objectClassName" : "nameserver",
         "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",
             "type" : "application/rdap+json"
           }
         ],
         "events" :
         [
           {
             "eventAction" : "registration",
             "eventDate" : "1990-12-31T23:59:59Z"
           },
           {
             "eventAction" : "last changed",



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 33]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


             "eventDate" : "1991-12-31T23:59:59Z"
           }
         ]
       },
       {
         "objectClassName" : "nameserver",
         "handle" : "XXXX",
         "ldhName" : "ns2.example.com",
         "status" : [ "active" ],
         "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",
             "type" : "application/rdap+json"
           }
         ],
         "events" :
         [
           {
             "eventAction" : "registration",
             "eventDate" : "1990-12-31T23:59:59Z"
           },
           {
             "eventAction" : "last changed",
             "eventDate" : "1991-12-31T23:59:59Z"
           }
         ]
       }
     ],
     "secureDNS":
     {



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 34]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


        "zoneSigned": true,
        "delegationSigned": true,
        "maxSigLife": 604800,
        "keyData":
        [
          {
            "flags": 257,
            "protocol": 3,
            "algorithm": 1,
            "publicKey": "AQPJ////4Q==",
            "events":
            [
              {
                "eventAction": "last changed",
                "eventDate": "2012-07-23T05:15:47Z"
              }
            ]
          }
        ]
     },
     "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/XXXX",
         "type" : "application/rdap+json"
       }
     ],
     "port43" : "whois.example.net",
     "events" :
     [
       {
         "eventAction" : "registration",
         "eventDate" : "1990-12-31T23:59:59Z"
       },
       {
         "eventAction" : "last changed",



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 35]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


         "eventDate" : "1991-12-31T23:59:59Z",
         "eventActor" : "joe@example.com"
       },
       {
         "eventAction" : "transfer",
         "eventDate" : "1991-12-31T23:59:59Z",
         "eventActor" : "joe@example.com"
       },
       {
         "eventAction" : "expiration",
         "eventDate" : "2016-12-31T23:59:59Z",
         "eventActor" : "joe@example.com"
       }
     ],
     "entities" :
     [
       {
         "objectClassName" : "entity",
         "handle" : "XXXX",
         "vcardArray":[
           "vcard",
           [
             ["version", {}, "text", "4.0"],
             ["fn", {}, "text", "Joe User"],
             ["kind", {}, "text", "individual"],
             ["lang", {
               "pref":"1"
             }, "language-tag", "fr"],
             ["lang", {
               "pref":"2"
             }, "language-tag", "en"],
             ["org", {
               "type":"work"
             }, "text", "Example"],
             ["title", {}, "text", "Research Scientist"],
             ["role", {}, "text", "Project Lead"],
             ["adr",
               { "type":"work" },
               "text",
               [
                 "",
                 "Suite 1234",
                 "4321 Rue Somewhere",
                 "Quebec",
                 "QC",
                 "G1V 2M2",
                 "Canada"
               ]



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 36]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


             ],
             ["tel",
               { "type":["work", "voice"], "pref":"1" },
               "uri", "tel:+1-555-555-1234;ext=102"
             ],
             ["email",
               { "type":"work" },
               "text", "joe.user@example.com"
             ]
           ]
         ],
         "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",
             "type" : "application/rdap+json"
           }
         ],
         "events" :
         [
           {
             "eventAction" : "registration",
             "eventDate" : "1990-12-31T23:59:59Z"
           },
           {
             "eventAction" : "last changed",
             "eventDate" : "1991-12-31T23:59:59Z"
           }
         ]
       }
     ]
   }

                                 Figure 24



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 37]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h3"><a class="selflink" id="section-5.4" href="#section-5.4">5.4</a>.  The IP Network Object Class</span>

   The IP network object class models IP network registrations found in
   RIRs and is the expected response for the "/ip" query as defined by
   [<a href="./rfc7482" title="&quot;Registration Data Access Protocol (RDAP) Query Format&quot;">RFC7482</a>].  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:

   {
     "objectClassName" : "ip network",
     "handle" : "XXX",
     ...
     "entities" :
     [
       ...
     ]
   }

                                 Figure 25

   The following is an example of the JSON object for the network
   registration information.

   {
     "objectClassName" : "ip network",
     "handle" : "XXXX-RIR",
     "startAddress" : "2001:db8::",
     "endAddress" : "2001:db8:0:ffff:ffff:ffff:ffff:ffff",
     "ipVersion" : "v6",
     "name": "NET-RTR-1",
     "type" : "DIRECT ALLOCATION",
     "country" : "AU",
     "parentHandle" : "YYYY-RIR",
     "status" : [ "active" ],
     "remarks" :
     [
       {
         "description" :
         [
           "She sells sea shells down by the sea shore.",
           "Originally written by Terry Sullivan."
         ]
       }
     ],



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 38]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


     "links" :
     [
       {
         "value" : "http://example.net/ip/2001:db8::/48",
         "rel" : "self",
         "href" : "http://example.net/ip/2001:db8::/48",
         "type" : "application/rdap+json"
       },
       {
         "value" : "http://example.net/ip/2001:db8::/48",
         "rel" : "up",
         "href" : "http://example.net/ip/2001:C00::/23",
         "type" : "application/rdap+json"
       }
     ],
     "events" :
     [
       {
         "eventAction" : "registration",
         "eventDate" : "1990-12-31T23:59:59Z"
       },
       {
         "eventAction" : "last changed",
         "eventDate" : "1991-12-31T23:59:59Z"
       }
     ],
     "entities" :
     [
       {
         "objectClassName" : "entity",
         "handle" : "XXXX",
         "vcardArray":[
           "vcard",
           [
             ["version", {}, "text", "4.0"],
             ["fn", {}, "text", "Joe User"],
             ["kind", {}, "text", "individual"],
             ["lang", {
               "pref":"1"
             }, "language-tag", "fr"],
             ["lang", {
               "pref":"2"
             }, "language-tag", "en"],
             ["org", {
               "type":"work"
             }, "text", "Example"],
             ["title", {}, "text", "Research Scientist"],
             ["role", {}, "text", "Project Lead"],



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 39]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


             ["adr",
               { "type":"work" },
               "text",
               [
                 "",
                 "Suite 1234",
                 "4321 Rue Somewhere",
                 "Quebec",
                 "QC",
                 "G1V 2M2",
                 "Canada"
               ]
             ],
             ["tel",
               { "type":["work", "voice"], "pref":"1" },
               "uri", "tel:+1-555-555-1234;ext=102"
             ],
             ["email",
               { "type":"work" },
               "text", "joe.user@example.com"
             ]
           ]
         ],
         "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",
             "type" : "application/rdap+json"
           }
         ],
         "events" :
         [
           {
             "eventAction" : "registration",
             "eventDate" : "1990-12-31T23:59:59Z"



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 40]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


           },
           {
             "eventAction" : "last changed",
             "eventDate" : "1991-12-31T23:59:59Z"
           }
         ]
       }
     ]
   }

                                 Figure 26

   The IP network object class can contain the following members:

   o  objectClassName -- the string "ip network"

   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

   o  ipVersion -- a string signifying the IP protocol version of the
      network: "v4" signifies an IPv4 network, and "v6" signifies an
      IPv6 network

   o  name -- an identifier assigned to the network registration by the
      registration holder

   o  type -- a string containing an RIR-specific classification of the
      network

   o  country -- a string containing the two-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 <a href="#section-5.1">Section 5.1</a>

   o  remarks -- see <a href="#section-4.3">Section 4.3</a>




<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 41]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   o  links -- see <a href="#section-4.2">Section 4.2</a>

   o  port43 -- see <a href="#section-4.7">Section 4.7</a>

   o  events -- see <a href="#section-4.5">Section 4.5</a>

<span class="h3"><a class="selflink" id="section-5.5" href="#section-5.5">5.5</a>.  Autonomous System Number Entity Object Class</span>

   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 [<a href="./rfc7482" title="&quot;Registration Data Access Protocol (RDAP) Query Format&quot;">RFC7482</a>].  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.

   {
     "objectClassName" : "autnum",
     "handle" : "XXXX-RIR",
     "startAutnum" : 10,
     "endAutnum" : 15,
     "name": "AS-RTR-1",
     "type" : "DIRECT ALLOCATION",
     "status" : [ "active" ],
     "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",
         "type" : "application/rdap+json"
       }
     ],
     "events" :



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 42]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


     [
       {
         "eventAction" : "registration",
         "eventDate" : "1990-12-31T23:59:59Z"
       },
       {
         "eventAction" : "last changed",
         "eventDate" : "1991-12-31T23:59:59Z"
       }
     ],
     "entities" :
     [
       {
         "objectClassName" : "entity",
         "handle" : "XXXX",
         "vcardArray":[
           "vcard",
           [
             ["version", {}, "text", "4.0"],
             ["fn", {}, "text", "Joe User"],
             ["kind", {}, "text", "individual"],
             ["lang", {
               "pref":"1"
             }, "language-tag", "fr"],
             ["lang", {
               "pref":"2"
             }, "language-tag", "en"],
             ["org", {
               "type":"work"
             }, "text", "Example"],
             ["title", {}, "text", "Research Scientist"],
             ["role", {}, "text", "Project Lead"],
             ["adr",
               { "type":"work" },
               "text",
               [
                 "",
                 "Suite 1234",
                 "4321 Rue Somewhere",
                 "Quebec",
                 "QC",
                 "G1V 2M2",
                 "Canada"
               ]
             ],
             ["tel",
               { "type":["work", "voice"], "pref":"1" },
               "uri", "tel:+1-555-555-1234;ext=102"



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 43]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


             ],
             ["email",
               { "type":"work" },
               "text", "joe.user@example.com"
             ]
           ]
         ],
         "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",
             "type" : "application/rdap+json"
           }
         ],
         "events" :
         [
           {
             "eventAction" : "registration",
             "eventDate" : "1990-12-31T23:59:59Z"
           },
           {
             "eventAction" : "last changed",
             "eventDate" : "1991-12-31T23:59:59Z"
           }
         ]
       }
     ]
   }

                                 Figure 27








<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 44]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   The Autonomous System number object class can contain the following
   members:

   o  objectClassName -- the string "autnum"

   o  handle -- a string representing an RIR-unique identifier of the
      autnum registration

   o  startAutnum -- a number representing the starting number [<a href="./rfc5396" title="&quot;Textual Representation of Autonomous System (AS) Numbers&quot;">RFC5396</a>]
      in the block of Autonomous System numbers

   o  endAutnum -- a number representing the ending number [<a href="./rfc5396" title="&quot;Textual Representation of Autonomous System (AS) Numbers&quot;">RFC5396</a>] in
      the block of Autonomous System numbers

   o  name -- an identifier assigned to the autnum registration by the
      registration holder

   o  type -- a string containing an RIR-specific classification of the
      autnum

   o  status -- an array of strings indicating the state of the autnum

   o  country -- a string containing the name of the two-character
      country code of the autnum

   o  entities -- an array of entity objects as defined by <a href="#section-5.1">Section 5.1</a>

   o  remarks -- see <a href="#section-4.3">Section 4.3</a>

   o  links -- see <a href="#section-4.2">Section 4.2</a>

   o  port43 -- see <a href="#section-4.7">Section 4.7</a>

   o  events -- see <a href="#section-4.5">Section 4.5</a>

<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>.  Error Response Body</span>

   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" and an array of strings named
   "description".







<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 45]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   This is an example of the common response body.

   {
     "errorCode": 418,
     "title": "Your Beverage Choice is Not Available",
     "description":
     [
       "I know coffee has more ummppphhh.",
       "Sorry, dude!"
     ]
   }

                                 Figure 28






































<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 46]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   This is an example of the common response body with an
   rdapConformance and notices data structures:

   {
     "rdapConformance" :
     [
       "rdap_level_0"
     ],
     "notices" :
     [
       {
         "title" : "Beverage Policy",
         "description" :
         [
           "Beverages with caffeine for keeping horses awake."
         ],
         "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",
     "errorCode": 418,
     "title": "Your beverage choice is not available",
     "description":
     [
       "I know coffee has more ummppphhh.",
       "Sorry, dude!"
     ]
   }

                                 Figure 29













<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 47]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>.  Responding to Help Queries</span>

   The appropriate response to /help queries as defined by [<a href="./rfc7482" title="&quot;Registration Data Access Protocol (RDAP) Query Format&quot;">RFC7482</a>] is
   to use the notices structure as defined in <a href="#section-4.3">Section 4.3</a>.

   This is an example of a response to a /help query including the
   rdapConformance data structure.

   {
     "rdapConformance" :
     [
       "rdap_level_0"
     ],
     "notices" :
     [
       {
         "title" : "Authentication Policy",
         "description" :
         [
           "Access to sensitive data for users with proper credentials."
         ],
         "links" :
         [
           {
             "value" : "http://example.net/help",
             "rel" : "alternate",
             "type" : "text/html",
             "href" : "http://www.example.com/auth_policy.html"
           }
         ]
       }
     ]
   }

                                 Figure 30

<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>.  Responding To Searches</span>

   [<a id="ref-RFC7482">RFC7482</a>] specifies three types of searches: domains, nameservers,
   and entities.  Responses to these searches take the form of an array
   of object instances where each instance is an appropriate object
   class for the search (i.e., a search for /domains yields an array of
   domain object instances).  These arrays are contained within the
   response object.







<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 48]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   The names of the arrays are as follows:

   o  for /domains searches, the array is "domainSearchResults"

   o  for /nameservers searches, the array is "nameserverSearchResults"

   o  for /entities searches, the array is "entitySearchResults"

   The following is an elided example of a response to a /domains
   search.

   {
     "rdapConformance" :
     [
       "rdap_level_0"
     ],
     ...
     "domainSearchResults" :
     [
       {
         "objectClassName" : "domain",
         "handle" : "1-XXXX",
         "ldhName" : "1.example.com",
         ...
       },
       {
         "objectClassName" : "domain",
         "handle" : "2-XXXX",
         "ldhName" : "2.example.com",
         ...
       }
     ]
   }

                                 Figure 31

<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>.  Indicating Truncated Responses</span>

   In cases where the data of a response needs to be limited or parts of
   the data need to be omitted, the response is considered "truncated".
   A truncated response is still valid JSON, but some of the results in
   a search set or some of the data in an object are not provided by the
   server.  A server may indicate this by including a typed notice in
   the response object.

   The following is an elided example of a search response that has been
   truncated.




<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 49]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   {
     "rdapConformance" :
     [
       "rdap_level_0"
     ],
     "notices" :
     [
       {
         "title" : "Search Policy",
         "type" : "result set truncated due to authorization",
         "description" :
         [
           "Search results are limited to 25 per day per querying IP."
         ],
         "links" :
         [
           {
             "value" : "http://example.net/help",
             "rel" : "alternate",
             "type" : "text/html",
             "href" : "http://www.example.com/search_policy.html"
           }
         ]
       }
     ],
     "domainSearchResults" :
     [
       ...
     ]
   }


                                 Figure 32

   A similar technique can be used with a typed remark where a single
   object has been returned and data in that object has been truncated.
   Such an example might be an entity object with only a partial set of
   the IP networks associated with it.













<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 50]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   The following is an elided example of an entity truncated data.

   {
     "objectClassName" : "entity",
     "handle" : "ANENTITY",
     "roles" : [ "registrant" ],
     ...
     "entities" :
     [
       {
         "objectClassName" : "entity",
         "handle": "ANEMBEDDEDENTITY",
         "roles" : [ "technical" ],
         ...
       },
       ...
     ],
     "networks" :
     [
       ...
     ],
     ...
     "remarks" :
     [
       {
         "title" : "Data Policy",
         "type" : "object truncated due to unexplainable reason",
         "description" :
         [
           "Some of the data in this object has been removed."
         ],
         "links" :
         [
           {
             "value" : "http://example.net/help",
             "rel" : "alternate",
             "type" : "text/html",
             "href" : "http://www.example.com/data_policy.html"
           }
         ]
       }
     ]
   }


                                 Figure 33





<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 51]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>.  IANA Considerations</span>

<span class="h3"><a class="selflink" id="section-10.1" href="#section-10.1">10.1</a>.  RDAP JSON Media Type Registration</span>

   This specification registers the "application/rdap+json" media type.

      Type name: application

      Subtype name: rdap+json

      Required parameters: n/a

      Encoding considerations: See <a href="./rfc6839#section-3.1">Section&nbsp;3.1 of [RFC6839]</a>.

      Security considerations: The media represented by this identifier
      does not have security considerations beyond that found in
      <a href="./rfc7159#section-6">Section&nbsp;6 of [RFC7159]</a>.

      Interoperability considerations: There are no known
      interoperability problems regarding this media format.

      Published specification: <a href="./rfc7483">RFC 7483</a>

      Applications that use this media type: Implementations of the
      Registration Data Access Protocol (RDAP).

      Additional information: This media type is a product of the IETF
      WEIRDS working group.  The WEIRDS charter, information on the
      WEIRDS mailing list, and other documents produced by the WEIRDS
      working group can be found at
      &lt;<a href="https://datatracker.ietf.org/wg/weirds/">https://datatracker.ietf.org/wg/weirds/</a>&gt;.

      Person &amp; email address to contact for further information: IESG
      &lt;iesg@ietf.org&gt;

      Intended usage: COMMON

      Restrictions on usage: none

      Author: Andy Newton

      Change controller: IETF

      Provisional Registration: No (upon publication of this RFC)







<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 52]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h3"><a class="selflink" id="section-10.2" href="#section-10.2">10.2</a>.  JSON Values Registry</span>

   IANA has created a category in the protocol registries labeled
   "Registration Data Access Protocol (RDAP)", and within that category,
   IANA has established a URL-referenceable, stand-alone registry
   labeled "RDAP JSON Values".  This new registry is for use in the
   notices and remarks (<a href="#section-4.3">Section 4.3</a>), status (<a href="#section-4.6">Section 4.6</a>), role
   (<a href="#section-5.1">Section 5.1</a>), event action (<a href="#section-4.5">Section 4.5</a>), and domain variant
   relation (<a href="#section-5.3">Section 5.3</a>) fields specified in RDAP.

   Each entry in the registry contains the following fields:

   1.  Value -- the string value being registered.

   2.  Type -- the type of value being registered.  It should be one of
       the following:

       *  "notice or remark type" -- denotes a type of notice or remark.

       *  "status" -- denotes a value for the "status" object member as
          defined by <a href="#section-4.6">Section 4.6</a>.

       *  "role" -- denotes a value for the "role" array as defined in
          <a href="#section-5.1">Section 5.1</a>.

       *  "event action" -- denotes a value for an event action as
          defined in <a href="#section-4.5">Section 4.5</a>.

       *  "domain variant relation" -- denotes a relationship between a
          domain and a domain variant as defined in <a href="#section-5.3">Section 5.3</a>.

   3.  Description -- a one- or two-sentence description regarding the
       meaning of the value, how it might be used, and/or how it should
       be interpreted by clients.

   4.  Registrant Name -- the name of the person registering the value.

   5.  Registrant Contact Information -- an email address, postal
       address, or some other information to be used to contact the
       registrant.

   This registry is operated under the "Expert Review" policy defined in
   [<a href="./rfc5226" title="">RFC5226</a>].








<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 53]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   Review of registrations into this registry by the designated
   expert(s) should be narrowly judged on the following criteria:

   1.  Values in need of being placed into multiple types must be
       assigned a separate registration for each type.

   2.  Values must be strings.  They should be multiple words separated
       by single space characters.  Every character should be
       lowercased.  If possible, every word should be given in English
       and each character should be US-ASCII.

   3.  Registrations should not duplicate the meaning of any existing
       registration.  That is, if a request for a registration is
       significantly similar in nature to an existing registration, the
       request should be denied.  For example, the terms "maintainer"
       and "registrant" are significantly similar in nature as they both
       denote a holder of a domain name or Internet number resource.  In
       cases where it may be reasonably argued that machine
       interpretation of two similar values may alter the operation of
       client software, designated experts should not judge the values
       to be of significant similarity.

   4.  Registrations should be relevant to the common usages of RDAP.
       Designated experts may rely upon the serving of the value by a
       DNR or RIR to make this determination.

   The following sections provide initial registrations into this
   registry.

<span class="h4"><a class="selflink" id="section-10.2.1" href="#section-10.2.1">10.2.1</a>.  Notice and Remark Types</span>

   The following values have been registered in the "RDAP JSON Values"
   registry:

      Value: result set truncated due to authorization
      Type: notice and remark type
      Description: The list of results does not contain all results due
         to lack of authorization.  This may indicate to some clients
         that proper authorization will yield a longer result set.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org










<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 54]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


      Value: result set truncated due to excessive load
      Type: notice and remark type
      Description: The list of results does not contain all results due
         to an excessively heavy load on the server.  This may indicate
         to some clients that requerying at a later time will yield a
         longer result set.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: result set truncated due to unexplainable reasons
      Type: notice and remark type
      Description: The list of results does not contain all results for
         an unexplainable reason.  This may indicate to some clients
         that requerying for any reason will not yield a longer result
         set.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: object truncated due to authorization
      Type: notice and remark type
      Description: The object does not contain all data due to lack of
         authorization.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: object truncated due to excessive load
      Type: notice and remark type
      Description: The object does not contain all data due to an
         excessively heavy load on the server.  This may indicate to
         some clients that requerying at a later time will yield all
         data of the object.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: object truncated due to unexplainable reasons
      Type: notice and remark type
      Description: The object does not contain all data for an
         unexplainable reason.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org







<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 55]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h4"><a class="selflink" id="section-10.2.2" href="#section-10.2.2">10.2.2</a>.  Status</span>

   The following values have been registered in the "RDAP JSON Values"
   registry:

      Value: validated
      Type: status
      Description: 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.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: renew prohibited
      Type: status
      Description: Renewal or reregistration of the object instance is
         forbidden.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: update prohibited
      Type: status
      Description: Updates to the object instance are forbidden.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: transfer prohibited
      Type: status
      Description: Transfers of the registration from one registrar to
         another are forbidden.  This type of status normally applies to
         DNR domain names.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: delete prohibited
      Type: status
      Description: Deletion of the registration of the object instance
         is forbidden.  This type of status normally applies to DNR
         domain names.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org





<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 56]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-57" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


      Value: proxy
      Type: status
      Description: The registration of the object instance has been
         performed by a third party.  This is most commonly applied to
         entities.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: private
      Type: status
      Description: The information of the object instance is not
         designated for public consumption.  This is most commonly
         applied to entities.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: removed
      Type: status
      Description: Some of the information of the object instance has
         not been made available and has been removed.  This is most
         commonly applied to entities.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: obscured
      Type: status
      Description: 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.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: associated
      Type: status
      Description: The object instance is associated with other object
         instances in the registry.  This is most commonly used to
         signify that a nameserver is associated with a domain or that
         an entity is associated with a network resource or domain.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org






<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 57]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-58" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


      Value: active
      Type: status
      Description: The object instance is in use.  For domain names, it
         signifies that the domain name is published in DNS.  For
         network and autnum registrations, it signifies that they are
         allocated or assigned for use in operational networks.  This
         maps to the "OK" status of the Extensible Provisioning Protocol
         (EPP) [<a href="./rfc5730" title="&quot;Extensible Provisioning Protocol (EPP)&quot;">RFC5730</a>] .
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: inactive
      Type: status
      Description: The object instance is not in use.  See "active".
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: locked
      Type: status
      Description: Changes to the object instance cannot be made,
         including the association of other object instances.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: pending create
      Type: status
      Description: A request has been received for the creation of the
         object instance, but this action is not yet complete.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: pending renew
      Type: status
      Description: A request has been received for the renewal of the
         object instance, but this action is not yet complete.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org










<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 58]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-59" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


      Value: pending transfer
      Type: status
      Description: A request has been received for the transfer of the
         object instance, but this action is not yet complete.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: pending update
      Type: status
      Description: A request has been received for the update or
         modification of the object instance, but this action is not yet
         complete.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: pending delete
      Type: status
      Description: A request has been received for the deletion or
         removal of the object instance, but this action is not yet
         complete.  For domains, this might mean that the name is no
         longer published in DNS but has not yet been purged from the
         registry database.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org

<span class="h4"><a class="selflink" id="section-10.2.3" href="#section-10.2.3">10.2.3</a>.  Event Actions</span>

   The following values have been registered in the "RDAP JSON Values"
   registry:

      Value: registration
      Type: event action
      Description: The object instance was initially registered.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: reregistration
      Type: event action
      Description: The object instance was registered subsequently to
         initial registration.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org






<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 59]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-60" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


      Value: last changed
      Type: event action
      Description: An action noting when the information in the object
         instance was last changed.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: expiration
      Type: event action
      Description: The object instance has been removed or will be
         removed at a predetermined date and time from the registry.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: deletion
      Type: event action
      Description: The object instance was removed from the registry at
         a point in time that was not predetermined.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: reinstantiation
      Type: event action
      Description: The object instance was reregistered after having
         been removed from the registry.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: transfer
      Type: event action
      Description: The object instance was transferred from one
         registrant to another.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: locked
      Type: event action
      Description: The object instance was locked (see the "locked"
         status).
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org





<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 60]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-61" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


      Value: unlocked
      Type: event action
      Description: The object instance was unlocked (see the "locked"
         status).
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org

<span class="h4"><a class="selflink" id="section-10.2.4" href="#section-10.2.4">10.2.4</a>.  Roles</span>

   The following values have been registered in the "RDAP JSON Values"
   registry:

      Value: registrant
      Type: role
      Description: The entity object instance is the registrant of the
         registration.  In some registries, this is known as a
         maintainer.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: technical
      Type: role
      Description: The entity object instance is a technical contact for
         the registration.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: administrative
      Type: role
      Description: The entity object instance is an administrative
         contact for the registration.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: abuse
      Type: role
      Description: The entity object instance handles network abuse
         issues on behalf of the registrant of the registration.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org








<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 61]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-62" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


      Value: billing
      Type: role
      Description: The entity object instance handles payment and
         billing issues on behalf of the registrant of the registration.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: registrar
      Type: role
      Description: The entity object instance represents the authority
         responsible for the registration in the registry.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: reseller
      Type: role
      Description: The entity object instance represents a third party
         through which the registration was conducted (i.e., not the
         registry or registrar).
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: sponsor
      Type: role
      Description: The entity object instance represents a domain policy
         sponsor, such as an ICANN-approved sponsor.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: proxy
      Type: role
      Description: The entity object instance represents a proxy for
         another entity object, such as a registrant.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: notifications
      Type: role
      Description: An entity object instance designated to receive
         notifications about association object instances.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org




<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 62]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-63" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


      Value: noc
      Type: role
      Description: The entity object instance handles communications
         related to a network operations center (NOC).
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org

<span class="h4"><a class="selflink" id="section-10.2.5" href="#section-10.2.5">10.2.5</a>.  Variant Relations</span>

   The following values have been registered in the "RDAP JSON Values"
   registry:

      Value: registered
      Type: domain variant relation
      Description: The variant names are registered in the registry.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: unregistered
      Type: domain variant relation
      Description: The variant names are not found in the registry.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: registration restricted
      Type: domain variant relation
      Description: Registration of the variant names is restricted to
         certain parties or within certain rules.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org


      Value: open registration
      Type: domain variant relation
      Description: Registration of the variant names is available to
         generally qualified registrants.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org











<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 63]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-64" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


      Value: conjoined
      Type: domain variant relation
      Description: Registration of the variant names occurs
         automatically with the registration of the containing domain
         registration.
      Registrant Name: IESG
      Registrant Contact Information: iesg@ietf.org

<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>.  Security Considerations</span>

   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 <a href="./rfc7159#section-6">Section&nbsp;6 of [RFC7159]</a> to
   prevent code injection.

   Though not specific to JSON, RDAP implementers should be aware of the
   security considerations specified in [<a href="./rfc7480" title="&quot;HTTP Usage in the Registration Data Access Protocol (RDAP)&quot;">RFC7480</a>] and the security
   requirements and considerations in [<a href="./rfc7481" title="&quot;Security Services for the Registration Data Access Protocol (RDAP)&quot;">RFC7481</a>].

   Clients caching data, especially clients using RDAP-specific caches
   (instead of HTTP-layer caches), should have safeguards to prevent
   cache poisoning.  See <a href="#section-5">Section 5</a> for advice on using the self links
   for caching.

   Finally, service operators should be aware of the privacy mechanisms
   noted in <a href="#section-13">Section 13</a>.

<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>.  Internationalization Considerations</span>

<span class="h3"><a class="selflink" id="section-12.1" href="#section-12.1">12.1</a>.  Character Encoding</span>

   The default text encoding for JSON responses in RDAP is UTF-8
   [<a href="./rfc3629" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC3629</a>], and all servers and clients MUST support UTF-8.

<span class="h3"><a class="selflink" id="section-12.2" href="#section-12.2">12.2</a>.  URIs and IRIs</span>

   [<a id="ref-RFC7480">RFC7480</a>] defines the use of URIs and IRIs in RDAP.

<span class="h3"><a class="selflink" id="section-12.3" href="#section-12.3">12.3</a>.  Language Tags</span>

   <a href="#section-4.4">Section 4.4</a> defines the use of language tags in the JSON responses
   defined in this document.









<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 64]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-65" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h3"><a class="selflink" id="section-12.4" href="#section-12.4">12.4</a>.  Internationalized Domain Names</span>

   IDNs are denoted in this specification by the separation of DNS names
   in LDH form and Unicode form (see <a href="#section-3">Section 3</a>).  Representation of IDNs
   in registries is described by the "variants" object in <a href="#section-5.3">Section 5.3</a>
   and the suggested values listed in <a href="#section-10.2.5">Section 10.2.5</a>.

<span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>.  Privacy Considerations</span>

   This specification suggests status values to denote contact and
   registrant information that has been marked as private and/or has
   been removed or obscured.  See <a href="#section-10.2.2">Section 10.2.2</a> for the complete list
   of status values.  A few of the status values indicate that there are
   privacy concerns associated with the object instance.  The following
   status codes SHOULD be used to describe data elements of a response
   when appropriate:

      private -- The object is not be shared in query responses, unless
      the user is authorized to view this information.

      removed -- Data elements within the object have been collected but
      have been omitted from the response.  This option can be used to
      prevent unauthorized access to associated object instances without
      the need to mark them as private.

      obscured -- Data elements within the object have been collected,
      but the response value has been altered so that values are not
      easily discernible.  A value changed from "1212" to "XXXX" is an
      example of obscured data.  This option may reveal privacy
      sensitive information and should only be used when data
      sensitivity does not require a more protective option like
      "private" or "removed".

   See <a href="#appendix-A.1">Appendix A.1</a> for an example of applying those values to contacts
   and registrants.

<span class="h2"><a class="selflink" id="section-14" href="#section-14">14</a>.  References</span>

<span class="h3"><a class="selflink" id="section-14.1" href="#section-14.1">14.1</a>.  Normative References</span>

   [<a id="ref-ISO.3166.1988">ISO.3166.1988</a>]
              International Organization for Standardization, "Codes for
              the representation of names of countries, 3rd edition",
              ISO Standard 3166, August 1988.

   [<a id="ref-RFC2119">RFC2119</a>]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997,
              &lt;<a href="http://www.rfc-editor.org/info/rfc2119">http://www.rfc-editor.org/info/rfc2119</a>&gt;.



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 65]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-66" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   [<a id="ref-RFC3339">RFC3339</a>]  Klyne, G., Ed. and C. Newman, "Date and Time on the
              Internet: Timestamps", <a href="./rfc3339">RFC 3339</a>, July 2002,
              &lt;<a href="http://www.rfc-editor.org/info/rfc3339">http://www.rfc-editor.org/info/rfc3339</a>&gt;.

   [<a id="ref-RFC3629">RFC3629</a>]  Yergeau, F., "UTF-8, a transformation format of ISO
              10646", STD 63, <a href="./rfc3629">RFC 3629</a>, November 2003,
              &lt;<a href="http://www.rfc-editor.org/info/rfc3629">http://www.rfc-editor.org/info/rfc3629</a>&gt;.

   [<a id="ref-RFC3986">RFC3986</a>]  Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
              Resource Identifier (URI): Generic Syntax", STD 66, <a href="./rfc3986">RFC</a>
              <a href="./rfc3986">3986</a>, January 2005,
              &lt;<a href="http://www.rfc-editor.org/info/rfc3986">http://www.rfc-editor.org/info/rfc3986</a>&gt;.

   [<a id="ref-RFC4034">RFC4034</a>]  Arends, R., Austein, R., Larson, M., Massey, D., and S.
              Rose, "Resource Records for the DNS Security Extensions",
              <a href="./rfc4034">RFC 4034</a>, March 2005,
              &lt;<a href="http://www.rfc-editor.org/info/rfc4034">http://www.rfc-editor.org/info/rfc4034</a>&gt;.

   [<a id="ref-RFC5226">RFC5226</a>]  Narten, T. and H. Alvestrand, "Guidelines for Writing an
              IANA Considerations Section in RFCs", <a href="https://www.rfc-editor.org/bcp/bcp26">BCP 26</a>, <a href="./rfc5226">RFC 5226</a>,
              May 2008, &lt;<a href="http://www.rfc-editor.org/info/rfc5226">http://www.rfc-editor.org/info/rfc5226</a>&gt;.

   [<a id="ref-RFC5396">RFC5396</a>]  Huston, G. and G. Michaelson, "Textual Representation of
              Autonomous System (AS) Numbers", <a href="./rfc5396">RFC 5396</a>, December 2008,
              &lt;<a href="http://www.rfc-editor.org/info/rfc5396">http://www.rfc-editor.org/info/rfc5396</a>&gt;.

   [<a id="ref-RFC5646">RFC5646</a>]  Phillips, A. and M. Davis, "Tags for Identifying
              Languages", <a href="https://www.rfc-editor.org/bcp/bcp47">BCP 47</a>, <a href="./rfc5646">RFC 5646</a>, September 2009,
              &lt;<a href="http://www.rfc-editor.org/info/rfc5646">http://www.rfc-editor.org/info/rfc5646</a>&gt;.

   [<a id="ref-RFC5890">RFC5890</a>]  Klensin, J., "Internationalized Domain Names for
              Applications (IDNA): Definitions and Document Framework",
              <a href="./rfc5890">RFC 5890</a>, August 2010,
              &lt;<a href="http://www.rfc-editor.org/info/rfc5890">http://www.rfc-editor.org/info/rfc5890</a>&gt;.

   [<a id="ref-RFC5952">RFC5952</a>]  Kawamura, S. and M. Kawashima, "A Recommendation for IPv6
              Address Text Representation", <a href="./rfc5952">RFC 5952</a>, August 2010,
              &lt;<a href="http://www.rfc-editor.org/info/rfc5952">http://www.rfc-editor.org/info/rfc5952</a>&gt;.

   [<a id="ref-RFC5988">RFC5988</a>]  Nottingham, M., "Web Linking", <a href="./rfc5988">RFC 5988</a>, October 2010,
              &lt;<a href="http://www.rfc-editor.org/info/rfc5988">http://www.rfc-editor.org/info/rfc5988</a>&gt;.

   [<a id="ref-RFC7095">RFC7095</a>]  Kewisch, P., "jCard: The JSON Format for vCard", <a href="./rfc7095">RFC 7095</a>,
              January 2014, &lt;<a href="http://www.rfc-editor.org/info/rfc7095">http://www.rfc-editor.org/info/rfc7095</a>&gt;.

   [<a id="ref-RFC7159">RFC7159</a>]  Bray, T., "The JavaScript Object Notation (JSON) Data
              Interchange Format", <a href="./rfc7159">RFC 7159</a>, March 2014,
              &lt;<a href="http://www.rfc-editor.org/info/rfc7159">http://www.rfc-editor.org/info/rfc7159</a>&gt;.



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 66]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-67" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   [<a id="ref-RFC7480">RFC7480</a>]  Newton, A., Ellacott, B., and N. Kong, "HTTP Usage in the
              Registration Data Access Protocol (RDAP)", <a href="./rfc7480">RFC 7480</a>, March
              2015, &lt;<a href="http://www.rfc-editor.org/info/rfc7480">http://www.rfc-editor.org/info/rfc7480</a>&gt;.

   [<a id="ref-RFC7481">RFC7481</a>]  Hollenbeck, S. and N. Kong, "Security Services for the
              Registration Data Access Protocol (RDAP)", <a href="./rfc7481">RFC 7481</a>, March
              2015, &lt;<a href="http://www.rfc-editor.org/info/rfc7481">http://www.rfc-editor.org/info/rfc7481</a>&gt;.

   [<a id="ref-RFC7482">RFC7482</a>]  Newton, A. and S. Hollenbeck, "Registration Data Access
              Protocol (RDAP) Query Format", <a href="./rfc7482">RFC 7482</a>, March 2015,
              &lt;<a href="http://www.rfc-editor.org/info/rfc7482">http://www.rfc-editor.org/info/rfc7482</a>&gt;.

<span class="h3"><a class="selflink" id="section-14.2" href="#section-14.2">14.2</a>.  Informative References</span>

   [<a id="ref-IANA_IDNTABLES">IANA_IDNTABLES</a>]
              IANA, "Repository of IDN Practices",
              &lt;<a href="http://www.iana.org/domains/idn-tables">http://www.iana.org/domains/idn-tables</a>&gt;.

   [<a id="ref-JSON_ascendancy">JSON_ascendancy</a>]
              MacVittie, L., "The Stealthy Ascendancy of JSON", April
              2011, &lt;<a href="https://devcentral.f5.com/weblogs/macvittie/archive/2011/04/27/the-stealthy-ascendancy-of-json.aspx">https://devcentral.f5.com/weblogs/macvittie/</a>
              <a href="https://devcentral.f5.com/weblogs/macvittie/archive/2011/04/27/the-stealthy-ascendancy-of-json.aspx">archive/2011/04/27/the-stealthy-ascendancy-of-json.aspx</a>&gt;.

   [<a id="ref-JSON_performance_study">JSON_performance_study</a>]
              Nurseitov, N., Paulson, M., Reynolds, R., and C. Izurieta,
              "Comparison of JSON and XML Data Interchange Formats: A
              Case Study", 2009,
              &lt;<a href="http://www.cs.montana.edu/izurieta/pubs/caine2009.pdf">http://www.cs.montana.edu/izurieta/pubs/caine2009.pdf</a>&gt;.

   [<a id="ref-RFC3912">RFC3912</a>]  Daigle, L., "WHOIS Protocol Specification", <a href="./rfc3912">RFC 3912</a>,
              September 2004, &lt;<a href="http://www.rfc-editor.org/info/rfc3912">http://www.rfc-editor.org/info/rfc3912</a>&gt;.

   [<a id="ref-RFC5730">RFC5730</a>]  Hollenbeck, S., "Extensible Provisioning Protocol (EPP)",
              STD 69, <a href="./rfc5730">RFC 5730</a>, August 2009,
              &lt;<a href="http://www.rfc-editor.org/info/rfc5730">http://www.rfc-editor.org/info/rfc5730</a>&gt;.

   [<a id="ref-RFC5910">RFC5910</a>]  Gould, J. and S. Hollenbeck, "Domain Name System (DNS)
              Security Extensions Mapping for the Extensible
              Provisioning Protocol (EPP)", <a href="./rfc5910">RFC 5910</a>, May 2010,
              &lt;<a href="http://www.rfc-editor.org/info/rfc5910">http://www.rfc-editor.org/info/rfc5910</a>&gt;.

   [<a id="ref-RFC6350">RFC6350</a>]  Perreault, S., "vCard Format Specification", <a href="./rfc6350">RFC 6350</a>,
              August 2011, &lt;<a href="http://www.rfc-editor.org/info/rfc6350">http://www.rfc-editor.org/info/rfc6350</a>&gt;.

   [<a id="ref-RFC6839">RFC6839</a>]  Hansen, T. and A. Melnikov, "Additional Media Type
              Structured Syntax Suffixes", <a href="./rfc6839">RFC 6839</a>, January 2013,
              &lt;<a href="http://www.rfc-editor.org/info/rfc6839">http://www.rfc-editor.org/info/rfc6839</a>&gt;.




<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 67]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-68" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>.  Suggested Data Modeling with the Entity Object Class</span>

<span class="h3"><a class="selflink" id="appendix-A.1" href="#appendix-A.1">A.1</a>.  Registrants and Contacts</span>

   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 <a href="#section-10.2.4">Section 10.2.4</a>
   be used.

   The following is an example of an elided containing object with an
   embedded entity that is both a registrant and administrative contact:

   {
     ...
     "entities" :
     [
       {
         "objectClassName" : "entity",
         "handle" : "XXXX",
         "vcardArray":[
           "vcard",
           [
             ["version", {}, "text", "4.0"],
             ["fn", {}, "text", "Joe User"],
             ["kind", {}, "text", "individual"],
             ["lang", {
               "pref":"1"
             }, "language-tag", "fr"],
             ["lang", {
               "pref":"2"
             }, "language-tag", "en"],
             ["org", {
               "type":"work"
             }, "text", "Example"],
             ["title", {}, "text", "Research Scientist"],
             ["role", {}, "text", "Project Lead"],
             ["adr",
               { "type":"work" },
               "text",
               [
                 "",
                 "Suite 1234",
                 "4321 Rue Somewhere",
                 "Quebec",
                 "QC",



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 68]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-69" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


                 "G1V 2M2",
                 "Canada"
               ]
             ],
             ["tel",
               { "type":["work", "voice"], "pref":"1" },
               "uri", "tel:+1-555-555-1234;ext=102"
             ],
             ["email",
               { "type":"work" },
               "text", "joe.user@example.com"
             ]
           ]
         ],
         "roles" : [ "registrant", "administrative" ],
         "remarks" :
         [
           {
             "description" :
             [
               "She sells sea shells down by the sea shore.",
               "Originally written by Terry Sullivan."
             ]
           }
         ],
         "events" :
         [
           {
             "eventAction" : "registration",
             "eventDate" : "1990-12-31T23:59:59Z"
           },
           {
             "eventAction" : "last changed",
             "eventDate" : "1991-12-31T23:59:59Z"
           }
         ]
       }
     ]
   }

                                 Figure 34

   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 <a href="#section-10.2.2">Section 10.2.2</a>).





<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 69]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-70" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   The following is an elided example of a registrant with information
   changed to reflect that of a third party.

   {
     ...
     "entities" :
     [
       {
         "objectClassName" : "entity",
         "handle" : "XXXX",
         ...
         "roles" : [ "registrant", "administrative" ],
         "status" : [ "proxy", "private", "obscured" ]
       }
     ]
   }

                                 Figure 35

<span class="h3"><a class="selflink" id="appendix-A.2" href="#appendix-A.2">A.2</a>.  Registrars</span>

   This document does not provide a specific object class for
   registrars, but like registrants and contacts (see <a href="#appendix-A.1">Appendix A.1</a>), the
   "roles" string array maybe used.  Additionally, many registrars have
   publicly assigned identifiers.  The publicIds structure (<a href="#section-4.8">Section 4.8</a>)
   represents that information.

   The following is an example of an elided containing object with an
   embedded entity that is a registrar:

   {
     ...
     "entities":[
       {
         "objectClassName" : "entity",
         "handle":"XXXX",
         "vcardArray":[
           "vcard",
           [
             ["version", {}, "text", "4.0"],
             ["fn", {}, "text", "Joe's Fish, Chips, and Domains"],
             ["kind", {}, "text", "org"],
             ["lang", {
               "pref":"1"
             }, "language-tag", "fr"],
             ["lang", {
               "pref":"2"
             }, "language-tag", "en"],



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 70]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-71" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


             ["org", {
               "type":"work"
             }, "text", "Example"],
             ["adr",
               { "type":"work" },
               "text",
               [
                 "",
                 "Suite 1234",
                 "4321 Rue Somewhere",
                 "Quebec",
                 "QC",
                 "G1V 2M2",
                 "Canada"
               ]
             ],
             ["tel",
               {
                 "type":["work", "voice"],
                 "pref":"1"
               },
               "uri", "tel:+1-555-555-1234;ext=102"
             ],
             ["email",
               { "type":"work" },
               "text", "joes_fish_chips_and_domains@example.com"
             ]
           ]
         ],
         "roles":[ "registrar" ],
         "publicIds":[
           {
             "type":"IANA Registrar ID",
             "identifier":"1"
           }
         ],
         "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",



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 71]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-72" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


             "type":"text/html",
             "href":"http://www.example.com"
           }
         ]
       }
     ]
   }

                                 Figure 36

<span class="h2"><a class="selflink" id="appendix-B" href="#appendix-B">Appendix B</a>.  Modeling Events</span>

   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 (<a href="#section-4.5">Section 4.5</a>) 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:59Z"
     }
   ]

                                 Figure 37

   For the second use case, the events data structure (<a href="#section-4.5">Section 4.5</a>) is
   used with the "eventActor" object member.








<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 72]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-73" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   This is an example of an "events" array with the "eventActor".

   "events" :
   [
     {
       "eventAction" : "registration",
       "eventActor" : "XYZ-NIC",
       "eventDate" : "1990-12-31T23:59:59Z"
     }
   ]

                                 Figure 38

   For the third use case, the "asEventActor" array is used when an
   entity (<a href="#section-5.1">Section 5.1</a>) 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.

   {
     "objectClassName" : "domain",
     "handle" : "XXXX",
     "ldhName" : "foo.example",
     "status" : [ "locked", "transfer prohibited" ],
     ...
     "entities" :
     [
       {
         "handle" : "XXXX",
         ...
         "asEventActor" :
         [
           {
             "eventAction" : "last changed",
             "eventDate" : "1990-12-31T23:59:59Z"
           }
         ]
       }
     ]
   }

                                 Figure 39







<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 73]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-74" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h2"><a class="selflink" id="appendix-C" href="#appendix-C">Appendix C</a>.  Structured vs. Unstructured Addresses</span>

   The entity (<a href="#section-5.1">Section 5.1</a>) object class uses jCard [<a href="./rfc7095" title="&quot;jCard: The JSON Format for vCard&quot;">RFC7095</a>] to
   represent contact information, including postal addresses. jCard has
   the ability to represent multiple language preferences, multiple
   email address and phone numbers, and multiple postal addresses in
   both a structured and unstructured format.  This section describes
   the use of jCard for representing structured and unstructured
   addresses.

   The following is an example of a jCard.

   {
     "vcardArray":[
       "vcard",
       [
         ["version", {}, "text", "4.0"],
         ["fn", {}, "text", "Joe User"],
         ["n", {}, "text",
           ["User", "Joe", "", "", ["ing. jr", "M.Sc."]]
         ],
         ["kind", {}, "text", "individual"],
         ["lang", {
           "pref":"1"
         }, "language-tag", "fr"],
         ["lang", {
           "pref":"2"
         }, "language-tag", "en"],
         ["org", {
           "type":"work"
         }, "text", "Example"],
         ["title", {}, "text", "Research Scientist"],
         ["role", {}, "text", "Project Lead"],
         ["adr",
           { "type":"work" },
           "text",
           [
             "",
             "Suite 1234",
             "4321 Rue Somewhere",
             "Quebec",
             "QC",
             "G1V 2M2",
             "Canada"
           ]
         ],
         ["adr",
           {



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 74]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-75" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


             "type":"home",
             "label":"123 Maple Ave\nSuite 90001\nVancouver\nBC\n1239\n"
           },
           "text",
           [
             "", "", "", "", "", "", ""
           ]
         ],
         ["tel",
           { "type":["work", "voice"], "pref":"1" },
           "uri", "tel:+1-555-555-1234;ext=102"
         ],
         ["tel",
           {
             "type":["work", "cell", "voice", "video", "text"]
           },
           "uri",
           "tel:+1-555-555-1234"
         ],
         ["email",
           { "type":"work" },
           "text", "joe.user@example.com"
         ],
         ["geo", {
           "type":"work"
         }, "uri", "geo:46.772673,-71.282945"],
         ["key",
           { "type":"work" },
           "uri", "http://www.example.com/joe.user/joe.asc"
         ],
         ["tz", {},
           "utc-offset", "-05:00"],
         ["url", { "type":"home" },
           "uri", "http://example.org"]
       ]
     ]
   }

                                 Figure 40

   The arrays in Figure 40 with the first member of "adr" represent
   postal addresses.  In the first example, the postal address is given
   as an array of strings and constitutes a structured address.  For
   components of the structured address that are not applicable, an
   empty string is given.  Each member of that array aligns with the
   positions of a vCard as given in [<a href="./rfc6350" title="&quot;vCard Format Specification&quot;">RFC6350</a>].  In this example, the
   following data corresponds to the following positional meanings:




<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 75]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-76" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   1.  post office box -- not applicable; empty string

   2.  extended address (e.g., apartment or suite number) -- Suite 1234

   3.  street address -- 4321 Rue Somewhere

   4.  locality (e.g., city) -- Quebec

   5.  region (e.g., state or province) -- QC

   6.  postal code -- G1V 2M2

   7.  country name (full name) -- Canada

   The second example is an unstructured address.  It uses the label
   attribute, which is a string containing a newline (\n) character to
   separate address components in an unordered, unspecified manner.
   Note that in this example, the structured address array is still
   given but that each string is an empty string.

<span class="h2"><a class="selflink" id="appendix-D" href="#appendix-D">Appendix D</a>.  Secure DNS</span>

   <a href="#section-5.3">Section 5.3</a> defines the "secureDNS" member to represent secure DNS
   information about domain names.

   DNSSEC provides data integrity for DNS through the digital signing of
   resource records.  To enable DNSSEC, the zone is signed by one or
   more private keys and the signatures are stored as RRSIG records.  To
   complete the chain of trust in the DNS zone hierarchy, a digest of
   each DNSKEY record (which contains the public key) must be loaded
   into the parent zone, stored as DS records, and signed by the
   parent's private key (RRSIG DS record), as indicated in "Resource
   Records for the DNS Security Extensions" [<a href="./rfc4034" title="&quot;Resource Records for the DNS Security Extensions&quot;">RFC4034</a>].  Creating the DS
   records in the parent zone can be done by the registration authority
   "Domain Name System (DNS) Security Extensions Mapping for the
   Extensible Provisioning Protocol (EPP)" [<a href="./rfc5910" title="&quot;Domain Name System (DNS) Security Extensions Mapping for the Extensible Provisioning Protocol (EPP)&quot;">RFC5910</a>].

   Only DS-related information is provided by RDAP, since other
   information is not generally stored in the registration database.
   Other DNSSEC-related information can be retrieved with other DNS
   tools such as dig.

   The domain object class (<a href="#section-5.3">Section 5.3</a>) can represent this information
   using either the "dsData" or "keyData" object arrays.  Client
   implementers should be aware that some registries do not collect or
   do not publish all of the secure DNS meta-information.





<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 76]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-77" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


<span class="h2"><a class="selflink" id="appendix-E" href="#appendix-E">Appendix E</a>.  Motivations for Using JSON</span>

   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
   [<a href="./rfc5730" title="&quot;Extensible Provisioning Protocol (EPP)&quot;">RFC5730</a>] 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 serving 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 that 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 [<a href="#ref-JSON_ascendancy">JSON_ascendancy</a>]).  Studies
   have also found that JSON is generally less bulky and consequently
   faster to parse (see [<a href="#ref-JSON_performance_study">JSON_performance_study</a>]).

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 work 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, Guangqing Deng, Steve Sheng, Francisco Arias, Ray Bellis, and
   Frederico Neves.

   Tom Harrison, Murray Kucherawy, Ed Lewis, Audric Schiltknecht, Naoki
   Kambe, and Maarten Bosteels contributed significant review comments
   and provided clarifying text.  James Mitchell provided text regarding
   the processing of unknown JSON attributes and identified issues



<span class="grey">Newton &amp; Hollenbeck          Standards Track                   [Page 77]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-78" ></span>
<span class="grey"><a href="./rfc7483">RFC 7483</a>                   RDAP JSON Responses                March 2015</span>


   leading to the remodeling of events.  Ernie Dainow and Francisco
   Obispo provided concrete suggestions that led to a better variant
   model for domain names.

   Ernie Dainow provided the background information on the secure DNS
   attributes and objects for domains, informative text on DNSSEC, and
   many other attributes that appear throughout the object classes of
   this document.

   The switch to and incorporation of jCard was performed by Simon
   Perreault.

   Olaf Kolkman and Murray Kucherawy chaired the IETF's WEIRDS working
   group from which this document has been created.

Authors' Addresses

   Andrew Lee Newton
   American Registry for Internet Numbers
   3635 Concorde Parkway
   Chantilly, VA  20151
   United States

   EMail: andy@arin.net
   URI:   <a href="http://www.arin.net">http://www.arin.net</a>


   Scott Hollenbeck
   Verisign Labs
   12061 Bluemont Way
   Reston, VA  20190
   United States

   EMail: shollenbeck@verisign.com
   URI:   <a href="http://www.verisignlabs.com/">http://www.verisignlabs.com/</a>
















Newton &amp; Hollenbeck          Standards Track                   [Page 78]
</pre>