idnits 2.17.1 draft-stepanek-jscontact-02.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 20, 2019) is 1773 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 483 Summary: 0 errors (**), 0 flaws (~~), 1 warning (==), 2 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 22, 2019 IIT-CNR 6 June 20, 2019 8 JSContact: A JSON representation of addressbook data 9 draft-stepanek-jscontact-02 11 Abstract 13 This specification defines a data model and JSON representation of 14 contact information that can be used for data storage and exchange in 15 address book or directory applications. It aims to be an alternative 16 to the vCard data format and to be unambiguous, extendable and simple 17 to process. In contrast to the JSON-based jCard format, it is not a 18 direct mapping from the vCard data model and expands semantics where 19 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 22, 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. Contact . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 59 3. Contact Group . . . . . . . . . . . . . . . . . . . . . . . . 8 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 data normally used in 71 address book or directory applications and services. It aims to be 72 an alternative to the vCard data format [RFC6350] and to provide a 73 JSON-based standard representation of contacts 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 contacts data represented must be described 85 as 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 JSContact 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. Contact 120 MIME type: "application/jscontact+json;type=jscontact" 122 A JSContact object stores contact information about a person, 123 organization or 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 JSContact object. 136 o updated: String (mandatory). The date and time when the data in 137 this JSContact 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 Contact 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 a contact. 155 A FullName object has the following properties: 157 * name: String (mandatory) The full name (e.g. the personal name 158 and surname of an individual, the name of an organization). 160 * language: String (optional) The [RFC5646] language tag of this 161 name, if any. 163 * isPreferred: Boolean (optional, default: "false"). Whether 164 this FullName is the preferred name for this contact. 166 o structuredName: StructuredName (optional). The name of this 167 contact, structured by its constituents. A StructuredName object 168 has the following properties: 170 * prefix: String[] (optional). The honorific title(s) of the 171 contact (e.g. "Mr", "Ms", "Dr"). 173 * personalName: String[] (optional). The personal name(s) of a 174 contact (also known as "first name", "give name"). 176 * surname: String[] (optional). The surname(s) of a contact 177 (also known as "last name", "family name"). 179 * additionalName: String[] (optional). The additional name(s) of 180 a contact (also known as "middle name"). 182 * suffix: String[] (optional). The honorific suffix(es) of the 183 contact (e.g. "B.A.", "Esq."). 185 o nickname: String[] (optional). The nickname(s) of the contact. 187 o birthday: String (optional). The contact's birth date in the form 188 "YYYY-MM-DD" (any part may be all 0s for unknown) or a [RFC3339] 189 timestamp. 191 o birthPlace: String (optional). The contact's birth place. 193 o deathDate: String (optional). The contact's death date in the 194 form "YYYY-MM-DD" (any part may be all 0s for unknown) or a 195 [RFC3339] timestamp. 197 o deathPlace: String (optional). The contact's death place. 199 o anniversary: String (optional). The contact's anniversary date in 200 the form "YYYY-MM-DD" (any part may be all 0s for unknown). 202 o organization: String[] (optional). The company or organization 203 name and units associated with this contact. The first entry in 204 the list names the organization, and any following entries name 205 organizational units. 207 o jobTitle[]: String (optional). The job title(s) or functional 208 position(s) of the contact. 210 o role[]: String (optional). The role(s), function(s) or part(s) 211 played in a particular situation by the contact. In contrast to a 212 job title, the roles might differ for example in project contexts. 214 o emails: ContactMethod[] (optional). An array of ContactMethod 215 objects where the values are email addresses. Types are: 217 * "personal" The address is for emailing the contact in a 218 personal context. 220 * "work" The address is for emailing the contact in a 221 professional context. 223 * "other" The address is for some other purpose. A label 224 property MAY be included to display next to the address to help 225 the user identify its purpose. 227 o phones: ContactMethod[] (optional). An array of ContactMethod 228 objects where the values are phone numbers. Types are: 230 * "voice" The number is for calling the contact. 232 * "fax" The number is for sending faxes to the contact. 234 * "pager" The number is for a pager or beeper associated with the 235 contact. 237 * "other" The number is for some other purpose. A label property 238 MAY be included to display next to the number to help the user 239 identify its purpose. 240 The following labels are pre-defined for phone contact methods: 242 * "private" The phone number should be used in a private context. 244 * "work" The phone number should be used in a professional 245 context 247 o online: ContactMethod[] (optional). An array of ContactMethod 248 objects where the values are URIs or usernames associated with the 249 contact for online services. Types are: 251 * "uri" The value is a URI, e.g. a website link. 253 * "username" The value is a username associated with the contact 254 (e.g. for social media, or an IM client). A label property 255 SHOULD be included to identify what service this is for. For 256 compatibility between clients, this label SHOULD be the 257 canonical service name, including capitalisation. e.g. 258 "Twitter", "Facebook", "Skype", "GitHub", "XMPP". 260 * "other" The value is something else not covered by the above 261 categories. A label property MAY be included to display next 262 to the number to help the user identify its purpose. 264 o preferredContactMethod: String (optional) Defines the preferred 265 contact method. The value MUST be the property name of one of the 266 ContactMethod lists: "emails", "phones", "online", "other". 268 o addresses: Address[] (optional). An array of Address objects, 269 containing physical locations associated with the contact. 271 o personalInfo: PersonalInformation[] (optional). A list of 272 personal information about this contact. A PersonalInformation 273 object has the following properties: 275 * type: String (mandatory). Specifies the type for this personal 276 information. Allowed values are: 278 + "expertise": a field of expertise or credential 280 + "hobby": a hobby of this contact 282 + "interest": an interest of this contact 284 + "other": an information not covered by the above categories 286 * value: String (mandatory). The actual contact information. 287 This generally is free-text, but future specifications MAY 288 restrict allowed values depending on the type of this 289 PersonalInformation. 291 * level: String (optional) Indicates the level of expertise, or 292 engagement in hobby or interest. Allowed values are: "high", 293 "medium" and "low". 295 o notes: String (optional). Arbitrary notes about the contact. 297 o categories: String[] (optional). A list of free-text or URI 298 categories that relate to the contact. 300 A ContactMethod object has the following properties: 302 o type: String (mandatory). Specifies the context of the contact 303 method. This MUST be taken from the set of values allowed 304 depending on whether this is part of the phones, emails or online 305 property (see above). 307 o label: String (optional). A label describing the value in more 308 detail, especially if the type property has value "other" (but MAY 309 be included with any type). 311 o value: String (mandatory). The actual contact method, e.g. the 312 email address or phone number. 314 o isPreferred: Boolean (optional, default: "false"). Whether this 315 ContactMethod is the preferred for its type. This SHOULD only be 316 one per type. 318 An Address object has the following properties: 320 o type: String (mandatory). Specifies the context of the address 321 information. The value MUST be either one of the following 322 values, registered in a future RFC, or a vendor-specific value: 324 * "home" An address of a residence associated with the contact. 326 * "work" An address of a workplace associated with the contact. 328 * "billing" An address to be used with billing associated with 329 the contact.. 331 * "postal" An address to be used for delivering physical items to 332 the contact. 334 * "other" An address not covered by the above categories. 336 o label: String (optional). A label describing the value in more 337 detail. 339 o fullAddress: String (optional). The complete address, excluding 340 type and label. This property is mainly useful to represent 341 addresses of which the individual address components are unknown. 343 o street: String (optional). The street address. This MAY be 344 multiple lines; newlines MUST be preserved. 346 o extension: String (optional) The extended address, such as an 347 apartment or suite number, or care-of address. 349 o postOfficeBox: String (optional) The post office box. 351 o locality: String (optional). The city, town, village, post town, 352 or other locality within which the street address may be found. 354 o region: String (optional). The province, such as a state, county, 355 or canton within which the locality may be found. 357 o postcode: String (optional). The postal code, post code, ZIP code 358 or other short code associated with the address by the relevant 359 country's postal system. 361 o country: String (optional). The country name. 363 o countryCode: String (optional). The ISO-3166-1 country code. 365 o coordinates: String (optional) A [RFC5870] "geo:" URI for the 366 address. 368 o timeZone: String (optional) Identifies the time zone this address 369 is located in. This SHOULD be a time zone name registered in the 370 IANA Time Zone Database [1]. Unknown time zone identifiers MAY be 371 ignored by implementations. 373 o isPreferred: Boolean (optional, default: "false"). Whether this 374 Address is the preferred for its type. This SHOULD only be one 375 per type. 377 3. Contact Group 379 MIME type: "application/jscontact+json;type=jscontactgroup" 381 A JSContactGroup object represents a named set of contacts. It has 382 the following properties: 384 o uid: String (mandatory). A globally unique identifier. The same 385 requirements as for the JSContact uid property apply. 387 o name: String (optional). The user-visible name for the group, 388 e.g. "Friends". This may be any UTF-8 string of at least 1 389 character in length and maximum 255 octets in size. The same name 390 may be used by two different groups. 392 o contactIds: String[] (mandatory). The ids of the contacts in the 393 group. Implementations MUST preserve the order of list entries. 395 4. IANA Considerations 397 TBD 399 5. Security Considerations 401 TBD 403 6. References 405 6.1. Normative References 407 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 408 Requirement Levels", BCP 14, RFC 2119, 409 DOI 10.17487/RFC2119, March 1997, 410 . 412 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 413 Unique IDentifier (UUID) URN Namespace", RFC 4122, 414 DOI 10.17487/RFC4122, July 2005, 415 . 417 [RFC5870] Mayrhofer, A. and C. Spanring, "A Uniform Resource 418 Identifier for Geographic Locations ('geo' URI)", 419 RFC 5870, DOI 10.17487/RFC5870, June 2010, 420 . 422 [RFC6350] Perreault, S., "vCard Format Specification", RFC 6350, 423 DOI 10.17487/RFC6350, August 2011, 424 . 426 [RFC6351] Perreault, S., "xCard: vCard XML Representation", 427 RFC 6351, DOI 10.17487/RFC6351, August 2011, 428 . 430 [RFC7095] Kewisch, P., "jCard: The JSON Format for vCard", RFC 7095, 431 DOI 10.17487/RFC7095, January 2014, 432 . 434 [RFC7493] Bray, T., Ed., "The I-JSON Message Format", RFC 7493, 435 DOI 10.17487/RFC7493, March 2015, 436 . 438 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 439 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 440 May 2017, . 442 [RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data 443 Interchange Format", STD 90, RFC 8259, 444 DOI 10.17487/RFC8259, December 2017, 445 . 447 6.2. Informative References 449 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 450 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 451 . 453 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 454 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 455 September 2009, . 457 [RFC6473] Saint-Andre, P., "vCard KIND:application", RFC 6473, 458 DOI 10.17487/RFC6473, December 2011, 459 . 461 [RFC6474] Li, K. and B. Leiba, "vCard Format Extensions: Place of 462 Birth, Place and Date of Death", RFC 6474, 463 DOI 10.17487/RFC6474, December 2011, 464 . 466 [RFC6715] Cauchie, D., Leiba, B., and K. Li, "vCard Format 467 Extensions: Representing vCard Extensions Defined by the 468 Open Mobile Alliance (OMA) Converged Address Book (CAB) 469 Group", RFC 6715, DOI 10.17487/RFC6715, August 2012, 470 . 472 [RFC6869] Salgueiro, G., Clarke, J., and P. Saint-Andre, "vCard 473 KIND:device", RFC 6869, DOI 10.17487/RFC6869, February 474 2013, . 476 [RFC8605] Hollenbeck, S. and R. Carney, "vCard Format Extensions: 477 ICANN Extensions for the Registration Data Access Protocol 478 (RDAP)", RFC 8605, DOI 10.17487/RFC8605, May 2019, 479 . 481 6.3. URIs 483 [1] https://www.iana.org/time-zones 485 Authors' Addresses 487 Robert Stepanek 488 FastMail 489 PO Box 234, Collins St West 490 Melbourne VIC 8007 491 Australia 493 Email: rsto@fastmailteam.com 495 Mario Loffredo 496 IIT-CNR 497 Via Moruzzi,1 498 Pisa 56124 499 Italy 501 Email: mario.loffredo@iit.cnr.it