idnits 2.17.00 (12 Aug 2021) /tmp/idnits39553/draft-ietf-calext-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: ---------------------------------------------------------------------------- == There is 1 instance of lines with non-ascii characters in the document. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The document seems to lack the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords. (The document does seem to have the reference to RFC 2119 which the ID-Checklist requires). -- The document date (11 April 2022) is 33 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) == Missing Reference: 'B' is mentioned on line 201, but not defined == Missing Reference: 'Relation' is mentioned on line 402, but not defined == Missing Reference: 'Boolean' is mentioned on line 1040, but not defined == Missing Reference: 'Organization' is mentioned on line 518, but not defined == Missing Reference: 'Title' is mentioned on line 533, but not defined == Missing Reference: 'EmailAddress' is mentioned on line 588, but not defined == Missing Reference: 'Phone' is mentioned on line 611, but not defined == Missing Reference: 'Resource' is mentioned on line 656, but not defined == Missing Reference: 'Scheduling' is mentioned on line 732, but not defined == Missing Reference: 'String' is mentioned on line 741, but not defined == Missing Reference: 'File' is mentioned on line 752, but not defined == Missing Reference: 'Address' is mentioned on line 814, but not defined == Missing Reference: 'PatchObject' is mentioned on line 912, but not defined == Missing Reference: 'Anniversary' is mentioned on line 943, but not defined == Missing Reference: 'PersonalInformation' is mentioned on line 971, but not defined == Missing Reference: 'TimeZone' is mentioned on line 1014, but not defined Summary: 0 errors (**), 0 flaws (~~), 18 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Calendaring Extensions R. Stepanek 3 Internet-Draft FastMail 4 Intended status: Standards Track M. Loffredo 5 Expires: 13 October 2022 IIT-CNR 6 11 April 2022 8 JSContact: A JSON representation of contact data 9 draft-ietf-calext-jscontact-02 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 13 October 2022. 38 Copyright Notice 40 Copyright (c) 2022 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 (https://trustee.ietf.org/ 45 license-info) in effect on the date of publication of this document. 46 Please review these documents carefully, as they describe your rights 47 and restrictions with respect to this document. Code Components 48 extracted from this document must include Revised BSD License text as 49 described in Section 4.e of the Trust Legal Provisions and are 50 provided without warranty as described in the Revised BSD License. 52 Table of Contents 54 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 55 1.1. Relation to the xCard and jCard formats . . . . . . . . . 4 56 1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4 57 1.3. Vendor-specific Property Extensions and Values . . . . . 4 58 1.4. Type Signatures . . . . . . . . . . . . . . . . . . . . . 5 59 1.5. Data types . . . . . . . . . . . . . . . . . . . . . . . 5 60 1.5.1. Context . . . . . . . . . . . . . . . . . . . . . . . 5 61 1.5.2. Id . . . . . . . . . . . . . . . . . . . . . . . . . 6 62 1.5.3. PatchObject . . . . . . . . . . . . . . . . . . . . . 6 63 1.5.4. Preference . . . . . . . . . . . . . . . . . . . . . 7 64 1.5.5. UnsignedInt . . . . . . . . . . . . . . . . . . . . . 7 65 1.5.6. UTCDateTime . . . . . . . . . . . . . . . . . . . . . 8 66 2. Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 67 2.1. Metadata properties . . . . . . . . . . . . . . . . . . . 8 68 2.1.1. @type . . . . . . . . . . . . . . . . . . . . . . . . 8 69 2.1.2. uid . . . . . . . . . . . . . . . . . . . . . . . . . 8 70 2.1.3. prodId . . . . . . . . . . . . . . . . . . . . . . . 8 71 2.1.4. created . . . . . . . . . . . . . . . . . . . . . . . 8 72 2.1.5. updated . . . . . . . . . . . . . . . . . . . . . . . 9 73 2.1.6. kind . . . . . . . . . . . . . . . . . . . . . . . . 9 74 2.1.7. relatedTo . . . . . . . . . . . . . . . . . . . . . . 9 75 2.1.8. language . . . . . . . . . . . . . . . . . . . . . . 10 76 2.2. Name and Organization properties . . . . . . . . . . . . 10 77 2.2.1. name . . . . . . . . . . . . . . . . . . . . . . . . 10 78 2.2.2. fullName . . . . . . . . . . . . . . . . . . . . . . 11 79 2.2.3. nickNames . . . . . . . . . . . . . . . . . . . . . . 11 80 2.2.4. organizations . . . . . . . . . . . . . . . . . . . . 12 81 2.2.5. titles . . . . . . . . . . . . . . . . . . . . . . . 12 82 2.2.6. speakToAs . . . . . . . . . . . . . . . . . . . . . . 12 83 2.3. Contact and Resource properties . . . . . . . . . . . . . 13 84 2.3.1. emails . . . . . . . . . . . . . . . . . . . . . . . 13 85 2.3.2. phones . . . . . . . . . . . . . . . . . . . . . . . 14 86 2.3.3. online . . . . . . . . . . . . . . . . . . . . . . . 15 87 2.3.4. scheduling . . . . . . . . . . . . . . . . . . . . . 16 88 2.3.5. photos . . . . . . . . . . . . . . . . . . . . . . . 17 89 2.3.6. preferredContactMethod . . . . . . . . . . . . . . . 17 90 2.3.7. preferredContactLanguages . . . . . . . . . . . . . . 17 92 2.4. Address and Location properties . . . . . . . . . . . . . 18 93 2.4.1. addresses . . . . . . . . . . . . . . . . . . . . . . 18 94 2.5. Multilingual properties . . . . . . . . . . . . . . . . . 20 95 2.5.1. localizations . . . . . . . . . . . . . . . . . . . . 20 96 2.6. Additional properties . . . . . . . . . . . . . . . . . . 21 97 2.6.1. anniversaries . . . . . . . . . . . . . . . . . . . . 21 98 2.6.2. personalInfo . . . . . . . . . . . . . . . . . . . . 21 99 2.6.3. notes . . . . . . . . . . . . . . . . . . . . . . . . 22 100 2.6.4. categories . . . . . . . . . . . . . . . . . . . . . 22 101 2.6.5. timeZones . . . . . . . . . . . . . . . . . . . . . . 22 102 3. CardGroup . . . . . . . . . . . . . . . . . . . . . . . . . . 22 103 3.1. Group properties . . . . . . . . . . . . . . . . . . . . 22 104 3.1.1. @type . . . . . . . . . . . . . . . . . . . . . . . . 22 105 3.1.2. uid . . . . . . . . . . . . . . . . . . . . . . . . . 23 106 3.1.3. members . . . . . . . . . . . . . . . . . . . . . . . 23 107 3.1.4. name . . . . . . . . . . . . . . . . . . . . . . . . 23 108 3.1.5. card . . . . . . . . . . . . . . . . . . . . . . . . 23 109 4. Implementation Status . . . . . . . . . . . . . . . . . . . . 23 110 4.1. IIT-CNR/Registro.it . . . . . . . . . . . . . . . . . . . 23 111 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 24 112 6. Security Considerations . . . . . . . . . . . . . . . . . . . 24 113 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 24 114 7.1. Normative References . . . . . . . . . . . . . . . . . . 24 115 7.2. Informative References . . . . . . . . . . . . . . . . . 25 116 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 27 118 1. Introduction 120 This document defines a data model for contact card data normally 121 used in address book or directory applications and services. It aims 122 to be an alternative to the vCard data format [RFC6350] and to 123 provide a JSON-based standard representation of contact card data. 125 The key design considerations for this data model are as follows: 127 * Most of the initial set of attributes should be taken from the 128 vCard data format [RFC6350] and extensions ([RFC6473], [RFC6474], 129 [RFC6715], [RFC6869], [RFC8605]). The specification should add 130 new attributes or value types, or not support existing ones, where 131 appropriate. Conversion between the data formats need not fully 132 preserve semantic meaning. 134 * The attributes of the cards data represented must be described as 135 a simple key-value pair, reducing complexity of its 136 representation. 138 * The data model should avoid all ambiguities and make it difficult 139 to make mistakes during implementation. 141 * Extensions, such as new properties and components, MUST NOT lead 142 to requiring an update to this document. 144 The representation of this data model is defined in the I-JSON format 145 [RFC7493], which is a strict subset of the JavaScript Object Notation 146 (JSON) Data Interchange Format [RFC8259]. Using JSON is mostly a 147 pragmatic choice: its widespread use makes Card easier to adopt, and 148 the availability of production-ready JSON implementations eliminates 149 a whole category of parser-related interoperability issues. 151 1.1. Relation to the xCard and jCard formats 153 The xCard [RFC6351] and jCard [RFC7095] specifications define 154 alternative representations for vCard data, in XML and JSON format 155 respectively. Both explicitly aim to not change the underlying data 156 model. Accordingly, they are regarded as equal to vCard in the 157 context of this document. 159 1.2. Terminology 161 The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, 162 SHOULD NOT, RECOMMENDED, NOT RECOMMENDED, MAY, and OPTIONAL in this 163 document are to be interpreted as described in BCP 14 [RFC2119] 164 [RFC8174] when, and only when, they appear in all capitals, as shown 165 here. 167 1.3. Vendor-specific Property Extensions and Values 169 Vendors MAY add additional properties to the contact object to 170 support their custom features. To avoid conflict, the names of these 171 properties MUST be prefixed by a domain name controlled by the vendor 172 followed by a colon, e.g., "example.com:customprop". If the value is 173 a new JSContact object, it either MUST include an "@type" property, 174 or it MUST explicitly be specified to not require a type designator. 175 The type name MUST be prefixed with a domain name controlled by the 176 vendor. 178 Some JSContact properties allow vendor-specific value extensions. 179 Such vendor-specific values MUST be prefixed by a domain name 180 controlled by the vendor followed by a colon, e.g., 181 "example.com:customrel". 183 Vendors are strongly encouraged to register any new property values 184 or extensions that are useful to other systems as well, rather than 185 use a vendor-specific prefix. 187 1.4. Type Signatures 189 Type signatures are given for all JSON values in this document. The 190 following conventions are used: 192 * * - The type is undefined (the value could be any type, although 193 permitted values may be constrained by the context of this value). 195 * String - The JSON string type. 197 * Number - The JSON number type. 199 * Boolean - The JSON boolean type. 201 * A[B] - A JSON object where the keys are all of type A, and the 202 values are all of type B. 204 * A[] - An array of values of type A. 206 * A|B - The value is either of type A or of type B. 208 1.5. Data types 210 In addition to the standard JSON data types, a couple of additional 211 data types are common to the definitions of JSContact objects and 212 properties. 214 1.5.1. Context 216 Contact information typically is associated with a context in which 217 it should be used. For example, someone might have distinct phone 218 numbers for work and private contexts. The Context data type 219 enumerates common contexts. 221 Common context values are: 223 * private: The contact information may be used to contact the card 224 holder in a private context. 226 * work: The contact information may be used to contact the card 227 holder in a professional context. 229 Additional allowed values may be defined in the properties or data 230 types that make use of the Context data type, registered in a future 231 RFC, or a vendor-specific value. 233 1.5.2. Id 235 Where Id is given as a data type, it means a String of at least 1 and 236 a maximum of 255 octets in size, and it MUST only contain characters 237 from the URL and Filename Safe base64url alphabet, as defined in 238 Section 5 of [RFC4648], excluding the pad character (=). This means 239 the allowed characters are the ASCII alphanumeric characters (A-Za- 240 z0-9), hyphen (-), and underscore (_). 242 In many places in JSContact a JSON map is used where the map keys are 243 of type Id and the map values are all the same type of object. This 244 construction represents an unordered set of objects, with the added 245 advantage that each entry has a name (the corresponding map key). 246 This allows for more concise patching of objects, and, when 247 applicable, for the objects in question to be referenced from other 248 objects within the JSContact object. 250 Unless otherwise specified for a particular property, there are no 251 uniqueness constraints on an Id value (other than, of course, the 252 requirement that you cannot have two values with the same key within 253 a single JSON map). For example, two Card objects might use the same 254 Ids in their respective photos properties. Or within the same Card 255 object the same Id could appear in the emails and phones properties. 256 These situations do not imply any semantic connections among the 257 objects. 259 1.5.3. PatchObject 261 A PatchObject is of type String[*], and represents an unordered set 262 of patches on a JSON object. Each key is a path represented in a 263 subset of JSON pointer format [RFC6901]. The paths have an implicit 264 leading /, so each key is prefixed with / before applying the JSON 265 pointer evaluation algorithm. 267 A patch within a PatchObject is only valid if all of the following 268 conditions apply: 270 1. The pointer MUST NOT reference inside an array (i.e., you MUST 271 NOT insert/delete from an array; the array MUST be replaced in 272 its entirety instead). 274 2. All parts prior to the last (i.e., the value after the final 275 slash) MUST already exist on the object being patched. 277 3. There MUST NOT be two patches in the PatchObject where the 278 pointer of one is the prefix of the pointer of the other, e.g., 279 addresses/1/city and addresses. 281 4. The value for the patch MUST be valid for the property being set 282 (of the correct type and obeying any other applicable 283 restrictions), or if null the property MUST be optional. 285 The value associated with each pointer determines how to apply that 286 patch: 288 * If null, remove the property from the patched object. If the key 289 is not present in the parent, this a no-op. 291 * If non-null, set the value given as the value for this property 292 (this may be a replacement or addition to the object being 293 patched). 295 A PatchObject does not define its own @type property. Instead, a 296 @type property in a patch MUST be handled as any other patched 297 property value. 299 Implementations MUST reject in its entirety a PatchObject if any of 300 its patches is invalid. Implementations MUST NOT apply partial 301 patches. 303 1.5.4. Preference 305 This data type allows to define a preference order on same-typed 306 contact information. For example, a card holder may have two email 307 addresses and prefer to be contacted with one of them. 309 A preference value MUST be an integer number in the range 1 and 100. 310 Lower values correspond to a higher level of preference, with 1 being 311 most preferred. If no preference is set, then the contact 312 information MUST be interpreted as being least preferred. 314 Note that the preference only is defined in relation to contact 315 information of the same type. For example, the preference orders 316 within emails and phone numbers are indendepent of each other. Also 317 note that the _preferredContactMethod_ property allows to define a 318 preferred contact method across method types. 320 1.5.5. UnsignedInt 322 Where UnsignedInt is given as a data type, it means an integer in the 323 range 0 <= value <= 2^53-1, represented as a JSON Number. 325 1.5.6. UTCDateTime 327 This is a string in [RFC3339] date-time format, with the further 328 restrictions that any letters MUST be in uppercase, and the time 329 offset MUST be the character Z. Fractional second values MUST NOT be 330 included unless non-zero and MUST NOT have trailing zeros, to ensure 331 there is only a single representation for each date-time. 333 For example, 2010-10-10T10:10:10.003Z is conformant, but 334 2010-10-10T10:10:10.000Z is invalid and is correctly encoded as 335 2010-10-10T10:10:10Z. 337 2. Card 339 MIME type: application/jscontact+json;type=card 341 A Card object stores information about a person, organization or 342 company. 344 2.1. Metadata properties 346 2.1.1. @type 348 Type: String (mandatory). 350 Specifies the type of this object. This MUST be Card. 352 2.1.2. uid 354 Type: String (mandatory). 356 An identifier, used to associate the object as the same across 357 different systems, addressbooks and views. [RFC4122] describes a 358 range of established algorithms to generate universally unique 359 identifiers (UUID), and the random or pseudo-random version is 360 recommended. For compatibility with [RFC6350] UIDs, implementations 361 MUST accept both URI and free-form text. 363 2.1.3. prodId 365 Type: String (optional). 367 The identifier for the product that created the Card object. 369 2.1.4. created 371 Type: UTCDateTime (optional). 373 The date and time when this Card object was created. 375 2.1.5. updated 377 Type: UTCDateTime (optional). 379 The date and time when the data in this Card object was last 380 modified. 382 2.1.6. kind 384 Type: String (optional). The kind of the entity the Card represents. 386 The value MUST be either one of the following values, registered in a 387 future RFC, or a vendor-specific value: 389 * individual: a single person 391 * org: an organization 393 * location: a named location 395 * device: a device, such as appliances, computers, or network 396 elements 398 * application: a software application 400 2.1.7. relatedTo 402 Type: String[Relation] (optional). 404 Relates the object to other Card and CardGroup objects. This is 405 represented as a map, where each key is the uid of the related Card 406 or CardGroup and the value defines the relation. The Relation object 407 has the following properties: 409 * @type: String (mandatory). Specifies the type of this object. 410 This MUST be Relation. 412 * relation: String[Boolean] (optional, default: empty Object) 413 Describes how the linked object is related to the linking object. 414 The relation is defined as a set of relation types. If empty, the 415 relationship between the two objects is unspecified. Keys in the 416 set MUST be one of the RELATED property [RFC6350] type parameter 417 values, or an IANA-registered value, or a vendor-specific value. 418 The value for each key in the set MUST be true. 420 2.1.8. language 422 Type: String (optional). 424 This defines the locale in which free-text property values can be 425 assumed to be written in. The value MUST be a language tag as 426 defined in [RFC5646]. Note that such values MAY be localized in the 427 localizations Section 2.5.1 property. 429 2.2. Name and Organization properties 431 2.2.1. name 433 Type: Name (optional). 435 The name of the entity represented by this Card. 437 A Name object has the following properties 439 * @type: Name (mandatory). Specifies the type of this object. This 440 MUST be Name. 442 * components: NameComponent[] (mandatory). The components making up 443 the name. The component list MUST have at least one entry. Name 444 components SHOULD be ordered such that their values joined by 445 whitespace produce a valid full name of this entity. Doing so, 446 implementations MAY ignore any components of type separator. 448 * locale: String (optional). The locale of the name. The value 449 MUST be a language tag as defined [RFC5646]. 451 A NameComponent object has the following properties: 453 * @type: String (mandatory). Specifies the type of this object. 454 This MUST be NameComponent. 456 * value: String (mandatory). The value of this name component. 458 * type: String (mandatory). The type of this name component. The 459 value MUST be either one of the following values, registered in a 460 future RFC, or a vendor-specific value: 462 - prefix. The value is a honorific title(s), e.g. "Mr", "Ms", 463 "Dr". 465 - given. The value is a given name, also known as "first name", 466 "personal name". 468 - surname. The value is a surname, also known as "last name", 469 "family name". 471 - middle. The value is a middle name, also known as "additional 472 name". 474 - suffix. The value is a honorific suffix, e.g. "B.A.", "Esq.". 476 - separator. A formatting separator for two name components. 477 The value property of the component includes the verbatim 478 separator, for example a newline character. 480 * nth: UnsignedInt (optional, default: 1). Defines the rank of this 481 name component to other name components of the same type. If set, 482 the property value MUST be higher than or equal to 1. 484 For example, two name components of type surname may have their 485 nth property value set to 1 and 2, respectively. In this case, 486 the first name component defines the surname, and the second name 487 component the secondary surname. 489 Note that this property value does not indicate the order in which 490 to print name components of the same type. Some cultures print 491 the secondary surname before the first surname, others the first 492 before the second. Implementations SHOULD inspect the locale 493 property of the Name object to determine the appropriate 494 formatting. They MAY print name components in order of appearance 495 in the components property of the Name object. 497 2.2.2. fullName 499 Type: String (optional). 501 The full name (e.g. the personal name and surname of an individual, 502 the name of an organization) of the entity represented by this card. 503 The purpose of this property is to define a name, even if the 504 individual name components are not known. In addition, it is meant 505 to provide alternative versions of the name for internationalisation. 506 Implementations SHOULD prefer using the _name_ property over this one 507 and SHOULD NOT store the concatenated name component values in this 508 property. 510 2.2.3. nickNames 512 Type: String[] (optional). 514 The nick names of the entity represented by this card. 516 2.2.4. organizations 518 Type: Id[Organization] (optional). 520 The companies or organization names and units associated with this 521 card. An Organization object has the following properties: 523 * @type: String (mandatory). Specifies the type of this object. 524 This MUST be Organization. 526 * name: String (mandatory). The name of this organization. 528 * units: String[] (optional). Additional levels of organizational 529 unit names. 531 2.2.5. titles 533 Type : Id[Title] (optional). 535 The job titles or functional positions of the entity represented by 536 this card. A Title has object the following properties: 538 * @type: String (mandatory). Specifies the type of this object. 539 This MUST be Title. 541 * title: String (mandatory). The title of the entity represented by 542 this card. 544 * organization: Id (optional). The id of the organization in which 545 this title is held. 547 2.2.6. speakToAs 549 Type: SpeakToAs (optional). 551 Provides information how to address, speak to or refer to the entity 552 that is represented by this card. A SpeakToAs object has the 553 following properties, of which at least one property other than @type 554 MUST be set: 556 * @type: String (mandatory). Specifies the type of this object. 557 This MUST be SpeakToAs. 559 * grammaticalGender: String (optional). Defines which grammatical 560 gender to use in salutations and other grammatical constructs. 561 Allowed values are: 563 - animate 564 - female 566 - inanimate 568 - male 570 - neuter 572 Note that the grammatical gender does not allow to infer the 573 gender identities or biological sex of the contact. 575 * pronouns: String (optional). Defines the gender pronouns that the 576 contact chooses to use for themselves. Any value or form is 577 allowed. Examples in English include she/her and they/them/ 578 theirs. 580 The property values SHOULD be localized in the language defined in 581 the language property. They MAY be overridden in the localizations 582 property (Section 2.5.1). 584 2.3. Contact and Resource properties 586 2.3.1. emails 588 Type: Id[EmailAddress] (optional). 590 The email addresses to contact the entity represented by this card. 591 An EmailAddress object has the following properties: 593 * @type: String (mandatory). Specifies the type of this object. 594 This MUST be EmailAddress. 596 * email: String (mandatory). The email address. This MUST be an 597 _addr-spec_ value as defined in Section 3.4.1 of [RFC5322]. 599 * contexts: Context[Boolean] (optional) The contexts in which to use 600 this email address. The value for each key in the object MUST be 601 true. 603 * pref: Preference (optional) The preference of this email address 604 in relation to other email addresses. 606 * label: String (optional). A label describing the value in more 607 detail. 609 2.3.2. phones 611 Type: Id[Phone] (optional). 613 The phone numbers to contact the entity represented by this card. A 614 Phone object has the following properties: 616 * @type: String (mandatory). Specifies the type of this object. 617 This MUST be Phone. 619 * phone: String (mandatory). The phone value, as either a URI or a 620 free-text phone number. Typical URI schemes are the [RFC3966] tel 621 or [RFC3261] sip schemes, but any URI scheme is allowed. 623 * features: String[Boolean] (optional). The set of contact features 624 that this phone number may be used for. The set is represented as 625 an object, with each key being a method type. The value for each 626 key in the object MUST be true. The method type MUST be either 627 one of the following values, registered in a future RFC, or a 628 vendor-specific value: 630 - voice The number is for calling by voice. 632 - fax The number is for sending faxes. 634 - pager The number is for a pager or beeper. 636 - text The number supports text messages (SMS). 638 - cell The number is for a cell phone. 640 - textphone The number is for a device for people with hearing or 641 speech difficulties. 643 - video The number supports video conferencing. 645 * contexts: Context[Boolean] (optional) The contexts in which to use 646 this number. The value for each key in the object MUST be true. 648 * pref: Preference (optional) The preference of this number in 649 relation to other numbers. 651 * label: String (optional). A label describing the value in more 652 detail. 654 2.3.3. online 656 Type: Id[Resource] (optional). 658 The online resources and services that are associated with the entity 659 represented by this card. A Resource object has the following 660 properties: 662 * @type: String (mandatory). Specifies the type of this object. 663 This MUST be Resource. 665 * resource: String (mandatory). The resource value, where the 666 allowed value form is defined by the the _type_ property. If the 667 value form is URI, then the property value MUST be a valid _URI_ 668 as defined in Section 3 of [RFC3986] and updates. In any case the 669 value MUST NOT be empty. 671 * type: String (optional). The type of the resource. Allowed 672 values are: 674 - audio The resource is a digital sound URI, such as a recording 675 of proper pronunciation of the name of this card. 677 - calendar The resource is a calendar URI associated with the 678 entity represented by this card. 680 - contact The resource is an alternative contact method URI to 681 contact the entity represented by this card. This typically is 682 a web contact form using the "https" URI scheme, but may be any 683 other. 685 - directory The resource is a directory service URI where the 686 entity represented by this card can be found in. This 687 typically is an organizational directory that also contains 688 associated entities, e.g. co-workers and management in a 689 company directory. 691 - directorySource The resource is a directory service entry URI 692 of the entity represented by this card. In contrast to the 693 "directory" type this resource only provides the means to 694 access directory information for this entity. 696 - freeBusy The resource is a free-busy calendaring URI for the 697 entity represented by this card. 699 - logo The resource is a graphic logo URI associated with the 700 entity represented by this card. 702 - publicKey The resorce is a cryptograhic public key or 703 certificate URI associated with the entity represented by this 704 card. 706 - uri The resource value is any URI, e.g. a website link. 708 - username The resource value is a username associated with the 709 entity represented by this card (e.g. for social media, or an 710 IM client). The _label_ property SHOULD be included to 711 identify what service this is for. For compatibility between 712 clients, this label SHOULD be the canonical service name, 713 including capitalisation. e.g. Twitter, Facebook, Skype, 714 GitHub, XMPP. The resource value may be any non-empty free 715 text. 717 * mediaType: String (optional). Used for URI resource values. 718 Provides the media type [RFC2046] of the resource identified by 719 the URI. 721 * contexts: Context[Boolean] (optional) The contexts in which to use 722 this resource. The value for each key in the object MUST be true. 724 * pref: Preference (optional) The preference of this resource in 725 relation to other resources. 727 * label: String (optional). A label describing the value in more 728 detail. 730 2.3.4. scheduling 732 Type: Id[Scheduling] (optional). 734 The methods by which the entity receives calendar scheduling 735 invitations and updates. A Scheduling object has the following 736 properties: 738 * @type: String (mandatory). Specifies the type of this object. 739 This MUST be Scheduling. 741 * sendTo: String[String] (mandatory). The keys in the property 742 value are the available methods for scheduling. The value is a 743 URI for the method specified in the key. This MUST be a valid 744 "sendTo" property value as specified in Section 4.4.6 of [RFC8984] 745 and updates. 747 * pref: Preference (optional) The preference of this scheduling 748 object in relation to other scheduling objects. 750 2.3.5. photos 752 Type: Id[File] (optional). 754 A map of photo ids to File objects that contain photographs or images 755 associated with this card. A typical use case is to include an 756 avatar for display along the contact name. 758 A File object has the following properties: 760 * @type: String (mandatory). Specifies the type of this object. 761 This MUST be File. 763 * href: String (mandatory). A URI where to fetch the data of this 764 file. 766 * mediaType: String (optional). The content-type of the file, if 767 known. 769 * size: UnsignedInt (optional). The size, in octets, of the file 770 when fully decoded (i.e., the number of octets in the file the 771 user would download), if known. 773 * pref: Preference (optional) The preference of this photo in 774 relation to other photos. 776 * label: String (optional). A label describing the value in more 777 detail. 779 2.3.6. preferredContactMethod 781 Type : String (optional) 783 Defines the preferred method to contact the holder of this card. The 784 value MUST be the property names: emails, phones, online. 786 2.3.7. preferredContactLanguages 788 Type : String[ContactLanguage[]] (optional) 790 Defines the preferred languages for contacting the entity associated 791 with this card. The keys in the object MUST be [RFC5646] language 792 tags. The values are a (possibly empty) list of contact language 793 preferences for this language. A valid ContactLanguage object MUST 794 have at least one of its properties set. 796 A ContactLanguage object has the following properties: 798 * @type: String (mandatory). Specifies the type of this object. 799 This MUST be ContactLanguage. 801 * context: Context (optional). Defines the context in which to use 802 this language. 804 * pref: Preference (optional). Defines the preference of this 805 language in relation to other languages of the same context. 807 Also see the definition of the VCARD LANG property (Section 6.4.4., 808 [RFC6350]). 810 2.4. Address and Location properties 812 2.4.1. addresses 814 Type: Id[Address] (optional). 816 A map of address ids to Address objects, containing physical 817 locations. An Address object has the following properties: 819 * @type: String (mandatory). Specifies the type of this object. 820 This MUST be Address. 822 * fullAddress: String (optional). The complete address, excluding 823 type and label. This property is mainly useful to represent 824 addresses of which the individual address components are unknown, 825 or to provide localized representations. 827 * street: StreetComponent[] (optional). The street address. The 828 concatenation of the component values, separated by whitespace, 829 SHOULD result in a valid street address for the address locale. 830 Doing so, implementations MAY ignore any separator components. 831 The StreetComponent object type is defined in the paragraph below. 833 * locality: String (optional). The city, town, village, post town, 834 or other locality within which the street address may be found. 836 * region: String (optional). The province, such as a state, county, 837 or canton within which the locality may be found. 839 * country: String (optional). The country name. 841 * postcode: String (optional). The postal code, post code, ZIP code 842 or other short code associated with the address by the relevant 843 country's postal system. 845 * countryCode: String (optional). The ISO-3166-1 country code. 847 * coordinates: String (optional) A [RFC5870] "geo:" URI for the 848 address. 850 * timeZone: String (optional) Identifies the time zone this address 851 is located in. This either MUST be a time zone name registered in 852 the IANA Time Zone Database (https://www.iana.org/time-zones), or 853 it MUST be a valid TimeZoneId as defined in [RFC8984]. For the 854 latter, a corresponding time zone MUST be defined in the timeZones 855 property. 857 * contexts: Context[Boolean] (optional). The contexts of the 858 address information. In addition to the common contexts, allowed 859 values are: 861 - billing An address to be used for billing. 863 - postal An address to be used for delivering physical items. 864 The value for each key in the object MUST be true. 866 * pref: Preference (optional) The preference of this address in 867 relation to other addresses. 869 * label: String (optional). A label describing the value in more 870 detail. 872 A StreetComponent object has the following properties: 874 * @type: String (mandatory). Specifies the type of this object. 875 This MUST be StreetComponent. 877 * type: String (mandatory). The type of this street component. The 878 value MUST be either one of the following values, registered in a 879 future RFC, or a vendor-specific value: 881 - name. The street name. 883 - number. The street number. 885 - apartment. The apartment number or identifier. 887 - room. The room number or identifier. 889 - extension. The extension designation or box number. 891 - direction. The cardinal direction, e.g. "North". 893 - building. The building or building part this address is 894 located in. 896 - floor. The floor this address is located on. 898 - postOfficeBox. The post office box number or identifier. 900 - separator. A separator for two street components. The value 901 property of the component includes the verbatim separator, for 902 example a newline character. 904 - unknown. A name component value for which no type is known. 906 * value: String (mandatory). The value of this street component. 908 2.5. Multilingual properties 910 2.5.1. localizations 912 Type: String[PatchObject] (optional). 914 A map of language tags [RFC5646] to patches, which localize a 915 property value into the locale of the respective language tag. The 916 paths in the PatchObject keys are relative to the Card object that 917 includes the localizations property. A patch MUST NOT target the 918 localizations property. 920 The following example shows a Card object, where one of its addresses 921 Tokyo is localized for the jp locale. 923 "@type": "Card", 924 ... 925 "addresses": { 926 "addr1": { 927 "@type": "Address", 928 "locality": "Tokyo", 929 } 930 }, 931 "localizations": { 932 "jp": { 933 "addresses/addr1/locality":"東京" 934 } 935 } 937 Figure 1 939 2.6. Additional properties 941 2.6.1. anniversaries 943 Type : Id[Anniversary] (optional). 945 These are memorable dates and events for the entity represented by 946 this card. An Anniversary object has the following properties: 948 * @type: String (mandatory). Specifies the type of this object. 949 This MUST be Anniversary. 951 * type: String (optional). Specifies the type of the anniversary. 952 This RFC predefines the following types, but implementations MAY 953 use additional values: 955 - birth: a birth day anniversary 957 - death: a death day anniversary 959 * date: String (mandatory). The date of this anniversary, in the 960 form "YYYY-MM-DD" (any part may be all 0s for unknown) or a 961 [RFC3339] timestamp. 963 * place: Address (optional). An address associated with this 964 anniversary, e.g. the place of birth or death. 966 * label: String (optional). A label describing the value in more 967 detail. 969 2.6.2. personalInfo 971 Type: Id[PersonalInformation] (optional). 973 Defines personal information about the entity represented by this 974 card. A PersonalInformation object has the following properties: 976 * @type: String (mandatory). Specifies the type of this object. 977 This MUST be PersonalInformation. 979 * type: String (mandatory). Specifies the type for this personal 980 information. Allowed values are: 982 - expertise: a field of expertise or credential 984 - hobby: a hobby 986 - interest: an interest 988 * value: String (mandatory). The actual information. This 989 generally is free-text, but future specifications MAY restrict 990 allowed values depending on the type of this PersonalInformation. 992 * level: String (optional) Indicates the level of expertise, or 993 engagement in hobby or interest. Allowed values are: high, medium 994 and low. 996 * label: String (optional). A label describing the value in more 997 detail. 999 2.6.3. notes 1001 Type: String (optional). 1003 Arbitrary notes about the entity represented by this card. 1005 2.6.4. categories 1007 Type: String[Boolean] (optional). The set of free-text or URI 1008 categories that relate to the card. The set is represented as an 1009 object, with each key being a category. The value for each key in 1010 the object MUST be true. 1012 2.6.5. timeZones 1014 Type: String[TimeZone] (optional). Maps identifiers of custom time 1015 zones to their time zone definitions. For a description of this 1016 property see the timeZones property definition in [RFC8984]. 1018 3. CardGroup 1020 MIME type: application/jscontact+json;type=cardgroup 1022 A CardGroup object represents a group of cards. Its members may be 1023 Cards or CardGroups. 1025 3.1. Group properties 1027 3.1.1. @type 1029 Type: String (mandatory). 1031 Specifies the type of this object. This MUST be CardGroup. 1033 3.1.2. uid 1035 Type: String (mandatory). The uid of this group. Both CardGroup and 1036 Card share the same namespace for the uid property. 1038 3.1.3. members 1040 Type: String[Boolean] (mandatory). The members of this group. 1042 The set is represented as an object, with each key being the uid of 1043 another Card or CardGroup. The value for each key in the object MUST 1044 be true. 1046 3.1.4. name 1048 Type: String (optional). The user-visible name for the group, e.g. 1049 "Friends". This may be any UTF-8 string of at least 1 character in 1050 length and maximum 255 octets in size. The same name may be used by 1051 two different groups. 1053 3.1.5. card 1055 Type: Card (optional). The card that represents this group. 1057 4. Implementation Status 1059 NOTE: Please remove this section and the reference to [RFC7942] prior 1060 to publication as an RFC. This section records the status of known 1061 implementations of the protocol defined by this specification at the 1062 time of posting of this Internet-Draft, and is based on a proposal 1063 described in [RFC7942]. The description of implementations in this 1064 section is intended to assist the IETF in its decision processes in 1065 progressing drafts to RFCs. Please note that the listing of any 1066 individual implementation here does not imply endorsement by the 1067 IETF. Furthermore, no effort has been spent to verify the 1068 information presented here that was supplied by IETF contributors. 1069 This is not intended as, and must not be construed to be, a catalog 1070 of available implementations or their features. Readers are advised 1071 to note that other implementations may exist. According to 1072 [RFC7942], "this will allow reviewers and working groups to assign 1073 due consideration to documents that have the benefit of running code, 1074 which may serve as evidence of valuable experimentation and feedback 1075 that have made the implemented protocols more mature. It is up to 1076 the individual working groups to use this information as they see 1077 fit". 1079 4.1. IIT-CNR/Registro.it 1080 * Responsible Organization: Institute of Informatics and Telematics 1081 of National Research Council (IIT-CNR)/Registro.it 1083 * Location: https://rdap.pubtest.nic.it/ 1084 (https://rdap.pubtest.nic.it/) 1086 * Description: This implementation includes support for RDAP queries 1087 using data from the public test environment of .it ccTLD. The 1088 RDAP server returns responses including Card in place of jCard 1089 when queries contain the parameter jscard=1. 1091 * Level of Maturity: This is an "alpha" test implementation. 1093 * Coverage: This implementation includes all of the features 1094 described in this specification. 1096 * Contact Information: Mario Loffredo, mario.loffredo@iit.cnr.it 1098 5. IANA Considerations 1100 TBD 1102 6. Security Considerations 1104 TBD 1106 7. References 1108 7.1. Normative References 1110 [RFC2046] Freed, N. and N. Borenstein, "Multipurpose Internet Mail 1111 Extensions (MIME) Part Two: Media Types", RFC 2046, 1112 DOI 10.17487/RFC2046, November 1996, 1113 . 1115 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1116 Requirement Levels", BCP 14, RFC 2119, 1117 DOI 10.17487/RFC2119, March 1997, 1118 . 1120 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 1121 Unique IDentifier (UUID) URN Namespace", RFC 4122, 1122 DOI 10.17487/RFC4122, July 2005, 1123 . 1125 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 1126 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 1127 September 2009, . 1129 [RFC5870] Mayrhofer, A. and C. Spanring, "A Uniform Resource 1130 Identifier for Geographic Locations ('geo' URI)", 1131 RFC 5870, DOI 10.17487/RFC5870, June 2010, 1132 . 1134 [RFC6350] Perreault, S., "vCard Format Specification", RFC 6350, 1135 DOI 10.17487/RFC6350, August 2011, 1136 . 1138 [RFC6351] Perreault, S., "xCard: vCard XML Representation", 1139 RFC 6351, DOI 10.17487/RFC6351, August 2011, 1140 . 1142 [RFC6901] Bryan, P., Ed., Zyp, K., and M. Nottingham, Ed., 1143 "JavaScript Object Notation (JSON) Pointer", RFC 6901, 1144 DOI 10.17487/RFC6901, April 2013, 1145 . 1147 [RFC7095] Kewisch, P., "jCard: The JSON Format for vCard", RFC 7095, 1148 DOI 10.17487/RFC7095, January 2014, 1149 . 1151 [RFC7493] Bray, T., Ed., "The I-JSON Message Format", RFC 7493, 1152 DOI 10.17487/RFC7493, March 2015, 1153 . 1155 [RFC7942] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1156 Code: The Implementation Status Section", BCP 205, 1157 RFC 7942, DOI 10.17487/RFC7942, July 2016, 1158 . 1160 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 1161 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 1162 May 2017, . 1164 [RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data 1165 Interchange Format", STD 90, RFC 8259, 1166 DOI 10.17487/RFC8259, December 2017, 1167 . 1169 [RFC8984] Jenkins, N. and R. Stepanek, "JSCalendar: A JSON 1170 Representation of Calendar Data", RFC 8984, 1171 DOI 10.17487/RFC8984, July 2021, 1172 . 1174 7.2. Informative References 1176 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, 1177 A., Peterson, J., Sparks, R., Handley, M., and E. 1178 Schooler, "SIP: Session Initiation Protocol", RFC 3261, 1179 DOI 10.17487/RFC3261, June 2002, 1180 . 1182 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 1183 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 1184 . 1186 [RFC3966] Schulzrinne, H., "The tel URI for Telephone Numbers", 1187 RFC 3966, DOI 10.17487/RFC3966, December 2004, 1188 . 1190 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 1191 Resource Identifier (URI): Generic Syntax", STD 66, 1192 RFC 3986, DOI 10.17487/RFC3986, January 2005, 1193 . 1195 [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data 1196 Encodings", RFC 4648, DOI 10.17487/RFC4648, October 2006, 1197 . 1199 [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322, 1200 DOI 10.17487/RFC5322, October 2008, 1201 . 1203 [RFC6473] Saint-Andre, P., "vCard KIND:application", RFC 6473, 1204 DOI 10.17487/RFC6473, December 2011, 1205 . 1207 [RFC6474] Li, K. and B. Leiba, "vCard Format Extensions: Place of 1208 Birth, Place and Date of Death", RFC 6474, 1209 DOI 10.17487/RFC6474, December 2011, 1210 . 1212 [RFC6715] Cauchie, D., Leiba, B., and K. Li, "vCard Format 1213 Extensions: Representing vCard Extensions Defined by the 1214 Open Mobile Alliance (OMA) Converged Address Book (CAB) 1215 Group", RFC 6715, DOI 10.17487/RFC6715, August 2012, 1216 . 1218 [RFC6869] Salgueiro, G., Clarke, J., and P. Saint-Andre, "vCard 1219 KIND:device", RFC 6869, DOI 10.17487/RFC6869, February 1220 2013, . 1222 [RFC8605] Hollenbeck, S. and R. Carney, "vCard Format Extensions: 1223 ICANN Extensions for the Registration Data Access Protocol 1224 (RDAP)", RFC 8605, DOI 10.17487/RFC8605, May 2019, 1225 . 1227 Authors' Addresses 1229 Robert Stepanek 1230 FastMail 1231 PO Box 234, Collins St West 1232 Melbourne VIC 8007 1233 Australia 1234 Email: rsto@fastmailteam.com 1236 Mario Loffredo 1237 IIT-CNR 1238 Via Moruzzi,1 1239 56124 Pisa 1240 Italy 1241 Email: mario.loffredo@iit.cnr.it