JSON Responses for the Industrial Internet Identifier Data Access Protocol (IIIDAP)
draft-mcd-identifier-access-responce-02

Document Type Active Internet-Draft (individual)
Last updated 2020-07-13
Stream (None)
Intended RFC status (None)
Formats plain text pdf htmlized (tools) htmlized bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Internet Engineering Task Force                                 C. Ma
Internet Draft                                                J. Chen
Intended status: Informational                                  X. Fan
Expires: January 13, 2021                                      M. Chen
                                                                Z. Li
             China Academy of Information and Communications Technology
                                                          July 13, 2020

     JSON Responses for the Industrial Internet Identifier Data Access
                             Protocol (IIIDAP)
                  draft-mcd-identifier-access-responce-02

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), its areas, and its working groups. Note that
   other groups may also distribute working documents as Internet-
   Drafts.

   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."

   The list of current Internet-Drafts can be accessed at
   http://www.ietf.org/ietf/1id-abstracts.txt

   The list of Internet-Draft Shadow Directories can be accessed at
   http://www.ietf.org/shadow.html

   This Internet-Draft will expire on January 13, 2021.

Copyright Notice

   Copyright (c) 2020 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
   (http://trustee.ietf.org/license-info) in effect on the date of
   publication of this document. Please review these documents
   carefully, as they describe your rights and restrictions with

Ma, et al.            Expires January 13, 2021                [Page 1]
Internet-Draft    Identifier Data Response Protocol      July 13, 2020

   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.

Abstract

   This document describes JSON data structures representing identifier
   information maintained by Second-Level Nodes (SLN). These data
   structures are used to form Industrial Internet Identifier Data
   Access Protocol (IIIDAP) query responses.

Table of Contents

   1. Introduction ................................................ 2
      1.1. Terminology and Definitions............................. 3
      1.2. Data Model ............................................. 3
   2. Use of JSON ................................................. 4
      2.1. Naming ................................................. 4
   3. Common Data Types ........................................... 4
   4. Common Data Structures....................................... 5
      4.1. IIIDAP Conformance...................................... 5
      4.2. Links .................................................. 5
      4.3. Notices and Remarks..................................... 6
      4.4. Language Identifier..................................... 8
   5. Nodes ....................................................... 8
   6. Error Response Body ........................................ 15
   7. Responding to Help Queries.................................. 16
   8. Responding To Searches...................................... 17
   9. Indicating Truncated Responses.............................. 18
   10. IANA Considerations........................................ 20
      10.1. IIIDAP JSON Media Type Registration................... 20
   11. Security Considerations.................................... 20
   12. Internationalization Considerations........................ 21
      12.1. Character Encoding.................................... 21
      12.2. URIs and IRIs ........................................ 21
   13. Privacy Considerations..................................... 21
   14. References ................................................ 22
      14.1. Normative References.................................. 22
      14.2. Informative References................................ 23

1. Introduction

   This document describes responses in the JSON [RFC7159] format for
   the queries as defined by the Industrial Internet Identifier Data
   Access Protocol Query Format [IDENTIFIER-QUERY]. A communication

Ma, et al.            Expires January 13, 2021                [Page 2]
Internet-Draft    Identifier Data Response Protocol      July 13, 2020

   protocol for exchanging queries and responses is described in
Show full document text