vCard representation of resources

This specification defines the vCard representation of resources to ease their discovery by clients.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in .

Data values MUST have valid representation for the specified value type with respect to escape characters, line folding, and so on.

A resource object definition SHOULD contain all information required to find the right resource. For this, it SHOULD contain all, or a set of properties described in . Additional proprietary properties may be defined as well, but MUST begin with "X-". Clients encountering properties they don't know about MUST ignore them. Properties required to contact the resource are not included in this specification. vCard properties defined in vCard Format Specification can be used to include additional contact information for the resource.

The following properties MUST be specified in a vCard representing a resource: FN UID KIND

Some of the possible values for the KIND property are "Location", "Individual", "Device", or "Group". Location is used for any physical location resource such as room, building, etc. Individual is used for a human resource such as driver, technician, etc. Device is used for a computing device such as an appliance, a computer, or a network element. Group is used to specify a group of resources with a specific skill set. For example: drivers, electricians, etc.

The following properties defined in or make sense for vCards representing resources (this list is not exhaustive, and other properties might be applicable as well): ADR CALADRURI CATEGORIES EMAIL FBURL FN KIND MEMBER NOTE NICKNAME ORG PHOTO RELATED TZ UID

A schedulable resource MUST contain the OBJECTCLASS property with the value schedulable as described in . It SHOULD also contain the following properties defined in for a schedulable entity. AUTOSCHEDULE BOOKINGINFO BOOKINGRESTRICTED BOOKINGWINDOWSTART BOOKINGWINDOWEND MAXINSTNCES MULTIBOOK

Format and cardinality of new vCard properties are defined as described in Section 3.3 of .

Specify if the resource is accessible to physically disabled people. Boolean value. *1

ACCESSIBLE-param = "VALUE=boolean" / any-param ACCESSIBLE-value = boolean FALSE. TRUE

Specify special resource accessibility info for the physically disabled people. URI value. It MAY also be a free-form text value. *

ACCESSIBILITYINFO-param = "VALUE=" ("text" / "uri") / any-param ACCESSIBILITYINFO-value = URI / text None http://www.example.com/room1_specialaccess.html

Provide information on the capacity of the resource. Integer. *1

CAPACITY-param = "VALUE=integer" / any-param CAPACITY-value = integer None 10

List other resources available as part of this resource. Value MAY be a URI that could be a vCard. The vCard could be of the KIND group whose members point to the various inventory items. Value MAY also be a free form text listing one or more inventory items. *

INVENTORY-param = "VALUE=" ("text" / "uri") / any-param INVENTORY-value = uri / text None Printer, Projector http://www.example.com/Room1Inventory.vcf

Provide more information on the type of a LOCATION resource. Text. The value SHOULD be one of the values defined in *

LOCATIONTYPE-param = "VALUE=text" / any-param LOCATIONTYPE-value = text None office

Specify if there are restrictions to physically accessing the resource. For example locked doors, or other barriers. Boolean value. *1

RESTRICTED-param = "VALUE=boolean" / any-param RESTRICTED-value = boolean FALSE. Absence of this property indicates no restriction to physically accessing the resource. TRUE

Specify extra information on physically accessing resources that have restrictions. For example where to pick up keys to a locked resource. URI value. It MAY also be a free-form text value. *

RESTRICTEDACCESSINFO-param = "VALUE=" ("text" / "uri") / any-param RESTRICTEDACCESSINFO-value = URI / text None http://www.example.com/room1_entryinfo.html

Specify if there is a cost associated with using the resource. Boolean value. *1

NOCOST-param = "VALUE=boolean" / any-param NOCOST-value = boolean If this property is absent, it indicates that the resource may be booked free of cost. TRUE TRUE

Provide the URL pointing to complete pricing information for usage of the resource. URI value. It MAY also be a free-form text value. *

COSTINFO-param = "VALUE=" ("text" / "uri") / any-param COSTINFO-value = uri / text None http://www.example.com/cost.html

This document specifies the following additional values that can be used as the value for the TYPE parameter of the RELATED property defined in Section 6.6.6 of . container: an entity that contains the entity associated with this vCard. For example, the building that contains the room resource specified by the vCard. manager: an entity that manages the resource entity associated with this vCard. owner: an entity that owns the resource entity associated with this vCard.

In this example we make use of OBJECTCLASS:schedulable to make this a schedulable resource. BEGIN:VCARD VERSION:4.0 UID:urn:uuid:room1-id KIND: location LOCATIONTYPE: classroom FN: Room One ORG: Engineering NICKNAME: The One NOTE: Room 1 in Engineering Building X CATEGORIES: rooms, engineering_resources OBJECTCLASS: schedulable BOOKINGRESTRICTED: TRUE BOOKINGINFO: http://www.example.com/room1_booking.html CALADRURI: mailto:room1@example.com MULTIBOOK: 1 MAXINSTANCES: 10 BOOKINGWINDOWSTART:P3M BOOKINGWINDOWEND: P3D AUTOSCHEDULE: AUTO RELATED;TYPE=schedule-admin: http://www.example.com/SchedAdmin1.vcf ACCESSIBLE: TRUE ACCESSIBILITYINFO: http://www.example.com/room1_disabledaccess.html CAPACITY: 100 INVENTORY: phone, projector FBURL: http://www.example.com/freebusy/home/Room1/ TZ: America/Los_Angeles RELATED;TYPE=owner: http://www.example.com/ResOwner1.vcf RELATED;TYPE=manager: http://www.example.com/ResManager1.vcf RELATED;TYPE=container:http://www.example.com/BldX.vcf RESTRICTED: TRUE RESTRICTEDACCESSINFO: http://www.example.com/room1_specialaccess.html NOCOST: FALSE COSTINFO: http://www.example.com/cost.html END:VCARD

This example also makes use of OBJECTCLASS:schedulable to make this a schedulable resource. BEGIN:VCARD VERSION:4.0 UID:urn:uuid:driverXPool-id KIND: group FN: Driver X Pool ORG: Transportation NICKNAME: The X Group NOTE: Drivers in the Transportation department driver pool X CATEGORIES: drivers MEMBER:urn:uuid:driver1-id MEMBER:urn:uuid:driver2-id MEMBER:urn:uuid:driver3-id FBURL: http://www.example.com/freebusy/home/DriversX/ OBJECTCLASS: schedulable CALADRURI: mailto:driversX@example.com MULTIBOOK: 3 MAXINSTANCES: 10 BOOKINGWINDOWSTART:P3M BOOKINGWINDOWEND: P3D AUTOSCHEDULE: NONE RELATED;TYPE=schedule-admin: http://www.example.com/DriversX_SchedAdmin.vcf TZ: America/Los_Angeles BOOKINGINFO: http://www.example.com/driversX_approval.html RELATED;TYPE=manager: http://www.example.com/DriversManager.vcf NOCOST: FALSE COSTINFO: http://www.example.com/driversXcost.html END:VCARD

As this document only defines schema for representing resource information for calendaring and scheduling and does not refer to the actual storage mechanism itself, or the calendaring and scheduling protocol, no special security considerations are required as part of this document.

The following new VCard Properties need to be registered by IANA. New VCard Properties Table: VCard Property Name VCard Property Definition ACCESSIBLE ACCESSIBILITYINFO CAPACITY COSTINFO INVENTORY LOCATIONTYPE NOCOST RESTRICTED RESTRICTEDACCESSINFO The following new VCard Parameter Values need to be registered by IANA. New VCard Properties Table: VCard Property Name VCard Parameter Name VCard Parameter Value RELATED TYPE container RELATED TYPE manager RELATED TYPE owner

This specification is a result of discussions that took place within the Calendaring and Scheduling Consortium's Resource Technical Committee. The authors thank the participants of that group, and specifically the following individuals for contributing their ideas and support: Arnaud Quillaud, Adam Lewenberg, Andrew Laurence, Guy Stalnaker, Mimi Mugler, Dave Thewlis, Bernard Desruisseaux, Alain Petit, Andrew Sciberras, Adrian Apthorp, and Jason Miller.