RDAP Simple Contact

Status of This Memo

This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶

Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶

This Internet-Draft will expire on 3 March 2024.¶

Copyright Notice

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

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶

Table of Contents

1. Background

[RFC9083] defines the contact data of an entity using jCard ([RFC7095]), which is a JSON format for vCard ([RFC6350]). Experience has shown that jCard is unsuitable for RDAP because its "jagged" array style is unlike any other JSON in RDAP; it is more difficutl to deserialize into objects that are easy to work with, it is error prone and difficult to debug, and it can express far more information than is necessary for RDAP.¶

This document defines the SimpleContact extension for RDAP. This extension intends to model JSON in the same style and manner as other RDAP structures and is purposefully limited to the data in-use by Internet Number Registries and Domain Name Registries.¶

The purposeful limitation of the contact data model defined in this document is informed by [RFC5733], the ICANN gTLD RDAP Response Profile, the NRO RDAP Profile, and [RFC7495].¶

2. Simple Contact Extension And Identifier

The RDAP extension identifier for this extension is "sc". This extension defines one JSON member named "sc_data" to be found in RDAP responses. "sc_data" is a JSON object, and it has child members described in the following sections. Each child member of "sc_data" is optional.¶

There are is one common, optional JSON member of these child members: "lang". The JSON member "lang" is the same as that defined by RDAP in Section 4.4.¶

Most of the child members are arrays allowing the expression of multiple variants of the same information. The order in which items appear in these arrays denotes preference order for the variants.¶

"kind" : "role"

"individualNames" : [
  {
    "name" : "Dr. Bob Lee Aloysius Smurd, Ph.d.",
    "lang" : "en-AU"
  }
],
"roleNames" : [
  {
    "name" : "Abuse Prevention, Trust and Safety",
    "lang" : "en-AU"
  }
],
"organizationNames" : [
  {
    "name" : "ACME Pty",
    "lang" : "en-AU"
  }
]

"postalAddresses" : [
  {
    "address" : [
      "Suite 300",
      "123 Random Tree Name Street",
      "Kalamazoo, MI 90125 US"
    ]
    "cc" : "US-MI",
    "pc" : "90215",
    "lang" : "en-US"
  }
]

"emails" : [
  {
    "email": "山田太郎@example.net",
    "lang" : "ja"
  },
  {
    "email" : "yamada.taro@example.net",
    "lang" : "ja-Latn"
  }
]

"voicePhones" : [
  "tel:+1-201-555-0123",
  "+447040202"
],
"faxPhones" : [
  "tel:+1-201-555-9999;ext=123"
]

"webContacts" : [
  "https://example.com/contact-me"
]

"geo" : [
  "geo:37.786971,-122.399677"
]

{
  "objectClassName" : "entity",
  "handle":"XXXX",
  "sc_data": {
    "kind" : "individual",
    "individualNames" : [
      {
        "name" : "山田太郎",
        "lang" : "ja"
      },
      {
        "name" : "Yomada Taro",
        "lang" : "ja-Latn"
      }
    ],
    "roleNames" : [
      {
        "name" : "登録サービス ヘルプデスク",
        "lang" : "ja"
      },
      {
        "name" : "Registration Services Help Desk",
        "lang" : "en"
      }
    ],
    "organizationNames" : [
      {
        "name" : "アクメ",
        "lang" : "ja"
      },
      {
        "name" : "ACME",
        "lang" : "en"
      }
    ],
    "postalAddresses" : [
      {
        "address" : [
          "〒150-2345 東京都渋谷区本町2丁目4-7サニーマンション203",
        ]
        "cc" : "JP-13",
        "pc" : "150-2345",
        "lang" : "ja"
      },
      {
        "address" : [
          "Sunny Mansion #203",
          "4-7 Hommachi 2-choume",
          "Shibuya-ku, TOKYO 150-2345"
        ]
        "cc" : "JP-13",
        "pc" : "150-2345",
        "lang" : "ja-Latn"
      }
    ],
    "emails" : [
      {
        "email": "山田太郎@example.net",
        "lang" : "ja"
      },
      {
        "email" : "yamada.taro@example.net",
        "lang" : "ja-Latn"
      }
    ],
    "voicePhones" : [
      "+81(03) 1234-5678"
    ],
    "faxPhones" : [
      "tel:+810312345679"
    ],
    "webContacts" : [
      "https://example.net/contact-me"
    ]
  },
  "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":"https://example.com/entity/XXXX",
      "rel":"self",
      "href":"https://example.com/entity/XXXX",
      "type" : "application/rdap+json"
    },
    {
      "value":"https://example.com/entity/XXXX",
      "rel":"about",
      "href":"https://example.com/entity/XXXX.vcard",
      "type" : "text/vcard"
    }
  ],
  "events":[
    {
      "eventAction":"registration",
      "eventDate":"1990-12-31T23:59:59Z"
    }
  ],
  "asEventActor":[
    {
      "eventAction":"last changed",
      "eventDate":"1991-12-31T23:59:59Z"
    }
  ]
}

3. EPP Int/Loc Data

[RFC5733] defines mechanisms to indicate data is "localized" or "internationalized" using "int" and "loc" types. The "int" designates data as being 7-bit ASCII. To express contact data with the "int" designation in SimpleContact, it is RECOMMENDED that a language tag with the "Latn" script subtag (see [RFC5646]) be used.¶

4. Links to Other Contact Formats

SimpleContact does not attempt to model all possible forms of contact formats or data. Where an RDAP server can provide a more extensive form such as vCard, jCard, or JSContact, these can be expressed in an RDAP link using the "about" rel type and the media type appropriate to that form. section Section 2.8 contains an example using vCard.¶

RDAP servers MUST place the same access restrictions upon these resources as they do on the RDAP entity from which they are referenced. It is NOT RECOMMENDED to link to contact data provided by other servers or servers under separate authorities.¶

5. The No jCard Extension and Identifier

This document also defines a second RDAP extension to signal the non-use of jCard in RDAP responses. The identifier for this extension is "noJCard". When used with the RDAP-X media type [I-D.newton-regext-rdap-x-media-type] and the SimpleContact identifier, a client can signal to a server that entities should substitute SimpleContact data for jCard data. When used with queries containing large amounts of entity data, such as RDAP searches, this can reduce the payload significantly (instead of sending both jCard and SimpleContact).¶

Use of the "noJCard" extension is independent of the SimpleContact extension, and may be used for other purposes as is appropriate to server policy.¶

Authors' Addresses