1.6.5 Shared Link Components

Utilised In

• <Link> (see )
• <LinkDefinition> (see )

Shared Attributes

url

The URL of the resource that this <Link> represents. This should be publically resolveable, i.e. viewable without requiring authentication, and ideally persistent so that the useful lifespan of data in an IVES message is as long as possible.

linkType

The overal constrained type that this <Link> fulfils. This is constrained to being one of the following values:

moreInfo

the default value which just implies that the link points at some resource that will supply more information about the element it is contained within. If no value is declared then this is the defacto default.

review

 

booking

 

media

the link points at a single entity that contains an element of media that is relevant to the containing element.

type

optional string

assetCreationDate

optional date

mimeType

optional string

width

optional integer

height

optional integer

duration

optional XML duration

filesize

optional integer. Size in bytes of the targetted resource.

isEmbeddable

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.

Shared Child Elements

<Title>

, optional. Permits the definition of structured title information about the Link. I would only expect people to utilise <MainTitle> and possibly <SortTitle>, but the alternatives are there if required.

<Description(Reference)>

(), optional and repeatable. Permits the inclusion of text documents describing the contents of the Link. If the Consumer is not in a position to utilise the contents of the Link inline directly then substituting the <Description> and providing a hyperlink to the external asset should be an alternative.

<Property>

, optional and repeatable