How Can We Help?
External Organisation XMLExternal Organisation XML
Overview
This page details the External 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 External 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 External 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.
The External Organisation content type represents organisations that your institution has relationships with, but not ownership of. This can be used for organisations that your institution recieves funding from, or where collaborators to your research are employed.
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.
External Organisations
externalOrganisations
A list of externalOrganisation elements of type externalOrganisation
XML Example
<externalOrganisations xmlns="v1.externalorganisation.base-uk.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<externalOrganisation id="external_organisation_id_002" type="government">
<name>European Union</name>
<translatedName>
<cmns:text lang="de" country="DE">Europäische Union</cmns:text>
</translatedName>
<acronym>EU</acronym>
<alternativeNames>
<alternativeName>European Economic Community</alternativeName>
</alternativeNames>
<natureTypes>
<natureType>spinout</natureType>
<natureType>qualifying_organisation</natureType>
</natureTypes>
<contactAddress>
<cmns:address1>European Parliament</cmns:address1>
<cmns:address2>Altiero Spinelli</cmns:address2>
<cmns:address3>Wiertzstraat 60</cmns:address3>
<cmns:postalCode>B-1047</cmns:postalCode>
<cmns:city>Brussels</cmns:city>
<cmns:country>be</cmns:country>
<cmns:geoLocation>
<cmns:point>50.863639, 4.380781</cmns:point>
</cmns:geoLocation>
</contactAddress>
<phone>+32(0)2 28 42111</phone>
<mobilePhone>23456789</mobilePhone>
<fax>+32(0)2 28 46974</fax>
<VATNumber>12345678</VATNumber>
<bankAccount>1234-456790132465</bankAccount>
<genericNote>Note of a generic nature</genericNote>
<documents>
<document id="doc01">
<type>other</type>
<fileLocation>https://ci-pure-elsevier-systems-public.s3-eu-west-1.amazonaws.com/staticfiles/Research_Output_Import_Wizard_Documentation.pdf</fileLocation>
<visibility>Public</visibility>
<title>Documentation</title>
<mimetype>application/pdf</mimetype>
<filename>Research_Output_Import_Wizard_Documentation.pdf</filename>
</document>
</documents>
<images>
<image id="image1">
<type>funderlogo</type>
<data><!--You have a CHOICE of the next 3 items at this level-->
<http>
<url>https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/N.Tesla.JPG/800px-N.Tesla.JPG</url>
<mimeType>image/jpeg</mimeType>
<fileName>Photo.jpg</fileName>
</http>
<!--<file>-->
<!--<path>https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/N.Tesla.JPG/800px-N.Tesla.JPG</path>-->
<!--<mimeType>image/jpeg</mimeType>-->
<!--<fileName>Photo.jpg</fileName>-->
<!--</file>-->
<!--<byte>-->
<!--<base64EncodedString>base64EncodedString</base64EncodedString>-->
<!--<mimeType>image/jpeg</mimeType>-->
<!--<fileName>Photo.jpg</fileName>-->
<!--</byte>-->
</data>
</image>
</images>
<email>epedinburgh@europarl.europa.eu</email>
<visibility>Public</visibility>
<ids>
<cmns:id type="scival_id">12345</cmns:id>
</ids>
<links>
<cmns:link>
<cmns:url>http://europarl.europa.eu</cmns:url>
<cmns:type>official</cmns:type>
<cmns:description>
<cmns:text>Official European Parliment Website</cmns:text>
</cmns:description>
</cmns:link>
</links>
<keywords>
<keyword logicalName="keywordContainers"
key="/dk/atira/pure/core/keywords/A/AC"
lang="en">free text keywor</keyword>
<keyword logicalName="keywordContainers"
key="/dk/atira/pure/core/keywords/U/U1"
lang="en">free keyword</keyword>
<keyword logicalName="keywordContainers" key="/dk/atira/pure/core/keywords/T/TF"/>
</keywords>
<workflow>approved</workflow>
</externalOrganisation>
</externalOrganisations>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="externalOrganisations">
<xs:complexType>
<xs:sequence>
<xs:element ref="externalOrganisation" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
Root element of the xml containing multiple external organisations
</xs:documentation>
</xs:annotation>
</xs:element>
</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>externalOrganisation
XML Example
<externalOrganisation xmlns="v1.externalorganisation.base-uk.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="external_organisation_id_002"
type="government">
<name>European Union</name>
<translatedName>
<cmns:text lang="de" country="DE">Europäische Union</cmns:text>
</translatedName>
<acronym>EU</acronym>
<alternativeNames>
<alternativeName>European Economic Community</alternativeName>
</alternativeNames>
<natureTypes>
<natureType>spinout</natureType>
<natureType>qualifying_organisation</natureType>
</natureTypes>
<contactAddress>
<cmns:address1>European Parliament</cmns:address1>
<cmns:address2>Altiero Spinelli</cmns:address2>
<cmns:address3>Wiertzstraat 60</cmns:address3>
<cmns:postalCode>B-1047</cmns:postalCode>
<cmns:city>Brussels</cmns:city>
<cmns:country>be</cmns:country>
<cmns:geoLocation>
<cmns:point>50.863639, 4.380781</cmns:point>
</cmns:geoLocation>
</contactAddress>
<phone>+32(0)2 28 42111</phone>
<mobilePhone>23456789</mobilePhone>
<fax>+32(0)2 28 46974</fax>
<VATNumber>12345678</VATNumber>
<bankAccount>1234-456790132465</bankAccount>
<genericNote>Note of a generic nature</genericNote>
<documents>
<document id="doc01">
<type>other</type>
<fileLocation>https://ci-pure-elsevier-systems-public.s3-eu-west-1.amazonaws.com/staticfiles/Research_Output_Import_Wizard_Documentation.pdf</fileLocation>
<visibility>Public</visibility>
<title>Documentation</title>
<mimetype>application/pdf</mimetype>
<filename>Research_Output_Import_Wizard_Documentation.pdf</filename>
</document>
</documents>
<images>
<image id="image1">
<type>funderlogo</type>
<data><!--You have a CHOICE of the next 3 items at this level-->
<http>
<url>https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/N.Tesla.JPG/800px-N.Tesla.JPG</url>
<mimeType>image/jpeg</mimeType>
<fileName>Photo.jpg</fileName>
</http>
<!--<file>-->
<!--<path>https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/N.Tesla.JPG/800px-N.Tesla.JPG</path>-->
<!--<mimeType>image/jpeg</mimeType>-->
<!--<fileName>Photo.jpg</fileName>-->
<!--</file>-->
<!--<byte>-->
<!--<base64EncodedString>base64EncodedString</base64EncodedString>-->
<!--<mimeType>image/jpeg</mimeType>-->
<!--<fileName>Photo.jpg</fileName>-->
<!--</byte>-->
</data>
</image>
</images>
<email>epedinburgh@europarl.europa.eu</email>
<visibility>Public</visibility>
<ids>
<cmns:id type="scival_id">12345</cmns:id>
</ids>
<links>
<cmns:link>
<cmns:url>http://europarl.europa.eu</cmns:url>
<cmns:type>official</cmns:type>
<cmns:description>
<cmns:text>Official European Parliment Website</cmns:text>
</cmns:description>
</cmns:link>
</links>
<keywords>
<keyword logicalName="keywordContainers"
key="/dk/atira/pure/core/keywords/A/AC"
lang="en">free text keywor</keyword>
<keyword logicalName="keywordContainers"
key="/dk/atira/pure/core/keywords/U/U1"
lang="en">free keyword</keyword>
<keyword logicalName="keywordContainers" key="/dk/atira/pure/core/keywords/T/TF"/>
</keywords>
<workflow>approved</workflow>
</externalOrganisation>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="externalOrganisationType">
<xs:all>
<xs:element name="name" type="commons:string_1024">
<xs:annotation>
<xs:documentation>
The name of the organisation. If nothing is defined in translated name, this name will be imported into all enabled UI locales of the Pure running
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="translatedName"
type="commons:localized_string_1024_required_lang"
minOccurs="0">
<xs:annotation>
<xs:documentation>Translated name of the external organisation, can be specified in multi languages if your Pure is multilingual</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="acronym" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>
The acronym for the organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="alternativeNames" type="alternativeNames" minOccurs="0">
<xs:annotation>
<xs:documentation>
List of alternative names of the organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="natureTypes" type="natureTypes" minOccurs="0">
<xs:annotation>
<xs:documentation>
List of nature type classifications
Classifications from the scheme: /dk/atira/pure/ueo/nature. Only use the last part of
the uri (token)
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="contactAddress" type="commons:CERIFAddress" minOccurs="0">
<xs:annotation>
<xs:documentation>
The address of the organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="phone" type="commons:string_64" minOccurs="0">
<xs:annotation>
<xs:documentation>
The phone number for the organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="mobilePhone" type="commons:string_64" minOccurs="0">
<xs:annotation>
<xs:documentation>
The mobile phone number for the organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fax" type="commons:string_64" minOccurs="0">
<xs:annotation>
<xs:documentation>
The fax number of the organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="email" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>
The email for the organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="VATNumber" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>
The Value Added Tax number of the organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="bankAccount" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>
Bank account information of the organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="genericNote" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
Free text note field for the organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="documents" type="documents" minOccurs="0">
<xs:annotation>
<xs:documentation>
Documents for the organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="links" type="commons:links" minOccurs="0">
<xs:annotation>
<xs:documentation>The links for the organisation. Type should be from the classification scheme /dk/atira/pure/links/ueoexternalorganisation</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="keywords" type="keywords" minOccurs="0">
<xs:annotation>
<xs:documentation>
Keywords for the organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility" minOccurs="0">
<xs:annotation>
<xs:documentation>
The visibility of the organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ids" type="commons:ids" minOccurs="0">
<xs:annotation>
<xs:documentation>
Used to set additional ids on the external organisation, e.g. scival_id, scopus_affiliation_id
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="images" type="images" minOccurs="0">
<xs:annotation>
<xs:documentation>
Images for the external organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="workflow" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
Used to set the workflow state of the external organisation. Valid values are forApproval or approved. Should only be used if workflow is enabled for the content type
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="required">
<xs:annotation>
<xs:documentation>
The external ID of the external organisation. This must be an unique value, and will be used to identify the record if any changes are made
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="commons:classification" name="type" use="required">
<xs:annotation>
<xs:documentation>
Classifications from the scheme: /dk/atira/pure/ueoexternalorganisation/ueoexternalorganisationtypes. Only use the last part of
the uri (token)
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:boolean" name="managedInPure" use="optional">
<xs:annotation>
<xs:documentation>Whether the external organisation is considered after creation to be managed in Pure or by an integrated external system. If you are planning to update external organisations with data from another system this should be set to "false"</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
The external ID of the external organisation. This must be an unique value, and will be used to identify the record if any changes are made |
Yes |
|
@type |
Classifications from the scheme: /dk/atira/pure/ueoexternalorganisation/ueoexternalorganisationtypes. Only use the last part of the uri (token) |
Yes |
|
@managedInPure |
Whether the external organisation is considered after creation to be managed in Pure or by an integrated external system. If you are planning to update external organisations with data from another system this should be set to "false" |
xsd:boolean |
Yes |
name |
The name of the organisation. If nothing is defined in translated name, this name will be imported into all enabled UI locales of the Pure running |
Yes |
|
translatedName |
Translated name of the external organisation, can be specified in multi languages if your Pure is multilingual |
No |
|
acronym |
The acronym for the organisation |
No |
|
alternativeNames |
List of alternative names of the organisation |
No |
|
natureTypes |
List of nature type classifications Classifications from the scheme: /dk/atira/pure/ueo/nature. Only use the last part of the uri (token) |
No |
|
contactAddress |
The address of the organisation |
No |
|
phone |
The phone number for the organisation |
No |
|
mobilePhone |
The mobile phone number for the organisation |
No |
|
fax |
The fax number of the organisation |
No |
|
The email for the organisation |
No |
||
VATNumber |
The Value Added Tax number of the organisation |
No |
|
bankAccount |
Bank account information of the organisation |
No |
|
genericNote |
Free text note field for the organisation |
xsd:string |
No |
documents |
Documents for the organisation |
No |
|
links |
The links for the organisation. Type should be from the classification scheme /dk/atira/pure/links/ueoexternalorganisation |
No |
|
keywords |
Keywords for the organisation |
No |
|
visibility |
The visibility of the organisation |
No |
|
ids |
Used to set additional ids on the external organisation, e.g. scival_id, scopus_affiliation_id |
No |
|
images |
Images for the external organisation |
No |
|
workflow |
Used to set the workflow state of the external organisation. Valid values are forApproval or approved. Should only be used if workflow is enabled for the content type |
xsd:string |
No |
Alternative Names
alternativeNames
A list of alternativeName elements of type commons:string_1024
A collection of different names that this organisation is known by. This can be used for organisations that have undergone name changes or to represent their name in different languages that you don't have setup as submission languages within your Pure.
XML Example
<alternativeNames xmlns="v1.externalorganisation.base-uk.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<alternativeName>European Economic Community</alternativeName>
</alternativeNames>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="alternativeNames">
<xs:annotation>
<xs:documentation>A collection of different names that this organisation is known by. This can be used for organisations that have undergone name changes or to represent their name in different languages that you don't have setup as submission languages within your Pure.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="alternativeName"
type="commons:string_1024"
maxOccurs="unbounded"
minOccurs="1">
<xs:annotation>
<xs:documentation>The value of the alternative name</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
alternativeName |
The value of the alternative name |
Yes |
Nature Types & Keywords
natureTypes
A list of natureType elements of type commons:classification
A collection of nature types that reflect the work this organisation does. They must be values from the /dk/atira/pure/ueo/nature classification scheme
XML Example
<natureTypes xmlns="v1.externalorganisation.base-uk.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<natureType>spinout</natureType>
<natureType>qualifying_organisation</natureType>
</natureTypes>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="natureTypes">
<xs:annotation>
<xs:documentation>A collection of nature types that reflect the work this organisation does. They must be values from the /dk/atira/pure/ueo/nature classification scheme</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="natureType"
type="commons:classification"
maxOccurs="unbounded"
minOccurs="1">
<xs:annotation>
<xs:documentation>The nature types of the organisation. Must be values from the /dk/atira/pure/ueo/nature classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
natureType |
The nature types of the organisation. Must be values from the /dk/atira/pure/ueo/nature classification scheme |
Yes |
keywords
A list of keyword elements of type commons:keyword
A collection of keywords related to the external organisation. Note that external organisations only supports the "keyword" elements, not the structuredKeyword like other content types
XML Example
<keywords xmlns="v1.externalorganisation.base-uk.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<keyword logicalName="keywordContainers"
key="/dk/atira/pure/core/keywords/A/AC"
lang="en">free text keywor</keyword>
<keyword logicalName="keywordContainers"
key="/dk/atira/pure/core/keywords/U/U1"
lang="en">free keyword</keyword>
<keyword logicalName="keywordContainers" key="/dk/atira/pure/core/keywords/T/TF"/>
</keywords>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="keywords">
<xs:annotation>
<xs:documentation>A collection of keywords related to the external organisation. Note that external organisations only supports the "keyword" elements, not the structuredKeyword like other content types</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="keyword" type="commons:keyword" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Keywords (either free-text and/or values from classification schemes). Must be defined as a keyword of External Organisations under Administrator -> Keywords</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
keyword |
Keywords (either free-text and/or values from classification schemes). Must be defined as a keyword of External Organisations under Administrator -> Keywords |
Yes |
Documents & Images
documents
A list of document elements of type document
XML Example
<documents xmlns="v1.externalorganisation.base-uk.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<document id="doc01">
<type>other</type>
<fileLocation>https://ci-pure-elsevier-systems-public.s3-eu-west-1.amazonaws.com/staticfiles/Research_Output_Import_Wizard_Documentation.pdf</fileLocation>
<visibility>Public</visibility>
<title>Documentation</title>
<mimetype>application/pdf</mimetype>
<filename>Research_Output_Import_Wizard_Documentation.pdf</filename>
</document>
</documents>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="documents">
<xs:sequence>
<xs:element name="document" type="document" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>document
XML Example
<document xmlns="v1.externalorganisation.base-uk.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="doc01">
<type>other</type>
<fileLocation>https://ci-pure-elsevier-systems-public.s3-eu-west-1.amazonaws.com/staticfiles/Research_Output_Import_Wizard_Documentation.pdf</fileLocation>
<visibility>Public</visibility>
<title>Documentation</title>
<mimetype>application/pdf</mimetype>
<filename>Research_Output_Import_Wizard_Documentation.pdf</filename>
</document>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="document">
<xs:all>
<xs:element name="type"
type="commons:classification"
minOccurs="0"
default="other">
<xs:annotation>
<xs:documentation>
Use a token from classification scheme /dk/atira/pure/core/document/types. Default is other.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fileLocation" type="commons:string_1024" minOccurs="1">
<xs:annotation>
<xs:documentation>
Location where Pure can read the file from. Must be prefixed with protocol either
http or https. Https is only supported if the remote server uses a trusted
certificate. If the remote server uses a self-signed certificate,
the JVM running Pure will need an updated keystore.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="mimetype" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>
The mime type of the document. If not provided Pure will attempt to derive from the file location response
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="filename" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>
The file name of the document. If not provided Pure will attempt to derive from the file location
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="title" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>
The title of the document. If not provided Pure will attempt to derive it
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility" minOccurs="0">
<xs:annotation>
<xs:documentation>
The visibility of the document. Values are Public, Campus, Restricted or Confidential
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="required">
<xs:annotation>
<xs:documentation>Unique identifier for the document. Used for synchronisation purposes and not displayed in the front-end editor</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
Unique identifier for the document. Used for synchronisation purposes and not displayed in the front-end editor |
Yes |
|
type |
Use a token from classification scheme /dk/atira/pure/core/document/types. Default is other. |
No |
|
fileLocation |
Location where Pure can read the file from. Must be prefixed with protocol either http or https. Https is only supported if the remote server uses a trusted certificate. If the remote server uses a self-signed certificate, the JVM running Pure will need an updated keystore. |
Yes |
|
mimetype |
The mime type of the document. If not provided Pure will attempt to derive from the file location response |
No |
|
filename |
The file name of the document. If not provided Pure will attempt to derive from the file location |
No |
|
title |
The title of the document. If not provided Pure will attempt to derive it |
No |
|
visibility |
The visibility of the document. Values are Public, Campus, Restricted or Confidential |
No |
images
A list of image elements of type imageType
XML Example
<images xmlns="v1.externalorganisation.base-uk.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<image id="image1">
<type>funderlogo</type>
<data><!--You have a CHOICE of the next 3 items at this level-->
<http>
<url>https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/N.Tesla.JPG/800px-N.Tesla.JPG</url>
<mimeType>image/jpeg</mimeType>
<fileName>Photo.jpg</fileName>
</http>
<!--<file>-->
<!--<path>https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/N.Tesla.JPG/800px-N.Tesla.JPG</path>-->
<!--<mimeType>image/jpeg</mimeType>-->
<!--<fileName>Photo.jpg</fileName>-->
<!--</file>-->
<!--<byte>-->
<!--<base64EncodedString>base64EncodedString</base64EncodedString>-->
<!--<mimeType>image/jpeg</mimeType>-->
<!--<fileName>Photo.jpg</fileName>-->
<!--</byte>-->
</data>
</image>
</images>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="images">
<xs:sequence>
<xs:element name="image" type="imageType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>imageType
XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="imageType">
<xs:all>
<xs:element name="type" type="commons:classification">
<xs:annotation>
<xs:documentation>
The type of image. Must be a valid classification from the /dk/atira/pure/ueoexternalorganisation/ueoexternalorganisationfiles classificationscheme
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="data" type="dataType">
<xs:annotation>
<xs:documentation>
The data of the image. Can be either a link to a url of the image, a file path on the server or a byte array of the image in the xml
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="required">
<xs:annotation>
<xs:documentation>
Identifier for the image. Used to differentiate when syncing updates
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
Identifier for the image. Used to differentiate when syncing updates |
Yes |
|
type |
The type of image. Must be a valid classification from the /dk/atira/pure/ueoexternalorganisation/ueoexternalorganisationfiles classificationscheme |
Yes |
|
data |
The data of the image. Can be either a link to a url of the image, a file path on the server or a byte array of the image in the xml |
Yes |
dataType
XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="dataType">
<xs:choice>
<xs:element name="http">
<xs:annotation>
<xs:documentation>Provides a url that Pure can access the image at</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="url" type="xs:string">
<xs:annotation>
<xs:documentation>
The url path to the image. Pure must be able to access this url for the image to load
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="mimeType" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>
The mime type of the image. If not provided, Pure will attempt to derive the value
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fileName" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>
The file name of the image. If not provided, Pure will attempt to derive the value
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="file">
<xs:annotation>
<xs:documentation>Provides a path on the server that Pure can retrieve the image from</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="path" type="xs:string">
<xs:annotation>
<xs:documentation>
Path on the file server that contains the image
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="mimeType" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>
The mime type of the image. If not provided, Pure will attempt to derive the value
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fileName" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>
The file name of the image. If not provided, Pure will attempt to derive the value
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="byte">
<xs:annotation>
<xs:documentation>Provides the image as a base64 encoded string in the xml file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="base64EncodedString" type="xs:string">
<xs:annotation>
<xs:documentation>
A base 64 encoded string containing the data of the image
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="mimeType" type="commons:string_256">
<xs:annotation>
<xs:documentation>
The mime type of the image
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fileName" type="commons:string_256">
<xs:annotation>
<xs:documentation>
The file name of the image.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
http |
Provides a url that Pure can access the image at |
Contains below components |
Yes |
http.url |
The url path to the image. Pure must be able to access this url for the image to load |
xsd:string |
Yes |
http.mimeType |
The mime type of the image. If not provided, Pure will attempt to derive the value |
No |
|
http.fileName |
The file name of the image. If not provided, Pure will attempt to derive the value |
No |
|
file |
Provides a path on the server that Pure can retrieve the image from |
Contains below components |
Yes |
file.path |
Path on the file server that contains the image |
xsd:string |
Yes |
file.mimeType |
The mime type of the image. If not provided, Pure will attempt to derive the value |
No |
|
file.fileName |
The file name of the image. If not provided, Pure will attempt to derive the value |
No |
|
byte |
Provides the image as a base64 encoded string in the xml file |
Contains below components |
Yes |
byte.base64EncodedString |
A base 64 encoded string containing the data of the image |
xsd:string |
Yes |
byte.mimeType |
The mime type of the image |
Yes |
|
byte.fileName |
The file name of the image. |
Yes |
Updated at July 27, 2024