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.

warnings

EventWarnings for this event session (if any).

Queryable
message

The text of the warning.

Qualifiers
resolved
seen
type

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
 }

Assign Slots to Event Session

Adds event session to the Slots identified by slot_ids.

 POST /api/eventsession/xxx/assign-slots
Required Params
slot_ids

One or more id values identifying specific Slots.

All Slot ids must identify an existing Slot. Identified Slots must: not be already assigned; not be reserved; must all be in the same Space; all be on the same ConventionDay; and must all be in sequence. If any of these is not true, no Slot is assigned (the request is all-or-nothing).

Optional Param
reschedule

Can be 1 or 0. When set to 1, indicates to un-assign all currently assigned Slots from the Event Session, before assigning the ones identified in slot_ids.

full_session

Can be 1 or 0. When set to 1, indicates to use the single id in slot_ids as the starting slot and to assign Slots subsequent to that one in the same space to the event session until its duration is met. If you set this flag, you must pass only one id in slot_ids, or an error will occur.

Returns the same as a normal read.

Un-Assign Session (All) Slots from Event Session

This endpoint is DEPRECATED. Use "Un-Assign Slots from Event Session" instead.

Removes event session from all slots to which it is currently assigned.

 POST /api/eventsession/xxx/schedule-unassign

Returns the same as a normal read.

Un-Assign Slots from Event Session

Removes the event session from the Slots identified by request parameter.

 POST /api/eventsession/xxx/unassign-slots
Required Params

NOTE that these parameters are not BOTH required, but one is always required.

slot_ids

One or more id values identifying specific Slots. If any ids are received that are not assigned to the event session, an error will occur, and no Slots are unassigned.

scope

The scope parameter can be set to the value session, which indicates to unassign all Slots assigned to the event session. Pass this if you just want to unschedule the event session without worrying about Slot ids.

Returns the same as a normal read.