How Can We Help?
Organisation XMLOrganisation XML
Overview
This page details the Organisation content type. On this page you will find different representations of the data elements contained within this type.
Below is the xsd for the Organisation content type that defines the import xml format. Also provided is mapping tables generated based on this XSD as well as an example xml that shows how the fields can be populated.
This is logical broken down into the different elements to help you gain a better understanding of the Organisation content type and how to create, read and update these records using the mechanisms provided in Pure.
Note: for the mapping tables all attributes and elements are listed, along with descriptions of the purposes of the field and any data requirements. Attribute are prefaced with an "@" to differentiate from elements, but as shown in the examples this isn't used when generating the xml.
Some elements offer options of which elements to include (such as whether to provide the ID of a person or organisation or name for lookup). These are denoted by reference to "Option Groups" where numbers are used to indicate where multiple elements are part of the same option. See example xmls for demonstrations of how to use these elements.
Below are a series of attachments for your reference:
- Simple Example XML - This shows only the mandatory fields that need to be populated
- Advanced Example XML - This shows all fields that can be used. Snippets of this file are shown with their related elements below.
- XSD (Xml Schema Definition) - This is a definition of what structure the XML must follow. This page has been generated based on the contents of the xsd file, and snippets of the definition are shown with their relevant element below
- Editor Example PNG - This image shows the result of loading the advanced example xml into Pure, to allow for easy reference of which fields in Pure point to which elements in the XML. Note that the way the data is presented within your Pure instance may be different due to different configuration
- Webservice Example Response - This shows an example response of retrieving the record generated via this xml via the webservice
- Pure API Example Response - This shows an example response of retrieving the record generated via this xml via the Pure API. Note as the Pure API allows for creation of records, this format could also be used to create a new record with these details, but some fields would be ignored in that case (such as audit fields like created/modified by and internal Pure identifiers like UUID and Pure ID which wouldn't exist yet). UUIDs for related content (such as organisational units) would need to be updated as well.
Download All
Organisations
organisations
A list of organisation elements of type organisation
The root element of the xml file.
XML Example
<organisations xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<organisation managedInPure="false">
<organisationId>organisation1</organisationId>
<type>university</type>
<name>
<cmns:text lang="en" country="GB">Tesla University</cmns:text>
</name>
<startDate>2007-10-26</startDate>
<endDate>2050-01-01</endDate>
<takenOverBy>organisation2</takenOverBy>
<visibility>Restricted</visibility>
<owner>organisation3</owner>
<parentOrganisationId>organisation3</parentOrganisationId>
<parentOrganisationId>organisation4</parentOrganisationId>
<nameVariants>
<nameVariant>
<type>shortname</type>
<name>
<cmns:text lang="en" country="GB">TeU</cmns:text>
</name>
</nameVariant>
</nameVariants>
<profileInfos>
<profileInfo>
<type>organisation_profile</type>
<profileInfo>
<cmns:text lang="en" country="GB">
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Mauris faucibus sem vitae nisl dapibus semper. Praesent iaculis lorem turpis, id dapibus mi tincidunt id.
Suspendisse aliquet magna turpis, quis dignissim elit mollis ut. Donec ut imperdiet ligula. Donec luctus malesuada laoreet.
Maecenas interdum dui ornare pharetra tempor. Vestibulum consectetur mollis magna. Vivamus tristique sem in sem imperdiet, laoreet vestibulum turpis commodo.
Duis nulla quam, bibendum eu turpis ut, venenatis imperdiet urna. Praesent sed ante purus.
</cmns:text>
</profileInfo>
</profileInfo>
</profileInfos>
<photos>
<photo>
<type>hero_image</type>
<photoValue>https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/N.Tesla.JPG/800px-N.Tesla.JPG</photoValue>
<photoProtocol>http</photoProtocol>
</photo>
</photos>
<phoneNumbers>
<phoneNumber>
<type>phone</type>
<phoneNumber>568425658</phoneNumber>
</phoneNumber>
</phoneNumbers>
<emails>
<email>
<type>email</type>
<email>noreply@elsevier.com</email>
</email>
</emails>
<webAddresses>
<webAddress>
<type>web</type>
<webAddress>
<cmns:text lang="en" country="GB">http://elsevier.com</cmns:text>
</webAddress>
</webAddress>
</webAddresses>
<addresses>
<address>
<type>postal</type>
<city>London</city>
<postalCode>SW1V 4NP</postalCode>
<street>Wayne Street</street>
<building>44</building>
<country>us</country>
<subdivision>us/ak</subdivision>
<geospatialPoint>40.64209354784047, -73.78486633300781</geospatialPoint>
<geospatialPolygon>40.64209354784047, -73.78486633300781, 35.64209354784047, 40.64209354784047</geospatialPolygon>
<displayFormat>
Tesla University
44 Wayne Street
London AK, SW1V 4NP
UNITED STATES
</displayFormat>
</address>
</addresses>
<keywords>
<cmns:logicalGroup logicalName="keywordContainers">
<cmns:structuredKeywords>
<cmns:structuredKeyword classification="A"/>
<cmns:structuredKeyword classification="T/TA"/>
<cmns:structuredKeyword classification="T/TP">
<cmns:freeKeywords>
<cmns:freeKeyword>
<cmns:text lang="en" country="GB">Inorganic chemistry</cmns:text>
<cmns:text lang="da" country="DK">Uorganisk kemi</cmns:text>
</cmns:freeKeyword>
<cmns:freeKeyword>
<cmns:text lang="da" country="DK">Applied biochemistry</cmns:text>
</cmns:freeKeyword>
</cmns:freeKeywords>
</cmns:structuredKeyword>
</cmns:structuredKeywords>
</cmns:logicalGroup>
</keywords>
<ids>
<id>
<idSource>organisationid</idSource>
<id>organisation1</id>
</id>
</ids>
<costCenters>
<costCenter>costcenter1</costCenter>
<costCenter>costcenter2</costCenter>
</costCenters>
<links>
<link id="link1">
<url>https://www.youtube.com/watch?v=dQw4w9WgXcQ</url>
<type>portalmultimedia</type>
<description>
<cmns:text>Organisational Unit Introduction</cmns:text>
</description>
</link>
</links>
</organisation>
<organisation managedInPure="false">
<organisationId>organisation2</organisationId>
<type>faculty</type>
<name>
<cmns:text lang="en" country="GB">Faculty of Science</cmns:text>
</name>
<startDate>2007-01-01</startDate>
<visibility>Public</visibility>
</organisation>
<organisation managedInPure="false">
<organisationId>organisation3</organisationId>
<type>faculty</type>
<name>
<cmns:text lang="en" country="GB">Old Faculty of Science</cmns:text>
</name>
<startDate>1907-10-26</startDate>
<endDate>2006-12-31</endDate>
<takenOverBy>organisation2</takenOverBy>
<visibility>Public</visibility>
</organisation>
<organisation managedInPure="false">
<organisationId>organisation4</organisationId>
<type>faculty</type>
<name>
<cmns:text lang="en" country="GB">Faculty of Medicine</cmns:text>
</name>
<startDate>2010-10-26</startDate>
<visibility>Public</visibility>
</organisation>
</organisations>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="organisations">
<xs:annotation>
<xs:documentation>
The root element of the xml file.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="organisation" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="resumptionToken" type="xs:string">
<xs:annotation>
<xs:documentation>
To enable resumption tokens, add an URL to the "XML source data location" in the job configuration with "{resumptionToken}" as a placeholder, for instance "https://example.org/data?resumptionToken={resumptionToken}".
The endpoint must handle the resumptionToken in the following manner:
If an empty resumptionToken is sent, the endpoint must return all data. If a non-empty resumptionToken is sent, the endpoint must return all data that has changed since the time the resumptionToken was sent.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>organisation
XML Example
<organisation xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
managedInPure="false">
<organisationId>organisation1</organisationId>
<type>university</type>
<name>
<cmns:text lang="en" country="GB">Tesla University</cmns:text>
</name>
<startDate>2007-10-26</startDate>
<endDate>2050-01-01</endDate>
<takenOverBy>organisation2</takenOverBy>
<visibility>Restricted</visibility>
<owner>organisation3</owner>
<parentOrganisationId>organisation3</parentOrganisationId>
<parentOrganisationId>organisation4</parentOrganisationId>
<nameVariants>
<nameVariant>
<type>shortname</type>
<name>
<cmns:text lang="en" country="GB">TeU</cmns:text>
</name>
</nameVariant>
</nameVariants>
<profileInfos>
<profileInfo>
<type>organisation_profile</type>
<profileInfo>
<cmns:text lang="en" country="GB">
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Mauris faucibus sem vitae nisl dapibus semper. Praesent iaculis lorem turpis, id dapibus mi tincidunt id.
Suspendisse aliquet magna turpis, quis dignissim elit mollis ut. Donec ut imperdiet ligula. Donec luctus malesuada laoreet.
Maecenas interdum dui ornare pharetra tempor. Vestibulum consectetur mollis magna. Vivamus tristique sem in sem imperdiet, laoreet vestibulum turpis commodo.
Duis nulla quam, bibendum eu turpis ut, venenatis imperdiet urna. Praesent sed ante purus.
</cmns:text>
</profileInfo>
</profileInfo>
</profileInfos>
<photos>
<photo>
<type>hero_image</type>
<photoValue>https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/N.Tesla.JPG/800px-N.Tesla.JPG</photoValue>
<photoProtocol>http</photoProtocol>
</photo>
</photos>
<phoneNumbers>
<phoneNumber>
<type>phone</type>
<phoneNumber>568425658</phoneNumber>
</phoneNumber>
</phoneNumbers>
<emails>
<email>
<type>email</type>
<email>noreply@elsevier.com</email>
</email>
</emails>
<webAddresses>
<webAddress>
<type>web</type>
<webAddress>
<cmns:text lang="en" country="GB">http://elsevier.com</cmns:text>
</webAddress>
</webAddress>
</webAddresses>
<addresses>
<address>
<type>postal</type>
<city>London</city>
<postalCode>SW1V 4NP</postalCode>
<street>Wayne Street</street>
<building>44</building>
<country>us</country>
<subdivision>us/ak</subdivision>
<geospatialPoint>40.64209354784047, -73.78486633300781</geospatialPoint>
<geospatialPolygon>40.64209354784047, -73.78486633300781, 35.64209354784047, 40.64209354784047</geospatialPolygon>
<displayFormat>
Tesla University
44 Wayne Street
London AK, SW1V 4NP
UNITED STATES
</displayFormat>
</address>
</addresses>
<keywords>
<cmns:logicalGroup logicalName="keywordContainers">
<cmns:structuredKeywords>
<cmns:structuredKeyword classification="A"/>
<cmns:structuredKeyword classification="T/TA"/>
<cmns:structuredKeyword classification="T/TP">
<cmns:freeKeywords>
<cmns:freeKeyword>
<cmns:text lang="en" country="GB">Inorganic chemistry</cmns:text>
<cmns:text lang="da" country="DK">Uorganisk kemi</cmns:text>
</cmns:freeKeyword>
<cmns:freeKeyword>
<cmns:text lang="da" country="DK">Applied biochemistry</cmns:text>
</cmns:freeKeyword>
</cmns:freeKeywords>
</cmns:structuredKeyword>
</cmns:structuredKeywords>
</cmns:logicalGroup>
</keywords>
<ids>
<id>
<idSource>organisationid</idSource>
<id>organisation1</id>
</id>
</ids>
<costCenters>
<costCenter>costcenter1</costCenter>
<costCenter>costcenter2</costCenter>
</costCenters>
<links>
<link id="link1">
<url>https://www.youtube.com/watch?v=dQw4w9WgXcQ</url>
<type>portalmultimedia</type>
<description>
<cmns:text>Organisational Unit Introduction</cmns:text>
</description>
</link>
</links>
</organisation>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema"
name="organisation"
type="organisation"/>
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="organisation">
<xs:sequence>
<xs:element name="organisationId" type="commons:string_400" minOccurs="1">
<xs:annotation>
<xs:documentation>
A unique identifier for the organisation. This is called the Source ID in the Pure interface and used to reference the organisation in XML files for other content types. Note, you can store multiple identifiers in the IDs element below.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="type" type="commons:classification" minOccurs="1">
<xs:annotation>
<xs:documentation>
The organisation type. Must be a valid classification from the /dk/atira/pure/organisation/organisationtypes classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="name"
type="commons:localized_string"
minOccurs="1"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
The name of the organisation. Element can be repeated for all submission locales in the Pure installation, by adding the "lang" attribute, with values matching the languages used in Pure. E.g. "da", "en", "de", "nl" etc.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="startDate" type="commons:date" minOccurs="1">
<xs:annotation>
<xs:documentation>
Date the organisational unit was founded. Should be in YYYY-MM-DD format
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="endDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>
Date the organisational unit ended. If left blank it is presumed the unit continues to exist. Should be in YYYY-MM-DD format
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="takenOverBy" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>
If this organisation is a historical organisation and another organisation has replaced it, the ID of this organisation can be specified here. Pure will then make a relation between the two organisations
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility" minOccurs="1">
<xs:annotation>
<xs:documentation>
If you want to you can set the visibility of the organisation. It can be either Publicly available, Campus (IP address) or Restricted to Pure users.
If you supply a value it must be one of the following: Public, Campus, Restricted
If no value is specified, Publicly available will be selected by default.
For organisational units that you do not wish to display on the Portal, use Restricted.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="owner" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>
A parent organisation marked as the primary parent organisation. Note the owner organisation must also be in the "hierarchy" element as a parent to this organisation.
In the editor this is the "Reporting organisation unit".
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="parentOrganisationId"
type="commons:string_400"
minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
The organisation ID of the parent of this organisational unit. You can repeat this element to reflect hybrid structures with multiple parent organisations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="nameVariants" type="nameVariants" minOccurs="0">
<xs:annotation>
<xs:documentation>
Alternative names of the organisation. Must of the types listed in /dk/atira/pure/organisation/namevariants classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="profileInfos" type="profileInfos" minOccurs="0">
<xs:annotation>
<xs:documentation>
Free text profile information about the organisation. Must be of the types listed in /dk/atira/pure/organisation/customfields classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="photos" type="photos" minOccurs="0">
<xs:annotation>
<xs:documentation>
Photos of the organisation and their work. Must be of the types listed in /dk/atira/pure/organisation/organisationfiles classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="phoneNumbers" type="phoneNumbers" minOccurs="0">
<xs:annotation>
<xs:documentation>
Contact numbers for the organisation. Type must be from the /dk/atira/pure/organisation/organisationphonenumbertype classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="emails" type="emails" minOccurs="0">
<xs:annotation>
<xs:documentation>
Contact emails for the organisation. Type must be from the /dk/atira/pure/organisation/organisationemailtype classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="webAddresses" type="webAddresses" minOccurs="0">
<xs:annotation>
<xs:documentation>
Websites for the organisation. Type must be from the /dk/atira/pure/organisation/organisationwebaddresstype classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="addresses" type="addresses" minOccurs="0">
<xs:annotation>
<xs:documentation>
Physical and postal addresses for the organisation. Type must be from the /dk/atira/pure/organisation/organisationaddresstype classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="keywords" type="commons:keywords" minOccurs="0">
<xs:annotation>
<xs:documentation>
Keywords related to the organisational unit. Can be managed under the Administrator -> Keywords menu
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ids" type="ids" minOccurs="0">
<xs:annotation>
<xs:documentation>
IDs of the organisation. Type must be from the /dk/atira/pure/organisation/organisationsources classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="costCenters" type="costCenters" minOccurs="0">
<xs:annotation>
<xs:documentation>
Related coster centers for the organisation. Must first be defined in /dk/atira/pure/upm/costcenter classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="links" type="links" minOccurs="0">
<xs:annotation>
<xs:documentation>The links for the organisation. Type must be in the /dk/atira/pure/links/organisation classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute type="xs:boolean" name="managedInPure" use="optional">
<xs:annotation>
<xs:documentation>
Indicates whether or not an organisation should be managed inside Pure. If set to TRUE, the synchronisation will only import the organisation and not lock any fields/relations. In subsequent synchronisation runs, the synchronisation will not update the organisation, unless the MANAGED_IN_PURE state is changed to FALSE. If changed the organisation will be picked up by the synchronisation and handled as a synchronised content and fields and relations will be locked based on the configuration.
The default behaviour for the synchronisation is to consider MANAGED_IN_PURE as FALSE.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
| @managedInPure | Indicates whether or not an organisation should be managed inside Pure. If set to TRUE, the synchronisation will only import the organisation and not lock any fields/relations. In subsequent synchronisation runs, the synchronisation will not update the organisation, unless the MANAGED_IN_PURE state is changed to FALSE. If changed the organisation will be picked up by the synchronisation and handled as a synchronised content and fields and relations will be locked based on the configuration. The default behaviour for the synchronisation is to consider MANAGED_IN_PURE as FALSE. | xsd:boolean | No |
| organisationId | A unique identifier for the organisation. This is called the Source ID in the Pure interface and used to reference the organisation in XML files for other content types. Note, you can store multiple identifiers in the IDs element below. | commons:string_400 | Yes |
| type | The organisation type. Must be a valid classification from the /dk/atira/pure/organisation/organisationtypes classification scheme | commons:classification | Yes |
| name | The name of the organisation. Element can be repeated for all submission locales in the Pure installation, by adding the "lang" attribute, with values matching the languages used in Pure. E.g. "da", "en", "de", "nl" etc. | commons:localized_string | Yes |
| startDate | Date the organisational unit was founded. Should be in YYYY-MM-DD format | commons:date | Yes |
| endDate | Date the organisational unit ended. If left blank it is presumed the unit continues to exist. Should be in YYYY-MM-DD format | commons:date | No |
| takenOverBy | If this organisation is a historical organisation and another organisation has replaced it, the ID of this organisation can be specified here. Pure will then make a relation between the two organisations | commons:string_1024 | No |
| visibility | If you want to you can set the visibility of the organisation. It can be either Publicly available, Campus (IP address) or Restricted to Pure users. If you supply a value it must be one of the following: Public, Campus, Restricted If no value is specified, Publicly available will be selected by default. For organisational units that you do not wish to display on the Portal, use Restricted. | commons:visibilityWithOutConfidential (From 5.32.1) | No |
| owner | A parent organisation marked as the primary parent organisation. Note the owner organisation must also be in the "hierarchy" element as a parent to this organisation. In the editor this is the "Reporting organisation unit". | commons:string_1024 | No |
| parentOrganisationId | The organisation ID of the parent of this organisational unit. You can repeat this element to reflect hybrid structures with multiple parent organisations. | commons:string_400 | No |
| nameVariants | Alternative names of the organisation. Must of the types listed in /dk/atira/pure/organisation/namevariants classification scheme | nameVariants | No |
| profileInfos | Free text profile information about the organisation. Must be of the types listed in /dk/atira/pure/organisation/customfields classification scheme | profileInfos | No |
| photos | Photos of the organisation and their work. Must be of the types listed in /dk/atira/pure/organisation/organisationfiles classification scheme | photos | No |
| phoneNumbers | Contact numbers for the organisation. Type must be from the /dk/atira/pure/organisation/organisationphonenumbertype classification scheme | phoneNumbers | No |
| emails | Contact emails for the organisation. Type must be from the /dk/atira/pure/organisation/organisationemailtype classification scheme | emails | No |
| webAddresses | Websites for the organisation. Type must be from the /dk/atira/pure/organisation/organisationwebaddresstype classification scheme | webAddresses | No |
| addresses | Physical and postal addresses for the organisation. Type must be from the /dk/atira/pure/organisation/organisationaddresstype classification scheme | addresses | No |
| keywords | Keywords related to the organisational unit. Can be managed under the Administrator -> Keywords menu | commons:keywords | No |
| ids | IDs of the organisation. Type must be from the /dk/atira/pure/organisation/organisationsources classification scheme | ids | No |
| costCenters | Related coster centers for the organisation. Must first be defined in /dk/atira/pure/upm/costcenter classification scheme | costCenters | No |
| links | The links for the organisation. Type must be in the /dk/atira/pure/links/organisation classification scheme | links | No |
Name Variants
nameVariants
A list of nameVariant elements of type nameVariant
XML Example
<nameVariants xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<nameVariant>
<type>shortname</type>
<name>
<cmns:text lang="en" country="GB">TeU</cmns:text>
</name>
</nameVariant>
</nameVariants>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="nameVariants">
<xs:sequence>
<xs:element ref="nameVariant" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>nameVariant
Pure comes with the shortname, sortname and webname types of name variants, but additional ones can be added. Sort name will be used to determine alphabetic sorting order if provided and web name will be used as the display name for the organisational unit on the portal if provided.
XML Example
<nameVariant xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<type>shortname</type>
<name>
<cmns:text lang="en" country="GB">TeU</cmns:text>
</name>
</nameVariant>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="nameVariant">
<xs:annotation>
<xs:documentation>
Pure comes with the shortname, sortname and webname types of name variants, but additional ones can be added. Sort name will be used to determine alphabetic sorting order if provided and web name will be used as the display name for the organisational unit on the portal if provided.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="type" type="commons:classification">
<xs:annotation>
<xs:documentation>
The name variant type. Must be a valid classification from the /dk/atira/pure/organisation/namevariants classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="name"
type="commons:localized_string"
minOccurs="1"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
The value of the name variant. Can be repeated for each submission language enabled in the system
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute type="commons:string_400" name="id" use="optional">
<xs:annotation>
<xs:documentation>Unique ID (across a single content) for the association</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
| @id | Unique ID (across a single content) for the association | commons:string_400 | Yes |
| type | The name variant type. Must be a valid classification from the /dk/atira/pure/organisation/namevariants classification scheme | commons:classification | Yes |
| name | The value of the name variant. Can be repeated for each submission language enabled in the system | commons:localized_string | Yes |
Profile Information
profileInfos
A list of profileInfo elements of type profileInfo
XML Example
<profileInfos xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<profileInfo>
<type>organisation_profile</type>
<profileInfo>
<cmns:text lang="en" country="GB">
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Mauris faucibus sem vitae nisl dapibus semper. Praesent iaculis lorem turpis, id dapibus mi tincidunt id.
Suspendisse aliquet magna turpis, quis dignissim elit mollis ut. Donec ut imperdiet ligula. Donec luctus malesuada laoreet.
Maecenas interdum dui ornare pharetra tempor. Vestibulum consectetur mollis magna. Vivamus tristique sem in sem imperdiet, laoreet vestibulum turpis commodo.
Duis nulla quam, bibendum eu turpis ut, venenatis imperdiet urna. Praesent sed ante purus.
</cmns:text>
</profileInfo>
</profileInfo>
</profileInfos>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="profileInfos">
<xs:sequence>
<xs:element ref="profileInfo" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>profileInfo
Free text information about the organisational unit. By adding additional types to the /dk/atira/pure/organisation/customfields classification scheme you can include many different types of profile information for display on the portal
XML Example
<profileInfo xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<type>organisation_profile</type>
<profileInfo>
<cmns:text lang="en" country="GB">
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Mauris faucibus sem vitae nisl dapibus semper. Praesent iaculis lorem turpis, id dapibus mi tincidunt id.
Suspendisse aliquet magna turpis, quis dignissim elit mollis ut. Donec ut imperdiet ligula. Donec luctus malesuada laoreet.
Maecenas interdum dui ornare pharetra tempor. Vestibulum consectetur mollis magna. Vivamus tristique sem in sem imperdiet, laoreet vestibulum turpis commodo.
Duis nulla quam, bibendum eu turpis ut, venenatis imperdiet urna. Praesent sed ante purus.
</cmns:text>
</profileInfo>
</profileInfo>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="profileInfo">
<xs:annotation>
<xs:documentation>
Free text information about the organisational unit. By adding additional types to the /dk/atira/pure/organisation/customfields classification scheme you can include many different types of profile information for display on the portal
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="type" type="commons:classification">
<xs:annotation>
<xs:documentation>
The profile information type. Must be a valid classification from the /dk/atira/pure/organisation/customfields classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="profileInfo"
type="commons:localized_string"
minOccurs="1"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
The free text profile information. Can contain basic html formatting, but must be escaped or wrapped in CDATA tags. Can be repeated for each submission language enabled in the system
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute type="commons:string_400" name="id" use="optional">
<xs:annotation>
<xs:documentation>Unique ID (across a single content) for the association</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
| @id | Unique ID (across a single content) for the association | commons:string_400 | Yes |
| type | The profile information type. Must be a valid classification from the /dk/atira/pure/organisation/customfields classification scheme | commons:classification | Yes |
| profileInfo | The free text profile information. Can contain basic html formatting, but must be escaped or wrapped in CDATA tags. Can be repeated for each submission language enabled in the system | commons:localized_string | Yes |
Photos
photos
A list of photo elements of type photo
XML Example
<photos xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<photo>
<type>hero_image</type>
<photoValue>https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/N.Tesla.JPG/800px-N.Tesla.JPG</photoValue>
<photoProtocol>http</photoProtocol>
</photo>
</photos>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="photos">
<xs:sequence>
<xs:element ref="photo" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>photo
Depending on the type of photo these can then be used on the portal page for this organisational unit.
XML Example
<photo xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<type>hero_image</type>
<photoValue>https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/N.Tesla.JPG/800px-N.Tesla.JPG</photoValue>
<photoProtocol>http</photoProtocol>
</photo>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="photo">
<xs:annotation>
<xs:documentation>
Depending on the type of photo these can then be used on the portal page for this organisational unit.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element name="type" type="commons:classification">
<xs:annotation>
<xs:documentation>
The photo type. Must be a valid classification from the /dk/atira/pure/organisation/organisationfiles classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="photoValue" type="xs:string">
<xs:annotation>
<xs:documentation>
The photo contents. If the protocol is HTTP then a URL that the Pure server can access should be provided. If FILE then a path on the server to the file. If BYTE then a base64 encoded byte array should be provided
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="photoProtocol" type="xs:string">
<xs:annotation>
<xs:documentation>
The protocol used to access the photo. Valid values are BYTE, FILE, HTTP
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="optional">
<xs:annotation>
<xs:documentation>Unique ID (across a single content) for the association</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
| @id | Unique ID (across a single content) for the association | commons:string_400 | Yes |
| type | The photo type. Must be a valid classification from the /dk/atira/pure/organisation/organisationfiles classification scheme | commons:classification | Yes |
| photoValue | The photo contents. If the protocol is HTTP then a URL that the Pure server can access should be provided. If FILE then a path on the server to the file. If BYTE then a base64 encoded byte array should be provided | xsd:string | Yes |
| photoProtocol | The protocol used to access the photo. Valid values are BYTE, FILE, HTTP | xsd:string | Yes |
Contact Details
phoneNumbers
A list of phoneNumber elements of type phoneNumber
XML Example
<phoneNumbers xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<phoneNumber>
<type>phone</type>
<phoneNumber>568425658</phoneNumber>
</phoneNumber>
</phoneNumbers>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="phoneNumbers">
<xs:sequence>
<xs:element ref="phoneNumber" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>phoneNumber
Can represent multiple types of phone numbers, to represent the different services they may provide
XML Example
<phoneNumber xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<type>phone</type>
<phoneNumber>568425658</phoneNumber>
</phoneNumber>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="phoneNumber">
<xs:annotation>
<xs:documentation>
Can represent multiple types of phone numbers, to represent the different services they may provide
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element name="type" type="commons:classification">
<xs:annotation>
<xs:documentation>
The phone number type. Must be a valid classification from the /dk/atira/pure/organisation/organisationphonenumbertype classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="phoneNumber" type="commons:string_64">
<xs:annotation>
<xs:documentation>
The phone number value
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="optional">
<xs:annotation>
<xs:documentation>Unique ID (across a single content) for the association</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
| @id | Unique ID (across a single content) for the association | commons:string_400 | Yes |
| type | The phone number type. Must be a valid classification from the /dk/atira/pure/organisation/organisationphonenumbertype classification scheme | commons:classification | Yes |
| phoneNumber | The phone number value | commons:string_64 | Yes |
emails
A list of email elements of type email
XML Example
<emails xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<email>
<type>email</type>
<email>noreply@elsevier.com</email>
</email>
</emails>Accordion Title
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="emails">
<xs:sequence>
<xs:element ref="email" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>Can represent many different types of email addresses, to cover different enquiry types that might be made
XML Example
<email xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<type>email</type>
<email>noreply@elsevier.com</email>
</email>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="email">
<xs:annotation>
<xs:documentation>
Can represent many different types of email addresses, to cover different enquiry types that might be made
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element name="type" type="commons:classification">
<xs:annotation>
<xs:documentation>
The email type. Must be a valid classification from the /dk/atira/pure/organisation/organisationemailtype classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="email" type="commons:string_256">
<xs:annotation>
<xs:documentation>
The email itself
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="optional">
<xs:annotation>
<xs:documentation>Unique ID (across a single content) for the association</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
| @id | Unique ID (across a single content) for the association | commons:string_400 | Yes |
| type | The email type. Must be a valid classification from the /dk/atira/pure/organisation/organisationemailtype classification scheme | commons:classification | Yes |
| The email itself | commons:string_256 | Yes |
webAddresses
A list of webAddress elements of type webAddress
XML Example
<webAddresses xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<webAddress>
<type>web</type>
<webAddress>
<cmns:text lang="en" country="GB">http://elsevier.com</cmns:text>
</webAddress>
</webAddress>
</webAddresses>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="webAddresses">
<xs:sequence>
<xs:element ref="webAddress" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>webAddress
Web address can obviously contain the same information as a link element, however web address should be used for official sites owned by the organisational unit.
XML Example
<webAddress xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<type>web</type>
<webAddress>
<cmns:text lang="en" country="GB">http://elsevier.com</cmns:text>
</webAddress>
</webAddress>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="webAddress">
<xs:annotation>
<xs:documentation>
Web address can obviously contain the same information as a link element, however web address should be used for official sites owned by the organisational unit.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="type" type="commons:classification">
<xs:annotation>
<xs:documentation>
The web address type. Must be a valid classification from the /dk/atira/pure/organisation/organisationwebaddresstype classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="webAddress"
type="commons:localized_string"
minOccurs="1"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
The web address, should be a full URL including prefix (e.g. http://). Can be repeated for each submission language enabled in the system, allowing for different URLs for different languages
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute type="commons:string_400" name="id" use="optional">
<xs:annotation>
<xs:documentation>Unique ID (across a single content) for the association</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
| @id | Unique ID (across a single content) for the association | commons:string_400 | Yes |
| type | The web address type. Must be a valid classification from the /dk/atira/pure/organisation/organisationwebaddresstype classification scheme | commons:classification | Yes |
| webAddress |
The web address, should be a full URL including prefix (e.g. http:// ). Can be repeated for each submission language enabled in the system, allowing for different URLs for different languages |
commons:localized_string | Yes |
addresses
A list of address elements of type address
XML Example
<addresses xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<address>
<type>postal</type>
<city>London</city>
<postalCode>SW1V 4NP</postalCode>
<street>Wayne Street</street>
<building>44</building>
<country>us</country>
<subdivision>us/ak</subdivision>
<geospatialPoint>40.64209354784047, -73.78486633300781</geospatialPoint>
<geospatialPolygon>40.64209354784047, -73.78486633300781, 35.64209354784047, 40.64209354784047</geospatialPolygon>
<displayFormat>
Tesla University
44 Wayne Street
London AK, SW1V 4NP
UNITED STATES
</displayFormat>
</address>
</addresses>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="addresses">
<xs:sequence>
<xs:element ref="address" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>address
Can represent multiple addresses of an organisational unit, such as the physical address of its building, or its postal address
XML Example
<address xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<type>postal</type>
<city>London</city>
<postalCode>SW1V 4NP</postalCode>
<street>Wayne Street</street>
<building>44</building>
<country>us</country>
<subdivision>us/ak</subdivision>
<geospatialPoint>40.64209354784047, -73.78486633300781</geospatialPoint>
<geospatialPolygon>40.64209354784047, -73.78486633300781, 35.64209354784047, 40.64209354784047</geospatialPolygon>
<displayFormat>
Tesla University
44 Wayne Street
London AK, SW1V 4NP
UNITED STATES
</displayFormat>
</address>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="address">
<xs:annotation>
<xs:documentation>
Can represent multiple addresses of an organisational unit, such as the physical address of its building, or its postal address
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element name="type" type="commons:classification" minOccurs="1">
<xs:annotation>
<xs:documentation>
The address type. Must be a valid classification from the /dk/atira/pure/organisation/organisationaddresstype classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="city" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>
The city part of the address
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="postalCode" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>
The post code of the address
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="street" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>
The street of the address
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="building" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>
The building related to the address
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="country" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>
The country type. Must be a valid classification from the /dk/atira/pure/core/countries classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="subdivision" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>
The subdivision type. Must be a valid classification from the /dk/atira/pure/core/countries/subdivision classification scheme. Note not all countries are presently supported for subdivisions.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="geospatialPoint" type="commons:string_512" minOccurs="0">
<xs:annotation>
<xs:documentation>
Coordinates to specify the location of the address. E.g. 57.013543, 9.98934
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="geospatialPolygon" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
A series of comma seperated coordinate pairs that specify the corners of a polygon position of the address
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="displayFormat" type="commons:string_2048" minOccurs="0">
<xs:annotation>
<xs:documentation>
Rather than providing a breakdown of the address by components, a single text field containing the entire address can be provided
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="optional">
<xs:annotation>
<xs:documentation>Unique ID (across a single content) for the association</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
| @id | Unique ID (across a single content) for the association | commons:string_400 | Yes |
| type | The address type. Must be a valid classification from the /dk/atira/pure/organisation/organisationaddresstype classification scheme | commons:classification | Yes |
| city | The city part of the address | commons:string_1024 | No |
| postalCode | The post code of the address | commons:string_1024 | No |
| street | The street of the address | commons:string_1024 | No |
| building | The building related to the address | commons:string_1024 | No |
| country | The country type. Must be a valid classification from the /dk/atira/pure/core/countries classification scheme | commons:classification | No |
| subdivision | The subdivision type. Must be a valid classification from the /dk/atira/pure/core/countries/subdivision classification scheme. Note not all countries are presently supported for subdivisions. | commons:classification | No |
| geospatialPoint | Coordinates to specify the location of the address. E.g. 57.013543, 9.98934 | commons:string_512 | No |
| geospatialPolygon | A series of comma seperated coordinate pairs that specify the corners of a polygon position of the address | xsd:string | No |
| displayFormat | Rather than providing a breakdown of the address by components, a single text field containing the entire address can be provided | commons:string_2048 | No |
IDs
ids
A list of id elements of type id
XML Example
<ids xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<id>
<idSource>organisationid</idSource>
<id>organisation1</id>
</id>
</ids>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ids">
<xs:sequence>
<xs:element ref="id" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>id
IDs can hold multiple different types of identifiers for an organisation unit to reflect the multiple codes it may have associated across an institution
XML Example
<id xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<idSource>organisationid</idSource>
<id>organisation1</id>
</id>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="id">
<xs:annotation>
<xs:documentation>
IDs can hold multiple different types of identifiers for an organisation unit to reflect the multiple codes it may have associated across an institution
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element name="idSource" type="commons:classification">
<xs:annotation>
<xs:documentation>
The id type. Must be a valid classification from the /dk/atira/pure/organisation/organisationsources classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="id" type="commons:string_256">
<xs:annotation>
<xs:documentation>
The value of the identifier
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
</xs:complexType>
</xs:element>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
| id | The value of the identifier | commons:string_256 | Yes |
| idSource | The id type. Must be a valid classification from the /dk/atira/pure/organisation/organisationsources classification scheme | commons:classification | Yes |
Cost Centers
costCenters
A list of costCenter elements of type commons:classification
XML Example
<costCenters xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<costCenter>costcenter1</costCenter>
<costCenter>costcenter2</costCenter>
</costCenters>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="costCenters">
<xs:sequence>
<xs:element name="costCenter"
type="commons:classification"
minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
The cost center. Must be a valid classification from the /dk/atira/pure/upm/costcenter classification scheme. Can contain multiple entries
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
| costCenter | The cost center. Must be a valid classification from the /dk/atira/pure/upm/costcenter classification scheme. Can contain multiple entries | commons:classification | No |
Links
links
A list of link elements of type link
XML Example
<links xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<link id="link1">
<url>https://www.youtube.com/watch?v=dQw4w9WgXcQ</url>
<type>portalmultimedia</type>
<description>
<cmns:text>Organisational Unit Introduction</cmns:text>
</description>
</link>
</links>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="links">
<xs:sequence>
<xs:element name="link" type="link" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
link
Links obviously have overlap with web addresses, web addresses should be used for official sites. Links can be used for related content, such as the Portal Multimedia type which allows for the display of videos on the organisation's portal page
XML Example
<link xmlns="v1.organisation-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="link1">
<url>https://www.youtube.com/watch?v=dQw4w9WgXcQ</url>
<type>portalmultimedia</type>
<description>
<cmns:text>Organisational Unit Introduction</cmns:text>
</description>
</link>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="link">
<xs:annotation>
<xs:documentation>
Links obviously have overlap with web addresses, web addresses should be used for official sites. Links can be used for related content, such as the Portal Multimedia type which allows for the display of videos on the organisation's portal page
</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="url" type="xs:string">
<xs:annotation>
<xs:documentation>
The url of the link. Should be a full URL including prefix (e.g. http://)
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="type" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>
The link type. Must be a valid classification from the /dk/atira/pure/links/organisation classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="description" type="commons:localized_string" minOccurs="0">
<xs:annotation>
<xs:documentation>
Free text description of the link
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="required">
<xs:annotation>
<xs:documentation>
Unique ID (across a single content) for the association
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
| @id | Unique ID (across a single content) for the association | commons:string_400 | Yes |
| url |
The url of the link. Should be a full URL including prefix (e.g. http:// ) |
xsd:string | Yes |
| type | The link type. Must be a valid classification from the /dk/atira/pure/links/organisation classification scheme | commons:classification | No |
| description | Free text description of the link | commons:localized_string | No |
Published at April 10, 2025