Retrieve properties for principal resources
Added by IBM contributorAnna G O'Neal | Edited by Claudia R Elbourn on June 26, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Retrieve a set of properties for principal resources of users based on their email addresses.

Table 1. API details

Method Resource address
PROPFIND PROPFIND /calendar/r/dav/calendar/<user_email>, where <user_email> is the email address of the user.

The following code provides a sample implementation of the API. For details about using the API in your own development environment, see the Internet Engineering Task Force (IETF) Request for Comments (RFC) resources at the end of this topic.

Sample request


PROPFIND https://mail-usw.lotuslive.com/calendar/r/dav/calendar/bgs_demo07%40try.lotuslive.com/ HTTP/1.1

Host: mail-usw.lotuslive.com

User-Agent: iOS/5.0.1 (9A405) dataaccessd/1.0

Content-Length: 1925

Accept: */*

Depth: 1

Accept-Encoding: gzip, deflate

Content-Type: text/xml

Accept-Language: en-us

Cookie: JSESSIONID=0C6BD47345FB1087BF1238ED02BFF5A2

Authorization: Basic <base64 encoding of user_email:password>

Connection: keep-alive

Proxy-Connection: keep-alive



<?xml version="1.0" encoding="UTF-8"?>

<A:propfind xmlns:A="DAV:">

<A:prop>

<A:add-member/>

<B:allow ed-sharing-modes xmlns:B="http://calendarserver.org/ns/"/>

<D:bulk-requests xmlns:D="http://me.com/_namespace/"/>

<E:calendar-color xmlns:E="http://apple.com/ns/ical/"/>

<C:calendar-description xmlns:C="urn:ietf:params:xml:ns:caldav"/>

<C:calendar-free-busy-set xmlns:C="urn:ietf:params:xml:ns:caldav"/>

<E:calendar-order xmlns:E="http://apple.com/ns/ical/"/>

<C:calendar-timezone xmlns:C="urn:ietf:params:xml:ns:caldav"/>

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

<A:displayname/>

<B:getctag xmlns:B="http://calendarserver.org/ns/"/>

<F:max-image-size xmlns:F="urn:ietf:params:xml:ns:carddav"/>

<F:max-resource-size xmlns:F="urn:ietf:params:xml:ns:carddav"/>

<B:me-card xmlns:B="http://calendarserver.org/ns/"/>

<A:ow ner/>

<B:publish-url xmlns:B="http://calendarserver.org/ns/"/>

<B:push-transports xmlns:B="http://calendarserver.org/ns/"/>

<B:pushkey xmlns:B="http://calendarserver.org/ns/"/>

<A:quota-available-bytes/>

<A:quota-used-bytes/>

<E:refreshrate xmlns:E="http://apple.com/ns/ical/"/>

<A:resource-id/>

<A:resourcetype/>

<C:schedule-calendar-transp xmlns:C="urn:ietf:params:xml:ns:caldav"/>

<C:schedule-default-calendar-URL xmlns:C="urn:ietf:params:xml:ns:caldav"/>

<B:source xmlns:B="http://calendarserver.org/ns/"/>

<B:subscribed-strip-alarms xmlns:B="http://calendarserver.org/ns/"/>

<B:subscribed-strip-attachments xmlns:B="http://calendarserver.org/ns/"/>

<B:subscribed-strip-todos xmlns:B="http://calendarserver.org/ns/"/>

<C:supported-calendar-component-set xmlns:C="urn:ietf:params:xml:ns:caldav"/>

<A:supported-report-set/>

<A:sync-token/>

<B:xmpp-server xmlns:B="http://calendarserver.org/ns/"/>

<B:xmpp-uri xmlns:B="http://calendarserver.org/ns/"/>

</A:prop>

</A:propfind>


Sample response


HTTP/1.1 207 Multi-Status

Server: nginx

Content-Type: application/xml;charset=utf-8

Cache-Control: private, max-age=0

Expires: Thu May 03 07:03:59 GMT 2012

DAV: 1, access-control, calendar-access, calendar-schedule, calendar-proxy, calendar-auto-schedule

Date: Thu, 03 May 2012 07:03:59 GMT

Content-Length: 9714

Connection: close

Set-Cookie: JSESSIONID=56D671529BCA69B2DE23B737A164B59E; Path=/calendar; Secure



<D:multistatus xmlns:CS="http://calendarserver.org/ns/" xmlns:C="urn:ietf:params:xml:ns:caldav" xmlns:D="DAV:">

<D:response>

<D:href>/calendar/r/dav/calendar/bgs_demo07@try.lotuslive.com/</D:href>

<D:propstat>

<D:prop>

<D:displayname>HOME</D:displayname>

<D:resourcetype>

<D:collection/>

</D:resourcetype>

<ns4:calendar-color xmlns:ns4="http://apple.com/ns/ical/"/>

<C:calendar-description xmlns:ns4="http://apple.com/ns/ical/"/>

<ns4:calendar-order xmlns:ns4="http://apple.com/ns/ical/"/>

<CS:getctag xmlns:ns4="http://apple.com/ns/ical/"/>

<D:ow ner xmlns:ns4="http://apple.com/ns/ical/">

<D:href>/calendar/r/dav/users/bgs_demo07@try.lotuslive.com/</D:href>

</D:ow ner>

<C:supported-calendar-component-set xmlns:ns4="http://apple.com/ns/ical/">

<C:comp name="VEVENT"/>

</C:supported-calendar-component-set>

<D:current-user-privilege-set xmlns:ns4="http://apple.com/ns/ical/">

<D:privilege>

<D:read/>

</D:privilege>

<D:privilege>

<D:read-acl/>

</D:privilege>

<D:privilege>

<D:read-current-user-privilege-set/>

</D:privilege>

<D:privilege>

<C:read-free-busy/>

</D:privilege>

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

</D:prop>

<D:status>HTTP/1.1 200 OK</D:status>

</D:propstat>

<D:propstat>

<D:prop>

<C:calendar-free-busy-set xmlns:ns4="http://apple.com/ns/ical/"/>

<A:add-member xmlns:A="DAV:"/>

<B:allow ed-sharing-modes xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<D:bulk-requests xmlns:A="DAV:" xmlns:D="http://me.com/_namespace/"/>

<C:calendar-timezone xmlns:A="DAV:"/>

<F:max-image-size xmlns:A="DAV:" xmlns:F="urn:ietf:params:xml:ns:carddav"/>

<F:max-resource-size xmlns:A="DAV:" xmlns:F="urn:ietf:params:xml:ns:carddav"/>

<B:me-card xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<B:publish-url xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<B:push-transports xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<B:pushkey xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<A:quota-available-bytes xmlns:A="DAV:"/>

<A:quota-used-bytes xmlns:A="DAV:"/>

<E:refreshrate xmlns:A="DAV:" xmlns:E="http://apple.com/ns/ical/"/>

<A:resource-id xmlns:A="DAV:"/>

<C:schedule-calendar-transp xmlns:A="DAV:"/>

<C:schedule-default-calendar-URL xmlns:A="DAV:"/>

<B:source xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<B:subscribed-strip-alarms xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<B:subscribed-strip-attachments xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<B:subscribed-strip-todos xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<A:sync-token xmlns:A="DAV:"/>

<B:xmpp-server xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<B:xmpp-uri xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

</D:prop>

<D:status>HTTP/1.1 404 Not Found</D:status>

</D:propstat>

</D:response>

<D:response>

<D:href>/calendar/r/dav/calendar/bgs_demo07@try.lotuslive.com/8a869f8e35dc722f01360a2b61244352/</D:href>

<D:propstat>

<D:prop>

<D:displayname>Demo User 7</D:displayname>

<D:resourcetype>

<D:collection/>

<C:calendar xmlns:ns4="http://apple.com/ns/ical/"/>

</D:resourcetype>

<ns4:calendar-color xmlns:ns4="http://apple.com/ns/ical/">#00BFFF</ns4:calendar-color>

<C:calendar-description xmlns:ns4="http://apple.com/ns/ical/">Demo User 7</C:calendar-description>

<ns4:calendar-order xmlns:ns4="http://apple.com/ns/ical/">1</ns4:calendar-order>

<CS:getctag xmlns:ns4="http://apple.com/ns/ical/">1331610476000</CS:getctag>

<D:ow ner xmlns:ns4="http://apple.com/ns/ical/">

<D:href>/calendar/r/dav/users/bgs_demo07@try.lotuslive.com/</D:href>

</D:ow ner>

<C:supported-calendar-component-set xmlns:ns4="http://apple.com/ns/ical/">

<C:comp name="VEVENT"/>

</C:supported-calendar-component-set>

<D:current-user-privilege-set xmlns:ns4="http://apple.com/ns/ical/">

<D:privilege>

<D:w rite/>

</D:privilege>

<D:privilege>

<D:w rite-acl/>

</D:privilege>

<D:privilege>

<D:w rite-properties/>

</D:privilege>

<D:privilege>

<D:w rite-content/>

</D:privilege>

<D:privilege>

<D:bind/>

</D:privilege>

<D:privilege>

<D:unbind/>

</D:privilege>

<D:privilege>

<D:read/>

</D:privilege>

<D:privilege>

<D:read-acl/>

</D:privilege>

<D:privilege>

<D:read-current-user-privilege-set/>

</D:privilege>

<D:privilege>

<C:read-free-busy/>

</D:privilege>

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

<D:supported-report-set xmlns:ns4="http://apple.com/ns/ical/">

<D:supported-report>

<D:report>

<D:acl-principal-prop-set/>

</D:report>

</D:supported-report>

<D:supported-report>

<D:report>

<D:principal-match/>

</D:report>

</D:supported-report>

<D:supported-report>

<D:report>

<D:principal-property-search/>

</D:report>

</D:supported-report>

<D:supported-report>

<D:report>

<C:calendar-query/>

</D:report>

</D:supported-report>

<D:supported-report>

<D:report>

<C:calendar-multiget/>

</D:report>

</D:supported-report>

<D:supported-report>

<D:report>

<D:principal-match/>

</D:report>

</D:supported-report>

</D:supported-report-set>

</D:prop>

<D:status>HTTP/1.1 200 OK</D:status>

</D:propstat>

<D:propstat>

<D:prop>

<C:calendar-free-busy-set xmlns:ns4="http://apple.com/ns/ical/"/>

<A:add-member xmlns:A="DAV:"/>

<B:allow ed-sharing-modes xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<D:bulk-requests xmlns:A="DAV:" xmlns:D="http://me.com/_namespace/"/>

<C:calendar-timezone xmlns:A="DAV:"/>

<F:max-image-size xmlns:A="DAV:" xmlns:F="urn:ietf:params:xml:ns:carddav"/>

<F:max-resource-size xmlns:A="DAV:" xmlns:F="urn:ietf:params:xml:ns:carddav"/>

<B:me-card xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<B:publish-url xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<B:push-transports xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<B:pushkey xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<A:quota-available-bytes xmlns:A="DAV:"/>

<A:quota-used-bytes xmlns:A="DAV:"/>

<E:refreshrate xmlns:A="DAV:" xmlns:E="http://apple.com/ns/ical/"/>

<A:resource-id xmlns:A="DAV:"/>

<C:schedule-calendar-transp xmlns:A="DAV:"/>

<C:schedule-default-calendar-URL xmlns:A="DAV:"/>

<B:source xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<B:subscribed-strip-alarms xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<B:subscribed-strip-attachments xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<B:subscribed-strip-todos xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<A:sync-token xmlns:A="DAV:"/>

<B:xmpp-server xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

<B:xmpp-uri xmlns:A="DAV:" xmlns:B="http://calendarserver.org/ns/"/>

</D:prop>

<D:status>HTTP/1.1 404 Not Found</D:status>

</D:propstat>

</D:response>

</D:multistatus>

 

Related Resources

Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol

Calendaring Extensions to WebDAV (CalDAV)