The Credits element contains Person and Organisation elements that
represent entities that you wish to publically assign credit to for this Event. This
is to be distinguished from the Contacts element which contains people that are
expecting to be contacted - while you can provide contact information inside the
Credits, it is not required.
ISO 3166 Country Code
ISO 4217 Currency Code
Optional attribute that can contain a
string describing how any data contained within CDATA
inside the Plain tag should be interpretted. This is
very Supplier specific and is intended to permit people
to send structured markup of a format not supported by
IVES directly.
Including a DropInEvent tag element signifies that the Event does not
have discrete Performances at specific times, but is instead open for visitors to
arrive and leave at any point during opening hours. In this case the
Performance.startTime becomes the time that the Venue is open for visitors and the
PerformanceDuration is how long the Venue is open for on that
day.
If you know how long your would expect people to spend attending
your DropInEvent then you should include this in the expectedVisitDuration
attribute
The emailType is a restricted text type that enforces compliance with
RFC 2822 and which can be used to hold any valid email.
This attribute should be used if Event is not to be published
before a given time. Please note that the information may be re-syndicated in
IVES with the attribute preserved to other Consumers before this
time.
A Group represents a collection an entity other than a Person that
can be on the list of Credits for an Event. The Group may optionally contain further
Person elements if you want to detail the individuals that make up the Group.
A Group represents a collection an entity other than a Person that
can be on the list of Credits for an Event. The Group may optionally contain further
Person elements if you want to detail the individuals that make up the Group.
Optional attribute that represents the time at which the
IvesMessage was generated. If an IvesMessage is passed on from party to party
without change then this attribute can be preserved, but if any changes are made
then the generationTime should be updated to the time when the changes were
applied.
The URL of the resource that this Link represents. This should be
publically resolveable and ideally persistent so that the useful lifespan of the
data is as long as possible.
The linkType defines what the fundamental purpose of the link is.
If not specified, then it is assumed to be a "moreinfo"
link.
Optional date when the asset being pointed at by this URL was
created on. This is particularly relevant to images, videos and
recordings.
Optional mime type of the asset being pointed to by the URL. It
is useful if this is defined, especially in the case of media URLs, because then
clients will only resolve URLs that they know they can use.
If your URL points an an asset that has a width in pixels (ie an
image or a video) then you should define the width in this
attribute.
If your URL points an an asset that has a height in pixels (ie an
image or a video) then you should define the height in this
attribute.
If your URL points at an asset that lasts for a fixed amount of
time (eg an audio clip or a video) then you can include the duration in this
attribute.
If your URL is pointing at a single downloadable object (eg
image, video, audio file etc etc) then you can include the size in bytes in this
attribute.
If your URL is pointing at a resource that may not be embeded in
the result generated by the Consumer, then this attribute should be set to false
which implies that any Consumer may only link to the URL as opposed to
downloading and re-using the target of the URL. This will default to true if not
defined thereby permitting Consumers to utilise the URL how they wish.
A URL with a role of "moreInfo" should provide further
information about the Event that doesn't fall into any of the other
categories of role.
A URL with a role of "booking" should point at a page where
tickets that may be used to gain access to the enclosing Event may be
purchased. If you are using the URL on a more specifc element such as a
Performance then the URL should be more specific in the type of ticket that
it lets you purchase.
A URL with a role of "review" should point at a 3rd party
page containing a review, preview or other form of opinion on the containing
Event.
A URL with a role of "media" should point directly at a
multi-media asset (not a page containing the asset) that has some connection
with the containing event. If you are using media URLs then it is advisable
(although not compulsory) to define other attributes on the URL as
appropriate, namely mimeType, width, height, duration and
filesize.
The performanceDuration should represent the time that each of
the performance elements contained within lasts. If the performances last
differing amounts of time then you should list them separately in their own
Extension elements
The StartDateTime is the time at which you want people to
arrive for the Performance. If your Event is a DropInEvent then the
startTime should be the opening time of the Venue after which people can
visit your Event.
The StartDate element is to be used when you know the day
of the performance, but not the time information. It is obviously better
to supply a StartDateTime if at all possible.
The StartUndefined element is to be used when the start
of the Performance is not known. It is optionally permitted to supply a
StartAfter and / or a StartBefore child element to give an indication of
when the Performance may start.
The StartAfterInclusive is a suggestion as to
a date when the unknown Start of the Performance is likely
to start on or after.
The StartBeforeInclusive is a suggestion as
to the latest date that the Performance may start on or
before.
If there is more than one performance which has
an unknown start time then this should be set to true. If the
actual number of performances is known, then the correct number
of Performance elements should be created. Additional supporting
information can be provided in the sibling Description
elements.
The FormattedStart field is to be used when you have a text
description of the start that is not parseable by a computer, but which
might be useful to a human.
If this Performance was previously advertised at a different
startTime then you can use this attribute to signify when it has been moved
from.
If you had previously advertised this Performance as happening
and it has now been cancelled then you can signify this with this attribute. If
the cancelled Performance has an id then this can be utilised to connect it to
the appropriate Performance in previous messages. Failing this it should be
assumed that the cancelled Performance is referring to any Performance with the
same startTime on a previous message. It is also possible that you can re-enable
this Performance if you want to "un-cancel" it, but this would be
unlikely.
This attribute should be used if this Schedule is not to be
published before a given time. The rest of the Event may be published (subject
to other restrictions as appropriate). Please note that the information may be
re-syndicated in IVES with the attribute preserved to other Consumers before
this time.
An optional, short, humanly readable phrase that may be used to
label this Performance.
The isPublicallyVisible attribute states whether or not
the key:value defined by this Property is intended to be shown to the
public. If you are using attributes to provide internal annotations onto
elements that assist with the processing of elements then this should
have a value of false otherwise an automated display of an IVES document
may end up showing all of your linking values which is probably not what
you want. The default value is true, ie Property elements are expected
to be shown to people unless explicitly told
otherwise.
The isCrossElement attribute signifies whether a Consumer
should link together elements of different types purely because they
contain the same Property. If a given Property is only applicable to a
single type of element then you should utilise a value of false but if
it may be used across the entire IVES schema to link elements of
different types then a value of true should be used. The default value
is false because cross-element definitions are probably in the minority.
The role attribute should specify the real-world purpose of the
element to which it is attached. This is not to be confused with the type
attribute which describes the category of object independently of the context of
this use. The format is not constrained at present.
The type attribute should specify the category of object that is
being described. This is not to be confused with the role attribute which is
what the object is for in this context. The format is not constrained at
present.
A Schedule is a list of Performances which all share the same Venue,
TicketTypes and PerformanceDuration
An optional, short, humanly readable phrase that may be used to
label this Schedule.
This attribute should be used if this Schedule is not to be
published before a given time. The rest of the Event may be published (subject
to other restrictions as appropriate). Please note that the information may be
re-syndicated in IVES with the attribute preserved to other Consumers before
this time.
If the Performances contained within this element may extend
beyond the explicitly defined elements, then this can be signified by including
isOpenEnded with a value of true. This is an indication only and there is no
implication as to how many Performances or the timing of the Performances and
Suppliers should provide more detailed IVES documents with updated information
as they become available.
The supplierIdType is the email address of the entity that is
responsible for generating the information about the event that is being described.
All Ives messages must include the supplierId for the message as a whole, and event
cross references may include the supplierId if they are referring to an event that
was created by an entity other than them.
The supplierSpecificId is a unique way of identifying an element that
makes sense to the supplier of the document that is using it. If you receive a
document that is incorrect and you wish to suggest a correction to the supplier then
it will be much easier to identify which element you are referring to if as many
elements as possible have supplierSpecificIds defined.
The CountryCallingCode should start with + followed by
the appropriate numerical calling code.
The AreaCode should be expressed with all leading values
as appropriate. For example "0131" for Edinburgh as opposed to either
"131" or "(0)131".
Optional timestamp that defines the point when the element to
which it is associated was first created. If the element is being syndicated
from an alternative Supplier then the creationTime should be
preserved.
Optional timestamp that defines the point at which the element,
or any of its immediate children, have last been updated compared to an IVES
document that the Supplier will have previously released. If the element
contains references to external entities which have been updated then this
element doesn't have to be marked as updated (but the external entities
should)