CardDAV API
Added by IBM contributorAnna G O'Neal | Edited by Claudia R Elbourn on June 9, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

IBM Connections Web Mail Cloud supports the vCard Extensions to WebDAV (CardDAV) standard for synchronizing iNotes contacts with different systems and devices such as the iPhone and iPad.

Note: The CardDAV API requires Basic HTTP Authentication for authenticating with the CalDAV client. A 401 error code is returned for unauthorized requests.

Supported vCard data field include:

N;<Last Name>;<first Name>;<middle Name>;

EMAIL

TEL

TITLE:

ORG:<company>;<department>

ADR;TYPE=<TYPE>;TYPE=PREF:;;<Street>;<City>;<State>;<Postal Code>;<Country>

NOTE

ORG:<company>;<department>


Mapping iNotes and iOS fields


Types other than those described in the following tables and custom defined types cannot be synchronized and are removed.

Table 1. Mapping iNotes and iPhone contact type fields

.iOS contact type fields
iNotes contact type fields
First
First Name
Last
Last Name
Job Title
Job Title
Department
Department
Company
Company
Phone
Phone x 5
Email
E-mail x 3
Address
Address x 2
Notes
Notes

 


Table 2. Mapping iNotes and iPhone email type fields

iOS email type fields
iNotes email type fields
Home
Home
Work
Work
Other
<removed>

 


Table 3. Mapping iNotes and iPhone address type fields

iOS address type fields
iNotes address type fields
Home
Home
Work
Work
Other
<removed>

 


Table 4. Mapping iNotes and iPhone phone type fields

iOS phone type fields
iNotes phone type fields
Mobile
Mobile
Work fax
Work
Home fax
Home
Home
Home
Work
Work
Main
Work
Iphone
Work
Pager
Pager
Other
<removed>

 


Conventions


The following conventions are used when making CardDAV API calls:

{username}

 

The unique name of the user.

{contactid}

The unique identifier of the contact.

Supported CardDAV and WebDAV methods


The following methods are supported:

 

  • REPORT
  • GET
  • DELETE
  • PROPFIND
  • OPTIONS
  • PUT
     

Supported CardDAV and WebDAV properties


The following properties are supported:

<A:getetag/>

<C:getctag/>

<B:address-data/>

<B:addressbook-multiget/>

<A:propfind/>

<A:prop/>

<A:current-user-principal/>

<A:principal-URL/>

<A:resourcetype/>

<A:current-user-privilege-set/>

<A:displayname/>

<A:owner/>

 

Related Specifications