This is a view that unifies Events and EventSessions in a single set of results.
Events and EventSessions are stored in entirely different tables in the database, but share many different properties because Events was the original table, with EventSessions added later to allow for multi-session Events.
See "Object Properties" in Introduction for basic shared properties.
Complete details in EventSessionUnion Properties.
Within the context of this union view, objects and their properties are read-only. To edit the Event or EventSession objects, see their specific API documents.
Note, with regard to unique IDs:
The type of object represented by the record, in all lowercase.
In this result set, this will be only either event or eventsession.
The id for the specific object in question.
It is only unique within its object type.
See "Related Objects" in Introduction for how to use them.
The Convention this Event or Session belongs to.
The Room this Event or Session is scheduled in, if it is only one.
The Space this Event or Session is scheduled in, if it is only one.
The DayPart on which this Event or Session is scheduled to start.
The EventType for this Event, or this Session's Event.
See "Relationships" in Introduction for how to use them.
Note that the normal self relationship will be specific to the object type.
That is,
it will be:
Requesting specific Event Session Union records by ID, in the normal Wing way, under the union endpoints available, is not supported. (Review "Properties" above if unclear why.)
EventSessions in the returned results will have an Event relationship. Events, of course, will not.
See "Includes" in Introduction for how to use them.
There are currently no includes for this view.
The services used to fetch objects in this result set.
Note that only read only services are provided here.
To edit or manipulate one of the objects received in a request to one of these services,
use its self relationship (see "Relationships"),
and refer to the API document for the object in question (Event or EventSession).
This section describes basic searchability of Event-Session union, which is available across several endpoints.
To request events, a user must make a request via an endpoint for a parent object. The parent objects for which this consolidated search behavior is valid are:
Departures/differences from basic behavior will be discussed in the documentation for the specific parent object relationship.
Returns:
{
"paging" : {...},
"items" : [
{
"id" : "xxx",
"name" : "Super Event!",
...
},
...
]
}
Pass a string query to search for a partial match in specifically allowed text fields.
(Event name.)
(can be searched only by specifying field with query_field=room_name; see options below)
(can be searched only by specifying field with query_field=space_name; see options below)
(can be searched only by specifying field with query_field=startdaypart_name; see options below)
Use of query will search only in the text fields name and session_name by default. To search in a different field (see above), or in just one of the default fields, set query_field to the field you want to search in.
You can't edit, write, or manipulate an object through this View.
Specific objects cannot be requested by ID through this View. See "Properties".