Next: 1.2.3.1 <StartDateTime>
Up: 1.2 Basic Event Structure
Previous: 1.2.2 <Schedule>
Contents
Index
1.2.3 <Performance>
A <Performance> represents a single period when the event is happening.
This will normally be a conventional performance, but if the event
has a <DropInEvent> element (), then the performance
will represent a single uninterrupted period of opening time.
The <Venue(Reference)>, <Tickets> and <PerformanceDuration> for this
<Performance> will be the values defined in the containing <Event>
unless they are overriden in the containing <Schedule> or are defined
explicitly in the <Performance> itself.
May Contain
- <Title>
- , optional. This provides a way to assign
a public title to a <Performance> which may be useful if it is sufficiently
different from the other performances to require highlighting in some
way.
- choice
- one of the following may be optionally defined. If so
then it will override any location definitions in either the containing
<Schedule> or the containing <Event>.
- <Venue>
-
- <VenueReference>
-
- <PerformanceSpaceReference>
-
- <Tickets>
-
- <PerformanceDuration>
-
- <PerformanceDescriptions>
- , optional
and repeatable. This will define any descriptions that only apply
to this performance. It will replace the contents, if defined, of
the <PerformanceDescriptions> contained in the enclosing <Schedule>
or <Event>.
- <PerformanceLinks>
- , optional and repeatable.
This will define any links that only apply to this performance. It
will replace the contents, if defined, of the <PerformanceLinks> contained
in the enclosing <Schedule> or <Event>.
- <PerformanceProperties>
- , optional
and repeatable. This will defined any properties that only apply to
this performance. It will replace the contents, if defined, of the
<PerformanceProperties> contained in the enclosing <Schedule> or <Event>.
- choice
-
- <StartDateTime>
-
- <StartDate>
-
- <StartUndefined>
-
- <FormattedStart>
- optional. A plain text description of the start
information for this performance. This may contain human readable
information that is not immediately machine parseable but which is
still valuable to include in the <Performance>. Suppliers should not
assume that Consumers can or will be able to extract any structured
information from this field and it is provided for human consumption
only.
It is worth noting that there are no conventional <Description(Reference)>,
<Link(Reference)> or <Property> elements within a <Performance>. This
is intentional as their role is fulfilled by the <PerformanceDescriptions>,
<PerformanceLinks> and <PerformanceProperties> elements thereby making
the overriding of the parent definitions (if any) explicit in the
naming of the elements.
Attributes
- rescheduledFrom
- optional. XML Schema datetime. If this performance
was previously scheduled and / or advertised to begin at a different
time, then this should contain the old time at which it was supposed
to begin. This attribute may also be used in conjunction with the
previousVID on <Venue> ()
- isCancelled
- optional, boolean. If defined and if true then it
means that this perormance is no longer going to take place. While
it may seem counterintuitive to advertise a performance that is no
longer going to happen, it may be invaluable to let Consumers know
about the change of status for a performance so previously supplied
information can be accurately updated.
- isSoldOut
- optional, boolean. If defined and true then it means
that as far as the Supplier is aware, there are no more tickets available
for this performance.
- supplierSpecificId
- optional, (see ).
If a Supplier is updating previously sent information with new times
or cancellations, then it is probably safest to provide the same supplierSpecificId
for both the original and the updated information as this reduces
the chances of the Consumer targetting the wrong performance for the
update. If this is not provided, then the startTime for the performance
may be used to determine performances, but this is not guaranteed
to be unambiguous or usable especially if the information update is
providing a more accurate model of the timing of the performance.
- notForPublicationBefore
- optional, XML datetime.
- label
-
May Contain
- choice
- a <Performance> may optionally define one of the following
location definitions. This permits the location of an event to be
set on a performance by performance basis. If the performance does
not opt to define a location then it should use the location defined
in the containing <Schedule>, if any, otherwise the location defined
in the containing <Event>.
- <Venue>
-
- <VenueReference>
-
- <PerformanceSpaceReference>
-
- <Tickets>
- optional. If not defined, then the <Tickets> from the
containing schedule should be utilised. If this is not defined then
the <Tickets> from the containing <Event> should be utilised. If this
is not defined then there is no ticketing information for the <Performance>.
- <PerformanceDuration>
- optional. If not defined then the duration
should set by the <PerformanceDuration> on the containing <Schedule>
or, failing that, the <PerformanceDuration> on the containing <Event>.
If none of these are specified then the duration is also unspecified.
- choice
- each <Performance> should have its start time specified
with the highest degree of accuracy available. IVES permits a number
of differing levels of accuracy, but the ability for Consumers to
be able to sort and filter performances will be greatly limited if
Consumers don't provide the most accurate timing information available.
- <StartDateTime>
-
The date and time at which this performance begins.
- <StartDate>
- The date
when the performance will take place.
- <StartUndefined>
-
A ``clearly undefined'' performance start.
- <FormattedStart>
- optional, unformatted text. This provides Suppliers
with the ability to provide a humanly readable description of structured
information contained within <StartDateTime> / <StartDate> / <StartUndefined>.
Suppliers should still utilise the most accurate structured description
of the start of the event at their disposal but they may choose to
supplement it with further information in the <FormattedStart> element.
However, Suppliers should not assume that Consumers will always display
the FormattedStart element as they might choose to do their own formatted
version directly from the structured data instead thereby getting
consistency of formatting between data from different Suppliers.
- <Description>
- , optional and repeatable
- <Link>
- , optional and repeatable
- <Property>
- , optional and repeatable
Contained Within
- <Schedule>
- , compulsory and repeatable
Subsections
Next: 1.2.3.1 <StartDateTime>
Up: 1.2 Basic Event Structure
Previous: 1.2.2 <Schedule>
Contents
Index
Alex Fiennes
2010-04-13