Client Request Formats (Sun Java System Calendar Server 6 2005Q4 Developer's Guide)

Sun Java System Calendar Server 6 2005Q4 Developer's Guide

Client Request Formats

Clients submit command requests to the Calendar Server in either Universal Resource Identifier (URI) data format, or with one of three HTML forms.

Command Format	Description
URI	Requests from client submitted using standard URI syntax.
HTML Form - `urlencoded`	Requests from client submitted as encoded URL's.
HTML Form - `text/xml`	Requests from client submitted using objects formatted as XML.
HTML Form - `text/calendar`	Requests from client submitted using objects formatted as iCalendar.

URI Format

Use the following format to submit a URI request:

http://webcalendarserver/COMMAND?PARAM=VAL&PARAM=VAL...

Multiple items are delimited by semicolons. If a string contains a semicolon character, replace the semicolon with its quoted-printable equivalent, %3B. For example, to represent the string “gh;i” in a list of ID's, use the following:

http://webcalendarserver/fetchcomponents_by_range.wcap?
               uid=abc;def;gh%3bi;jkl

HTML Form

Submit a form with method=[GET|POST] and action=command (where command is the command to execute). Parameters need to be formatted as specified in the encoding.

Note –

The maximum length for WCAP parameters is 1024 characters.

Client Side Event Notification

All client side JavaScript code in the parent frame of the response page is required to implement a method called CalcommandCallback(), where command is the name of the command requested. This callback is invoked when the HTML response has completed loading.

When used with HTTP GET, commands are for data retrieval.

When used with HTTP POST, commands are for data modifications, including creation or deletion.