Link Relationships

What are they?

A link is a connection between one web resource and another. The rel or 'relationship' attribute of the link describes the relationship between the current resource and the one being linked to. For example, where a resource is presented in multiple pages, the current page may include link elements that give the addresses of the next and previous pages in the sequence.

The most common relationship that you will see in the set of resources that make up the NICE Syndication Services API is self. As you would expect, this simply gives the address of the current resource.

            <link rel="self" href="http://www.domain.com/paged-resource?page=2"/>
            <link rel="next" href="http://www.domain.com/paged-resource?page=3"/>
            <link rel="prev" href="http://www.domain.com/paged-resource?page=1"/>
          

self

The cannonical address of the current resource

alternate

An alternate representation of the current resource. For example, this could be a link to a page to the NICE website, another third-party website, or a PDF version of the resource.

up

The resource 'above' the current resource in the hierarchy, i.e. the current resource's parent.

first

The first page of resources in the current set.

previous

The previous page of resources in the current set.

next

The next page of resources in the current set.

last

The last page of resources in the current set.

/linkrels/guidance

A guidance document.

/linkrels/guidance/by-date

All guidance documents published or updated between a given date-range.

/linkrels/guidance/current/by-date

All guidance documents published or updated between a given date-range, which excludes withdrawn guidance

/linkrels/guidance/by-date/selector

An HTML form that can create the URI for a guidance-by-date request.

/linkrels/guidance/current/by-date/selector

An HTML form that can create the URI for a guidance-by-date request which will exclude withdrawn guidance

/linkrels/guidance/chapter

A single chapter from a guidance document.

/linkrels/guidance/custom-document

A customised version of a guidance document continuing only selected chapters.

/linkrels/guidance/full-document

A guidance document with all it's chapters included in-line within the main content section.

/linkrels/guidance/index

The index of all guidance documents including their metadata.

/linkrels/guidance/current/index

The index of guidance documents including their metadata, which excludes withdrawn guidance

/linkrels/guidance/programmes2

A list of all guidance programmes.

/linkrels/guidance/current/programmes2

A list of all guidance programmes.

/linkrels/guidance/programme

(deprecated) An individual guidance programme, with links to all the guidance documents that are part of that programme.

/linkrels/guidance/current/programme

(deprecated) An individual guidance programme, with links to all the guidance documents that are part of that programme.

/linkrels/guidance/programme2

An individual guidance programme, with links to all the guidance documents that are part of that programme.

/linkrels/guidance/current/programme2

An individual guidance programme, with links to all the guidance documents that are part of that programme, excluding the withdrawn documents.

/linkrels/guidance/section

A section from a guidance document.

/linkrels/guidance/structured-document

A complete guidance document that contains the component sections of the document in discrete elements, as distinct from the FullDocument (above) where all the content is aggregated into a single element.

/linkrels/guidance/structured-documents/by-date

A set of guidance structured documents that were published or updated in a specified date range.

/linkrels/guidance/current/structured-documents/by-date

A set of guidance structured documents that were published or updated in a specified date range, excluding withdrawn guidance

/linkrels/guidance/structured-documents/by-date/selector

An HTML form that can be used to create a URI for guidance structured documents by date requests.

/linkrels/guidance/current/structured-documents/by-date/selector

An HTML form that can be used to create a URI for guidance structured documents by date requests, excluding withdrawn guidance

/linkrels/guidance/newtaxonomy

The taxonomy of guidance documents, with links to the guidance documents from the leaf-level nodes.

/linkrels/guidance/current/newtaxonomy

The taxonomy of guidance documents, with links to the guidance documents from the leaf-level nodes, excluding withdrawn guidance.

/linkrels/ifp/index

The index of all information for the public document

/linkrels/services

The list of all the services that you have subscribed to.