How Can We Help?
Prize XMLPrize XML
Overview
This page details the Prize content type. On this page you will find different representations of the data elements contained within this type.
Below is the xsd for the Prize 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 Prize 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.
Prizes are recognition or distinctions bestowed upon researchers.
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
Prizes
prizes
A list of prize elements of type prize
Root element of the document
XML Example
<prizes xmlns="v1.prize-sync.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<prize id="prize1" type="prize" managedInPure="false"><!-- Title of the prize -->
<title>Prize for most promising new research in the area of bio chemistry</title>
<!-- Translated titles of the prize. Only will be loaded if submission languages are configured in Pure -->
<translatedTitles>
<title lang="de">Preis für vielversprechendsten neuen Forschung auf dem Gebiet der Biochemie</title>
<title lang="dk">Pris for mest lovende ny forskning i området bio kemi</title>
</translatedTitles>
<!-- Description of the prize -->
<description>This was awarded at the Niels Bohr Institute in 2002 by Jørgen Erikson</description>
<!-- Additional descriptions. Can be used for different submission languages or alternative descriptions defined in "Prize: Descriptions" classification scheme -->
<additionalDescriptions>
<description type="additionaldescription">This was the first award for John Doe, and a total of five award were awarded during the ceremony</description>
</additionalDescriptions>
<!-- Granting organisations, can be internal or external -->
<grantingOrganisations>
<organisation lookupId="organisation1"/>
</grantingOrganisations>
<!-- Degree of Recognition must be defined in "Degree of recognition" classification scheme -->
<degreeOfRecognition>international</degreeOfRecognition>
<!-- Prize awarded date. Only year is required -->
<awardedDate>
<cmns:year>2014</cmns:year>
<cmns:month>2</cmns:month>
<cmns:day>2</cmns:day>
</awardedDate>
<!-- Receivers of the prize, can be internal or external people -->
<receiversOfPrize><!--Person can be lookedup by ID or matched to existing external person based on information provided -->
<receiverOfPrize id="reciever1">
<person lookupId="person1"/>
<organisations><!--For internal organisations can match on ID or search for existing external organisations by name. Will create if not found-->
<organisation lookupId="organisation1"/>
</organisations>
<!-- Role must be defined in "Prize person role" classification scheme -->
<personRole>recipient</personRole>
</receiverOfPrize>
<!-- External person -->
<receiverOfPrize id="reciever2">
<person lookupId="externalPerson1" origin="external">
<firstName>John</firstName>
<lastName>Doe</lastName>
</person>
<organisations><!--1 or more repetitions:-->
<organisation lookupId="externalOrganisation1" origin="external">
<name>Niels Bohr Institutet</name>
</organisation>
</organisations>
<personRole>recipient</personRole>
</receiverOfPrize>
</receiversOfPrize>
<organisations>
<organisation lookupId="organisation2"/>
<organisation origin="external">
<name>Niels Bohr Institute</name>
<country>dk</country>
<type>academic</type>
</organisation>
</organisations>
<!-- Managing Organisation -->
<managedBy lookupId="organisation1"/>
<!-- Prizes should already exist in Pure or be in same file -->
<relatedPrizes>
<relatedPrizeId>prize2</relatedPrizeId>
</relatedPrizes>
<!-- Must be defined in "Prize categories" classification scheme and related to prize type -->
<prizeCategory>scholarship</prizeCategory>
<!-- -->
<event lookupId="eventId" lookupHint="scopus">
<cmns:startDate>2022-10-23</cmns:startDate>
<cmns:title>Event Title</cmns:title>
</event>
<keywords>
<keyword>Free text keyword example</keyword>
<keyword logicalName="ASJCSubjectAreas" key="1200/1201"/>
</keywords>
<!-- Links -->
<links>
<cmns:link id="link1">
<cmns:url>http:\\www.google.dk</cmns:url>
<!-- Type must be defined in "Types of links for Prizes" Classification scheme-->
<cmns:type>unspecified</cmns:type>
</cmns:link>
</links>
<!-- Documents -->
<documents>
<document id="doc1">
<title>Emblem</title>
<fileLocation>http://f4.bcbits.com/img/a0824248102_16.jpg</fileLocation>
<fileName>test.jpg</fileName>
<!-- Type must be defined in "Types for documents" classification scheme-->
<type>text</type>
<mimeType>image/jpeg</mimeType>
<license>cc-by</license>
<visibility>Restricted</visibility>
</document>
</documents>
<!-- Values are Public, Campus or Restricted-->
<visibility>Public</visibility>
<!-- Values are entryInProgress, forValidation and validated-->
<workflow>validated</workflow>
<comments>
<cmns:comment>
<cmns:date>12-10-2012</cmns:date>
<cmns:username>bob</cmns:username>
<cmns:text>This is an example comment that would be stored with the record</cmns:text>
</cmns:comment>
</comments>
<!-- Additional ids for the prize -->
<ids><!-- ID type must be defined in "Prizes: IDs" classification scheme-->
<cmns:id type="internalid">prize1_scopus</cmns:id>
</ids>
</prize>
<prize id="prize2" type="prize"><!-- Title of the prize -->
<title>Prize for most promising new research in the area of bio chemistry</title>
<!-- Receivers of the prize -->
<receiversOfPrize>
<receiverOfPrize id="reciever1">
<person lookupId="person1"/>
<organisations>
<organisation lookupId="organisation1"/>
</organisations>
<personRole>recipient</personRole>
</receiverOfPrize>
</receiversOfPrize>
<managedBy lookupId="organisation1"/>
<!-- Prize awarded date -->
<awardedDate>
<cmns:year>2014</cmns:year>
</awardedDate>
<visibility>Public</visibility>
</prize>
</prizes>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="prizes">
<xs:annotation>
<xs:documentation>Root element of the document</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="prize" 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>prize
For each prize to be created in Pure there should be a new instance of this element in the xml
XML Example
<prize xmlns="v1.prize-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="prize1"
type="prize"
managedInPure="false"><!-- Title of the prize -->
<title>Prize for most promising new research in the area of bio chemistry</title>
<!-- Translated titles of the prize. Only will be loaded if submission languages are configured in Pure -->
<translatedTitles>
<title lang="de">Preis für vielversprechendsten neuen Forschung auf dem Gebiet der Biochemie</title>
<title lang="dk">Pris for mest lovende ny forskning i området bio kemi</title>
</translatedTitles>
<!-- Description of the prize -->
<description>This was awarded at the Niels Bohr Institute in 2002 by Jørgen Erikson</description>
<!-- Additional descriptions. Can be used for different submission languages or alternative descriptions defined in "Prize: Descriptions" classification scheme -->
<additionalDescriptions>
<description type="additionaldescription">This was the first award for John Doe, and a total of five award were awarded during the ceremony</description>
</additionalDescriptions>
<!-- Granting organisations, can be internal or external -->
<grantingOrganisations>
<organisation lookupId="organisation1"/>
</grantingOrganisations>
<!-- Degree of Recognition must be defined in "Degree of recognition" classification scheme -->
<degreeOfRecognition>international</degreeOfRecognition>
<!-- Prize awarded date. Only year is required -->
<awardedDate>
<cmns:year>2014</cmns:year>
<cmns:month>2</cmns:month>
<cmns:day>2</cmns:day>
</awardedDate>
<!-- Receivers of the prize, can be internal or external people -->
<receiversOfPrize><!--Person can be lookedup by ID or matched to existing external person based on information provided -->
<receiverOfPrize id="reciever1">
<person lookupId="person1"/>
<organisations><!--For internal organisations can match on ID or search for existing external organisations by name. Will create if not found-->
<organisation lookupId="organisation1"/>
</organisations>
<!-- Role must be defined in "Prize person role" classification scheme -->
<personRole>recipient</personRole>
</receiverOfPrize>
<!-- External person -->
<receiverOfPrize id="reciever2">
<person lookupId="externalPerson1" origin="external">
<firstName>John</firstName>
<lastName>Doe</lastName>
</person>
<organisations><!--1 or more repetitions:-->
<organisation lookupId="externalOrganisation1" origin="external">
<name>Niels Bohr Institutet</name>
</organisation>
</organisations>
<personRole>recipient</personRole>
</receiverOfPrize>
</receiversOfPrize>
<organisations>
<organisation lookupId="organisation2"/>
<organisation origin="external">
<name>Niels Bohr Institute</name>
<country>dk</country>
<type>academic</type>
</organisation>
</organisations>
<!-- Managing Organisation -->
<managedBy lookupId="organisation1"/>
<!-- Prizes should already exist in Pure or be in same file -->
<relatedPrizes>
<relatedPrizeId>prize2</relatedPrizeId>
</relatedPrizes>
<!-- Must be defined in "Prize categories" classification scheme and related to prize type -->
<prizeCategory>scholarship</prizeCategory>
<!-- -->
<event lookupId="eventId" lookupHint="scopus">
<cmns:startDate>2022-10-23</cmns:startDate>
<cmns:title>Event Title</cmns:title>
</event>
<keywords>
<keyword>Free text keyword example</keyword>
<keyword logicalName="ASJCSubjectAreas" key="1200/1201"/>
</keywords>
<!-- Links -->
<links>
<cmns:link id="link1">
<cmns:url>http:\\www.google.dk</cmns:url>
<!-- Type must be defined in "Types of links for Prizes" Classification scheme-->
<cmns:type>unspecified</cmns:type>
</cmns:link>
</links>
<!-- Documents -->
<documents>
<document id="doc1">
<title>Emblem</title>
<fileLocation>http://f4.bcbits.com/img/a0824248102_16.jpg</fileLocation>
<fileName>test.jpg</fileName>
<!-- Type must be defined in "Types for documents" classification scheme-->
<type>text</type>
<mimeType>image/jpeg</mimeType>
<license>cc-by</license>
<visibility>Restricted</visibility>
</document>
</documents>
<!-- Values are Public, Campus or Restricted-->
<visibility>Public</visibility>
<!-- Values are entryInProgress, forValidation and validated-->
<workflow>validated</workflow>
<comments>
<cmns:comment>
<cmns:date>12-10-2012</cmns:date>
<cmns:username>bob</cmns:username>
<cmns:text>This is an example comment that would be stored with the record</cmns:text>
</cmns:comment>
</comments>
<!-- Additional ids for the prize -->
<ids><!-- ID type must be defined in "Prizes: IDs" classification scheme-->
<cmns:id type="internalid">prize1_scopus</cmns:id>
</ids>
</prize>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="prizeType">
<xs:annotation>
<xs:documentation>For each prize to be created in Pure there should be a new instance of this element in the xml</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="title" type="commons:string_1024">
<xs:annotation>
<xs:documentation>The title of the prize</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="translatedTitles" type="translatedTitles" minOccurs="0">
<xs:annotation>
<xs:documentation>Translated titles of the prize. Use if the title is different in another language</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="description" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>The description of the prize. This will add a description of the type /dk/atira/pure/prize/descriptions/prizedescription</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="additionalDescriptions" type="descriptions" minOccurs="0">
<xs:annotation>
<xs:documentation>Descriptions of the prize. Use if description is different in another language, or for other description types defined in /dk/atira/pure/prize/descriptions classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="degreeOfRecognition"
type="commons:classification"
minOccurs="0">
<xs:annotation>
<xs:documentation>Degree of recognition classification. Must be a token from the classification scheme /dk/atira/pure/prize/degreeofrecognition</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="grantingOrganisations" type="organisations" minOccurs="0">
<xs:annotation>
<xs:documentation>Internal or External Organisations who bestowed the prize</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="awardedDate" type="commons:compoundDate" minOccurs="1">
<xs:annotation>
<xs:documentation>Date that prize was awared. Can be just a year or year and month rather than full date</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="receiversOfPrize" minOccurs="1">
<xs:annotation>
<xs:documentation>Internal or external persons who recieved the prize</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="organisations" type="organisations" minOccurs="0">
<xs:annotation>
<xs:documentation>The internal or external organisations that are related to the prize</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="managedBy" type="managedBy" minOccurs="1">
<xs:annotation>
<xs:documentation>The internal organisation responsible for managing the award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="relatedPrizes" minOccurs="0">
<xs:annotation>
<xs:documentation>IDs of related prizes. These must already exist in Pure or be in the same xml file</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="prizeCategory" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>Prize category classification. Must be a token from the classification scheme /dk/atira/pure/prize/category</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="event" type="commons:simpleEvent" minOccurs="0">
<xs:annotation>
<xs:documentation>
Details of the event the prize is related to
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="keywords" type="keywords" minOccurs="0">
<xs:annotation>
<xs:documentation>Keywords of the prize. Must be align with the defined keywords against the prize content type</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="links" type="commons:links" minOccurs="0">
<xs:annotation>
<xs:documentation>Links to websites related to the prize. Type must be defined in the /dk/atira/pure/links/prize classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="documents" type="documents" minOccurs="0">
<xs:annotation>
<xs:documentation>The documents related to the prize. Type must be defined in /dk/atira/pure/core/document/types classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility">
<xs:annotation>
<xs:documentation>Visibility of the prize. Valid values are Public, Campus and Confidential</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 prize (Workflow states: entryInProgress, forValidation, validated)
Note that workflow is disabled by default, and must be enabled in Pure, if values are present in this tag
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="comments" type="commons:comments" minOccurs="0">
<xs:annotation>
<xs:documentation>Comments related to the record</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ids" type="commons:ids" minOccurs="0">
<xs:annotation>
<xs:documentation>Type attribute must be a token from the classification scheme /dk/atira/pure/prize/prizesources</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="required">
<xs:annotation>
<xs:documentation>
Id of the prize. This would be the id from an external source.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="type" type="commons:classification" use="required">
<xs:annotation>
<xs:documentation>The prize type. Must be a valid classification from the /dk/atira/pure/prize/prizetypes classification scheme</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:boolean" name="managedInPure" use="optional">
<xs:annotation>
<xs:documentation>Determines whether the prize is managed in Pure, if set to to true the prize will be fully editable and deletable in Pure</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
Id of the prize. This would be the id from an external source. |
Yes |
|
@type |
The prize type. Must be a valid classification from the /dk/atira/pure/prize/prizetypes classification scheme |
Yes |
|
@managedInPure |
Determines whether the prize is managed in Pure, if set to to true the prize will be fully editable and deletable in Pure |
xsd:boolean |
Yes |
title |
The title of the prize |
Yes |
|
translatedTitles |
Translated titles of the prize. Use if the title is different in another language |
No |
|
description |
The description of the prize. This will add a description of the type /dk/atira/pure/prize/descriptions/prizedescription |
xsd:string |
No |
additionalDescriptions |
Descriptions of the prize. Use if description is different in another language, or for other description types defined in /dk/atira/pure/prize/descriptions classification scheme |
No |
|
degreeOfRecognition |
Degree of recognition classification. Must be a token from the classification scheme /dk/atira/pure/prize/degreeofrecognition |
No |
|
grantingOrganisations |
Internal or External Organisations who bestowed the prize |
No |
|
awardedDate |
Date that prize was awared. Can be just a year or year and month rather than full date |
Yes |
|
receiversOfPrize |
Internal or external persons who recieved the prize |
Yes |
|
organisations |
The internal or external organisations that are related to the prize |
No |
|
managedBy |
The internal organisation responsible for managing the award |
Yes |
|
relatedPrizes |
IDs of related prizes. These must already exist in Pure or be in the same xml file |
No |
|
prizeCategory |
Prize category classification. Must be a token from the classification scheme /dk/atira/pure/prize/category |
No |
|
event |
Details of the event the prize is related to |
No |
|
keywords |
Keywords of the prize. Must be align with the defined keywords against the prize content type |
No |
|
links |
Links to websites related to the prize. Type must be defined in the /dk/atira/pure/links/prize classification scheme |
No |
|
documents |
The documents related to the prize. Type must be defined in /dk/atira/pure/core/document/types classification scheme |
No |
|
visibility |
Visibility of the prize. Valid values are Public, Campus and Confidential |
Yes |
|
workflow |
Used to set the workflow state of the prize (Workflow states: entryInProgress, forValidation, validated) Note that workflow is disabled by default, and must be enabled in Pure, if values are present in this tag |
xsd:string |
No |
comments |
Comments related to the record |
No |
|
ids |
Type attribute must be a token from the classification scheme /dk/atira/pure/prize/prizesources |
No |
Translations and Descriptions
translatedTitles
A list of title elements of type commons:localized_text_1024_lang
XML Example
<translatedTitles xmlns="v1.prize-sync.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<title lang="de">Preis für vielversprechendsten neuen Forschung auf dem Gebiet der Biochemie</title>
<title lang="dk">Pris for mest lovende ny forskning i området bio kemi</title>
</translatedTitles>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="translatedTitles">
<xs:sequence>
<xs:element name="title"
type="commons:localized_text_1024_lang"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Translated title of the prize. Can be specified in multiple languages, if your Pure is multilingual</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
title |
Translated title of the prize. Can be specified in multiple languages, if your Pure is multilingual |
Yes |
descriptions
A list of description elements of type description
XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="descriptions">
<xs:sequence>
<xs:element name="description" type="description" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>description
A free text description of the prize. Can be specified in multiple languages if your Pure is configured for multiple submission languages
XML Example
<description xmlns="v1.prize-sync.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">This was awarded at the Niels Bohr Institute in 2002 by Jørgen Erikson</description>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="description">
<xs:annotation>
<xs:documentation>A free text description of the prize. Can be specified in multiple languages if your Pure is configured for multiple submission languages</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="commons:localized_text_lang">
<xs:attribute name="type" type="commons:classification" use="required">
<xs:annotation>
<xs:documentation>The prize description type. Must be a valid classification from the /dk/atira/pure/prize/descriptions classification scheme</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@type |
The prize description type. Must be a valid classification from the /dk/atira/pure/prize/descriptions classification scheme |
Yes |
Prize Recipients
receiversOfPrize
A list of receiverOfPrize elements of type receiverOfPrize
XML Example
<receiversOfPrize xmlns="v1.prize-sync.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!--Person can be lookedup by ID or matched to existing external person based on information provided -->
<receiverOfPrize id="reciever1">
<person lookupId="person1"/>
<organisations><!--For internal organisations can match on ID or search for existing external organisations by name. Will create if not found-->
<organisation lookupId="organisation1"/>
</organisations>
<!-- Role must be defined in "Prize person role" classification scheme -->
<personRole>recipient</personRole>
</receiverOfPrize>
<!-- External person -->
<receiverOfPrize id="reciever2">
<person lookupId="externalPerson1" origin="external">
<firstName>John</firstName>
<lastName>Doe</lastName>
</person>
<organisations><!--1 or more repetitions:-->
<organisation lookupId="externalOrganisation1" origin="external">
<name>Niels Bohr Institutet</name>
</organisation>
</organisations>
<personRole>recipient</personRole>
</receiverOfPrize>
</receiversOfPrize>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="receiversOfPrize">
<xs:complexType>
<xs:sequence>
<xs:element ref="receiverOfPrize" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>receiverOfPrize
An internal or external person who recieved the prize
XML Example
<receiverOfPrize xmlns="v1.prize-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="reciever1">
<person lookupId="person1"/>
<organisations><!--For internal organisations can match on ID or search for existing external organisations by name. Will create if not found-->
<organisation lookupId="organisation1"/>
</organisations>
<!-- Role must be defined in "Prize person role" classification scheme -->
<personRole>recipient</personRole>
</receiverOfPrize>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="receiverOfPrize">
<xs:annotation>
<xs:documentation>An internal or external person who recieved the prize</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element name="person" type="person" minOccurs="0">
<xs:annotation>
<xs:documentation>Can be an internal or external person</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="organisations" type="organisations" minOccurs="0">
<xs:annotation>
<xs:documentation>Internal or external organisations that are affiliated with the recipient at the time of bestowal</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="firstName" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>
First name of the person at the time of bestowal. If not populated will reference details of the person record directly
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="lastName" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>
Last name of the person at the time of bestowal. If not populated will reference details of the person record directly
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="personRole" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>The role of the person on the prize. Must be a valid classification from the /dk/atira/pure/prize/personrole classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="required">
<xs:annotation>
<xs:documentation>The ID of this receiver relation</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
The ID of this receiver relation |
Yes |
|
person |
Can be an internal or external person |
No |
|
organisations |
Internal or external organisations that are affiliated with the recipient at the time of bestowal |
No |
|
firstName |
First name of the person at the time of bestowal. If not populated will reference details of the person record directly |
No |
|
lastName |
Last name of the person at the time of bestowal. If not populated will reference details of the person record directly |
No |
|
personRole |
The role of the person on the prize. Must be a valid classification from the /dk/atira/pure/prize/personrole classification scheme |
No |
relatedPrizes
A list of relatedPrizeId elements of type commons:string_400
XML Example
<relatedPrizes xmlns="v1.prize-sync.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<relatedPrizeId>prize2</relatedPrizeId>
</relatedPrizes>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="relatedPrizes">
<xs:complexType>
<xs:sequence>
<xs:element name="relatedPrizeId"
type="commons:string_400"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
The ID of any related prizes. Must already exist in Pure or be seperate entries in this xml
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>person
Can be an internal or external person. Use origin to enforce either internal or external
If the person is an internal person in Pure, then the lookupId attribute must be used.
If the person is an external person, and id is given, matching will be done on the id. If not found, then matching will be done on name. If still not found, then an external person with the specified id and name will be created.
XML Example
<person xmlns="v1.prize-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
lookupId="person1"/>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="person">
<xs:annotation>
<xs:documentation>
Can be an internal or external person. Use origin to enforce either internal or external
If the person is an internal person in Pure, then the lookupId attribute must be used.
If the person is an external person, and id is given, matching will be done on the id. If not found, then matching will be done on name. If still not found, then an external person with the specified id and name will be created.
</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="firstName" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>First name of the person. Will only be used on external persons</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="lastName" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Last name of the person. Will only be used on external persons</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="country" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>token from the classification scheme /dk/atira/pure/core/countries</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attributeGroup ref="commons:originId">
<xs:annotation>
<xs:documentation>The ID of the person used to lookup for existing records. Origin can be used to indicate if it is an internal or external person</xs:documentation>
</xs:annotation>
</xs:attributeGroup>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@commons:originId |
The ID of the person used to lookup for existing records. Origin can be used to indicate if it is an internal or external person |
Yes |
|
firstName |
First name of the person. Will only be used on external persons |
No |
|
lastName |
Last name of the person. Will only be used on external persons |
No |
|
country |
token from the classification scheme /dk/atira/pure/core/countries |
No |
organisations
A list of organisation elements of type organisation
XML Example
<organisations xmlns="v1.prize-sync.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!--For internal organisations can match on ID or search for existing external organisations by name. Will create if not found-->
<organisation lookupId="organisation1"/>
</organisations>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="organisations">
<xs:sequence>
<xs:element name="organisation" type="organisation" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>organisation
Can be either an internal or an external organisation, indicated with the 'origin' attribute.
If the organisation is an internal organisation in Pure, only the lookupId attribute is used.
If the organisation is an external organisation and ID is given, matching will be done on the ID. If no match is found, matching will be done on name. If still no match is found, an external organisation will be created, using the available data. (TODO is this true)
XML Example
<organisation xmlns="v1.prize-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
lookupId="organisation1"/>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="organisation">
<xs:annotation>
<xs:documentation>
Can be either an internal or an external organisation, indicated with the 'origin' attribute.
If the organisation is an internal organisation in Pure, only the lookupId attribute is used.
If the organisation is an external organisation and ID is given, matching will be done on the ID. If no match is found, matching will be done on name. If still no match is found, an external organisation will be created, using the available data. (TODO is this true)
</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="name" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Name of an external organisation</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="country" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>The country of the external organisation. Token from /dk/atira/pure/core/countries</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="type" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>The type of the external organisation (will default if nothing is written)</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attributeGroup ref="commons:originId">
<xs:annotation>
<xs:documentation>The ID of the organisation used to lookup for existing records. Origin can be used to indicate if it is an internal or external organisation</xs:documentation>
</xs:annotation>
</xs:attributeGroup>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@commons:originId |
The ID of the organisation used to lookup for existing records. Origin can be used to indicate if it is an internal or external organisation |
Yes |
|
name |
Name of an external organisation |
No |
|
country |
The country of the external organisation. Token from /dk/atira/pure/core/countries |
No |
|
type |
The type of the external organisation (will default if nothing is written) |
No |
id
XSD Definition
<xs:attributeGroup xmlns:xs="http://www.w3.org/2001/XMLSchema" name="id">
<xs:attribute name="id" type="commons:string_400" use="optional">
<xs:annotation>
<xs:documentation>
ID of the external entity. If it is not found in Pure, an element with this ID will be created for
most types
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="source" type="commons:string_400" use="optional">
<xs:annotation>
<xs:documentation>
Source can be used to hint to Pure, when there are two entities that match during the ID search,
which one to prefer.
i.e. organisation A has a synchronised ID "1234" and organisation B was created by pure using ID
1234. This would cause both to match, and the source can be used to hint the correct one
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
ID of the external entity. If it is not found in Pure, an element with this ID will be created for most types |
Yes |
|
@source |
Source can be used to hint to Pure, when there are two entities that match during the ID search, which one to prefer. i.e. organisation A has a synchronised ID "1234" and organisation B was created by pure using ID 1234. This would cause both to match, and the source can be used to hint the correct one |
Yes |
Keywords
keywords
A list of keyword elements of type commons:keyword
XML Example
<keywords xmlns="v1.prize-sync.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<keyword>Free text keyword example</keyword>
<keyword logicalName="ASJCSubjectAreas" key="1200/1201"/>
</keywords>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="keywords">
<xs:sequence>
<xs:element name="keyword" type="commons:keyword" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Keyword related to the prize. Must align with keywords defined for the content type Prize</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
keyword |
Keyword related to the prize. Must align with keywords defined for the content type Prize |
Yes |
Managed By
managedBy
XML Example
<managedBy xmlns="v1.prize-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
lookupId="organisation1"/>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="managedBy">
<xs:attributeGroup ref="commons:lookupId">
<xs:annotation>
<xs:documentation>The ID of an internal organisation that is responsible for managing the content</xs:documentation>
</xs:annotation>
</xs:attributeGroup>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@commons:lookupId |
The ID of an internal organisation that is responsible for managing the content |
Yes |
Documents
documents
A list of document elements of type document
XML Example
<documents xmlns="v1.prize-sync.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<document id="doc1">
<title>Emblem</title>
<fileLocation>http://f4.bcbits.com/img/a0824248102_16.jpg</fileLocation>
<fileName>test.jpg</fileName>
<!-- Type must be defined in "Types for documents" classification scheme-->
<type>text</type>
<mimeType>image/jpeg</mimeType>
<license>cc-by</license>
<visibility>Restricted</visibility>
</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.prize-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="doc1">
<title>Emblem</title>
<fileLocation>http://f4.bcbits.com/img/a0824248102_16.jpg</fileLocation>
<fileName>test.jpg</fileName>
<!-- Type must be defined in "Types for documents" classification scheme-->
<type>text</type>
<mimeType>image/jpeg</mimeType>
<license>cc-by</license>
<visibility>Restricted</visibility>
</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>A token from classification scheme /dk/atira/pure/core/document/types</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>Mimetype of the document. If not provided will be derived</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fileName" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>Filename of the document. If not provided will be derived</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="title" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Title of the document. If not provided will be derived</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="license" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>
Token from the classification scheme /dk/atira/pure/core/document/licenses
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility" minOccurs="0">
<xs:annotation>
<xs:documentation>Visibility of the document</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="required">
<xs:annotation>
<xs:documentation>ID of the document for synchronisation purposes</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
ID of the document for synchronisation purposes |
Yes |
|
type |
A token from classification scheme /dk/atira/pure/core/document/types |
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 |
Mimetype of the document. If not provided will be derived |
No |
|
fileName |
Filename of the document. If not provided will be derived |
No |
|
title |
Title of the document. If not provided will be derived |
No |
|
license |
Token from the classification scheme /dk/atira/pure/core/document/licenses |
No |
|
visibility |
Visibility of the document |
No |
Published at December 26, 2023