Quick Reliable Conferencing

Conference

Add a new conference

Request:

POST /users/{user_id}/conferences
Accept: application/xml
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<conference>
  <name>{name}</name>
  <scheduled-to-start-at type="datetime">{scheduled_to_start_at}</scheduled-to-start-at>
</conference>

Below is a description of these elements:

scheduled-to-start-at

The time the conference should start at. Can be in many different forms, below are some examples:

Relative Times

• now
• thursday
• november
• friday 13:00
• mon 2:35
• 4pm
• 6 in the morning
• friday 1pm
• sat 7 in the evening
• today
• tomorrow
• this tuesday
• next month
• this morning
• this second
• tomorrow at 6:45pm

Complex Times

• 7 days from now
• 1 week hence
• in 3 hours
• 7 hours before tomorrow at noon
• 3rd wednesday in november
• 3rd month next year
• 3rd thursday this september
• 4th day last week

Specific Dates

• January 5
• dec 25
• may 27th
• October 2006
• oct 06
• jan 3 2010
• 3 jan 2000
• 17 april 85
• 5/27/1979
• 27/5/1979
• 05/06
• 1979-05-27
• Friday

Specific Times

• 5
• 4:00
• 17:00
• 0800
• January 5 at 7pm
• 1979-05-27 05:00

Response:

201 Created
Content-Type: application/xml
Location: /users/{user_id}/conferences/{conference_id}

<?xml version="1.0" encoding="UTF-8"?>
<conference>
  <id type="integer">{conference_id}</id>
  <created-at type="datetime">{created_at}</created-at>
  <updated-at type="datetime">{updated_at}</updated-at>
  <lock-version type="integer">{lock_version}</lock-version>
  <state>{state}</state>
  <name>{name}</name>
  <scheduled-to-start-at type="datetime">{scheduled_to_start_at}</scheduled-to-start-at>
  <started-at type="datetime">{started_at}</started-at>
  <ended-at type="datetime">{ended_at}</ended-at>
</conference>

Example:

curl \
  -u username:password \
  -H 'Accept: application/xml' \
  -H 'Content-Type: application/xml' \
  -d '<?xml version="1.0" encoding="UTF-8"?>
      <conference>
        <name>Development Team Meeting</name>
        <scheduled-to-start-at type="datetime">2007-08-24T20:19:34Z</scheduled-to-start-at>
      </conference>' \
  -X POST \
  http://lypp.com/users/1/conferences

List all conferences

Request:

GET /users/{user_id}/conferences
Accept: application/xml

Response:

200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<conferences type="array">
  <conference>
      <id type="integer">{conference_id}</id>
      <created-at type="datetime">{created_at}</created-at>
      <updated-at type="datetime">{updated_at}</updated-at>
      <lock-version type="integer">{lock_version}</lock-version>
      <state>{state}</state>
      <name>{name}</name>
      <scheduled-to-start-at type="datetime">{scheduled_to_start_at}</scheduled-to-start-at>
      <started-at type="datetime">{started_at}</started-at>
      <ended-at type="datetime">{ended_at}</ended-at>
  </conference>
  ...
</conferences>

Example:

curl \
  -u username:password \
  -H 'Accept: application/xml' \
  http://lypp.com/users/1/conferences

Show a conference

Request:

GET /users/{user_id}/conferences/{conference_id}
Accept: application/xml

Response:

200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<conference>
  <id type="integer">{conference_id}</id>
  <created-at type="datetime">{created_at}</created-at>
  <updated-at type="datetime">{updated_at}</updated-at>
  <lock-version type="integer">{lock_version}</lock-version>
  <state>{state}</state>
  <name>{name}</name>
  <scheduled-to-start-at type="datetime">{scheduled_to_start_at}</scheduled-to-start-at>
  <started-at type="datetime">{started_at}</started-at>
  <ended-at type="datetime">{ended_at}</ended-at>
</conference>

Example:

curl \
  -u username:password \
  -H 'Accept: application/xml' \
  http://lypp.com/users/1/conferences/226

Update a conference

Request:

PUT /users/{user_id}/conferences/{conference_id}
Accept: application/xml
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<conference>
  <name>{name}</name>
  <scheduled-to-start-at type="datetime">{scheduled_to_start_at}</scheduled-to-start-at>
</conference>

*NOTE: Status can be changed from new to pending when all attendees have been added, but no other values.

Response:

200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<conference>
  <id type="integer">{conference_id}</id>
  <created-at type="datetime">{created_at}</created-at>
  <updated-at type="datetime">{updated_at}</updated-at>
  <lock-version type="integer">{lock_version}</lock-version>
  <state>{state}</state>
  <name>{name}</name>
  <scheduled-to-start-at type="datetime">{scheduled_to_start_at}</scheduled-to-start-at>
  <started-at type="datetime">{started_at}</started-at>
  <ended-at type="datetime">{ended_at}</ended-at>
</conference>

Example:

curl \
  -u username:password \
  -H 'Accept: application/xml' \
  -H 'Content-Type: application/xml' \
  -d '<?xml version="1.0" encoding="UTF-8"?>
      <conference>
        <name>Marketing Meeting</name>
        <scheduled-to-start-at type="datetime">2007-08-25T20:19:34Z</scheduled-to-start-at>
      </conference>' \
  -X PUT \
  http://lypp.com/users/1/conferences/226

Delete a conference

Request:

DELETE /users/{user_id}/conferences/{conference_id}
Accept: application/xml

Response:

204 No Content

Example:

curl \
  -u username:password \
  -H 'Accept: application/xml' \
  -X DELETE \
  http://lypp.com/users/1/conferences/226