EventSession

Extra sessions for an Event. Note that all Events track their first session themselves; you will only need to query Event Sessions for schedule information if an Event has more than one session.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in EventSessionProperties.

Related Objects

See "Related Objects" in Introduction for how to use them.

alternatedaypart

The alternate DayPart preferred for when the event session will start.

convention

The Convention to which the event session belongs.

event

The Event to which the session belongs.

preferreddaypart

The primary DayPart preferred for when the event session will start.

room

The Room where the event session will be held, if it will be in a single room.

space

The Space where the event session will be held, if it will be in a single space.

startdaypart

The DayPart when the event session will start.

Relationships

See "Relationships" in Introduction for how to use them.

dayparts

The DayParts to which the event session is scheduled.

rooms

The Rooms to which the event session is scheduled. This can be a single room if all scheduled Slots are for the same room.

slots

The Slots to which the event session is scheduled.

spaces

The Spaces to which the event session is scheduled. This can be a single space if all scheduled Slots are for the same space.

Includes

See "Includes" in Introduction for how to use them.

conventionday

A description of the ConventionDay on which the event session's starting schedule DayPart takes place.

end_date

Applies the session's event type's end buffer to its end_date. (Normally the end_date will be simply the session's starting time plus its duration.)

first_slot

A description of the event session's first scheduled slot (in time order), if any.

is_on_schedule

This adds two fields to the event session description, event_on_schedule and session_on_schedule. "On schedule" means the session has slots assigned to it. 1 means slots are assigned, 0 means no slots are assigned.

**Note that for Events, session_on_schedule will not be added.

multi_spaces

An array of the names of the spaces the event session is scheduled to. This will appear only if the event session is actually scheduled to multiple spaces. It will also add an array called multi_rooms, if the spaces are in separate rooms, containing the names of the spaces' rooms.

schedule_integrity

You must have the scheduling ConventionPrivilege to use this include. An analysis will be performed on this event session telling you what problems you might encounter. It will return a string of text-based warnings.

Services

The services used to fetch and manipulate event session options.

Search Event Sessions

The Event Session API does not support a general, cross-convention search endpoint.

Create Event Session

Note that Event Sessions for an event cannot duplicate alternate or preferred or starting DayParts. An Event Session cannot be before its Event's session.

 POST /api/eventsession

Required Params

session_id

alternatedaypart_id

convention_id

event_id

preferreddaypart_id

session_name

Returns the same as a normal read.

Read Event Session

 GET /api/eventsession/xxx

Returns:

 {
   "id" : "xxx",
   "session_name" : "Second Session",
   ...
 }

Update Event Session

The Event Session API does not support an update (PUT) action. To "edit" an event session, delete the wrong session and replace it with a new correct one.

Delete Event Session

 DELETE /api/eventsession/xxx

Returns:

 {
   "success" : 1
 }

Un-Assign Slots from Event Session

Removes event session from the slots to which it is currently scheduled.

 POST /api/eventsession/xxx/schedule-unassign

Returns the same as a normal read.