idnits 2.17.1 draft-stepanek-jscontact-03.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 (June 29, 2019) is 1756 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Looks like a reference, but probably isn't: '1' on line 508 -- Obsolete informational reference (is this intentional?): RFC 2368 (Obsoleted by RFC 6068) Summary: 0 errors (**), 0 flaws (~~), 1 warning (==), 3 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 TBD R. Stepanek 3 Internet-Draft FastMail 4 Intended status: Standards Track M. Loffredo 5 Expires: December 31, 2019 IIT-CNR 6 June 29, 2019 8 JSContact: A JSON representation of addressbook data 9 draft-stepanek-jscontact-03 11 Abstract 13 This specification defines a data model and JSON representation of 14 contact card information that can be used for data storage and 15 exchange in address book or directory applications. It aims to be an 16 alternative to the vCard data format and to be unambiguous, 17 extendable and simple to process. In contrast to the JSON-based 18 jCard format, it is not a direct mapping from the vCard data model 19 and expands semantics where appropriate. 21 Status of This Memo 23 This Internet-Draft is submitted in full conformance with the 24 provisions of BCP 78 and BCP 79. 26 Internet-Drafts are working documents of the Internet Engineering 27 Task Force (IETF). Note that other groups may also distribute 28 working documents as Internet-Drafts. The list of current Internet- 29 Drafts is at https://datatracker.ietf.org/drafts/current/. 31 Internet-Drafts are draft documents valid for a maximum of six months 32 and may be updated, replaced, or obsoleted by other documents at any 33 time. It is inappropriate to use Internet-Drafts as reference 34 material or to cite them other than as "work in progress." 36 This Internet-Draft will expire on December 31, 2019. 38 Copyright Notice 40 Copyright (c) 2019 IETF Trust and the persons identified as the 41 document authors. All rights reserved. 43 This document is subject to BCP 78 and the IETF Trust's Legal 44 Provisions Relating to IETF Documents 45 (https://trustee.ietf.org/license-info) in effect on the date of 46 publication of this document. Please review these documents 47 carefully, as they describe your rights and restrictions with respect 48 to this document. Code Components extracted from this document must 49 include Simplified BSD License text as described in Section 4.e of 50 the Trust Legal Provisions and are provided without warranty as 51 described in the Simplified BSD License. 53 Table of Contents 55 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 56 1.1. Relation to the xCard and jCard formats . . . . . . . . . 3 57 1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 58 2. JSCard . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 59 3. JSCardGroup . . . . . . . . . . . . . . . . . . . . . . . . . 9 60 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9 61 5. Security Considerations . . . . . . . . . . . . . . . . . . . 9 62 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 9 63 6.1. Normative References . . . . . . . . . . . . . . . . . . 9 64 6.2. Informative References . . . . . . . . . . . . . . . . . 10 65 6.3. URIs . . . . . . . . . . . . . . . . . . . . . . . . . . 11 66 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 11 68 1. Introduction 70 This document defines a data model for contact card data normally 71 used in address book or directory applications and services. It aims 72 to be an alternative to the vCard data format [RFC6350] and to 73 provide a JSON-based standard representation of contact card data. 75 The key design considerations for this data model are as follows: 77 o Most of the initial set of attributes should be taken from the 78 vCard data format [RFC6350] and extensions ([RFC6473], [RFC6474], 79 [RFC6715], [RFC6869], [RFC8605]). The specification should add 80 new attributes or value types, or not support existing ones, where 81 appropriate. Conversion between the data formats need not fully 82 preserve semantic meaning. 84 o The attributes of the cards data represented must be described as 85 a simple key-value pair, reducing complexity of its 86 representation. 88 o The data model should avoid all ambiguities and make it difficult 89 to make mistakes during implementation. 91 o Extensions, such as new properties and components, MUST NOT lead 92 to requiring an update to this document. 94 The representation of this data model is defined in the I-JSON format 95 [RFC7493], which is a strict subset of the JavaScript Object Notation 96 (JSON) Data Interchange Format [RFC8259]. Using JSON is mostly a 97 pragmatic choice: its widespread use makes JSCard easier to adopt, 98 and the availability of production-ready JSON implementations 99 eliminates a whole category of parser-related interoperability 100 issues. 102 1.1. Relation to the xCard and jCard formats 104 The xCard [RFC6351] and jCard [RFC7095] specifications define 105 alternative representations for vCard data, in XML and JSON format 106 respectively. Both explicitly aim to not change the underlying data 107 model. Accordingly, they are regarded as equal to vCard in the 108 context of this document. 110 1.2. Terminology 112 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 113 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 114 "OPTIONAL" in this document are to be interpreted as described in BCP 115 14 [RFC2119] [RFC8174] when, and only when, they appear in all 116 capitals, as shown here. 118 2. JSCard 120 MIME type: "application/jscontact+json;type=jscard" 122 A JSCard object stores information about a person, organization or 123 company. It has the following properties: 125 o uid: String (mandatory). An identifier, used to associate the 126 object as the same across different systems, addressbooks and 127 views. [RFC4122] describes a range of established algorithms to 128 generate universally unique identifiers (UUID), and the random or 129 pseudo-random version is recommended. For compatibility with 130 [RFC6350] UIDs, implementations MUST accept both URI and free-form 131 text. 133 o prodId: String (optional). The identifier for the product that 134 created the JSCard object. 136 o updated: String (mandatory). The date and time when the data in 137 this JSCard object was last modified. The timestamp MUST be 138 formatted as specified in [RFC3339]. 140 o kind: String (optional). The kind of the entity the Card 141 represents. The value MUST be either one of the following values, 142 registered in a future RFC, or a vendor-specific value: 144 * "individual": a single person 145 * "org": an organization 147 * "location": a named location 149 * "device": a device, such as appliances, computers, or network 150 elements 152 * "application": a software application 154 o fullName: FullName[] (mandatory). The full name(s) of the entity 155 represented by this card. A FullName object has the following 156 properties: 158 * name: String (mandatory) The full name (e.g. the personal name 159 and surname of an individual, the name of an organization). 161 * language: String (optional) The [RFC5646] language tag of this 162 name, if any. 164 * isPreferred: Boolean (optional, default: "false"). Whether 165 this FullName is the preferred name. 167 o structuredName: StructuredName (optional). The name of the person 168 represented by this card, structured by its constituents. A 169 StructuredName object has the following properties: 171 * prefix: String[] (optional). The honorific title(s), e.g. 172 "Mr", "Ms", "Dr". 174 * personalName: String[] (optional). The personal name(s), also 175 known as "first name", "give name". 177 * surname: String[] (optional). The surname(s) (also known as 178 "last name", "family name"). 180 * additionalName: String[] (optional). The additional name(s), 181 also known as "middle name". 183 * suffix: String[] (optional). The honorific suffix(es), e.g. 184 "B.A.", "Esq.". 186 o nickname: String[] (optional). The nickname(s) of the person 187 represented by this card. 189 o anniversaries: Anniversary[] (optional). Memorable dates and 190 events for the entity represented by this card. An Anniversary 191 object has the following properties: 193 * type: String (mandatory). Specifies the type of the 194 anniversary. This RFC predefines the following types, but 195 implementations MAY use additional values: 197 + "birth": a birth day anniversary 199 + "death": a death day anniversary 201 + "other": an anniversary not covered by any of the known 202 types. 204 * date: String (mandatory). The date of this anniversary, in the 205 form "YYYY-MM-DD" (any part may be all 0s for unknown) or a 206 [RFC3339] timestamp. 208 * place: Address (optional). An address associated with this 209 anniversary, e.g. the place of birth or death. 211 o organization: String[] (optional). The company or organization 212 name and units associated with this card. The first entry in the 213 list names the organization, and any following entries name 214 organizational units. 216 o jobTitle[]: String (optional). The job title(s) or functional 217 position(s) of the entity represented by this card. 219 o role[]: String (optional). The role(s), function(s) or part(s) 220 played in a particular situation by the entity represented by this 221 card. In contrast to a job title, the roles might differ for 222 example in project contexts. 224 o emails: ContactMethod[] (optional). An array of ContactMethod 225 objects where the values are URLs in the [RFC2368] "mailto" scheme 226 or free-text email addresses. Types are: 228 * "personal" The address is for emailing in a personal context. 230 * "work" The address is for emailing in a professional context. 232 * "other" The address is for some other purpose. A label 233 property MAY be included to display next to the address to help 234 the user identify its purpose. 236 o phones: ContactMethod[] (optional). An array of ContactMethod 237 objects where the values are URIs scheme or free-text phone 238 numbers. Typical URI schemes are the [RFC3966] "tel" or [RFC3261] 239 "sip" schemes, but any URI scheme is allowed. Contact method 240 types are: 242 * "voice" The number is for calling by voice. 244 * "fax" The number is for sending faxes. 246 * "pager" The number is for a pager or beeper. 248 * "other" The number is for some other purpose. A label property 249 MAY be included to display next to the number to help the user 250 identify its purpose. 251 The following labels are pre-defined for phone contact methods: 253 * "private" The phone number should be used in a private context. 255 * "work" The phone number should be used in a professional 256 context 258 o online: ContactMethod[] (optional). An array of ContactMethod 259 objects where the values are URIs or usernames associated with the 260 card for online services. Types are: 262 * "uri" The value is a URI, e.g. a website link. 264 * "username" The value is a username associated with the entity 265 represented by this card (e.g. for social media, or an IM 266 client). A label property SHOULD be included to identify what 267 service this is for. For compatibility between clients, this 268 label SHOULD be the canonical service name, including 269 capitalisation. e.g. "Twitter", "Facebook", "Skype", "GitHub", 270 "XMPP". 272 * "other" The value is something else not covered by the above 273 categories. A label property MAY be included to display next 274 to the number to help the user identify its purpose. 276 o preferredContactMethod: String (optional) Defines the preferred 277 contact method. The value MUST be the property name of one of the 278 ContactMethod lists: "emails", "phones", "online", "other". 280 o addresses: Address[] (optional). An array of Address objects, 281 containing physical locations. 283 o personalInfo: PersonalInformation[] (optional). A list of 284 personal information about the entity represented by this card. A 285 PersonalInformation object has the following properties: 287 * type: String (mandatory). Specifies the type for this personal 288 information. Allowed values are: 290 + "expertise": a field of expertise or credential 292 + "hobby": a hobby 294 + "interest": an interest 296 + "other": an information not covered by the above categories 298 * value: String (mandatory). The actual information. This 299 generally is free-text, but future specifications MAY restrict 300 allowed values depending on the type of this 301 PersonalInformation. 303 * level: String (optional) Indicates the level of expertise, or 304 engagement in hobby or interest. Allowed values are: "high", 305 "medium" and "low". 307 o notes: String (optional). Arbitrary notes about the entity 308 represented by this card. 310 o categories: String[] (optional). A list of free-text or URI 311 categories that relate to the card. 313 A ContactMethod object has the following properties: 315 o type: String (mandatory). Specifies the context of the contact 316 method. This MUST be taken from the set of values allowed 317 depending on whether this is part of the phones, emails or online 318 property (see above). 320 o label: String (optional). A label describing the value in more 321 detail, especially if the type property has value "other" (but MAY 322 be included with any type). 324 o value: String (mandatory). The actual contact method, e.g. the 325 email address or phone number. 327 o isPreferred: Boolean (optional, default: "false"). Whether this 328 ContactMethod is the preferred for its type. This SHOULD only be 329 one per type. 331 An Address object has the following properties: 333 o type: String (mandatory). Specifies the context of the address 334 information. The value MUST be either one of the following 335 values, registered in a future RFC, or a vendor-specific value: 337 * "home" An address of a residence. 339 * "work" An address of a workplace. 341 * "billing" An address to be used for billing. 343 * "postal" An address to be used for delivering physical items. 345 * "other" An address not covered by the above categories. 347 o label: String (optional). A label describing the value in more 348 detail. 350 o fullAddress: String (optional). The complete address, excluding 351 type and label. This property is mainly useful to represent 352 addresses of which the individual address components are unknown. 354 o street: String (optional). The street address. This MAY be 355 multiple lines; newlines MUST be preserved. 357 o extension: String (optional) The extended address, such as an 358 apartment or suite number, or care-of address. 360 o postOfficeBox: String (optional) The post office box. 362 o locality: String (optional). The city, town, village, post town, 363 or other locality within which the street address may be found. 365 o region: String (optional). The province, such as a state, county, 366 or canton within which the locality may be found. 368 o postcode: String (optional). The postal code, post code, ZIP code 369 or other short code associated with the address by the relevant 370 country's postal system. 372 o country: String (optional). The country name. 374 o countryCode: String (optional). The ISO-3166-1 country code. 376 o coordinates: String (optional) A [RFC5870] "geo:" URI for the 377 address. 379 o timeZone: String (optional) Identifies the time zone this address 380 is located in. This SHOULD be a time zone name registered in the 381 IANA Time Zone Database [1]. Unknown time zone identifiers MAY be 382 ignored by implementations. 384 o isPreferred: Boolean (optional, default: "false"). Whether this 385 Address is the preferred for its type. This SHOULD only be one 386 per type. 388 3. JSCardGroup 390 MIME type: "application/jscontact+json;type=jscardgroup" 392 A JSCardGroup object represents a named set of JSCards. It has the 393 following properties: 395 o uid: String (mandatory). A globally unique identifier. The same 396 requirements as for the JSCard uid property apply. 398 o name: String (optional). The user-visible name for the group, 399 e.g. "Friends". This may be any UTF-8 string of at least 1 400 character in length and maximum 255 octets in size. The same name 401 may be used by two different groups. 403 o cardIds: String[] (mandatory). The ids of the cards in the group. 404 Implementations MUST preserve the order of list entries. 406 4. IANA Considerations 408 TBD 410 5. Security Considerations 412 TBD 414 6. References 416 6.1. Normative References 418 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 419 Requirement Levels", BCP 14, RFC 2119, 420 DOI 10.17487/RFC2119, March 1997, 421 . 423 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 424 Unique IDentifier (UUID) URN Namespace", RFC 4122, 425 DOI 10.17487/RFC4122, July 2005, 426 . 428 [RFC5870] Mayrhofer, A. and C. Spanring, "A Uniform Resource 429 Identifier for Geographic Locations ('geo' URI)", 430 RFC 5870, DOI 10.17487/RFC5870, June 2010, 431 . 433 [RFC6350] Perreault, S., "vCard Format Specification", RFC 6350, 434 DOI 10.17487/RFC6350, August 2011, 435 . 437 [RFC6351] Perreault, S., "xCard: vCard XML Representation", 438 RFC 6351, DOI 10.17487/RFC6351, August 2011, 439 . 441 [RFC7095] Kewisch, P., "jCard: The JSON Format for vCard", RFC 7095, 442 DOI 10.17487/RFC7095, January 2014, 443 . 445 [RFC7493] Bray, T., Ed., "The I-JSON Message Format", RFC 7493, 446 DOI 10.17487/RFC7493, March 2015, 447 . 449 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 450 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 451 May 2017, . 453 [RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data 454 Interchange Format", STD 90, RFC 8259, 455 DOI 10.17487/RFC8259, December 2017, 456 . 458 6.2. Informative References 460 [RFC2368] Hoffman, P., Masinter, L., and J. Zawinski, "The mailto 461 URL scheme", RFC 2368, DOI 10.17487/RFC2368, July 1998, 462 . 464 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, 465 A., Peterson, J., Sparks, R., Handley, M., and E. 466 Schooler, "SIP: Session Initiation Protocol", RFC 3261, 467 DOI 10.17487/RFC3261, June 2002, 468 . 470 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 471 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 472 . 474 [RFC3966] Schulzrinne, H., "The tel URI for Telephone Numbers", 475 RFC 3966, DOI 10.17487/RFC3966, December 2004, 476 . 478 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 479 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 480 September 2009, . 482 [RFC6473] Saint-Andre, P., "vCard KIND:application", RFC 6473, 483 DOI 10.17487/RFC6473, December 2011, 484 . 486 [RFC6474] Li, K. and B. Leiba, "vCard Format Extensions: Place of 487 Birth, Place and Date of Death", RFC 6474, 488 DOI 10.17487/RFC6474, December 2011, 489 . 491 [RFC6715] Cauchie, D., Leiba, B., and K. Li, "vCard Format 492 Extensions: Representing vCard Extensions Defined by the 493 Open Mobile Alliance (OMA) Converged Address Book (CAB) 494 Group", RFC 6715, DOI 10.17487/RFC6715, August 2012, 495 . 497 [RFC6869] Salgueiro, G., Clarke, J., and P. Saint-Andre, "vCard 498 KIND:device", RFC 6869, DOI 10.17487/RFC6869, February 499 2013, . 501 [RFC8605] Hollenbeck, S. and R. Carney, "vCard Format Extensions: 502 ICANN Extensions for the Registration Data Access Protocol 503 (RDAP)", RFC 8605, DOI 10.17487/RFC8605, May 2019, 504 . 506 6.3. URIs 508 [1] https://www.iana.org/time-zones 510 Authors' Addresses 512 Robert Stepanek 513 FastMail 514 PO Box 234, Collins St West 515 Melbourne VIC 8007 516 Australia 518 Email: rsto@fastmailteam.com 520 Mario Loffredo 521 IIT-CNR 522 Via Moruzzi,1 523 Pisa 56124 524 Italy 526 Email: mario.loffredo@iit.cnr.it