Event Warning

Event schedule warnings. An Event Warning is always attached to a specific event session; either the main session for the Event or an actual EventSession. You must have the scheduling ConventionPrivilege to access this.

Properties

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

Complete details in EventWarningProperties.

Related Objects

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

convention

The Convention this event warning belongs to.

event

The Event this event warning belongs to.

eventsession

The EventSession this event warning belongs to.

Relationships

Event Warnings have no child relationships.

Includes

Event Warnings have no descriptor includes.

Services

The services used to fetch and manipulate event warnings.

Search Event Warnings

Available Endpoints

To request events, a user must make a request via an endpoint for a parent object. Currently these are:

Convention
Event
EventSession

Departures/differences from basic behavior will be discussed in the documentation for the specific parent=>eventwarning relationship.

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "message" : "You've been warned!",
          ...
        },
        ...
    ]
 }

Optional Params

Queryables

Pass a string query to search for a partial match in specifically allowed text fields.

Queryable fields

message: The text of the warning.

Valid types are:

start_misaligned: The start time in the Event or EventSession does not match that of its first DayPart.
unscheduled_has_slots: Not marked scheduled, but has assigned slots.
scheduled_no_slots: Marked scheduled, but has no assigned slots.
host_double_booked
special_request_missing: Special request not met.
start_not_preferred: Start daypart doesn't match preferred or alternate daypart.
multiple_days: Spans multiple days.
spaces_dont_match_needed: Spaces used doesn't match spaces needed.
slots_noncontiguous: Time slots are non-contiguous.
slots_vs_duration: Time slots don't match event duration.

Create Event Warning

The Event Warning API does not support a discrete endpoint for event warning creation. Event Warnings are created automatically whenever there is a conflict in the schedule of an Event or EventSession.

Read Event Warning

 GET /api/eventwarning/xxx

Returns:

 {
   "id" : "xxx",
   "event_id" : "xxx",
   "type" : "host_double_booked",
   ...
 }

Update Event Warning

The Event Warning API does not support a discrete endpoint for general-purpose editing. Event Warnings are resolved automatically when a conflict in the schedule of an Event or EventSession is resolved.

Delete Event Warning

Deletes the specified warning. Only resolved warnings may be deleted. See also "Delete Resolved Event Warnings" in Event.

 DELETE /api/eventwarning/xxx

Returns:

 {
   "success" : 1
 }

Hide Event Warning

This will set the event warning as seen. A warning marked as seen (or hidden) will not appear by default on the Events scheduling index page. Some types of warnings, such as "host double booked", can't be hidden.

 POST /api/eventwarning/xxx/hide

Returns same as a normal read.

Un-Hide Event Warning

This will un-set the event warning as seen.

 POST /api/eventwarning/xxx/unhide

Returns same as a normal read.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 174:: You forgot a '=back' before '=head3'

Developer Documentation

Introduction