idnits 2.17.1 draft-peterson-modern-teri-json-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (October 31, 2016) is 2734 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- == Outdated reference: A later version (-04) exists of draft-ietf-modern-problem-framework-01 == Outdated reference: A later version (-04) exists of draft-peterson-modern-teri-01 -- Obsolete informational reference (is this intentional?): RFC 7159 (Obsoleted by RFC 8259) Summary: 0 errors (**), 0 flaws (~~), 3 warnings (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group J. Peterson 3 Internet-Draft Neustar 4 Intended status: Informational October 31, 2016 5 Expires: May 4, 2017 7 A JSON Binding and Encoding for TeRI 8 draft-peterson-modern-teri-json-00.txt 10 Abstract 12 The Telephone-Related Information (TeRI) framework defines an 13 information model for data objects related to the acquisiton, 14 management, and retrieval of telephone numbers and information 15 related to them via the Internet. TeRI provides an abstract 16 framework that must be instantiated by a particular binding and 17 encoding. This document defines an HTTP binding for TeRI and a 18 JavaScript Object Notation (JSON) encoding for TeRI. 20 Status of This Memo 22 This Internet-Draft is submitted in full conformance with the 23 provisions of BCP 78 and BCP 79. 25 Internet-Drafts are working documents of the Internet Engineering 26 Task Force (IETF). Note that other groups may also distribute 27 working documents as Internet-Drafts. The list of current Internet- 28 Drafts is at http://datatracker.ietf.org/drafts/current/. 30 Internet-Drafts are draft documents valid for a maximum of six months 31 and may be updated, replaced, or obsoleted by other documents at any 32 time. It is inappropriate to use Internet-Drafts as reference 33 material or to cite them other than as "work in progress." 35 This Internet-Draft will expire on May 4, 2017. 37 Copyright Notice 39 Copyright (c) 2016 IETF Trust and the persons identified as the 40 document authors. All rights reserved. 42 This document is subject to BCP 78 and the IETF Trust's Legal 43 Provisions Relating to IETF Documents 44 (http://trustee.ietf.org/license-info) in effect on the date of 45 publication of this document. Please review these documents 46 carefully, as they describe your rights and restrictions with respect 47 to this document. Code Components extracted from this document must 48 include Simplified BSD License text as described in Section 4.e of 49 the Trust Legal Provisions and are provided without warranty as 50 described in the Simplified BSD License. 52 Table of Contents 54 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 55 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 2 56 3. HTTP TeRI Binding . . . . . . . . . . . . . . . . . . . . . . 3 57 4. JSON TeRI Encoding . . . . . . . . . . . . . . . . . . . . . 3 58 4.1. TeRI Requests . . . . . . . . . . . . . . . . . . . . . . 3 59 4.2. TeRI Responses . . . . . . . . . . . . . . . . . . . . . 4 60 4.3. TeRI Records . . . . . . . . . . . . . . . . . . . . . . 4 61 5. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 4 62 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 5 63 7. Security Considerations . . . . . . . . . . . . . . . . . . . 5 64 8. Informative References . . . . . . . . . . . . . . . . . . . 5 65 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 5 67 1. Introduction 69 The Telephone-Related Information (TeRI) framework 70 [I-D.peterson-modern-teri] defines an information model for data 71 objects related to the acquisiton, management, and retrieval of 72 telephone numbers and information related to them via the Internet. 73 TeRI provides an abstract framework that must be instantiated by a 74 particular binding and encoding, as described in 75 [I-D.peterson-modern-teri] Section 6.2 and 6.3, respectively. This 76 document defines an HTTP binding and JavaScript Object Notation 77 (JSON) [RFC7159] encoding for TeRI. It does not however define any 78 particular profile or deployment environment for using TeRI in this 79 fashion; this only demonstrates an instantiation of the baseline TeRI 80 specification using JSON. 82 This is an early stage Internet-Draft that serves primarily as a 83 vehicle to give examples of a potential syntax for TeRI Requests and 84 Responses in order to facilitate discussion. 86 2. Terminology 88 In this document, the key words "MAY", "MUST, "MUST NOT", "SHOULD", 89 and "SHOULD NOT", are to be interpreted as described in [RFC2119]. 90 This document also incorporates the terminology of the MODERN 91 Framework [I-D.ietf-modern-problem-framework]. 93 3. HTTP TeRI Binding 95 This specification defines a RESTful interface for getting and 96 putting JSON objects related to TeRI at a web service. 98 TBD. 100 4. JSON TeRI Encoding 102 This specification defines separate JSON objects to carry TeRI 103 Requests and Responses. All JSON objects begin with a "TeRI" 104 element, which has a value stating whether the object contains a 105 Request or a Response. 107 4.1. TeRI Requests 109 Per TeRI [I-D.peterson-modern-teri], all requests will have a Source 110 and a Subject. Optionally, a block of Attributes will also appear in 111 the Request. 113 This simplest TeRI request will therefore have the following form: 115 { "TeRI":"Request", 116 "Source":{"Request":"example.com"}, 117 "Subject":{"T":"12125551111"} } 119 A Request may have two types of Sources: a "Request" Source or an 120 "Intermediary" Source. The "Source" element is given as an array 121 here because a Request may have multiple Sources, including one 122 "Request" Source and one or more "Intermediary" Sources. All 123 Requests have a single Subject. The encoding of a Subject follows 124 the Service Types given in [I-D.peterson-modern-teri] Section 4.2.1. 125 Here, Type "T" signifies a single telephone number. 127 Most of the complexity in Requests comes from Attributes. Attributes 128 appear in their own JSON array. An Attribute typically serves to 129 qualify a request. In this example, the TeRI request is only asking 130 for an Internet-based SMS service (see [I-D.peterson-modern-teri] 131 Section 5.5.2) associated with the telephone number "12125551000". 133 { "TeRI":"Request", 134 "Source":{"Request":"example.com"}, 135 "Subject":{T":"12125551000" } , 136 "Attribute":{ 137 "Service":"sms"} 138 } 140 4.2. TeRI Responses 142 All TeRI responses will give a Response Code. The simplest TeRI 143 responses are therefore simple failure responses. 145 { "TeRI":"Response", 146 "Code":"Unauthorized Source" } 148 [TBD: Note that TeRI has not allocate Response Codes yet; these will 149 accompany the human-readable response indicators like "Unauthorized 150 Source"] 152 Most interesting TeRI responses contain Records, which are specified 153 in Section 4.3. 155 4.3. TeRI Records 157 A TeRI Record consists of a JSON array containing a set of elements 158 as defined in [I-D.peterson-modern-teri]. Records may appear in both 159 TeRI Requests and Responses; for Retrieval Operations, it would be 160 most common for Records to appear in Responses, when the Request 161 indicates a Subject that the Source would like receive Records 162 related to. 164 { "TeRI":"Response", 165 "Code":"Success", 166 "Record:{ 167 "Identifier":"dc9a25c5-e44a-4dc1-9ff7-609da04bd694", 168 "Authority":{"x5u":"http://example.com/cert.cert"}, 169 "Contact":"admin@example.com", 170 "Service":{"U":"sip:alice@example.com"}, 171 "Signature":"dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk" } 172 } 174 This is a simple example of a Record; more complex records may 175 contain Priorities or Expiries. Note that the Service Type here 176 follows the [I-D.peterson-modern-teri] Section 4.2.1 Types, as did 177 the Attributes in the Request above. 179 5. Acknowledgments 181 We would like to thank you for your contributions to this problem 182 statement and framework. 184 6. IANA Considerations 186 This memo includes no request to IANA. 188 7. Security Considerations 190 TBD. 192 8. Informative References 194 [I-D.ietf-modern-problem-framework] 195 Peterson, J. and T. McGarry, "Modern Problem Statement, 196 Use Cases, and Framework", draft-ietf-modern-problem- 197 framework-01 (work in progress), July 2016. 199 [I-D.peterson-modern-teri] 200 Peterson, J., "An Architecture and Information Model for 201 Telephone-Related Information (TeRI)", draft-peterson- 202 modern-teri-01 (work in progress), July 2016. 204 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 205 Requirement Levels", BCP 14, RFC 2119, 206 DOI 10.17487/RFC2119, March 1997, 207 . 209 [RFC7159] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data 210 Interchange Format", RFC 7159, DOI 10.17487/RFC7159, March 211 2014, . 213 Author's Address 215 Jon Peterson 216 Neustar, Inc. 217 1800 Sutter St Suite 570 218 Concord, CA 94520 219 US 221 Email: jon.peterson@neustar.biz