New Admins: Register for our new Pure Lecture Series!
Pure's logos
Pure Help Center for Pure Administrators

If you are a researcher, or other non-admin at your institution, click here.

  • Home
  • Announcements
  • Release Notes
  • Technical user guides
  • Training
  • Events
  • Support
  • Contact Us
  • Home
  • Training
  • Technical user guides
  • Integrations
  • Synchronizations
  • Content Type XML Documentation
  • Master Data Types

How Can We Help?

Search Results

Filter By Category

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Contact us

Person XMLPerson XML

Overview

This page details the Person content type. On this page you will find different representations of the data elements contained within this type.

Below is the xsd for the Person 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 Person 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 Person content type represents a person who has relationships with specific organisation units at your institution (e.g. an "internal" person). For each person you need to have a person element with metadata about the person and at least one organisation affiliation element, which can be for either a staff, student, honorary or visitor relationship. A person can have multiple relationships and of different types (for example the same person can have be a student studying a PhD and a staff member working as part of a research team).

Below files are available for your download at Pure: 

  • 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


Persons

persons

A list of person elements of type person 
Root element of the xml document.

XML Example

<persons xmlns="v1.unified-person-sync.pure.atira.dk"
                 xmlns:cmns="v3.commons.pure.atira.dk"><!--These first two lines should always be included in the xml as they appear above. A full set of records with each data load, not a delta set.  If a record is removed from the XML that person will appear Former in Pure-->
           <person id="person1" managedInPure="false"><!--There are many IDs required in the Pure XML.  They can be alpha numeric and need to be unique.  These IDs should not change with subsequent data loads as Pure will view them as new records and create duplicates.-->
              <name>
                 <cmns:firstname>John</cmns:firstname>
                 <cmns:lastname>Doe</cmns:lastname>
              </name>
              <names><!-- IDs like this need to be unique for the person, but not for all people in Pure. They are used to definitively identify the entry, so if the type or value is changed, then the existing entry will be updated, not a new one created -->
                 <classifiedName id="classifiedAssoc1">
                    <name>
                       <cmns:firstname>Johnny</cmns:firstname>
                       <cmns:lastname>Doe</cmns:lastname>
                    </name>
                    <typeClassification>knownas</typeClassification>
                 </classifiedName>
              </names>
              <titles>
                 <title id="titleAssoc1">
                    <typeClassification>honorary</typeClassification>
                    <value>
                       <cmns:text lang="en" country="GB">Professor</cmns:text>
                    </value>
                 </title>
              </titles>
              <gender>male</gender>
              <!-- Dates should be formatted DD-MM-YYYY -->
              <dateOfBirth>17-04-1971</dateOfBirth>
              <nationality>GB</nationality>
              <employeeStartDate>06-12-2001</employeeStartDate>
              <systemLeavingDate>21-08-2007</systemLeavingDate>
              <academicProfessionEntry>06-02-2006</academicProfessionEntry>
              <retiralDate>05-05-2009</retiralDate>
              <privateAddress>
                 <cmns:country>GB</cmns:country>
                 <cmns:road>Brewery Street 21</cmns:road>
                 <cmns:room>5B</cmns:room>
                 <cmns:city>Glastonbury</cmns:city>
                 <cmns:building>The old brewery</cmns:building>
                 <cmns:postalCode>SW1V 4NP</cmns:postalCode>
              </privateAddress>
              <expert>true</expert>
              <leavesOfAbsence>
                 <leaveOfAbsence id="leaveAssoc1">
                    <classification>other</classification>
                    <startDate>02-04-2003</startDate>
                    <endDate>02-10-2003</endDate>
                 </leaveOfAbsence>
              </leavesOfAbsence>
              <willingnessToPhd>true</willingnessToPhd>
              <photos>
                 <personPhoto id="personPhotoAssoc1">
                    <classification>portrait</classification>
                    <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>
                          <!--Optional:-->
                          <mimeType>image/png</mimeType>
                          <!--Optional:-->
                          <fileName>portrait.png</fileName>
                       </http>
                       <!--<file>
                                <path>c:\data\photo1.jpg/path>
                                Optional:
                                <mimeType>image/png</mimeType>
                                Optional:
                                <fileName>portrait.png</fileName>
                            </file>-->
                       <!--<byte>
                                <base64EncodedString>iVBORw0KGgoAAAANSUhEUgAAAaUAAAA6CAYAAAAQlUaMAAAABmJLR0QAAAAAAAD5Q7t/AAAACXBIWXMAAC4jAAAuIwF4pT92AAALK0lEQVR42u1dPdJeNQ99t5AtZAvZQraQLaSiJi1lqKlSUDOTipq0lBlaqhTUzKSjfuCEMXNx5HslW5JlXxWe+b7hzXP9I58jH8ny0+PxeArZvnv+6fHNP/+ztN8/vAzb153b7utwHFvaWTat9sPLD/+zq5/fvM154bWYHfvj44sEC4OGOazbn5+eN/8e/23ndcBY0s6yeTg7SUoCUvr13esvE0a1X96+IYHMuuHbWmABYG2ND+2396/E/TubsyjGV8b946v3j2+fff5qPuv2/YuPj59ev/uy5nAK8BsYp9Y6nM3XLDvDeKXjOxtHaZi3+luwM86/RTtzFEq7skE0al+d/W3P/und39J+9M7DDLuCPWuSkvfeKft/GinVx8yorRcMKW/Yus0kI2xSjTWFbAei0lqHFWyMM74otq69b1ug6b1/pOC9Cn6NkNKsPgMDML/Fef/r87MkpSQlmeTpsZZJSklKSUr3IKWWooLTmSFBJSntQEqUzJaklKSUpJSkZNUQEsCYDMjpXw+b0nqx2GiUhLMSKWHSqFgQ4glljHWGGedIW461VGwqIiFhvOhjHa8o84MxcNZ6xDnYwc7qMZT+98giRxs6xgY4G73s22OsCvHDq/4ATPDf8bfH77biWK39w/kW1cq/aY2dE0+j5qFlV1FIa4SUWnHJHvyyICf0yz37jko8sDwhaIKhpseFv4mUqQJj4PRZstGxyakEAI918LQzKrNwZHxUxmirSYG3p7XW0CKIzT1Nzcps9O4fRRLWCVCj+FWcDzgI3OQoo/HFJCXNAPuupAQjujIcAJNmWv5OpIRGzd/I+LinPWx8a/ugxob+7QD60fsHUF+NlCh8gZ1KTmEjeBOelKhFTVLiecJHichiTnYiJe3xUanArWDxjBO0FRkmKV3b8WqkdCQnCo8NHa6YYKF5T2lHUoKhXPUV+v9q67C6nbUkQW8Jr+WwWH0zSenaKViVlLhOsKJEHBMsZty0X4mUOMkNGlkxmpdnI9oZdbIZHV8ECc9TuktS4knfq5OSxLYHZbyYYDGjvM1KpHR1nNaQ7maUe9rB+Zkt4XlLd0lKMcoMeeAXdx7hFA04xTHBYkahzJVI6aqvmv3cmZQsxieR8CwuILZkFsvb+ElK13t0B1JyUgLigkU9yUlK/Mt0Wicl73WYYWcWVdC5gWGNuB9HukN/dgP96P2rnYNdSIm7RwfGGxcsop0+ViIlzaB2fWHPMkC/i51xLzRrk0VLurMgvySle+IXdy4HvpWktCsprVgqfxc742RHWshqrfmzLqSZpJSklKR0c1Li6LqDwcYkpQUlPOqio7V0l6R0P/xKUkpS6ga8aGWR7mRn3hJeqwKHtXSXpJQnpSSlJCV22rFi6Y8kJYMyUJryGjV3+H6CfpLSDFIawJ0kpRVJSZJ2XO7ErCDl7WZn3FvwGqcZSrrzckiSlO6DX9w9OmDTMcAiAvCvVvtOWpIfXnP0TbebnXGquGtIeC3pTvlJgSQlZox3Z/zi3lNa+vJs7fUnKdmclo7ec9RTk6Wd1cDktZYeEt5M6S5J6SnEST5SRYflywzNAovVSUmyLhRgeQTAI5FSnXjgtZYeEt5M6e7upESdUnfFL843gC2Ddxnng0X920lKNsfpVqwpkqS3o51ZS3gt6c7iMb8kJd767ohfDrGkOKRUe5JJSvIsr9GnxAGIHq+hzrSzen0915L7UFqPhEfNmWaZqSQl+fzvhl/cfbnNI38zwWIHUtIiplIFYma8ydLO6tiO51paepkznt5OUjq/M7gLfmE+uAlVYZ9D12hJSv3EJM3IaxVz9crauoudtSS2UQkvgnS3EylptVXxCxiCucI+5Dq5cPaU8SJJaRdS0l4rAKT3qWlnO7OQ8CJId0lK65CSZgMZGSkrCRa7kVLxoDXkPACcp9e9s51ZSHgRpLskpXuREmzOWOZPsNiRlI7rxr0n4/3uz93sTFvCa/3ejISVJKV7kJITDuiCBRZf2mqPPklJ/5It967MbIO0tLMIa6l5G56aK6sn1u9CSqgpOYpfO5OSR8X5ENl3dfZKkpLdxhw1XGti2j3Lk1tIlzPPFBgOPEGdpHSDlPByL7FuEoXCIQkqL8/ehZSOlQ1GJD3LGNPu9+G4paGuPNLW78y6a3ZnUqKeKFkRvyTZdsYJUPPBor4RnaTkkz7eG7+xzO6ytLP6lDJrLTUkPOrENdM270xK1G+viF+SuJuxjDcfLOqAbZJS/Cw9qwyvO9RY1JDwqDWbWcswC7LucU8piIw3HyzqRU1Sin+3yaoCtaWd4eQRYS1HJbzWv59ZiSOfrtjj6QrYEPc+nULh1dikdAy6ed9GT1Jqa+PentId7KxVmoZLNNRJyykrKknpRHE42tbK+CWR8YzwMAZYRGizSKnOhFmFmCyeRriDnUnmmZLkokl3SUr74ZdEOTGQ8hMsZpOSdA7Rh9IsYjvctbZIeLgLKdVSIlfCo6Q7h2yoJKWb4ZdExjPIyF0HLKyPyDNIqSdzxyO2w73PtCspeZxeeyQ8SrrzfMwvSUkPv7QdCW38ksh4IDDF8awDFvXdmh1IqeeOlkeAmysv7UpKHt/rkfAo6W5WRfckpbFkCO1vWeCXRMZTjGuuARYeTw7PIKWeKgNeG+mupFTfm7M6jcKZ4FxiLpu9Jd1FqRaSpCSTa7Uz1yzwSyrjKVUUWQMs6u9bxDNmkFLP73uVluHMx46k5FlhhFuTEOAQVbpLUpI7Ois51dJitgrxpTXAwqNumTcpUYbKOQJ7AdNdScmzQDBlAy0JL6p0l6Qkdz4sTrgRnkNXSryJDxbU0dfiXoY3KVFzysmm86oMfTUfFmA9m5Qoicz6fSKOhEcR0ozH/JKU+lotga3oVEsqvwxiUnywoALCFkDhTUq9D7R53eZ30o9DkRIlkVmTUu+zIjMe80tS0omHr0hKGIekkPOAghMfLKjJXp2UWpukl5S0JTyOrGRRYmQ2Kc24mMqV8DyrtScp2Todq+IXt27joOMaGyxadb4stHRPUmp5xxwAPPNMtE5MM6S72aTUAi4PIJVkOEWT7pKU5BmWKzvV3Pt1A05dbLBoTcDKl2fPnsXmjIvziJe1524FLtFO5F5AKi2IG0m6S1KSr6uF9O2FX9yrDAPzqrtpNBf17KhoIV1wX24cPfmdBQxHSel4auqR1/D9K4OzBESunWnH0M5szQM0zxyVSI/57U5KmgrM2TdXr0gjTRMHpggw+5oV0QFuMBYnGwALFlf61j2Oefi3+NaVnGFR/oObXYI+SsZY/p5jNFqkdCQnzkYDyHEIAXNkkVThaWczbU1DwrPKthwBKG6sAX/nTUyS/mFuYRewD6lNwRbLXr/CEs05wN7l4ldRUjScmp7nbpjE9PTfBi1FPnseffNu0kUrAFTGKNXwvRoH8Ht+FwZRA/lx3bkbdoSQjuS8ip15xm64m9zqsvQZqKNvsJ+ydppzXBcYlgJ2jV/a/ZuNX9Te0cQv7MPe+e/dw+g/vlcw6StSWmERR46g0qNmdGOl5sOaZGE4oyeklWxsxvtZXAnPW7qTesQatmZRPHhlUoo6/7BFaXyJMR9JSquTUvGc4TFqkxN+T0tqWJGUvB/Pu/I8Z0h3SUrzT9+R51/6OOiWpCS9k7M7KdU6Lf4/DGvEg8Eca2v/K5KSd5bbVezDW7pLUopx+o5u870XwJukVL/zEelSnmYQ/diiZS/1GuhVDS2Ms9bcz7RdyyB0vQa72ZlW0LrED6g24zG/Eki32jujv1/j18oP9c1436vGRytspNapMZ4EgtXaEaRmP4OdLVu2bMrtb/rmDTutlLmzAAAAAElFTkSuQmCC</base64EncodedString>
                                <mimeType>image/png</mimeType>
                                <fileName>portrait.png</fileName>
                            </byte>-->
                    </data>
                 </personPhoto>
              </photos>
              <phdResearchProjects>Tesla Coil</phdResearchProjects>
              <organisationAssociations><!-- At least one organisation association is required, but it can be any of the four types -->
                 <staffOrganisationAssociation id="staffAssoc1" managedInPure="false">
                    <affiliationId>affilID1</affiliationId>
                    <addresses>
                       <cmns:classifiedAddress id="staffAssoc1ClassifiedAddressAssoc1">
                          <cmns:addressType>visiting</cmns:addressType>
                          <cmns:city>London</cmns:city>
                          <cmns:postalCode>SW1V 4NP</cmns:postalCode>
                          <cmns:street>Wayne Street</cmns:street>
                          <cmns:country>GB</cmns:country>
                          <cmns:building>21</cmns:building>
                          <cmns:displayFormat>
                                    London
                                    Wayne Street
                                    England
                                    SW1V 4NP
                                </cmns:displayFormat>
                          <cmns:subDivision>us/ak</cmns:subDivision>
                          <cmns:geoLocation>
                             <cmns:point>57.021218,9.976927</cmns:point>
                             <cmns:polygon>
                                        57.100452089370705, 9.525146484375
                                        56.935984453472, 9.832763671875
                                        57.01083265740579, 10.2008056640625
                                        57.1779474000072, 10.1019287109375
                                        57.20771009775018, 9.7833251953125
                                        57.097468259301586, 9.5196533203125
                                    </cmns:polygon>
                          </cmns:geoLocation>
                       </cmns:classifiedAddress>
                    </addresses>
                    <phoneNumbers>
                       <cmns:classifiedPhoneNumber id="personStaffAssoc1PhoneNumber1">
                          <cmns:classification>phone</cmns:classification>
                          <cmns:value>07700900005</cmns:value>
                       </cmns:classifiedPhoneNumber>
                    </phoneNumbers>
                    <emails>
                       <cmns:classifiedEmail id="personStaffAssocEmail1">
                          <cmns:classification>email</cmns:classification>
                          <cmns:value>london@london.uk</cmns:value>
                       </cmns:classifiedEmail>
                    </emails>
                    <webAddresses>
                       <cmns:classifiedWebAddress id="personStaffAssoc1WebAdress1">
                          <cmns:classification>web</cmns:classification>
                          <cmns:value>
                             <cmns:text lang="en" country="GB">http:\\www.london.uk</cmns:text>
                          </cmns:value>
                       </cmns:classifiedWebAddress>
                    </webAddresses>
                    <employmentType>academic</employmentType>
                    <primaryAssociation>true</primaryAssociation>
                    <organisation>
                       <cmns:source_id>organisation1</cmns:source_id>
                    </organisation>
                    <period>
                       <cmns:startDate>02-02-1988</cmns:startDate>
                       <cmns:endDate>04-04-2011</cmns:endDate>
                    </period>
                    <keywords>
                       <cmns:logicalGroup logicalName="exofficio">
                          <cmns:structuredKeywords>
                             <cmns:structuredKeyword classification="headofdepartment"/>
                          </cmns:structuredKeywords>
                       </cmns:logicalGroup>
                    </keywords>
                    <!--
                            When using Synchronised Jobs to create people, supervisor relationships are created
                            by using the Configurable Supervisor Synchronisation job on the same xml.
                            The Configurable Person Synchronisation job must be run first so as to create
                            all the people before these relationships are then added
                        -->
                    <supervisedByRelations>
                       <supervisorRelation id="supervisorRelation1">
                          <supervisor>
                             <cmns:source_id>supervisor1</cmns:source_id>
                          </supervisor>
                          <supervisionPercentage>1</supervisionPercentage>
                          <period>
                             <cmns:startDate>18-07-2004</cmns:startDate>
                             <cmns:endDate>17-08-2005</cmns:endDate>
                          </period>
                          <supervisorRole>lead</supervisorRole>
                       </supervisorRelation>
                    </supervisedByRelations>
                    <staffType>academic</staffType>
                    <!-- This value is required and is used to determine licenses, which are based on current Academic staff -->
                    <contractType>fixedterm</contractType>
                    <jobTitle>juniorprofessor</jobTitle>
                    <jobDescription>
                       <cmns:text lang="en">Science research</cmns:text>
                    </jobDescription>
                    <fte>1</fte>
                 </staffOrganisationAssociation>
                 <visitingOrganisationAssociation id="visitingAssoc2">
                    <organisation>
                       <cmns:non_explicit_id>organisation2</cmns:non_explicit_id>
                    </organisation>
                    <period>
                       <cmns:startDate>01-01-2000</cmns:startDate>
                    </period>
                    <jobTitle>visitingprofessor</jobTitle>
                    <jobDescription>
                       <cmns:text lang="en">Scientific Research</cmns:text>
                    </jobDescription>
                    <purposeOfStay>Sabbatical</purposeOfStay>
                    <visitorFrom>
                       <identification>
                          <cmns:source_id>extorganisation2</cmns:source_id>
                       </identification>
                       <!-- Rather than specifying the id for the organisation you can specify the details below, Pure will attempt to match to existing organisations and create if not found -->
                       <!--
                            <externalOrganisation>
                                <name>Harvard</name>
                                <type>academic</type>
                                <country>us</country>
                            </externalOrganisation> -->
                    </visitorFrom>
                 </visitingOrganisationAssociation>
                 <honoraryOrganisationAssociation id="honoraryAssoc3">
                    <organisation>
                       <cmns:non_explicit_id>organisation2</cmns:non_explicit_id>
                    </organisation>
                    <period>
                       <cmns:startDate>01-05-2010</cmns:startDate>
                    </period>
                    <jobTitle>adjunctprofessor</jobTitle>
                    <jobDescription>
                       <cmns:text lang="en">Adjunct Professor in Microbology</cmns:text>
                    </jobDescription>
                 </honoraryOrganisationAssociation>
                 <studentOrganisationAssociation id="studentAssoc4">
                    <organisation>
                       <cmns:source_id>organisation2</cmns:source_id>
                    </organisation>
                    <period>
                       <cmns:startDate>25-08-2022</cmns:startDate>
                       <!--Date format should be DD-MM-YYYYY-->
                    </period>
                    <supervisedByRelations>
                       <supervisorRelation id="supervisorRelation2"><!-- Supervisor element is used to match to internal supervisor -->
                          <supervisor>
                             <cmns:source_id>supervisor1</cmns:source_id>
                          </supervisor>
                          <supervisionPercentage>0.6</supervisionPercentage>
                          <period>
                             <cmns:startDate>25-08-2022</cmns:startDate>
                             <cmns:endDate>31-12-2022</cmns:endDate>
                          </period>
                          <supervisorRole>lead</supervisorRole>
                       </supervisorRelation>
                       <supervisorRelation id="supervisorRelation2">
                          <externalSupervisor><!-- Can use either ID or name matching. If name does not match any existing external persons then it will be created --><!--
                                    <id>
                                        <cmns:source_id>supervisor2</cmns:source_id>
                                    </id> -->
                             <firstName>Pedro</firstName>
                             <lastName>Luna</lastName>
                             <country>br</country>
                          </externalSupervisor>
                          <supervisionPercentage>0.4</supervisionPercentage>
                          <period><!-- Exclude end date element to show supervision is ongoing -->
                             <cmns:startDate>18-07-2004</cmns:startDate>
                          </period>
                          <supervisorRole>second</supervisorRole>
                       </supervisorRelation>
                    </supervisedByRelations>
                    <status>current</status>
                    <!-- related to classification: /dk/atira/pure/person/studentstatus-->
                    <startYear>2022</startYear>
                    <programme>Doctorate of Philosophy</programme>
                    <studentTypeDescription>other</studentTypeDescription>
                    <!-- related to classification: /dk/atira/pure/person/studenttypedescription-->
                    <expectedStudyDuration>4</expectedStudyDuration>
                    <minStudyDuration>3</minStudyDuration>
                    <maxStudyDuration>5</maxStudyDuration>
                    <programmeYear>2023</programmeYear>
                    <initialSubmissionDate>01-02-2023</initialSubmissionDate>
                    <expectedEndDate>31-12-2023</expectedEndDate>
                    <studentNationality>US</studentNationality>
                    <studentResidencyFlag>home</studentResidencyFlag>
                    <studentCountryOfDomicile>GB</studentCountryOfDomicile>
                    <awardGained>PhD</awardGained>
                    <projectTitle>
                       <cmns:text lang="en">Study of the effects of low gravity upon micro-organisms</cmns:text>
                    </projectTitle>
                    <awardDate>30-06-2023</awardDate>
                    <fte>1</fte>
                 </studentOrganisationAssociation>
              </organisationAssociations>
              <affiliationNote>Exchange Student</affiliationNote>
              <personEducations>
                 <personEducation id="person1EducationAssoc1">
                    <startDate>
                       <cmns:year>2002</cmns:year>
                       <cmns:month>12</cmns:month>
                       <cmns:day>31</cmns:day>
                    </startDate>
                    <endDate>
                       <cmns:year>2006</cmns:year>
                       <cmns:month>12</cmns:month>
                       <cmns:day>31</cmns:day>
                    </endDate>
                    <!-- Only one of the two following fields should be used. Whether to use the fieldOfStudy as a string or classification is defined under System Settings -> Person -->
                    <fieldOfStudyString>
                       <cmns:text lang="en" country="GB">Electronics</cmns:text>
                    </fieldOfStudyString>
                    <fieldOfStudy>unknown</fieldOfStudy>
                    <!-- Only one of the two following fields should be used. Whether to use the qualification as a string or classification is defined under System Settings -> Person -->
                    <qualificationString>
                       <cmns:text lang="en" country="GB">Child genius</cmns:text>
                    </qualificationString>
                    <qualification>doctorate</qualification>
                    <organisations>
                       <organisation>
                          <cmns:source_id>organisation1</cmns:source_id>
                       </organisation>
                    </organisations>
                    <projectTitle>
                       <cmns:text lang="en" country="GB">Tesla Coils influence on the earths core</cmns:text>
                    </projectTitle>
                    <awardDate>05-04-2009</awardDate>
                 </personEducation>
              </personEducations>
              <externalPositions>
                 <externalPosition id="person1ExternalPosAssoc1">
                    <startDate>
                       <cmns:year>2005</cmns:year>
                       <cmns:month>04</cmns:month>
                       <cmns:day>13</cmns:day>
                    </startDate>
                    <endDate>
                       <cmns:year>2007</cmns:year>
                       <cmns:month>02</cmns:month>
                       <cmns:day>13</cmns:day>
                    </endDate>
                    <!-- Only one of the two following fields should be used. Whether to use the appointment as a string or classification is defined under System Settings -> Person -->
                    <appointment>professor</appointment>
                    <appointmentString>Professor</appointmentString>
                    <externalOrganisationAssociation><!--
                            <identification>
                                <cmns:source_id>extorganisation1</cmns:source_id>
                            </identification> --><!-- Rather than specifying the id for the organisation you can specify the details below, Pure will attempt to match to existing organisations and create if not found -->
                       <externalOrganisation>
                          <name>IBM</name>
                          <type>corporate</type>
                          <country>us</country>
                       </externalOrganisation>
                    </externalOrganisationAssociation>
                 </externalPosition>
              </externalPositions>
              <profileInformation>
                 <personCustomField id="person1ProfileInfo1">
                    <typeClassification>researchinterests</typeClassification>
                    <value>
                       <cmns:text lang="en" country="GB">
                                Elsevier is a world-leading provider of information solutions that help you make better decisions, deliver better care, and sometimes make groundbreaking discoveries in science, health, and technology.
                                Elsevier's cross-discipline platforms support your research journey, enable research and career management, and empower you to make an even greater impact in your field.
                            </cmns:text>
                    </value>
                 </personCustomField>
              </profileInformation>
              <professionalQualifications>
                 <professionalQualification id="person1Qualification1">
                    <startDate>
                       <cmns:year>2001</cmns:year>
                       <cmns:month>12</cmns:month>
                       <cmns:day>31</cmns:day>
                    </startDate>
                    <endDate>
                       <cmns:year>2003</cmns:year>
                       <cmns:month>12</cmns:month>
                       <cmns:day>31</cmns:day>
                    </endDate>
                    <qualification>
                       <cmns:text lang="en" country="GB">Genius</cmns:text>
                    </qualification>
                    <abbreviatedQualification>
                       <cmns:text lang="en" country="GB">Genius</cmns:text>
                    </abbreviatedQualification>
                 </professionalQualification>
              </professionalQualifications>
              <keywords><!-- Free text keyword not tied to classification. By default on Persons the default keyword is tied to a classification --><!-- <cmns:keyword logicalName="keywordContainers">Research Systems</cmns:keyword> --><!-- Keyword tied to classification scheme. Key should match URI suffix of desired classification value -->
                 <cmns:keyword logicalName="sustainabledevelopmentgoals" key="no_poverty"/>
                 <!-- If User Defined keywords are enabled for the keyword definition then values can be specified within the tag as per below -->
                 <cmns:keyword logicalName="keywordContainers" key="T/TK">Electromagnetism</cmns:keyword>
              </keywords>
              <links>
                 <cmns:link id="person1LinkAssoc1">
                    <cmns:url>https://www.mendeley.com/</cmns:url>
                    <cmns:type>mendeley</cmns:type>
                    <cmns:description>
                       <cmns:text lang="en" country="GB">Website for his proposed solution</cmns:text>
                    </cmns:description>
                 </cmns:link>
              </links>
              <!-- This user must be loaded before the person record to ensure the linkage can be made -->
              <user id="user1"/>
              <personIds>
                 <cmns:id type="employee" id="person1">person1</cmns:id>
              </personIds>
              <orcId>0000-0002-1825-0097</orcId>
              <visibility>Restricted</visibility>
              <profiled>false</profiled>
           </person>
           <!-- Supervisors should already exist in Pure or be included in the load file -->
           <person id="supervisor1">
              <name>
                 <cmns:firstname>Jane</cmns:firstname>
                 <cmns:lastname>Smith</cmns:lastname>
              </name>
              <gender>female</gender>
              <organisationAssociations><!-- association can be either staffOrganisationAssociation, studentOrganisationAssociation, honoraryOrganisationAssociation, or visitingOrganisationAssociation -->
                 <staffOrganisationAssociation id="organisationAssoc1">
                    <organisation><!-- organisation can be found in organisation-simple-examples.xml -->
                       <cmns:source_id>organisation1</cmns:source_id>
                    </organisation>
                    <period>
                       <cmns:startDate>02-02-1990</cmns:startDate>
                    </period>
                    <staffType>academic</staffType>
                 </staffOrganisationAssociation>
              </organisationAssociations>
           </person>
        </persons>
 
 

XSD Definition

<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="persons">
           <xs:annotation>
              <xs:documentation>Root element of the xml document.</xs:documentation>
           </xs:annotation>
           <xs:complexType>
              <xs:sequence>
                 <xs:element ref="person" 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>
 
 

person

This xml element is used for persons you want to synchronise into Pure. This means that one entry in the xml has to exist per person you want to have in Pure. For each person you have to specify a unique ID, which will be the primary source ID for identifiying this person in the synchronisation. 
This ID is for synchronisation purposes only, it has to be unique for each person and cannot change over time.

XML Example

<person xmlns="v1.unified-person-sync.pure.atira.dk"
                xmlns:cmns="v3.commons.pure.atira.dk"
                id="person1"
                managedInPure="false"><!--There are many IDs required in the Pure XML.  They can be alpha numeric and need to be unique.  These IDs should not change with subsequent data loads as Pure will view them as new records and create duplicates.-->
           <name>
              <cmns:firstname>John</cmns:firstname>
              <cmns:lastname>Doe</cmns:lastname>
           </name>
           <names><!-- IDs like this need to be unique for the person, but not for all people in Pure. They are used to definitively identify the entry, so if the type or value is changed, then the existing entry will be updated, not a new one created -->
              <classifiedName id="classifiedAssoc1">
                 <name>
                    <cmns:firstname>Johnny</cmns:firstname>
                    <cmns:lastname>Doe</cmns:lastname>
                 </name>
                 <typeClassification>knownas</typeClassification>
              </classifiedName>
           </names>
           <titles>
              <title id="titleAssoc1">
                 <typeClassification>honorary</typeClassification>
                 <value>
                    <cmns:text lang="en" country="GB">Professor</cmns:text>
                 </value>
              </title>
           </titles>
           <gender>male</gender>
           <!-- Dates should be formatted DD-MM-YYYY -->
           <dateOfBirth>17-04-1971</dateOfBirth>
           <nationality>GB</nationality>
           <employeeStartDate>06-12-2001</employeeStartDate>
           <systemLeavingDate>21-08-2007</systemLeavingDate>
           <academicProfessionEntry>06-02-2006</academicProfessionEntry>
           <retiralDate>05-05-2009</retiralDate>
           <privateAddress>
              <cmns:country>GB</cmns:country>
              <cmns:road>Brewery Street 21</cmns:road>
              <cmns:room>5B</cmns:room>
              <cmns:city>Glastonbury</cmns:city>
              <cmns:building>The old brewery</cmns:building>
              <cmns:postalCode>SW1V 4NP</cmns:postalCode>
           </privateAddress>
           <expert>true</expert>
           <leavesOfAbsence>
              <leaveOfAbsence id="leaveAssoc1">
                 <classification>other</classification>
                 <startDate>02-04-2003</startDate>
                 <endDate>02-10-2003</endDate>
              </leaveOfAbsence>
           </leavesOfAbsence>
           <willingnessToPhd>true</willingnessToPhd>
           <photos>
              <personPhoto id="personPhotoAssoc1">
                 <classification>portrait</classification>
                 <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>
                       <!--Optional:-->
                       <mimeType>image/png</mimeType>
                       <!--Optional:-->
                       <fileName>portrait.png</fileName>
                    </http>
                    <!--<file>
                                <path>c:\data\photo1.jpg/path>
                                Optional:
                                <mimeType>image/png</mimeType>
                                Optional:
                                <fileName>portrait.png</fileName>
                            </file>-->
                    <!--<byte>
                                <base64EncodedString>iVBORw0KGgoAAAANSUhEUgAAAaUAAAA6CAYAAAAQlUaMAAAABmJLR0QAAAAAAAD5Q7t/AAAACXBIWXMAAC4jAAAuIwF4pT92AAALK0lEQVR42u1dPdJeNQ99t5AtZAvZQraQLaSiJi1lqKlSUDOTipq0lBlaqhTUzKSjfuCEMXNx5HslW5JlXxWe+b7hzXP9I58jH8ny0+PxeArZvnv+6fHNP/+ztN8/vAzb153b7utwHFvaWTat9sPLD/+zq5/fvM154bWYHfvj44sEC4OGOazbn5+eN/8e/23ndcBY0s6yeTg7SUoCUvr13esvE0a1X96+IYHMuuHbWmABYG2ND+2396/E/TubsyjGV8b946v3j2+fff5qPuv2/YuPj59ev/uy5nAK8BsYp9Y6nM3XLDvDeKXjOxtHaZi3+luwM86/RTtzFEq7skE0al+d/W3P/und39J+9M7DDLuCPWuSkvfeKft/GinVx8yorRcMKW/Yus0kI2xSjTWFbAei0lqHFWyMM74otq69b1ug6b1/pOC9Cn6NkNKsPgMDML/Fef/r87MkpSQlmeTpsZZJSklKSUr3IKWWooLTmSFBJSntQEqUzJaklKSUpJSkZNUQEsCYDMjpXw+b0nqx2GiUhLMSKWHSqFgQ4glljHWGGedIW461VGwqIiFhvOhjHa8o84MxcNZ6xDnYwc7qMZT+98giRxs6xgY4G73s22OsCvHDq/4ATPDf8bfH77biWK39w/kW1cq/aY2dE0+j5qFlV1FIa4SUWnHJHvyyICf0yz37jko8sDwhaIKhpseFv4mUqQJj4PRZstGxyakEAI918LQzKrNwZHxUxmirSYG3p7XW0CKIzT1Nzcps9O4fRRLWCVCj+FWcDzgI3OQoo/HFJCXNAPuupAQjujIcAJNmWv5OpIRGzd/I+LinPWx8a/ugxob+7QD60fsHUF+NlCh8gZ1KTmEjeBOelKhFTVLiecJHichiTnYiJe3xUanArWDxjBO0FRkmKV3b8WqkdCQnCo8NHa6YYKF5T2lHUoKhXPUV+v9q67C6nbUkQW8Jr+WwWH0zSenaKViVlLhOsKJEHBMsZty0X4mUOMkNGlkxmpdnI9oZdbIZHV8ECc9TuktS4knfq5OSxLYHZbyYYDGjvM1KpHR1nNaQ7maUe9rB+Zkt4XlLd0lKMcoMeeAXdx7hFA04xTHBYkahzJVI6aqvmv3cmZQsxieR8CwuILZkFsvb+ElK13t0B1JyUgLigkU9yUlK/Mt0Wicl73WYYWcWVdC5gWGNuB9HukN/dgP96P2rnYNdSIm7RwfGGxcsop0+ViIlzaB2fWHPMkC/i51xLzRrk0VLurMgvySle+IXdy4HvpWktCsprVgqfxc742RHWshqrfmzLqSZpJSklKR0c1Li6LqDwcYkpQUlPOqio7V0l6R0P/xKUkpS6ga8aGWR7mRn3hJeqwKHtXSXpJQnpSSlJCV22rFi6Y8kJYMyUJryGjV3+H6CfpLSDFIawJ0kpRVJSZJ2XO7ErCDl7WZn3FvwGqcZSrrzckiSlO6DX9w9OmDTMcAiAvCvVvtOWpIfXnP0TbebnXGquGtIeC3pTvlJgSQlZox3Z/zi3lNa+vJs7fUnKdmclo7ec9RTk6Wd1cDktZYeEt5M6S5J6SnEST5SRYflywzNAovVSUmyLhRgeQTAI5FSnXjgtZYeEt5M6e7upESdUnfFL843gC2Ddxnng0X920lKNsfpVqwpkqS3o51ZS3gt6c7iMb8kJd767ohfDrGkOKRUe5JJSvIsr9GnxAGIHq+hzrSzen0915L7UFqPhEfNmWaZqSQl+fzvhl/cfbnNI38zwWIHUtIiplIFYma8ydLO6tiO51paepkznt5OUjq/M7gLfmE+uAlVYZ9D12hJSv3EJM3IaxVz9crauoudtSS2UQkvgnS3EylptVXxCxiCucI+5Dq5cPaU8SJJaRdS0l4rAKT3qWlnO7OQ8CJId0lK65CSZgMZGSkrCRa7kVLxoDXkPACcp9e9s51ZSHgRpLskpXuREmzOWOZPsNiRlI7rxr0n4/3uz93sTFvCa/3ejISVJKV7kJITDuiCBRZf2mqPPklJ/5It967MbIO0tLMIa6l5G56aK6sn1u9CSqgpOYpfO5OSR8X5ENl3dfZKkpLdxhw1XGti2j3Lk1tIlzPPFBgOPEGdpHSDlPByL7FuEoXCIQkqL8/ehZSOlQ1GJD3LGNPu9+G4paGuPNLW78y6a3ZnUqKeKFkRvyTZdsYJUPPBor4RnaTkkz7eG7+xzO6ytLP6lDJrLTUkPOrENdM270xK1G+viF+SuJuxjDcfLOqAbZJS/Cw9qwyvO9RY1JDwqDWbWcswC7LucU8piIw3HyzqRU1Sin+3yaoCtaWd4eQRYS1HJbzWv59ZiSOfrtjj6QrYEPc+nULh1dikdAy6ed9GT1Jqa+PentId7KxVmoZLNNRJyykrKknpRHE42tbK+CWR8YzwMAZYRGizSKnOhFmFmCyeRriDnUnmmZLkokl3SUr74ZdEOTGQ8hMsZpOSdA7Rh9IsYjvctbZIeLgLKdVSIlfCo6Q7h2yoJKWb4ZdExjPIyF0HLKyPyDNIqSdzxyO2w73PtCspeZxeeyQ8SrrzfMwvSUkPv7QdCW38ksh4IDDF8awDFvXdmh1IqeeOlkeAmysv7UpKHt/rkfAo6W5WRfckpbFkCO1vWeCXRMZTjGuuARYeTw7PIKWeKgNeG+mupFTfm7M6jcKZ4FxiLpu9Jd1FqRaSpCSTa7Uz1yzwSyrjKVUUWQMs6u9bxDNmkFLP73uVluHMx46k5FlhhFuTEOAQVbpLUpI7Ois51dJitgrxpTXAwqNumTcpUYbKOQJ7AdNdScmzQDBlAy0JL6p0l6Qkdz4sTrgRnkNXSryJDxbU0dfiXoY3KVFzysmm86oMfTUfFmA9m5Qoicz6fSKOhEcR0ozH/JKU+lotga3oVEsqvwxiUnywoALCFkDhTUq9D7R53eZ30o9DkRIlkVmTUu+zIjMe80tS0omHr0hKGIekkPOAghMfLKjJXp2UWpukl5S0JTyOrGRRYmQ2Kc24mMqV8DyrtScp2Todq+IXt27joOMaGyxadb4stHRPUmp5xxwAPPNMtE5MM6S72aTUAi4PIJVkOEWT7pKU5BmWKzvV3Pt1A05dbLBoTcDKl2fPnsXmjIvziJe1524FLtFO5F5AKi2IG0m6S1KSr6uF9O2FX9yrDAPzqrtpNBf17KhoIV1wX24cPfmdBQxHSel4auqR1/D9K4OzBESunWnH0M5szQM0zxyVSI/57U5KmgrM2TdXr0gjTRMHpggw+5oV0QFuMBYnGwALFlf61j2Oefi3+NaVnGFR/oObXYI+SsZY/p5jNFqkdCQnzkYDyHEIAXNkkVThaWczbU1DwrPKthwBKG6sAX/nTUyS/mFuYRewD6lNwRbLXr/CEs05wN7l4ldRUjScmp7nbpjE9PTfBi1FPnseffNu0kUrAFTGKNXwvRoH8Ht+FwZRA/lx3bkbdoSQjuS8ip15xm64m9zqsvQZqKNvsJ+ydppzXBcYlgJ2jV/a/ZuNX9Te0cQv7MPe+e/dw+g/vlcw6StSWmERR46g0qNmdGOl5sOaZGE4oyeklWxsxvtZXAnPW7qTesQatmZRPHhlUoo6/7BFaXyJMR9JSquTUvGc4TFqkxN+T0tqWJGUvB/Pu/I8Z0h3SUrzT9+R51/6OOiWpCS9k7M7KdU6Lf4/DGvEg8Eca2v/K5KSd5bbVezDW7pLUopx+o5u870XwJukVL/zEelSnmYQ/diiZS/1GuhVDS2Ms9bcz7RdyyB0vQa72ZlW0LrED6g24zG/Eki32jujv1/j18oP9c1436vGRytspNapMZ4EgtXaEaRmP4OdLVu2bMrtb/rmDTutlLmzAAAAAElFTkSuQmCC</base64EncodedString>
                                <mimeType>image/png</mimeType>
                                <fileName>portrait.png</fileName>
                            </byte>-->
                 </data>
              </personPhoto>
           </photos>
           <phdResearchProjects>Tesla Coil</phdResearchProjects>
           <organisationAssociations><!-- At least one organisation association is required, but it can be any of the four types -->
              <staffOrganisationAssociation id="staffAssoc1" managedInPure="false">
                 <affiliationId>affilID1</affiliationId>
                 <addresses>
                    <cmns:classifiedAddress id="staffAssoc1ClassifiedAddressAssoc1">
                       <cmns:addressType>visiting</cmns:addressType>
                       <cmns:city>London</cmns:city>
                       <cmns:postalCode>SW1V 4NP</cmns:postalCode>
                       <cmns:street>Wayne Street</cmns:street>
                       <cmns:country>GB</cmns:country>
                       <cmns:building>21</cmns:building>
                       <cmns:displayFormat>
                                    London
                                    Wayne Street
                                    England
                                    SW1V 4NP
                                </cmns:displayFormat>
                       <cmns:subDivision>us/ak</cmns:subDivision>
                       <cmns:geoLocation>
                          <cmns:point>57.021218,9.976927</cmns:point>
                          <cmns:polygon>
                                        57.100452089370705, 9.525146484375
                                        56.935984453472, 9.832763671875
                                        57.01083265740579, 10.2008056640625
                                        57.1779474000072, 10.1019287109375
                                        57.20771009775018, 9.7833251953125
                                        57.097468259301586, 9.5196533203125
                                    </cmns:polygon>
                       </cmns:geoLocation>
                    </cmns:classifiedAddress>
                 </addresses>
                 <phoneNumbers>
                    <cmns:classifiedPhoneNumber id="personStaffAssoc1PhoneNumber1">
                       <cmns:classification>phone</cmns:classification>
                       <cmns:value>07700900005</cmns:value>
                    </cmns:classifiedPhoneNumber>
                 </phoneNumbers>
                 <emails>
                    <cmns:classifiedEmail id="personStaffAssocEmail1">
                       <cmns:classification>email</cmns:classification>
                       <cmns:value>london@london.uk</cmns:value>
                    </cmns:classifiedEmail>
                 </emails>
                 <webAddresses>
                    <cmns:classifiedWebAddress id="personStaffAssoc1WebAdress1">
                       <cmns:classification>web</cmns:classification>
                       <cmns:value>
                          <cmns:text lang="en" country="GB">http:\\www.london.uk</cmns:text>
                       </cmns:value>
                    </cmns:classifiedWebAddress>
                 </webAddresses>
                 <employmentType>academic</employmentType>
                 <primaryAssociation>true</primaryAssociation>
                 <organisation>
                    <cmns:source_id>organisation1</cmns:source_id>
                 </organisation>
                 <period>
                    <cmns:startDate>02-02-1988</cmns:startDate>
                    <cmns:endDate>04-04-2011</cmns:endDate>
                 </period>
                 <keywords>
                    <cmns:logicalGroup logicalName="exofficio">
                       <cmns:structuredKeywords>
                          <cmns:structuredKeyword classification="headofdepartment"/>
                       </cmns:structuredKeywords>
                    </cmns:logicalGroup>
                 </keywords>
                 <!--
                            When using Synchronised Jobs to create people, supervisor relationships are created
                            by using the Configurable Supervisor Synchronisation job on the same xml.
                            The Configurable Person Synchronisation job must be run first so as to create
                            all the people before these relationships are then added
                        -->
                 <supervisedByRelations>
                    <supervisorRelation id="supervisorRelation1">
                       <supervisor>
                          <cmns:source_id>supervisor1</cmns:source_id>
                       </supervisor>
                       <supervisionPercentage>1</supervisionPercentage>
                       <period>
                          <cmns:startDate>18-07-2004</cmns:startDate>
                          <cmns:endDate>17-08-2005</cmns:endDate>
                       </period>
                       <supervisorRole>lead</supervisorRole>
                    </supervisorRelation>
                 </supervisedByRelations>
                 <staffType>academic</staffType>
                 <!-- This value is required and is used to determine licenses, which are based on current Academic staff -->
                 <contractType>fixedterm</contractType>
                 <jobTitle>juniorprofessor</jobTitle>
                 <jobDescription>
                    <cmns:text lang="en">Science research</cmns:text>
                 </jobDescription>
                 <fte>1</fte>
              </staffOrganisationAssociation>
              <visitingOrganisationAssociation id="visitingAssoc2">
                 <organisation>
                    <cmns:non_explicit_id>organisation2</cmns:non_explicit_id>
                 </organisation>
                 <period>
                    <cmns:startDate>01-01-2000</cmns:startDate>
                 </period>
                 <jobTitle>visitingprofessor</jobTitle>
                 <jobDescription>
                    <cmns:text lang="en">Scientific Research</cmns:text>
                 </jobDescription>
                 <purposeOfStay>Sabbatical</purposeOfStay>
                 <visitorFrom>
                    <identification>
                       <cmns:source_id>extorganisation2</cmns:source_id>
                    </identification>
                    <!-- Rather than specifying the id for the organisation you can specify the details below, Pure will attempt to match to existing organisations and create if not found -->
                    <!--
                            <externalOrganisation>
                                <name>Harvard</name>
                                <type>academic</type>
                                <country>us</country>
                            </externalOrganisation> -->
                 </visitorFrom>
              </visitingOrganisationAssociation>
              <honoraryOrganisationAssociation id="honoraryAssoc3">
                 <organisation>
                    <cmns:non_explicit_id>organisation2</cmns:non_explicit_id>
                 </organisation>
                 <period>
                    <cmns:startDate>01-05-2010</cmns:startDate>
                 </period>
                 <jobTitle>adjunctprofessor</jobTitle>
                 <jobDescription>
                    <cmns:text lang="en">Adjunct Professor in Microbology</cmns:text>
                 </jobDescription>
              </honoraryOrganisationAssociation>
              <studentOrganisationAssociation id="studentAssoc4">
                 <organisation>
                    <cmns:source_id>organisation2</cmns:source_id>
                 </organisation>
                 <period>
                    <cmns:startDate>25-08-2022</cmns:startDate>
                    <!--Date format should be DD-MM-YYYYY-->
                 </period>
                 <supervisedByRelations>
                    <supervisorRelation id="supervisorRelation2"><!-- Supervisor element is used to match to internal supervisor -->
                       <supervisor>
                          <cmns:source_id>supervisor1</cmns:source_id>
                       </supervisor>
                       <supervisionPercentage>0.6</supervisionPercentage>
                       <period>
                          <cmns:startDate>25-08-2022</cmns:startDate>
                          <cmns:endDate>31-12-2022</cmns:endDate>
                       </period>
                       <supervisorRole>lead</supervisorRole>
                    </supervisorRelation>
                    <supervisorRelation id="supervisorRelation2">
                       <externalSupervisor><!-- Can use either ID or name matching. If name does not match any existing external persons then it will be created --><!--
                                    <id>
                                        <cmns:source_id>supervisor2</cmns:source_id>
                                    </id> -->
                          <firstName>Pedro</firstName>
                          <lastName>Luna</lastName>
                          <country>br</country>
                       </externalSupervisor>
                       <supervisionPercentage>0.4</supervisionPercentage>
                       <period><!-- Exclude end date element to show supervision is ongoing -->
                          <cmns:startDate>18-07-2004</cmns:startDate>
                       </period>
                       <supervisorRole>second</supervisorRole>
                    </supervisorRelation>
                 </supervisedByRelations>
                 <status>current</status>
                 <!-- related to classification: /dk/atira/pure/person/studentstatus-->
                 <startYear>2022</startYear>
                 <programme>Doctorate of Philosophy</programme>
                 <studentTypeDescription>other</studentTypeDescription>
                 <!-- related to classification: /dk/atira/pure/person/studenttypedescription-->
                 <expectedStudyDuration>4</expectedStudyDuration>
                 <minStudyDuration>3</minStudyDuration>
                 <maxStudyDuration>5</maxStudyDuration>
                 <programmeYear>2023</programmeYear>
                 <initialSubmissionDate>01-02-2023</initialSubmissionDate>
                 <expectedEndDate>31-12-2023</expectedEndDate>
                 <studentNationality>US</studentNationality>
                 <studentResidencyFlag>home</studentResidencyFlag>
                 <studentCountryOfDomicile>GB</studentCountryOfDomicile>
                 <awardGained>PhD</awardGained>
                 <projectTitle>
                    <cmns:text lang="en">Study of the effects of low gravity upon micro-organisms</cmns:text>
                 </projectTitle>
                 <awardDate>30-06-2023</awardDate>
                 <fte>1</fte>
              </studentOrganisationAssociation>
           </organisationAssociations>
           <affiliationNote>Exchange Student</affiliationNote>
           <personEducations>
              <personEducation id="person1EducationAssoc1">
                 <startDate>
                    <cmns:year>2002</cmns:year>
                    <cmns:month>12</cmns:month>
                    <cmns:day>31</cmns:day>
                 </startDate>
                 <endDate>
                    <cmns:year>2006</cmns:year>
                    <cmns:month>12</cmns:month>
                    <cmns:day>31</cmns:day>
                 </endDate>
                 <!-- Only one of the two following fields should be used. Whether to use the fieldOfStudy as a string or classification is defined under System Settings -> Person -->
                 <fieldOfStudyString>
                    <cmns:text lang="en" country="GB">Electronics</cmns:text>
                 </fieldOfStudyString>
                 <fieldOfStudy>unknown</fieldOfStudy>
                 <!-- Only one of the two following fields should be used. Whether to use the qualification as a string or classification is defined under System Settings -> Person -->
                 <qualificationString>
                    <cmns:text lang="en" country="GB">Child genius</cmns:text>
                 </qualificationString>
                 <qualification>doctorate</qualification>
                 <organisations>
                    <organisation>
                       <cmns:source_id>organisation1</cmns:source_id>
                    </organisation>
                 </organisations>
                 <projectTitle>
                    <cmns:text lang="en" country="GB">Tesla Coils influence on the earths core</cmns:text>
                 </projectTitle>
                 <awardDate>05-04-2009</awardDate>
              </personEducation>
           </personEducations>
           <externalPositions>
              <externalPosition id="person1ExternalPosAssoc1">
                 <startDate>
                    <cmns:year>2005</cmns:year>
                    <cmns:month>04</cmns:month>
                    <cmns:day>13</cmns:day>
                 </startDate>
                 <endDate>
                    <cmns:year>2007</cmns:year>
                    <cmns:month>02</cmns:month>
                    <cmns:day>13</cmns:day>
                 </endDate>
                 <!-- Only one of the two following fields should be used. Whether to use the appointment as a string or classification is defined under System Settings -> Person -->
                 <appointment>professor</appointment>
                 <appointmentString>Professor</appointmentString>
                 <externalOrganisationAssociation><!--
                            <identification>
                                <cmns:source_id>extorganisation1</cmns:source_id>
                            </identification> --><!-- Rather than specifying the id for the organisation you can specify the details below, Pure will attempt to match to existing organisations and create if not found -->
                    <externalOrganisation>
                       <name>IBM</name>
                       <type>corporate</type>
                       <country>us</country>
                    </externalOrganisation>
                 </externalOrganisationAssociation>
              </externalPosition>
           </externalPositions>
           <profileInformation>
              <personCustomField id="person1ProfileInfo1">
                 <typeClassification>researchinterests</typeClassification>
                 <value>
                    <cmns:text lang="en" country="GB">
                                Elsevier is a world-leading provider of information solutions that help you make better decisions, deliver better care, and sometimes make groundbreaking discoveries in science, health, and technology.
                                Elsevier's cross-discipline platforms support your research journey, enable research and career management, and empower you to make an even greater impact in your field.
                            </cmns:text>
                 </value>
              </personCustomField>
           </profileInformation>
           <professionalQualifications>
              <professionalQualification id="person1Qualification1">
                 <startDate>
                    <cmns:year>2001</cmns:year>
                    <cmns:month>12</cmns:month>
                    <cmns:day>31</cmns:day>
                 </startDate>
                 <endDate>
                    <cmns:year>2003</cmns:year>
                    <cmns:month>12</cmns:month>
                    <cmns:day>31</cmns:day>
                 </endDate>
                 <qualification>
                    <cmns:text lang="en" country="GB">Genius</cmns:text>
                 </qualification>
                 <abbreviatedQualification>
                    <cmns:text lang="en" country="GB">Genius</cmns:text>
                 </abbreviatedQualification>
              </professionalQualification>
           </professionalQualifications>
           <keywords><!-- Free text keyword not tied to classification. By default on Persons the default keyword is tied to a classification --><!-- <cmns:keyword logicalName="keywordContainers">Research Systems</cmns:keyword> --><!-- Keyword tied to classification scheme. Key should match URI suffix of desired classification value -->
              <cmns:keyword logicalName="sustainabledevelopmentgoals" key="no_poverty"/>
              <!-- If User Defined keywords are enabled for the keyword definition then values can be specified within the tag as per below -->
              <cmns:keyword logicalName="keywordContainers" key="T/TK">Electromagnetism</cmns:keyword>
           </keywords>
           <links>
              <cmns:link id="person1LinkAssoc1">
                 <cmns:url>https://www.mendeley.com/</cmns:url>
                 <cmns:type>mendeley</cmns:type>
                 <cmns:description>
                    <cmns:text lang="en" country="GB">Website for his proposed solution</cmns:text>
                 </cmns:description>
              </cmns:link>
           </links>
           <!-- This user must be loaded before the person record to ensure the linkage can be made -->
           <user id="user1"/>
           <personIds>
              <cmns:id type="employee" id="person1">person1</cmns:id>
           </personIds>
           <orcId>0000-0002-1825-0097</orcId>
           <visibility>Restricted</visibility>
           <profiled>false</profiled>
        </person>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="personType">
           <xs:annotation>
              <xs:documentation>
                        This xml element is used for persons you want to synchronise into Pure. This means that one entry in the xml has to exist per person you want to have in Pure. For each person you have to specify a unique ID, which will be the primary source ID for identifiying this person in the synchronisation.
                        This ID is for synchronisation purposes only, it has to be unique for each person and cannot change over time.
                    </xs:documentation>
           </xs:annotation>
           <xs:sequence>
              <xs:element name="name" type="commons:name" minOccurs="1">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">First name(s) &amp; Last name</xs:appinfo>
                    <xs:documentation>The default name of the person</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="names" type="names" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Name variant</xs:appinfo>
                    <xs:documentation>Name variants of the person, as defined in the /dk/atira/pure/person/names classification scheme</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="titles" type="titles" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Title</xs:appinfo>
                    <xs:documentation>Different titles for the person. typeClassification element must be a token from the classification scheme /dk/atira/pure/person/titles</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="gender" type="commons:classification" minOccurs="1">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Gender</xs:appinfo>
                    <xs:documentation>
                                The gender of the person. Should be a classification token from the scheme /dk/atira/pure/person/gender
                                Examples could be 'male', 'female', or 'unknown'
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="dateOfBirth" type="commons:date" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Date of birth</xs:appinfo>
                    <xs:documentation>Should be in format dd-MM-yyyy</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="nationality" type="commons:classification" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Nationality</xs:appinfo>
                    <xs:documentation>
                                The nationality of the person. Should be a classification token from the scheme /dk/atira/pure/core/countries
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="employeeStartDate" type="commons:date" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Start date at institution</xs:appinfo>
                    <xs:documentation>Date the person started at the organisation. Format should be dd-MM-yyyy</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="systemLeavingDate" type="commons:date" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">End date at institution</xs:appinfo>
                    <xs:documentation>Date the person left the organisation. Format should be dd-MM-yyyy</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="academicProfessionEntry" type="commons:date" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Start date as an independant researcher</xs:appinfo>
                    <xs:documentation>Date when the person began working as a researcher. Format should be dd-MM-yyyy</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="retiralDate" type="commons:date" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Retirement date</xs:appinfo>
                    <xs:documentation>Date when the person retired from working as a researcher. Format should be dd-MM-yyyy</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="privateAddress" type="commons:address" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Home address</xs:appinfo>
                    <xs:documentation>Private/Home address of a person (needs to be enabled in the System Settings options under Person)</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="expert" type="xs:boolean" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Create person as an expert</xs:appinfo>
                    <xs:documentation>Indicates a person is considered an expert (needs to be enabled in the System Settings options under Person)</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="leavesOfAbsence" type="leavesOfAbsence" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Leave of absence</xs:appinfo>
                    <xs:documentation>Details of leaves of absence the person has scheduled (needs to be enabled in the System Settings options under Person)</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="willingnessToPhd" type="xs:boolean" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Willingness to take PhD students</xs:appinfo>
                    <xs:documentation>Whether the person is willing to be contacted as a potential PhD supervisor (needs to be enabled in the System Settings options under Person)</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="photos" type="personPhotos" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Profile photos</xs:appinfo>
                    <xs:documentation>Photos of the person, such as a profile photo</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="phdResearchProjects" type="xs:string" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">PhD research projects available</xs:appinfo>
                    <xs:documentation>A list of the current research projects the person is looking for PhD candidates to work on</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="organisationAssociations" type="organisationAssociations">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Organisational affiliations</xs:appinfo>
                    <xs:documentation>A collection of associations the person has with the institution. Can be of type staff, student, honorary or visiting.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="affiliationNote" type="xs:string" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Further information on the affiliation</xs:appinfo>
                    <xs:documentation>Free text field describing the person's affiliation with the organisation (needs to be enabled in the System Settings options under Person)</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="personEducations" type="personEducations" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Education/Academic Qualification</xs:appinfo>
                    <xs:documentation>A list of the person education qualifications</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="externalPositions" type="externalPositions" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Positions outside of the institution</xs:appinfo>
                    <xs:documentation>A list of the external positions the person has held</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="profileInformation" type="personCustomFields" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Curriculum and research description</xs:appinfo>
                    <xs:documentation>A list of free text fields providing biographical information of the person. typeClassification must be a token from the classification scheme /dk/atira/pure/person/customfields</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="professionalQualifications"
                          type="professionalQualifications"
                          minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Professional Qualifications</xs:appinfo>
                    <xs:documentation>A list of different professional qualifications the person has achieved (needs to be enabled in the System Settings options under Person)</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="keywords" type="commons:keywords" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Keywords</xs:appinfo>
                    <xs:documentation>A combination of free text and structured keywords. Logical groups are validated against those defined as being tied to the Person Main Editor</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="links" type="commons:links" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Links</xs:appinfo>
                    <xs:documentation>A collection of urls related to the person. The type attribute must be from the classification /dk/atira/pure/links/person</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="user" type="user" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Associated User</xs:appinfo>
                    <xs:documentation>Used to link the person to an associated user. This grants Personal User access to this user to view, create and edit records associated with this person. The User import/sync needs to be run first to create the user so that it can be referenced here. The element has an attribute of "id", which would be the id from an external source used to create the user record i.e. an HR system.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="personIds" type="commons:ids" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">ID</xs:appinfo>
                    <xs:documentation>IDs can be used to synchronise additional IDs to the persons. These IDs are not the IDs/primary keys we use to synchronise person data, but additional ones, like the HR ID of a person, or the ID in a student management system.
                            Type attribute must be a token from the classification scheme /dk/atira/pure/person/personsources. Note that the ID attribute of this element is used to differentiate from other IDs in the load file. The subelement </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="orcId" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">ORCID</xs:appinfo>
                    <xs:documentation>The Orcid identifier of the person. Note just the suffix is accepted here, not the full URL. For example "0000-0001-2345-6789"</xs:documentation>
                 </xs:annotation>
                 <xs:simpleType>
                    <xs:restriction base="xs:string">
                       <xs:maxLength value="20"/>
                    </xs:restriction>
                 </xs:simpleType>
              </xs:element>
              <xs:element name="visibility" type="commons:visibility" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Visibility</xs:appinfo>
                    <xs:documentation>How the content can be viewed by others. Options include "Public", "Campus" &amp; "Restricted". If no value is specified, Public will be selected by default.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="profiled" type="xs:boolean" minOccurs="0">
                 <xs:annotation>
                    <xs:appinfo source="pure.field">Profiled</xs:appinfo>
                    <xs:documentation>
                                Profiled is only available for customers who have the author profile module enabled, and is used to indicate who should be sent for the Profile Refinement Service. Please note, that this element will be set to false automatically when a person is retired.
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:sequence>
           <xs:attribute type="commons:string_400" name="id" use="required">
              <xs:annotation>
                 <xs:appinfo source="pure.field">Source-ID</xs:appinfo>
                 <xs:documentation>
                            This is unique ID of the Person, which will be the primary source ID for identifiying this person in the synchronisation.
                            This ID is for synchronisation purposes only, it has to be unique for each person and cannot change over time.
                        </xs:documentation>
              </xs:annotation>
           </xs:attribute>
           <xs:attribute type="xs:boolean" name="managedInPure" use="optional">
              <xs:annotation>
                 <xs:documentation>Whether the person is considered after creation to be managed in Pure or by an integrated external system. If you are planning to update people with data from your HR system this should be set to "false"</xs:documentation>
              </xs:annotation>
           </xs:attribute>
        </xs:complexType>
 
 

Field in Pure

XML Attribute/Element

Description

Type

Mandatory

Source-ID

@id

This is unique ID of the Person, which will be the primary source ID for identifiying this person in the synchronisation. This ID is for synchronisation purposes only, it has to be unique for each person and cannot change over time.

commons:string_400

Yes

 

@managedInPure

Whether the person is considered after creation to be managed in Pure or by an integrated external system. If you are planning to update people with data from your HR system this should be set to "false"

xsd:boolean

Yes

First name(s) & Last name

name

The default name of the person

commons:name

Yes

Name variant

names

Name variants of the person, as defined in the /dk/atira/pure/person/names classification scheme

names

No

Title

titles

Different titles for the person. typeClassification element must be a token from the classification scheme /dk/atira/pure/person/titles

titles

No

Gender

gender

The gender of the person. Should be a classification token from the scheme /dk/atira/pure/person/gender Examples could be 'male', 'female', or 'unknown'

commons:classification

Yes

Date of birth

dateOfBirth

Should be in format dd-MM-yyyy

commons:date

No

Nationality

nationality

The nationality of the person. Should be a classification token from the scheme /dk/atira/pure/core/countries

commons:classification

No

Start date at institution

employeeStartDate

Date the person started at the organisation. Format should be dd-MM-yyyy

commons:date

No

End date at institution

systemLeavingDate

Date the person left the organisation. Format should be dd-MM-yyyy

commons:date

No

Start date as an independant researcher

academicProfessionEntry

Date when the person began working as a researcher. Format should be dd-MM-yyyy

commons:date

No

Retirement date

retiralDate

Date when the person retired from working as a researcher. Format should be dd-MM-yyyy

commons:date

No

Home address

privateAddress

Private/Home address of a person (needs to be enabled in the System Settings options under Person)

commons:address

No

Create person as an expert

expert

Indicates a person is considered an expert (needs to be enabled in the System Settings options under Person)

xsd:boolean

No

Leave of absence

leavesOfAbsence

Details of leaves of absence the person has scheduled (needs to be enabled in the System Settings options under Person)

leavesOfAbsence

No

Willingness to take PhD students

willingnessToPhd

Whether the person is willing to be contacted as a potential PhD supervisor (needs to be enabled in the System Settings options under Person)

xsd:boolean

No

Profile photos

photos

Photos of the person, such as a profile photo

personPhotos

No

PhD research projects available

phdResearchProjects

A list of the current research projects the person is looking for PhD candidates to work on

xsd:string

No

Organisational affiliations

organisationAssociations

A collection of associations the person has with the institution. Can be of type staff, student, honorary or visiting.

organisationAssociations

Yes

Further information on the affiliation

affiliationNote

Free text field describing the person's affiliation with the organisation (needs to be enabled in the System Settings options under Person)

xsd:string

No

Education/Academic Qualification

personEducations

A list of the person education qualifications

personEducations

No

Positions outside of the institution

externalPositions

A list of the external positions the person has held

externalPositions

No

Curriculum and research description

profileInformation

A list of free text fields providing biographical information of the person. typeClassification must be a token from the classification scheme /dk/atira/pure/person/customfields

personCustomFields

No

Professional Qualifications

professionalQualifications

A list of different professional qualifications the person has achieved (needs to be enabled in the System Settings options under Person)

professionalQualifications

No

Keywords

keywords

A combination of free text and structured keywords. Logical groups are validated against those defined as being tied to the Person Main Editor

commons:keywords

No

Links

links

A collection of urls related to the person. The type attribute must be from the classification /dk/atira/pure/links/person

commons:links

No

Associated User

user

Used to link the person to an associated user. This grants Personal User access to this user to view, create and edit records associated with this person. The User import/sync needs to be run first to create the user so that it can be referenced here. The element has an attribute of "id", which would be the id from an external source used to create the user record i.e. an HR system.

user

No

ID

personIds

IDs can be used to synchronise additional IDs to the persons. These IDs are not the IDs/primary keys we use to synchronise person data, but additional ones, like the HR ID of a person, or the ID in a student management system. Type attribute must be a token from the classification scheme /dk/atira/pure/person/personsources. Note that the ID attribute of this element is used to differentiate from other IDs in the load file. The subelement

commons:ids

No

ORCID

orcId

The Orcid identifier of the person. Note just the suffix is accepted here, not the full URL. For example "0000-0001-2345-6789"

xsd:string

No

Visibility

visibility

How the content can be viewed by others. Options include "Public", "Campus" & "Restricted". If no value is specified, Public will be selected by default.

commons:visibility

No

Profiled

profiled

Profiled is only available for customers who have the author profile module enabled, and is used to indicate who should be sent for the Profile Refinement Service. Please note, that this element will be set to false automatically when a person is retired.

xsd:boolean

No

user

Used to link the person to an associated user. This grants Personal User access to this user to view, create and edit records associated with this person. The User import/sync needs to be run first to create the user so that it can be referenced here. The element has an attribute of "id", which would be the id from an external source used to create the user record i.e. an HR system.

XML Example

<user xmlns="v1.unified-person-sync.pure.atira.dk"
              xmlns:cmns="v3.commons.pure.atira.dk"
              id="user1"/>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="user">
           <xs:annotation>
              <xs:documentation>Used to link the person to an associated user. This grants Personal User access to this user to view, create and edit records associated with this person. The User import/sync needs to be run first to create the user so that it can be referenced here. The element has an attribute of "id", which would be the id from an external source used to create the user record i.e. an HR system.</xs:documentation>
           </xs:annotation>
           <xs:sequence>
              <xs:element name="userName" type="commons:string_256" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>
                                DEPRECATED: This field is deprecated from 5.12 and will be removed in 5.15.
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="email" type="commons:string_256" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>
                                DEPRECATED: This field is deprecated from 5.12 and will be removed in 5.15.
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:sequence>
           <xs:attribute type="commons:string_400" name="id" use="required">
              <xs:annotation>
                 <xs:documentation>Id of the user. This would be the id from an external source i.e. an HR system.</xs:documentation>
              </xs:annotation>
           </xs:attribute>
        </xs:complexType>
 
 

 Expand source

XML Attribute/Element

Description

Type

Mandatory

@id

Id of the user. This would be the id from an external source i.e. an HR system.

commons:string_400

Yes


Titles

titles

A list of title elements of type title

XML Example

<titles xmlns="v1.unified-person-sync.pure.atira.dk"
                xmlns:cmns="v3.commons.pure.atira.dk">
           <title id="titleAssoc1">
              <typeClassification>honorary</typeClassification>
              <value>
                 <cmns:text lang="en" country="GB">Professor</cmns:text>
              </value>
           </title>
        </titles>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="titles">
           <xs:sequence>
              <xs:element name="title" type="title" maxOccurs="unbounded"/>
           </xs:sequence>
        </xs:complexType>
 
 

title

A title for the person. This might be an official title, a preferred title or an honorary

XML Example

<title xmlns="v1.unified-person-sync.pure.atira.dk"
               xmlns:cmns="v3.commons.pure.atira.dk"
               id="titleAssoc1">
           <typeClassification>honorary</typeClassification>
           <value>
              <cmns:text lang="en" country="GB">Professor</cmns:text>
           </value>
        </title>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="title">
           <xs:annotation>
              <xs:documentation>
                        A title for the person. This might be an official title, a preferred title or an honorary
                    </xs:documentation>
           </xs:annotation>
           <xs:all>
              <xs:element name="typeClassification"
                          type="commons:classification"
                          minOccurs="1">
                 <xs:annotation>
                    <xs:documentation>
                                The type of title. Must be a valid classification from the /dk/atira/pure/person/titles classification scheme
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="value" type="commons:localized_string" minOccurs="1">
                 <xs:annotation>
                    <xs:documentation>Free text value of the title (e.g. Mrs, Professor, etc)</xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:all>
           <xs:attribute type="commons:string_400" name="id" use="required">
              <xs:annotation>
                 <xs:documentation>
                            This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor
                        </xs:documentation>
              </xs:annotation>
           </xs:attribute>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

@id

This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor

commons:string_400

Yes

typeClassification

The type of title. Must be a valid classification from the /dk/atira/pure/person/titles classification scheme

commons:classification

Yes

value

Free text value of the title (e.g. Mrs, Professor, etc)

commons:localized_string

Yes


Leaves of absence

leavesOfAbsence

A list of leaveOfAbsence elements of type leaveOfAbsence

XML Example

<leavesOfAbsence xmlns="v1.unified-person-sync.pure.atira.dk"
                         xmlns:cmns="v3.commons.pure.atira.dk">
           <leaveOfAbsence id="leaveAssoc1">
              <classification>other</classification>
              <startDate>02-04-2003</startDate>
              <endDate>02-10-2003</endDate>
           </leaveOfAbsence>
        </leavesOfAbsence>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="leavesOfAbsence">
           <xs:sequence>
              <xs:element name="leaveOfAbsence" type="leaveOfAbsence" maxOccurs="unbounded"/>
           </xs:sequence>
        </xs:complexType>
 
 

leaveOfAbsence

A specific instance of leave for the person. This can be representing leave already taken or future dated leave

XML Example

<leaveOfAbsence xmlns="v1.unified-person-sync.pure.atira.dk"
                        xmlns:cmns="v3.commons.pure.atira.dk"
                        id="leaveAssoc1">
           <classification>other</classification>
           <startDate>02-04-2003</startDate>
           <endDate>02-10-2003</endDate>
        </leaveOfAbsence>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="leaveOfAbsence">
           <xs:annotation>
              <xs:documentation>
                            A specific instance of leave for the person. This can be representing leave already taken or future dated leave
                        </xs:documentation>
           </xs:annotation>
           <xs:all>
              <xs:element name="classification" type="commons:classification" minOccurs="1">
                 <xs:annotation>
                    <xs:documentation>
                                The type of leave. Must be a valid classification from the /dk/atira/pure/person/loa classification scheme
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="startDate" type="commons:date" minOccurs="1">
                 <xs:annotation>
                    <xs:documentation>Start date of the leave. Should be in format dd-MM-yyyy</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="endDate" type="commons:date" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>End date of the leave. Should be in format dd-MM-yyyy</xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:all>
           <xs:attribute type="commons:string_400" name="id" use="required">
              <xs:annotation>
                 <xs:documentation>
                            This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor
                        </xs:documentation>
              </xs:annotation>
           </xs:attribute>
        </xs:complexType>
 
 

 

XML Attribute/Element

Description

Type

Mandatory

@id

This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor

commons:string_400

Yes

classification

The type of leave. Must be a valid classification from the /dk/atira/pure/person/loa classification scheme

commons:classification

Yes

startDate

Start date of the leave. Should be in format dd-MM-yyyy

commons:date

Yes

endDate

End date of the leave. Should be in format dd-MM-yyyy

commons:date

No


Documents

documents

A list of document elements of type document

XSD Definition

<xs:complexType name="documents">
	<xs:sequence>
		<xs:element name="document" type="document" maxOccurs="unbounded"/>
	</xs:sequence>
</xs:complexType>
 
 

.document

A specific  Document

XML Example

<v1:document id="string">
	<!--Optional:-->
	<v1:type>/dk/atira/pure/person/persondocumenttypes/general</v1:type>
	<!--Optional:-->
	<v1:fileLocation>https://www.elsevier.com/images/elsevier-logo.svg</v1:fileLocation>
	<!--Optional:-->
	<v1:visibility>Public</v1:visibility>
	<!--Optional:-->
	<v1:title>Elsevier Logo</v1:title>
	<!--Optional:-->
	<v1:mimeType>image/svg+xml</v1:mimeType>
	<!--Optional:-->
	<v1:fileName>elsevier-logo.svg</v1:fileName>
	<!--Optional:-->
</v1:document>
 
 

XSD Definition

<xs:complexType name="document">
	<xs:all>
		<xs:element name="type" type="commons:classification" minOccurs="1" default="other"/>
		<xs:element name="fileLocation" type="commons:string_1024" minOccurs="1"/>
		<xs:element name="mimeType" type="commons:string_256" minOccurs="0"/>
		<xs:element name="fileName" type="commons:string_256" minOccurs="0"/>
		<xs:element name="title" type="commons:string_1024" minOccurs="0"/>
		<xs:element name="visibility" type="commons:visibility" minOccurs="0"/>
	</xs:all>
	<xs:attribute type="commons:string_400" name="id" use="required"/>
</xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

@id

This should be unique for the document and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor

commons:string_400

Yes

type

The type of photo. Must be a valid classification from the "/dk/atira/pure/person/persondocumenttypes".

Default is general.

commons:classification

Yes

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.

commons:string_1000

Yes

mimeType What kind of file it is. commons:string_256 No
fileName What the file is named. commons:string_256 No
title Document Title. commons:string_256 No
visibility Where the document should be accessible from. commons:visibility No

Photos

personPhotos

A list of personPhoto elements of type personPhoto

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="personPhotos">
           <xs:sequence>
              <xs:element name="personPhoto" type="personPhoto" maxOccurs="unbounded"/>
           </xs:sequence>
        </xs:complexType>
 
 

personPhoto

A specific photo of a given type. For instance a headshot as a profile photo, or a photo of them recieving an award. These can be displayed on the portal

XML Example

<personPhoto xmlns="v1.unified-person-sync.pure.atira.dk"
                     xmlns:cmns="v3.commons.pure.atira.dk"
                     id="personPhotoAssoc1">
           <classification>portrait</classification>
           <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>
                 <!--Optional:-->
                 <mimeType>image/png</mimeType>
                 <!--Optional:-->
                 <fileName>portrait.png</fileName>
              </http>
              <!--<file>
                                <path>c:\data\photo1.jpg/path>
                                Optional:
                                <mimeType>image/png</mimeType>
                                Optional:
                                <fileName>portrait.png</fileName>
                            </file>-->
              <!--<byte>
                                <base64EncodedString>iVBORw0KGgoAAAANSUhEUgAAAaUAAAA6CAYAAAAQlUaMAAAABmJLR0QAAAAAAAD5Q7t/AAAACXBIWXMAAC4jAAAuIwF4pT92AAALK0lEQVR42u1dPdJeNQ99t5AtZAvZQraQLaSiJi1lqKlSUDOTipq0lBlaqhTUzKSjfuCEMXNx5HslW5JlXxWe+b7hzXP9I58jH8ny0+PxeArZvnv+6fHNP/+ztN8/vAzb153b7utwHFvaWTat9sPLD/+zq5/fvM154bWYHfvj44sEC4OGOazbn5+eN/8e/23ndcBY0s6yeTg7SUoCUvr13esvE0a1X96+IYHMuuHbWmABYG2ND+2396/E/TubsyjGV8b946v3j2+fff5qPuv2/YuPj59ev/uy5nAK8BsYp9Y6nM3XLDvDeKXjOxtHaZi3+luwM86/RTtzFEq7skE0al+d/W3P/und39J+9M7DDLuCPWuSkvfeKft/GinVx8yorRcMKW/Yus0kI2xSjTWFbAei0lqHFWyMM74otq69b1ug6b1/pOC9Cn6NkNKsPgMDML/Fef/r87MkpSQlmeTpsZZJSklKSUr3IKWWooLTmSFBJSntQEqUzJaklKSUpJSkZNUQEsCYDMjpXw+b0nqx2GiUhLMSKWHSqFgQ4glljHWGGedIW461VGwqIiFhvOhjHa8o84MxcNZ6xDnYwc7qMZT+98giRxs6xgY4G73s22OsCvHDq/4ATPDf8bfH77biWK39w/kW1cq/aY2dE0+j5qFlV1FIa4SUWnHJHvyyICf0yz37jko8sDwhaIKhpseFv4mUqQJj4PRZstGxyakEAI918LQzKrNwZHxUxmirSYG3p7XW0CKIzT1Nzcps9O4fRRLWCVCj+FWcDzgI3OQoo/HFJCXNAPuupAQjujIcAJNmWv5OpIRGzd/I+LinPWx8a/ugxob+7QD60fsHUF+NlCh8gZ1KTmEjeBOelKhFTVLiecJHichiTnYiJe3xUanArWDxjBO0FRkmKV3b8WqkdCQnCo8NHa6YYKF5T2lHUoKhXPUV+v9q67C6nbUkQW8Jr+WwWH0zSenaKViVlLhOsKJEHBMsZty0X4mUOMkNGlkxmpdnI9oZdbIZHV8ECc9TuktS4knfq5OSxLYHZbyYYDGjvM1KpHR1nNaQ7maUe9rB+Zkt4XlLd0lKMcoMeeAXdx7hFA04xTHBYkahzJVI6aqvmv3cmZQsxieR8CwuILZkFsvb+ElK13t0B1JyUgLigkU9yUlK/Mt0Wicl73WYYWcWVdC5gWGNuB9HukN/dgP96P2rnYNdSIm7RwfGGxcsop0+ViIlzaB2fWHPMkC/i51xLzRrk0VLurMgvySle+IXdy4HvpWktCsprVgqfxc742RHWshqrfmzLqSZpJSklKR0c1Li6LqDwcYkpQUlPOqio7V0l6R0P/xKUkpS6ga8aGWR7mRn3hJeqwKHtXSXpJQnpSSlJCV22rFi6Y8kJYMyUJryGjV3+H6CfpLSDFIawJ0kpRVJSZJ2XO7ErCDl7WZn3FvwGqcZSrrzckiSlO6DX9w9OmDTMcAiAvCvVvtOWpIfXnP0TbebnXGquGtIeC3pTvlJgSQlZox3Z/zi3lNa+vJs7fUnKdmclo7ec9RTk6Wd1cDktZYeEt5M6S5J6SnEST5SRYflywzNAovVSUmyLhRgeQTAI5FSnXjgtZYeEt5M6e7upESdUnfFL843gC2Ddxnng0X920lKNsfpVqwpkqS3o51ZS3gt6c7iMb8kJd767ohfDrGkOKRUe5JJSvIsr9GnxAGIHq+hzrSzen0915L7UFqPhEfNmWaZqSQl+fzvhl/cfbnNI38zwWIHUtIiplIFYma8ydLO6tiO51paepkznt5OUjq/M7gLfmE+uAlVYZ9D12hJSv3EJM3IaxVz9crauoudtSS2UQkvgnS3EylptVXxCxiCucI+5Dq5cPaU8SJJaRdS0l4rAKT3qWlnO7OQ8CJId0lK65CSZgMZGSkrCRa7kVLxoDXkPACcp9e9s51ZSHgRpLskpXuREmzOWOZPsNiRlI7rxr0n4/3uz93sTFvCa/3ejISVJKV7kJITDuiCBRZf2mqPPklJ/5It967MbIO0tLMIa6l5G56aK6sn1u9CSqgpOYpfO5OSR8X5ENl3dfZKkpLdxhw1XGti2j3Lk1tIlzPPFBgOPEGdpHSDlPByL7FuEoXCIQkqL8/ehZSOlQ1GJD3LGNPu9+G4paGuPNLW78y6a3ZnUqKeKFkRvyTZdsYJUPPBor4RnaTkkz7eG7+xzO6ytLP6lDJrLTUkPOrENdM270xK1G+viF+SuJuxjDcfLOqAbZJS/Cw9qwyvO9RY1JDwqDWbWcswC7LucU8piIw3HyzqRU1Sin+3yaoCtaWd4eQRYS1HJbzWv59ZiSOfrtjj6QrYEPc+nULh1dikdAy6ed9GT1Jqa+PentId7KxVmoZLNNRJyykrKknpRHE42tbK+CWR8YzwMAZYRGizSKnOhFmFmCyeRriDnUnmmZLkokl3SUr74ZdEOTGQ8hMsZpOSdA7Rh9IsYjvctbZIeLgLKdVSIlfCo6Q7h2yoJKWb4ZdExjPIyF0HLKyPyDNIqSdzxyO2w73PtCspeZxeeyQ8SrrzfMwvSUkPv7QdCW38ksh4IDDF8awDFvXdmh1IqeeOlkeAmysv7UpKHt/rkfAo6W5WRfckpbFkCO1vWeCXRMZTjGuuARYeTw7PIKWeKgNeG+mupFTfm7M6jcKZ4FxiLpu9Jd1FqRaSpCSTa7Uz1yzwSyrjKVUUWQMs6u9bxDNmkFLP73uVluHMx46k5FlhhFuTEOAQVbpLUpI7Ois51dJitgrxpTXAwqNumTcpUYbKOQJ7AdNdScmzQDBlAy0JL6p0l6Qkdz4sTrgRnkNXSryJDxbU0dfiXoY3KVFzysmm86oMfTUfFmA9m5Qoicz6fSKOhEcR0ozH/JKU+lotga3oVEsqvwxiUnywoALCFkDhTUq9D7R53eZ30o9DkRIlkVmTUu+zIjMe80tS0omHr0hKGIekkPOAghMfLKjJXp2UWpukl5S0JTyOrGRRYmQ2Kc24mMqV8DyrtScp2Todq+IXt27joOMaGyxadb4stHRPUmp5xxwAPPNMtE5MM6S72aTUAi4PIJVkOEWT7pKU5BmWKzvV3Pt1A05dbLBoTcDKl2fPnsXmjIvziJe1524FLtFO5F5AKi2IG0m6S1KSr6uF9O2FX9yrDAPzqrtpNBf17KhoIV1wX24cPfmdBQxHSel4auqR1/D9K4OzBESunWnH0M5szQM0zxyVSI/57U5KmgrM2TdXr0gjTRMHpggw+5oV0QFuMBYnGwALFlf61j2Oefi3+NaVnGFR/oObXYI+SsZY/p5jNFqkdCQnzkYDyHEIAXNkkVThaWczbU1DwrPKthwBKG6sAX/nTUyS/mFuYRewD6lNwRbLXr/CEs05wN7l4ldRUjScmp7nbpjE9PTfBi1FPnseffNu0kUrAFTGKNXwvRoH8Ht+FwZRA/lx3bkbdoSQjuS8ip15xm64m9zqsvQZqKNvsJ+ydppzXBcYlgJ2jV/a/ZuNX9Te0cQv7MPe+e/dw+g/vlcw6StSWmERR46g0qNmdGOl5sOaZGE4oyeklWxsxvtZXAnPW7qTesQatmZRPHhlUoo6/7BFaXyJMR9JSquTUvGc4TFqkxN+T0tqWJGUvB/Pu/I8Z0h3SUrzT9+R51/6OOiWpCS9k7M7KdU6Lf4/DGvEg8Eca2v/K5KSd5bbVezDW7pLUopx+o5u870XwJukVL/zEelSnmYQ/diiZS/1GuhVDS2Ms9bcz7RdyyB0vQa72ZlW0LrED6g24zG/Eki32jujv1/j18oP9c1436vGRytspNapMZ4EgtXaEaRmP4OdLVu2bMrtb/rmDTutlLmzAAAAAElFTkSuQmCC</base64EncodedString>
                                <mimeType>image/png</mimeType>
                                <fileName>portrait.png</fileName>
                            </byte>-->
           </data>
        </personPhoto>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="personPhoto">
           <xs:annotation>
              <xs:documentation>
                        A specific photo of a given type. For instance a headshot as a profile photo, or a photo of them recieving an award. These can be displayed on the portal
                    </xs:documentation>
           </xs:annotation>
           <xs:all>
              <xs:element name="classification" type="commons:classification" minOccurs="1">
                 <xs:annotation>
                    <xs:documentation>
                                The type of photo. Must be a valid classification from the /dk/atira/pure/person/personfiles classificationscheme
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="data" type="dataType" minOccurs="1">
                 <xs:annotation>
                    <xs:documentation>
                                The data of the photo. This can be provided via a link to a URL that the Pure server has access to, a file path on the server or the base64 encoded byte being included in the xml file
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:all>
           <xs:attribute type="commons:string_400" name="id" use="required">
              <xs:annotation>
                 <xs:documentation>
                            This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor
                        </xs:documentation>
              </xs:annotation>
           </xs:attribute>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

@id

This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor

commons:string_400

Yes

classification

The type of photo. Must be a valid classification from the /dk/atira/pure/person/personfiles classificationscheme

commons:classification

Yes

data

The data of the photo. This can be provided via a link to a URL that the Pure server has access to, a file path on the server or the base64 encoded byte being included in the xml file

dataType

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>
                                Use the HTTP element to indicate that the synchronization should fetch the file from an URL.
                            </xs:documentation>
                 </xs:annotation>
                 <xs:complexType>
                    <xs:sequence>
                       <xs:element name="url" type="xs:string" minOccurs="1">
                          <xs:annotation>
                             <xs:documentation>URL pointing to where Pure can access the file</xs:documentation>
                          </xs:annotation>
                       </xs:element>
                       <xs:element name="mimeType" type="commons:string_256" minOccurs="0">
                          <xs:annotation>
                             <xs:documentation>MIME Type of the file, Pure will attempt to determine if not provided</xs:documentation>
                          </xs:annotation>
                       </xs:element>
                       <xs:element name="fileName" type="commons:string_256" minOccurs="0">
                          <xs:annotation>
                             <xs:documentation>Name to use for the file. Pure will derive if not provided</xs:documentation>
                          </xs:annotation>
                       </xs:element>
                    </xs:sequence>
                 </xs:complexType>
              </xs:element>
              <xs:element name="file">
                 <xs:annotation>
                    <xs:documentation>
                                Use the FILE element to indicate that the synchronization should fetch the file from the disk of the Pure installation.
                            </xs:documentation>
                 </xs:annotation>
                 <xs:complexType>
                    <xs:sequence>
                       <xs:element name="path" type="xs:string" minOccurs="1">
                          <xs:annotation>
                             <xs:documentation>Path to the file on the server</xs:documentation>
                          </xs:annotation>
                       </xs:element>
                       <xs:element name="mimeType" type="commons:string_256" minOccurs="0">
                          <xs:annotation>
                             <xs:documentation>MIME Type of the file, Pure will attempt to determine if not provided</xs:documentation>
                          </xs:annotation>
                       </xs:element>
                       <xs:element name="fileName" type="commons:string_256" minOccurs="0">
                          <xs:annotation>
                             <xs:documentation>Name to use for the file. Pure will derive if not provided</xs:documentation>
                          </xs:annotation>
                       </xs:element>
                    </xs:sequence>
                 </xs:complexType>
              </xs:element>
              <xs:element name="byte">
                 <xs:annotation>
                    <xs:documentation>
                                Use the byte element to indicate that the synchronization should fetch the base64 encoded file from base64EncodedString element
                            </xs:documentation>
                 </xs:annotation>
                 <xs:complexType>
                    <xs:sequence>
                       <xs:element name="base64EncodedString" type="xs:string" minOccurs="1">
                          <xs:annotation>
                             <xs:documentation>Base64 encoded string containing the file data</xs:documentation>
                          </xs:annotation>
                       </xs:element>
                       <xs:element name="mimeType" type="commons:string_256" minOccurs="1">
                          <xs:annotation>
                             <xs:documentation>MIME Type of the file</xs:documentation>
                          </xs:annotation>
                       </xs:element>
                       <xs:element name="fileName" type="commons:string_256" minOccurs="1">
                          <xs:annotation>
                             <xs:documentation>Name to use for the file</xs:documentation>
                          </xs:annotation>
                       </xs:element>
                    </xs:sequence>
                 </xs:complexType>
              </xs:element>
           </xs:choice>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

http 
(Option Group 1)

Use the HTTP element to indicate that the synchronization should fetch the file from an URL.

Contains below components

Yes

http.url 
(Option Group 1)

URL pointing to where Pure can access the file

xsd:string

Yes

http.mimeType 
(Option Group 1)

MIME Type of the file, Pure will attempt to determine if not provided

commons:string_256

No

http.fileName 
(Option Group 1)

Name to use for the file. Pure will derive if not provided

commons:string_256

No

file 
(Option Group 2)

Use the FILE element to indicate that the synchronization should fetch the file from the disk of the Pure installation.

Contains below components

Yes

file.path 
(Option Group 2)

Path to the file on the server

xsd:string

Yes

file.mimeType 
(Option Group 2)

MIME Type of the file, Pure will attempt to determine if not provided

commons:string_256

No

file.fileName 
(Option Group 2)

Name to use for the file. Pure will derive if not provided

commons:string_256

No

byte 
(Option Group 3)

Use the byte element to indicate that the synchronization should fetch the base64 encoded file from base64EncodedString element

Contains below components

Yes

byte.base64EncodedString 
(Option Group 3)

Base64 encoded string containing the file data

xsd:string

Yes

byte.mimeType 
(Option Group 3)

MIME Type of the file

commons:string_256

Yes

byte.fileName 
(Option Group 3)

Name to use for the file

commons:string_256

Yes


Profile Information

personCustomFields

A list of personCustomField elements of type personCustomField

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="personCustomFields">
           <xs:sequence>
              <xs:element name="personCustomField"
                          type="personCustomField"
                          maxOccurs="unbounded"/>
           </xs:sequence>
        </xs:complexType>
 
 

personCustomField

A free text field containing biographical information of the person

XML Example

<personCustomField xmlns="v1.unified-person-sync.pure.atira.dk"
                           xmlns:cmns="v3.commons.pure.atira.dk"
                           id="person1ProfileInfo1">
           <typeClassification>researchinterests</typeClassification>
           <value>
              <cmns:text lang="en" country="GB">
                                Elsevier is a world-leading provider of information solutions that help you make better decisions, deliver better care, and sometimes make groundbreaking discoveries in science, health, and technology.
                                Elsevier's cross-discipline platforms support your research journey, enable research and career management, and empower you to make an even greater impact in your field.
                            </cmns:text>
           </value>
        </personCustomField>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="personCustomField">
           <xs:annotation>
              <xs:documentation>
                        A free text field containing biographical information of the person
                    </xs:documentation>
           </xs:annotation>
           <xs:all>
              <xs:element name="typeClassification"
                          type="commons:classification"
                          minOccurs="1">
                 <xs:annotation>
                    <xs:documentation>
                                The type of the custom field. Must be a valid classification from the /dk/atira/pure/person/customfields classification scheme
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="value" type="commons:localized_string" minOccurs="1">
                 <xs:annotation>
                    <xs:documentation>
                                The text value for the field
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:all>
           <xs:attribute type="commons:string_400" name="id" use="required">
              <xs:annotation>
                 <xs:documentation>
                            This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor
                        </xs:documentation>
              </xs:annotation>
           </xs:attribute>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

@id

This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor

commons:string_400

Yes

typeClassification

The type of the custom field. Must be a valid classification from the /dk/atira/pure/person/customfields classification scheme

commons:classification

Yes

value

The text value for the field

commons:localized_string

Yes


Name Variants

names

A list of classifiedName elements of type classifiedName

XML Example

<names xmlns="v1.unified-person-sync.pure.atira.dk"
               xmlns:cmns="v3.commons.pure.atira.dk"><!-- IDs like this need to be unique for the person, but not for all people in Pure. They are used to definitively identify the entry, so if the type or value is changed, then the existing entry will be updated, not a new one created -->
           <classifiedName id="classifiedAssoc1">
              <name>
                 <cmns:firstname>Johnny</cmns:firstname>
                 <cmns:lastname>Doe</cmns:lastname>
              </name>
              <typeClassification>knownas</typeClassification>
           </classifiedName>
        </names>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="names">
           <xs:sequence>
              <xs:element name="classifiedName" type="classifiedName" maxOccurs="unbounded"/>
           </xs:sequence>
        </xs:complexType>
 
 

classifiedName

A name variant of a defined type

XML Example

<classifiedName xmlns="v1.unified-person-sync.pure.atira.dk"
                        xmlns:cmns="v3.commons.pure.atira.dk"
                        id="classifiedAssoc1">
           <name>
              <cmns:firstname>Johnny</cmns:firstname>
              <cmns:lastname>Doe</cmns:lastname>
           </name>
           <typeClassification>knownas</typeClassification>
        </classifiedName>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="classifiedName">
           <xs:annotation>
              <xs:documentation>
                        A name variant of a defined type
                    </xs:documentation>
           </xs:annotation>
           <xs:all>
              <xs:element name="name" type="commons:name" minOccurs="1"/>
              <xs:element name="typeClassification"
                          type="commons:classification"
                          minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>
                                The type of name. Must be a valid classification from the /dk/atira/pure/person/names classification scheme
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:all>
           <xs:attribute type="commons:string_400" name="id" use="required">
              <xs:annotation>
                 <xs:documentation>
                            This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor
                        </xs:documentation>
              </xs:annotation>
           </xs:attribute>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

@id

This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor

commons:string_400

Yes

name

 

commons:name

Yes

typeClassification

The type of name. Must be a valid classification from the /dk/atira/pure/person/names classification scheme

commons:classification

No


Education/Qualifications

personEducations

A list of personEducation elements of type personEducation

XML Example

<personEducations xmlns="v1.unified-person-sync.pure.atira.dk"
                          xmlns:cmns="v3.commons.pure.atira.dk">
           <personEducation id="person1EducationAssoc1">
              <startDate>
                 <cmns:year>2002</cmns:year>
                 <cmns:month>12</cmns:month>
                 <cmns:day>31</cmns:day>
              </startDate>
              <endDate>
                 <cmns:year>2006</cmns:year>
                 <cmns:month>12</cmns:month>
                 <cmns:day>31</cmns:day>
              </endDate>
              <!-- Only one of the two following fields should be used. Whether to use the fieldOfStudy as a string or classification is defined under System Settings -> Person -->
              <fieldOfStudyString>
                 <cmns:text lang="en" country="GB">Electronics</cmns:text>
              </fieldOfStudyString>
              <fieldOfStudy>unknown</fieldOfStudy>
              <!-- Only one of the two following fields should be used. Whether to use the qualification as a string or classification is defined under System Settings -> Person -->
              <qualificationString>
                 <cmns:text lang="en" country="GB">Child genius</cmns:text>
              </qualificationString>
              <qualification>doctorate</qualification>
              <organisations>
                 <organisation>
                    <cmns:source_id>organisation1</cmns:source_id>
                 </organisation>
              </organisations>
              <projectTitle>
                 <cmns:text lang="en" country="GB">Tesla Coils influence on the earths core</cmns:text>
              </projectTitle>
              <awardDate>05-04-2009</awardDate>
           </personEducation>
        </personEducations>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="personEducations">
           <xs:sequence>
              <xs:element name="personEducation" type="personEducation" maxOccurs="unbounded"/>
           </xs:sequence>
        </xs:complexType>
 
 

personEducation

Details of a specific education qualification the person has achieved

XML Example

<personEducation xmlns="v1.unified-person-sync.pure.atira.dk"
                         xmlns:cmns="v3.commons.pure.atira.dk"
                         id="person1EducationAssoc1">
           <startDate>
              <cmns:year>2002</cmns:year>
              <cmns:month>12</cmns:month>
              <cmns:day>31</cmns:day>
           </startDate>
           <endDate>
              <cmns:year>2006</cmns:year>
              <cmns:month>12</cmns:month>
              <cmns:day>31</cmns:day>
           </endDate>
           <!-- Only one of the two following fields should be used. Whether to use the fieldOfStudy as a string or classification is defined under System Settings -> Person -->
           <fieldOfStudyString>
              <cmns:text lang="en" country="GB">Electronics</cmns:text>
           </fieldOfStudyString>
           <fieldOfStudy>unknown</fieldOfStudy>
           <!-- Only one of the two following fields should be used. Whether to use the qualification as a string or classification is defined under System Settings -> Person -->
           <qualificationString>
              <cmns:text lang="en" country="GB">Child genius</cmns:text>
           </qualificationString>
           <qualification>doctorate</qualification>
           <organisations>
              <organisation>
                 <cmns:source_id>organisation1</cmns:source_id>
              </organisation>
           </organisations>
           <projectTitle>
              <cmns:text lang="en" country="GB">Tesla Coils influence on the earths core</cmns:text>
           </projectTitle>
           <awardDate>05-04-2009</awardDate>
        </personEducation>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="personEducation">
           <xs:annotation>
              <xs:documentation>
                        Details of a specific education qualification the person has achieved
                    </xs:documentation>
           </xs:annotation>
           <xs:all>
              <xs:element name="startDate" type="commons:compoundDate" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The start date of the education, broken into seperate elements for year, month and day.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="endDate" type="commons:compoundDate" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The end date of the education, broken into seperate elements for year, month and day.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="fieldOfStudyString"
                          type="commons:localized_string_1024"
                          minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>
                                Free text description of the field of study. Only one of the field of study fields should be used, which is determined by System Settings under Person
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="fieldOfStudy" type="commons:classification" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The field of study. Must be a valid classification from the /dk/atira/pure/personeducation/fieldofstudy classification scheme. Only one of the field of study fields should be used, which is determined by System Settings under Person</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="qualificationString"
                          type="commons:localized_string_1024"
                          minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Free text description of the qualification. Only one of the qualification fields should be used, which is determined by System Settings under Person</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="qualification" type="commons:classification" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The qualification. Must be a valid classification from the /dk/atira/pure/personeducation/qualification classification scheme. Only one of the qualification fields should be used, which is determined by System Settings under Person</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="organisations"
                          type="internalExternalOrganisationAssociation"
                          minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The organisation the study was undertaken at. Can be internal or external.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="projectTitle"
                          type="commons:localized_string_1024"
                          minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>
                                This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="awardDate" type="commons:date" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Should be in format dd-MM-yyyy</xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:all>
           <xs:attribute type="commons:string_400" name="id" use="required">
              <xs:annotation>
                 <xs:documentation>
                            This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor
                        </xs:documentation>
              </xs:annotation>
           </xs:attribute>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

@id

This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor

commons:string_400

Yes

startDate

The start date of the education, broken into seperate elements for year, month and day.

commons:compoundDate

No

endDate

The end date of the education, broken into seperate elements for year, month and day.

commons:compoundDate

No

fieldOfStudyString

Free text description of the field of study. Only one of the field of study fields should be used, which is determined by System Settings under Person

commons:localized_string_1024

No

fieldOfStudy

The field of study. Must be a valid classification from the /dk/atira/pure/personeducation/fieldofstudy classification scheme. Only one of the field of study fields should be used, which is determined by System Settings under Person

commons:classification

No

qualificationString

Free text description of the qualification. Only one of the qualification fields should be used, which is determined by System Settings under Person

commons:localized_string_1024

No

qualification

The qualification. Must be a valid classification from the /dk/atira/pure/personeducation/qualification classification scheme. Only one of the qualification fields should be used, which is determined by System Settings under Person

commons:classification

No

organisations

The organisation the study was undertaken at. Can be internal or external.

internalExternalOrganisationAssociation

No

projectTitle

This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor

commons:localized_string_1024

No

awardDate

Should be in format dd-MM-yyyy

commons:date

No

professionalQualifications

A list of professionalQualification elements of type professionalQualification

Contains one or more professional qualifications

XML Example

<professionalQualifications xmlns="v1.unified-person-sync.pure.atira.dk"
                                    xmlns:cmns="v3.commons.pure.atira.dk">
           <professionalQualification id="person1Qualification1">
              <startDate>
                 <cmns:year>2001</cmns:year>
                 <cmns:month>12</cmns:month>
                 <cmns:day>31</cmns:day>
              </startDate>
              <endDate>
                 <cmns:year>2003</cmns:year>
                 <cmns:month>12</cmns:month>
                 <cmns:day>31</cmns:day>
              </endDate>
              <qualification>
                 <cmns:text lang="en" country="GB">Genius</cmns:text>
              </qualification>
              <abbreviatedQualification>
                 <cmns:text lang="en" country="GB">Genius</cmns:text>
              </abbreviatedQualification>
           </professionalQualification>
        </professionalQualifications>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema"
                        name="professionalQualifications">
           <xs:annotation>
              <xs:documentation>
                        Contains one or more professional qualifications
                    </xs:documentation>
           </xs:annotation>
           <xs:sequence>
              <xs:element name="professionalQualification"
                          type="professionalQualification"
                          maxOccurs="unbounded"/>
           </xs:sequence>
        </xs:complexType>
 
 

professionalQualification

Details of a professional qualification the person has achieved

XML Example

<professionalQualification xmlns="v1.unified-person-sync.pure.atira.dk"
                                   xmlns:cmns="v3.commons.pure.atira.dk"
                                   id="person1Qualification1">
           <startDate>
              <cmns:year>2001</cmns:year>
              <cmns:month>12</cmns:month>
              <cmns:day>31</cmns:day>
           </startDate>
           <endDate>
              <cmns:year>2003</cmns:year>
              <cmns:month>12</cmns:month>
              <cmns:day>31</cmns:day>
           </endDate>
           <qualification>
              <cmns:text lang="en" country="GB">Genius</cmns:text>
           </qualification>
           <abbreviatedQualification>
              <cmns:text lang="en" country="GB">Genius</cmns:text>
           </abbreviatedQualification>
        </professionalQualification>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema"
                        name="professionalQualification">
           <xs:annotation>
              <xs:documentation>
                        Details of a professional qualification the person has achieved
                    </xs:documentation>
           </xs:annotation>
           <xs:all>
              <xs:element name="startDate" type="commons:compoundDate" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The start date of the qualification, broken into seperate elements for year, month and day.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="endDate" type="commons:compoundDate" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The end date of the qualification, broken into seperate elements for year, month and day.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="qualification" type="commons:localized_string_1024">
                 <xs:annotation>
                    <xs:documentation>Free text description of the qualification</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="abbreviatedQualification"
                          type="commons:localized_string_1024"
                          minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Abbreviated name of the qualification</xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:all>
           <xs:attribute type="commons:string_400" name="id" use="required">
              <xs:annotation>
                 <xs:documentation>
                            This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor
                        </xs:documentation>
              </xs:annotation>
           </xs:attribute>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

@id

This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor

commons:string_400

Yes

startDate

The start date of the qualification, broken into seperate elements for year, month and day.

commons:compoundDate

No

endDate

The end date of the qualification, broken into seperate elements for year, month and day.

commons:compoundDate

No

qualification

Free text description of the qualification

commons:localized_string_1024

Yes

abbreviatedQualification

Abbreviated name of the qualification

commons:localized_string_1024

No


Positions outside the institution

externalPositions

A list of externalPosition elements of type externalPosition

XML Example

<externalPositions xmlns="v1.unified-person-sync.pure.atira.dk"
                           xmlns:cmns="v3.commons.pure.atira.dk">
           <externalPosition id="person1ExternalPosAssoc1">
              <startDate>
                 <cmns:year>2005</cmns:year>
                 <cmns:month>04</cmns:month>
                 <cmns:day>13</cmns:day>
              </startDate>
              <endDate>
                 <cmns:year>2007</cmns:year>
                 <cmns:month>02</cmns:month>
                 <cmns:day>13</cmns:day>
              </endDate>
              <!-- Only one of the two following fields should be used. Whether to use the appointment as a string or classification is defined under System Settings -> Person -->
              <appointment>professor</appointment>
              <appointmentString>Professor</appointmentString>
              <externalOrganisationAssociation><!--
                            <identification>
                                <cmns:source_id>extorganisation1</cmns:source_id>
                            </identification> --><!-- Rather than specifying the id for the organisation you can specify the details below, Pure will attempt to match to existing organisations and create if not found -->
                 <externalOrganisation>
                    <name>IBM</name>
                    <type>corporate</type>
                    <country>us</country>
                 </externalOrganisation>
              </externalOrganisationAssociation>
           </externalPosition>
        </externalPositions>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="externalPositions">
           <xs:sequence>
              <xs:element name="externalPosition"
                          type="externalPosition"
                          maxOccurs="unbounded"/>
           </xs:sequence>
        </xs:complexType>
 
 

externalPosition

Details of an external position the person has been appointed to

XML Example

<externalPosition xmlns="v1.unified-person-sync.pure.atira.dk"
                          xmlns:cmns="v3.commons.pure.atira.dk"
                          id="person1ExternalPosAssoc1">
           <startDate>
              <cmns:year>2005</cmns:year>
              <cmns:month>04</cmns:month>
              <cmns:day>13</cmns:day>
           </startDate>
           <endDate>
              <cmns:year>2007</cmns:year>
              <cmns:month>02</cmns:month>
              <cmns:day>13</cmns:day>
           </endDate>
           <!-- Only one of the two following fields should be used. Whether to use the appointment as a string or classification is defined under System Settings -> Person -->
           <appointment>professor</appointment>
           <appointmentString>Professor</appointmentString>
           <externalOrganisationAssociation><!--
                            <identification>
                                <cmns:source_id>extorganisation1</cmns:source_id>
                            </identification> --><!-- Rather than specifying the id for the organisation you can specify the details below, Pure will attempt to match to existing organisations and create if not found -->
              <externalOrganisation>
                 <name>IBM</name>
                 <type>corporate</type>
                 <country>us</country>
              </externalOrganisation>
           </externalOrganisationAssociation>
        </externalPosition>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="externalPosition">
           <xs:annotation>
              <xs:documentation>
                        Details of an external position the person has been appointed to
                    </xs:documentation>
           </xs:annotation>
           <xs:all>
              <xs:element name="startDate" type="commons:compoundDate" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The start date of the external position, broken into seperate elements for year, month and day.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="endDate" type="commons:compoundDate" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The end date of the position, broken into seperate elements for year, month and day.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="appointment" type="commons:classification" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The type of appointment. Must be a valid classification from the /dk/atira/pure/person/externalposition classification scheme. By default the appointment field is free text using the appointmentString field. This must be enabled under System Settings -&gt; Person</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="appointmentString" type="commons:string_512" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Description of the appointment. By default the appointment field is free text, but you can switch to using a classification and the appointment element. This must be enabled under System Settings -&gt; Person</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="externalOrganisationAssociation"
                          type="externalOrganisationAssociation"
                          minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The external organisation where the position was based.</xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:all>
           <xs:attribute type="commons:string_400" name="id" use="required">
              <xs:annotation>
                 <xs:documentation>
                            This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor
                        </xs:documentation>
              </xs:annotation>
           </xs:attribute>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

@id

This should be unique for the person and is used to differentiate which record is modified when data is synchronized. It is not displayed in the editor

commons:string_400

Yes

startDate

The start date of the external position, broken into seperate elements for year, month and day.

commons:compoundDate

No

endDate

The end date of the position, broken into seperate elements for year, month and day.

commons:compoundDate

No

appointment

The type of appointment. Must be a valid classification from the /dk/atira/pure/person/externalposition classification scheme. By default the appointment field is free text using the appointmentString field. This must be enabled under System Settings -> Person

commons:classification

No

appointmentString

Description of the appointment. By default the appointment field is free text, but you can switch to using a classification and the appointment element. This must be enabled under System Settings -> Person

commons:string_512

No

externalOrganisationAssociation

The external organisation where the position was based.

externalOrganisationAssociation

No


Organisational Affiliations

organisationAssociations

A list of organisationAssociation elements of type organisationAssociation 
For each person at least one organisation association has to be included in the XML file. The association can be one of four types: staffOrganisationAssociation, studentOrganisationAssociation, honoraryOrganisationAssociation or visitingOrganisationAssociation. 
There can always be more than one association per person , e.g. two staffOrganisationAssociation elements, even to the same organisation, or a visitingOrganisationAssociation element and a staffOrganisationAssociation element. You do not need to add elements you do not want to synchronise, so if you only want to synchronise staffOrganisationAssociation element, you do not need to add any other association elements.

XML Example

<organisationAssociations xmlns="v1.unified-person-sync.pure.atira.dk"
                                  xmlns:cmns="v3.commons.pure.atira.dk"><!-- At least one organisation association is required, but it can be any of the four types -->
           <staffOrganisationAssociation id="staffAssoc1" managedInPure="false">
              <affiliationId>affilID1</affiliationId>
              <addresses>
                 <cmns:classifiedAddress id="staffAssoc1ClassifiedAddressAssoc1">
                    <cmns:addressType>visiting</cmns:addressType>
                    <cmns:city>London</cmns:city>
                    <cmns:postalCode>SW1V 4NP</cmns:postalCode>
                    <cmns:street>Wayne Street</cmns:street>
                    <cmns:country>GB</cmns:country>
                    <cmns:building>21</cmns:building>
                    <cmns:displayFormat>
                                    London
                                    Wayne Street
                                    England
                                    SW1V 4NP
                                </cmns:displayFormat>
                    <cmns:subDivision>us/ak</cmns:subDivision>
                    <cmns:geoLocation>
                       <cmns:point>57.021218,9.976927</cmns:point>
                       <cmns:polygon>
                                        57.100452089370705, 9.525146484375
                                        56.935984453472, 9.832763671875
                                        57.01083265740579, 10.2008056640625
                                        57.1779474000072, 10.1019287109375
                                        57.20771009775018, 9.7833251953125
                                        57.097468259301586, 9.5196533203125
                                    </cmns:polygon>
                    </cmns:geoLocation>
                 </cmns:classifiedAddress>
              </addresses>
              <phoneNumbers>
                 <cmns:classifiedPhoneNumber id="personStaffAssoc1PhoneNumber1">
                    <cmns:classification>phone</cmns:classification>
                    <cmns:value>07700900005</cmns:value>
                 </cmns:classifiedPhoneNumber>
              </phoneNumbers>
              <emails>
                 <cmns:classifiedEmail id="personStaffAssocEmail1">
                    <cmns:classification>email</cmns:classification>
                    <cmns:value>london@london.uk</cmns:value>
                 </cmns:classifiedEmail>
              </emails>
              <webAddresses>
                 <cmns:classifiedWebAddress id="personStaffAssoc1WebAdress1">
                    <cmns:classification>web</cmns:classification>
                    <cmns:value>
                       <cmns:text lang="en" country="GB">http:\\www.london.uk</cmns:text>
                    </cmns:value>
                 </cmns:classifiedWebAddress>
              </webAddresses>
              <employmentType>academic</employmentType>
              <primaryAssociation>true</primaryAssociation>
              <organisation>
                 <cmns:source_id>organisation1</cmns:source_id>
              </organisation>
              <period>
                 <cmns:startDate>02-02-1988</cmns:startDate>
                 <cmns:endDate>04-04-2011</cmns:endDate>
              </period>
              <keywords>
                 <cmns:logicalGroup logicalName="exofficio">
                    <cmns:structuredKeywords>
                       <cmns:structuredKeyword classification="headofdepartment"/>
                    </cmns:structuredKeywords>
                 </cmns:logicalGroup>
              </keywords>
              <!--
                            When using Synchronised Jobs to create people, supervisor relationships are created
                            by using the Configurable Supervisor Synchronisation job on the same xml.
                            The Configurable Person Synchronisation job must be run first so as to create
                            all the people before these relationships are then added
                        -->
              <supervisedByRelations>
                 <supervisorRelation id="supervisorRelation1">
                    <supervisor>
                       <cmns:source_id>supervisor1</cmns:source_id>
                    </supervisor>
                    <supervisionPercentage>1</supervisionPercentage>
                    <period>
                       <cmns:startDate>18-07-2004</cmns:startDate>
                       <cmns:endDate>17-08-2005</cmns:endDate>
                    </period>
                    <supervisorRole>lead</supervisorRole>
                 </supervisorRelation>
              </supervisedByRelations>
              <staffType>academic</staffType>
              <!-- This value is required and is used to determine licenses, which are based on current Academic staff -->
              <contractType>fixedterm</contractType>
              <jobTitle>juniorprofessor</jobTitle>
              <jobDescription>
                 <cmns:text lang="en">Science research</cmns:text>
              </jobDescription>
              <fte>1</fte>
           </staffOrganisationAssociation>
           <visitingOrganisationAssociation id="visitingAssoc2">
              <organisation>
                 <cmns:non_explicit_id>organisation2</cmns:non_explicit_id>
              </organisation>
              <period>
                 <cmns:startDate>01-01-2000</cmns:startDate>
              </period>
              <jobTitle>visitingprofessor</jobTitle>
              <jobDescription>
                 <cmns:text lang="en">Scientific Research</cmns:text>
              </jobDescription>
              <purposeOfStay>Sabbatical</purposeOfStay>
              <visitorFrom>
                 <identification>
                    <cmns:source_id>extorganisation2</cmns:source_id>
                 </identification>
                 <!-- Rather than specifying the id for the organisation you can specify the details below, Pure will attempt to match to existing organisations and create if not found -->
                 <!--
                            <externalOrganisation>
                                <name>Harvard</name>
                                <type>academic</type>
                                <country>us</country>
                            </externalOrganisation> -->
              </visitorFrom>
           </visitingOrganisationAssociation>
           <honoraryOrganisationAssociation id="honoraryAssoc3">
              <organisation>
                 <cmns:non_explicit_id>organisation2</cmns:non_explicit_id>
              </organisation>
              <period>
                 <cmns:startDate>01-05-2010</cmns:startDate>
              </period>
              <jobTitle>adjunctprofessor</jobTitle>
              <jobDescription>
                 <cmns:text lang="en">Adjunct Professor in Microbology</cmns:text>
              </jobDescription>
           </honoraryOrganisationAssociation>
           <studentOrganisationAssociation id="studentAssoc4">
              <organisation>
                 <cmns:source_id>organisation2</cmns:source_id>
              </organisation>
              <period>
                 <cmns:startDate>25-08-2022</cmns:startDate>
                 <!--Date format should be DD-MM-YYYYY-->
              </period>
              <supervisedByRelations>
                 <supervisorRelation id="supervisorRelation2"><!-- Supervisor element is used to match to internal supervisor -->
                    <supervisor>
                       <cmns:source_id>supervisor1</cmns:source_id>
                    </supervisor>
                    <supervisionPercentage>0.6</supervisionPercentage>
                    <period>
                       <cmns:startDate>25-08-2022</cmns:startDate>
                       <cmns:endDate>31-12-2022</cmns:endDate>
                    </period>
                    <supervisorRole>lead</supervisorRole>
                 </supervisorRelation>
                 <supervisorRelation id="supervisorRelation2">
                    <externalSupervisor><!-- Can use either ID or name matching. If name does not match any existing external persons then it will be created --><!--
                                    <id>
                                        <cmns:source_id>supervisor2</cmns:source_id>
                                    </id> -->
                       <firstName>Pedro</firstName>
                       <lastName>Luna</lastName>
                       <country>br</country>
                    </externalSupervisor>
                    <supervisionPercentage>0.4</supervisionPercentage>
                    <period><!-- Exclude end date element to show supervision is ongoing -->
                       <cmns:startDate>18-07-2004</cmns:startDate>
                    </period>
                    <supervisorRole>second</supervisorRole>
                 </supervisorRelation>
              </supervisedByRelations>
              <status>current</status>
              <!-- related to classification: /dk/atira/pure/person/studentstatus-->
              <startYear>2022</startYear>
              <programme>Doctorate of Philosophy</programme>
              <studentTypeDescription>other</studentTypeDescription>
              <!-- related to classification: /dk/atira/pure/person/studenttypedescription-->
              <expectedStudyDuration>4</expectedStudyDuration>
              <minStudyDuration>3</minStudyDuration>
              <maxStudyDuration>5</maxStudyDuration>
              <programmeYear>2023</programmeYear>
              <initialSubmissionDate>01-02-2023</initialSubmissionDate>
              <expectedEndDate>31-12-2023</expectedEndDate>
              <studentNationality>US</studentNationality>
              <studentResidencyFlag>home</studentResidencyFlag>
              <studentCountryOfDomicile>GB</studentCountryOfDomicile>
              <awardGained>PhD</awardGained>
              <projectTitle>
                 <cmns:text lang="en">Study of the effects of low gravity upon micro-organisms</cmns:text>
              </projectTitle>
              <awardDate>30-06-2023</awardDate>
              <fte>1</fte>
           </studentOrganisationAssociation>
        </organisationAssociations>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="organisationAssociations">
           <xs:annotation>
              <xs:documentation>For each person at least one organisation association has to be included in the XML file. The association can be one of four types: staffOrganisationAssociation, studentOrganisationAssociation, honoraryOrganisationAssociation or visitingOrganisationAssociation.
                    There can always be more than one association per person , e.g. two staffOrganisationAssociation elements, even to the same organisation, or a visitingOrganisationAssociation element and a staffOrganisationAssociation element. You do not need to add elements you do not want to synchronise, so if you only want to synchronise staffOrganisationAssociation element, you do not need to add any other association elements.</xs:documentation>
           </xs:annotation>
           <xs:sequence>
              <xs:element ref="organisationAssociation" maxOccurs="unbounded"/>
           </xs:sequence>
        </xs:complexType>
 
 

organisationAssociation

Base details common across all organisation association types

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema"
                        name="organisationAssociationType"
                        abstract="true">
           <xs:annotation>
              <xs:documentation>Base details common across all organisation association types</xs:documentation>
           </xs:annotation>
           <xs:sequence>
              <xs:element name="affiliationId" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The person's unique identifier for this position (such as staff id or student id)</xs:documentation>
                 </xs:annotation>
                 <xs:simpleType>
                    <xs:restriction base="xs:string">
                       <xs:maxLength value="30"/>
                    </xs:restriction>
                 </xs:simpleType>
              </xs:element>
              <xs:element name="addresses" type="commons:classifiedAddresses" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>A list of addresses related to the organisation affiliation (such as office location). The addressType element must be a token of the classification /dk/atira/pure/person/personaddresstype</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="phoneNumbers"
                          type="commons:classifiedPhoneNumbers"
                          minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>A list of phone numbers related to the organisation affiliation. The classification element must be a token of the classification /dk/atira/pure/person/personphonenumbertype</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="emails" type="commons:classifiedEmails" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>A list of email addresses related to the organisation affiliation. The classification element must be a token of the classification /dk/atira/pure/person/personemailtype</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="webAddresses"
                          type="commons:classifiedWebAddresses"
                          minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>A list of web addresses related to the organisation affiliation. The classification element must be a token of the classification /dk/atira/pure/person/personwebaddresstype</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="employmentType" type="commons:classification" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>
                                The type of association. Must be a valid classification from the /dk/atira/pure/person/employmenttypes classification scheme for staff, visiting and honorary organisation associations
                                or /dk/atira/pure/person/studenttype for student organisation associations
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="primaryAssociation"
                          type="xs:boolean"
                          default="false"
                          minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Whether the association is the primary one for the person. Default false. Please be aware that only one associaton in total (staff, student, visting and honory) an be the primary association. Whether this field is enabled is controlled by the System Settings -&gt; Person</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="organisation"
                          type="commons:classifiedIdentification"
                          minOccurs="1">
                 <xs:annotation>
                    <xs:documentation>The unique id of the organisation unit this association is related to</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="period" type="commons:dateRange">
                 <xs:annotation>
                    <xs:documentation>The period of time that the affiliation ran for. To show ongoing relationships, omit the endDate element.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="keywords" type="commons:keywords" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>A list of free text and/or structured keywords related to the association. Note that the logicalGroups here should match the affiliation type with the affiliation recorded in the Keyword specification</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="supervisedByRelations"
                          type="supervisorRelations"
                          minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>A list of the supervisors of the person in this particular affiliation. To load these via XML synchronization, the person xml sync job must be run first, followed by the Supervisor Synchronization job which uses the same XML. This way all necessary people are created before they are then linked as supervisors.</xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:sequence>
           <xs:attribute type="commons:string_400" name="id" use="required">
              <xs:annotation>
                 <xs:documentation>The unique identifier for the organisation association. This ID must be unique and not change. It is used to control any updates to the record via the synchronization and is not displayed in the editor</xs:documentation>
              </xs:annotation>
           </xs:attribute>
           <xs:attribute type="xs:boolean" name="managedInPure" use="optional">
              <xs:annotation>
                 <xs:documentation>Whether the association is managed in Pure after creation or by the XML synchronisation. If you wish to update the record via XML post creation, this must be "false"</xs:documentation>
              </xs:annotation>
           </xs:attribute>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

@id

The unique identifier for the organisation association. This ID must be unique and not change. It is used to control any updates to the record via the synchronization and is not displayed in the editor

commons:string_400

Yes

@managedInPure

Whether the association is managed in Pure after creation or by the XML synchronisation. If you wish to update the record via XML post creation, this must be "false"

xsd:boolean

Yes

affiliationId

The person's unique identifier for this position (such as staff id or student id)

xsd:string

No

addresses

A list of addresses related to the organisation affiliation (such as office location). The addressType element must be a token of the classification /dk/atira/pure/person/personaddresstype

commons:classifiedAddresses

No

phoneNumbers

A list of phone numbers related to the organisation affiliation. The classification element must be a token of the classification /dk/atira/pure/person/personphonenumbertype

commons:classifiedPhoneNumbers

No

emails

A list of email addresses related to the organisation affiliation. The classification element must be a token of the classification /dk/atira/pure/person/personemailtype

commons:classifiedEmails

No

webAddresses

A list of web addresses related to the organisation affiliation. The classification element must be a token of the classification /dk/atira/pure/person/personwebaddresstype

commons:classifiedWebAddresses

No

employmentType

The type of association. Must be a valid classification from the /dk/atira/pure/person/employmenttypes classification scheme for staff, visiting and honorary organisation associations or /dk/atira/pure/person/studenttype for student organisation associations

commons:classification

No

primaryAssociation

Whether the association is the primary one for the person. Default false. Please be aware that only one associaton in total (staff, student, visting and honory) an be the primary association. Whether this field is enabled is controlled by the System Settings -> Person

xsd:boolean

No

organisation

The unique id of the organisation unit this association is related to

commons:classifiedIdentification

Yes

period

The period of time that the affiliation ran for. To show ongoing relationships, omit the endDate element.

commons:dateRange

Yes

keywords

A list of free text and/or structured keywords related to the association. Note that the logicalGroups here should match the affiliation type with the affiliation recorded in the Keyword specification

commons:keywords

No

supervisedByRelations

A list of the supervisors of the person in this particular affiliation. To load these via XML synchronization, the person xml sync job must be run first, followed by the Supervisor Synchronization job which uses the same XML. This way all necessary people are created before they are then linked as supervisors.

supervisorRelations

No

staffOrganisationAssociation

Used to represent a persons staff affiliation with an organisational unit. Note that licence counts in Pure are determined based on the number of people with current staff affiliations with staffType of academic.

XML Example

<staffOrganisationAssociation xmlns="v1.unified-person-sync.pure.atira.dk"
                                      xmlns:cmns="v3.commons.pure.atira.dk"
                                      id="staffAssoc1"
                                      managedInPure="false">
           <affiliationId>affilID1</affiliationId>
           <addresses>
              <cmns:classifiedAddress id="staffAssoc1ClassifiedAddressAssoc1">
                 <cmns:addressType>visiting</cmns:addressType>
                 <cmns:city>London</cmns:city>
                 <cmns:postalCode>SW1V 4NP</cmns:postalCode>
                 <cmns:street>Wayne Street</cmns:street>
                 <cmns:country>GB</cmns:country>
                 <cmns:building>21</cmns:building>
                 <cmns:displayFormat>
                                    London
                                    Wayne Street
                                    England
                                    SW1V 4NP
                                </cmns:displayFormat>
                 <cmns:subDivision>us/ak</cmns:subDivision>
                 <cmns:geoLocation>
                    <cmns:point>57.021218,9.976927</cmns:point>
                    <cmns:polygon>
                                        57.100452089370705, 9.525146484375
                                        56.935984453472, 9.832763671875
                                        57.01083265740579, 10.2008056640625
                                        57.1779474000072, 10.1019287109375
                                        57.20771009775018, 9.7833251953125
                                        57.097468259301586, 9.5196533203125
                                    </cmns:polygon>
                 </cmns:geoLocation>
              </cmns:classifiedAddress>
           </addresses>
           <phoneNumbers>
              <cmns:classifiedPhoneNumber id="personStaffAssoc1PhoneNumber1">
                 <cmns:classification>phone</cmns:classification>
                 <cmns:value>07700900005</cmns:value>
              </cmns:classifiedPhoneNumber>
           </phoneNumbers>
           <emails>
              <cmns:classifiedEmail id="personStaffAssocEmail1">
                 <cmns:classification>email</cmns:classification>
                 <cmns:value>london@london.uk</cmns:value>
              </cmns:classifiedEmail>
           </emails>
           <webAddresses>
              <cmns:classifiedWebAddress id="personStaffAssoc1WebAdress1">
                 <cmns:classification>web</cmns:classification>
                 <cmns:value>
                    <cmns:text lang="en" country="GB">http:\\www.london.uk</cmns:text>
                 </cmns:value>
              </cmns:classifiedWebAddress>
           </webAddresses>
           <employmentType>academic</employmentType>
           <primaryAssociation>true</primaryAssociation>
           <organisation>
              <cmns:source_id>organisation1</cmns:source_id>
           </organisation>
           <period>
              <cmns:startDate>02-02-1988</cmns:startDate>
              <cmns:endDate>04-04-2011</cmns:endDate>
           </period>
           <keywords>
              <cmns:logicalGroup logicalName="exofficio">
                 <cmns:structuredKeywords>
                    <cmns:structuredKeyword classification="headofdepartment"/>
                 </cmns:structuredKeywords>
              </cmns:logicalGroup>
           </keywords>
           <!--
                            When using Synchronised Jobs to create people, supervisor relationships are created
                            by using the Configurable Supervisor Synchronisation job on the same xml.
                            The Configurable Person Synchronisation job must be run first so as to create
                            all the people before these relationships are then added
                        -->
           <supervisedByRelations>
              <supervisorRelation id="supervisorRelation1">
                 <supervisor>
                    <cmns:source_id>supervisor1</cmns:source_id>
                 </supervisor>
                 <supervisionPercentage>1</supervisionPercentage>
                 <period>
                    <cmns:startDate>18-07-2004</cmns:startDate>
                    <cmns:endDate>17-08-2005</cmns:endDate>
                 </period>
                 <supervisorRole>lead</supervisorRole>
              </supervisorRelation>
           </supervisedByRelations>
           <staffType>academic</staffType>
           <!-- This value is required and is used to determine licenses, which are based on current Academic staff -->
           <contractType>fixedterm</contractType>
           <jobTitle>juniorprofessor</jobTitle>
           <jobDescription>
              <cmns:text lang="en">Science research</cmns:text>
           </jobDescription>
           <fte>1</fte>
        </staffOrganisationAssociation>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema"
                        name="staffOrganisationAssociationType">
           <xs:annotation>
              <xs:documentation>Used to represent a persons staff affiliation with an organisational unit. Note that licence counts in Pure are determined based on the number of people with current staff affiliations with staffType of academic.</xs:documentation>
           </xs:annotation>
           <xs:complexContent>
              <xs:extension base="organisationAssociationType">
                 <xs:sequence>
                    <xs:element name="staffType" type="commons:classification">
                       <xs:annotation>
                          <xs:documentation>
                                        The type of staff. Must be a valid classification from the /dk/atira/pure/person/personstafftype classification. Note that license counts are based on current staff organisation associations with a staffType of academic
                                    </xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="contractType" type="commons:classification" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>
                                        The type of employment contract. Must be a valid classification from the /dk/atira/pure/person/personcontracttype classification.
                                    </xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="jobTitle" type="commons:classification" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>
                                        The title of the job. Must be a valid classification from the /dk/atira/pure/person/jobtitles classification.
                                    </xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="jobDescription"
                                type="commons:localized_string_1024"
                                minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>
                                        A free text description of the job.
                                    </xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="fte" type="xs:double" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>
                                        The full time equivalent of the role expressed as a decimal number
                                    </xs:documentation>
                       </xs:annotation>
                    </xs:element>
                 </xs:sequence>
              </xs:extension>
           </xs:complexContent>
        </xs:complexType>
 
 

In addition to below items, this element contains all fields as defined by organisationAssociation

XML Attribute/Element

Description

Type

Mandatory

staffType

The type of staff. Must be a valid classification from the /dk/atira/pure/person/personstafftype classification. Note that license counts are based on current staff organisation associations with a staffType of academic

commons:classification

Yes

contractType

The type of employment contract. Must be a valid classification from the /dk/atira/pure/person/personcontracttype classification.

commons:classification

No

jobTitle

The title of the job. Must be a valid classification from the /dk/atira/pure/person/jobtitles classification.

commons:classification

No

jobDescription

A free text description of the job.

commons:localized_string_1024

No

fte

The full time equivalent of the role expressed as a decimal number

xsd:double

No

studentOrganisationAssociation

Represents a student's relationship to an organisational unit (e.g. they are studying a course run by this unit)

XML Example

<studentOrganisationAssociation xmlns="v1.unified-person-sync.pure.atira.dk"
                                        xmlns:cmns="v3.commons.pure.atira.dk"
                                        id="studentAssoc4">
           <organisation>
              <cmns:source_id>organisation2</cmns:source_id>
           </organisation>
           <period>
              <cmns:startDate>25-08-2022</cmns:startDate>
              <!--Date format should be DD-MM-YYYYY-->
           </period>
           <supervisedByRelations>
              <supervisorRelation id="supervisorRelation2"><!-- Supervisor element is used to match to internal supervisor -->
                 <supervisor>
                    <cmns:source_id>supervisor1</cmns:source_id>
                 </supervisor>
                 <supervisionPercentage>0.6</supervisionPercentage>
                 <period>
                    <cmns:startDate>25-08-2022</cmns:startDate>
                    <cmns:endDate>31-12-2022</cmns:endDate>
                 </period>
                 <supervisorRole>lead</supervisorRole>
              </supervisorRelation>
              <supervisorRelation id="supervisorRelation2">
                 <externalSupervisor><!-- Can use either ID or name matching. If name does not match any existing external persons then it will be created --><!--
                                    <id>
                                        <cmns:source_id>supervisor2</cmns:source_id>
                                    </id> -->
                    <firstName>Pedro</firstName>
                    <lastName>Luna</lastName>
                    <country>br</country>
                 </externalSupervisor>
                 <supervisionPercentage>0.4</supervisionPercentage>
                 <period><!-- Exclude end date element to show supervision is ongoing -->
                    <cmns:startDate>18-07-2004</cmns:startDate>
                 </period>
                 <supervisorRole>second</supervisorRole>
              </supervisorRelation>
           </supervisedByRelations>
           <status>current</status>
           <!-- related to classification: /dk/atira/pure/person/studentstatus-->
           <startYear>2022</startYear>
           <programme>Doctorate of Philosophy</programme>
           <studentTypeDescription>other</studentTypeDescription>
           <!-- related to classification: /dk/atira/pure/person/studenttypedescription-->
           <expectedStudyDuration>4</expectedStudyDuration>
           <minStudyDuration>3</minStudyDuration>
           <maxStudyDuration>5</maxStudyDuration>
           <programmeYear>2023</programmeYear>
           <initialSubmissionDate>01-02-2023</initialSubmissionDate>
           <expectedEndDate>31-12-2023</expectedEndDate>
           <studentNationality>US</studentNationality>
           <studentResidencyFlag>home</studentResidencyFlag>
           <studentCountryOfDomicile>GB</studentCountryOfDomicile>
           <awardGained>PhD</awardGained>
           <projectTitle>
              <cmns:text lang="en">Study of the effects of low gravity upon micro-organisms</cmns:text>
           </projectTitle>
           <awardDate>30-06-2023</awardDate>
           <fte>1</fte>
        </studentOrganisationAssociation>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema"
                        name="studentOrganisationAssociationType">
           <xs:annotation>
              <xs:documentation>Represents a student's relationship to an organisational unit (e.g. they are studying a course run by this unit)</xs:documentation>
           </xs:annotation>
           <xs:complexContent>
              <xs:extension base="organisationAssociationType">
                 <xs:sequence>
                    <xs:element name="status" type="commons:classification" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>The current status of the student's studies. Must be a token from the classification scheme /dk/atira/pure/person/studentstatus</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="startYear" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>The year the student commenced this program of study</xs:documentation>
                       </xs:annotation>
                       <xs:simpleType>
                          <xs:restriction base="xs:string">
                             <xs:maxLength value="30"/>
                          </xs:restriction>
                       </xs:simpleType>
                    </xs:element>
                    <xs:element name="programme" type="commons:string_512" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Free text description of the student study programme</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="studentTypeDescription"
                                type="commons:classification"
                                minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Description of the student type. Must be a valid key from the classification scheme /dk/atira/pure/person/studentTypeDescription.</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="expectedStudyDuration" type="xs:integer" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Expected duration of the student's studies expressed as integer</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="minStudyDuration" type="xs:integer" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Minimum duration of the student's studies expressed as integer</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="maxStudyDuration" type="xs:integer" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Maximum duration of the student's studies expressed as integer</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="programmeYear" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Year of the study program that the student is participating in</xs:documentation>
                       </xs:annotation>
                       <xs:simpleType>
                          <xs:restriction base="xs:string">
                             <xs:maxLength value="65"/>
                          </xs:restriction>
                       </xs:simpleType>
                    </xs:element>
                    <xs:element name="initialSubmissionDate" type="commons:date" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Date that the student initially submitted for examination. Format is dd-MM-yyyy</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="expectedEndDate" type="commons:date" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Date that the student is expected to complete their studies. Format is dd-MM-yyyy</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="studentNationality"
                                type="commons:classification"
                                minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Nationality of the student. Should be a token of the classification /dk/atira/pure/core/countries which is based on the ISO 2 Digit Country code standard</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="studentResidencyFlag" type="residencyFlag" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>
                                        Where the student is based. Possible values are "unknown", "home" or "overseas"
                                    </xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="studentCountryOfDomicile"
                                type="commons:classification"
                                minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Country of Domicile of the student. Should be a token of the classification /dk/atira/pure/core/countries which is based on the ISO 2 Digit Country code standard</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="awardGained" type="commons:string_256" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Free text description of the award recieved by the student</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="projectTitle"
                                type="commons:localized_string_1024"
                                minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Free text title of the project undertaken by the student in their studies</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="awardDate" type="commons:date" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Date that the student was awarded their degree. Format is dd-MM-yyyy</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="fte" type="xs:double" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Full time equivalent expressed as a decimal number</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="fundingAssociations" type="fundingAssociations" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>Deprecated - Funding associations.</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                 </xs:sequence>
              </xs:extension>
           </xs:complexContent>
        </xs:complexType>
 
 

In addition to below items, this element contains all fields as defined by organisationAssociation

XML Attribute/Element

Description

Type

Mandatory

status

The current status of the student's studies. Must be a token from the classification scheme /dk/atira/pure/person/studentstatus

commons:classification

No

startYear

The year the student commenced this program of study

xsd:string

No

programme

Free text description of the student study programme

commons:string_512

No

studentTypeDescription

Description of the student type. Must be a valid key from the classification scheme /dk/atira/pure/person/studentTypeDescription.

commons:classification

No

expectedStudyDuration

Expected duration of the student's studies expressed as integer

xsd:integer

No

minStudyDuration

Minimum duration of the student's studies expressed as integer

xsd:integer

No

maxStudyDuration

Maximum duration of the student's studies expressed as integer

xsd:integer

No

programmeYear

Year of the study program that the student is participating in

xsd:string

No

initialSubmissionDate

Date that the student initially submitted for examination. Format is dd-MM-yyyy

commons:date

No

expectedEndDate

Date that the student is expected to complete their studies. Format is dd-MM-yyyy

commons:date

No

studentNationality

Nationality of the student. Should be a token of the classification /dk/atira/pure/core/countries which is based on the ISO 2 Digit Country code standard

commons:classification

No

studentResidencyFlag

Where the student is based. Possible values are "unknown", "home" or "overseas"

residencyFlag

No

studentCountryOfDomicile

Country of Domicile of the student. Should be a token of the classification /dk/atira/pure/core/countries which is based on the ISO 2 Digit Country code standard

commons:classification

No

awardGained

Free text description of the award recieved by the student

commons:string_256

No

projectTitle

Free text title of the project undertaken by the student in their studies

commons:localized_string_1024

No

awardDate

Date that the student was awarded their degree. Format is dd-MM-yyyy

commons:date

No

fte

Full time equivalent expressed as a decimal number

xsd:double

No

fundingAssociations

Funding associations.

fundingAssociations

No

honoraryOrganisationAssociation

XML Example

<honoraryOrganisationAssociation xmlns="v1.unified-person-sync.pure.atira.dk"
                                         xmlns:cmns="v3.commons.pure.atira.dk"
                                         id="honoraryAssoc3">
           <organisation>
              <cmns:non_explicit_id>organisation2</cmns:non_explicit_id>
           </organisation>
           <period>
              <cmns:startDate>01-05-2010</cmns:startDate>
           </period>
           <jobTitle>adjunctprofessor</jobTitle>
           <jobDescription>
              <cmns:text lang="en">Adjunct Professor in Microbology</cmns:text>
           </jobDescription>
        </honoraryOrganisationAssociation>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema"
                        name="honoraryOrganisationAssociationType">
           <xs:complexContent>
              <xs:extension base="organisationAssociationType">
                 <xs:sequence>
                    <xs:element name="jobTitle" type="commons:classification" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>
                                        The title of the job. Must be a valid classification from the /dk/atira/pure/person/jobtitles classification.
                                    </xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="jobDescription"
                                type="commons:localized_string_1024"
                                minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>
                                        A free text description of the job.
                                    </xs:documentation>
                       </xs:annotation>
                    </xs:element>
                 </xs:sequence>
              </xs:extension>
           </xs:complexContent>
        </xs:complexType>
 
 

In addition to below items, this element contains all fields as defined by organisationAssociation

XML Attribute/Element

Description

Type

Mandatory

jobTitle

The title of the job. Must be a valid classification from the /dk/atira/pure/person/jobtitles classification.

commons:classification

No

jobDescription

A free text description of the job.

commons:localized_string_1024

No

visitingOrganisationAssociation

XML Example

<visitingOrganisationAssociation xmlns="v1.unified-person-sync.pure.atira.dk"
                                         xmlns:cmns="v3.commons.pure.atira.dk"
                                         id="visitingAssoc2">
           <organisation>
              <cmns:non_explicit_id>organisation2</cmns:non_explicit_id>
           </organisation>
           <period>
              <cmns:startDate>01-01-2000</cmns:startDate>
           </period>
           <jobTitle>visitingprofessor</jobTitle>
           <jobDescription>
              <cmns:text lang="en">Scientific Research</cmns:text>
           </jobDescription>
           <purposeOfStay>Sabbatical</purposeOfStay>
           <visitorFrom>
              <identification>
                 <cmns:source_id>extorganisation2</cmns:source_id>
              </identification>
              <!-- Rather than specifying the id for the organisation you can specify the details below, Pure will attempt to match to existing organisations and create if not found -->
              <!--
                            <externalOrganisation>
                                <name>Harvard</name>
                                <type>academic</type>
                                <country>us</country>
                            </externalOrganisation> -->
           </visitorFrom>
        </visitingOrganisationAssociation>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema"
                        name="visitingOrganisationAssociationType">
           <xs:complexContent>
              <xs:extension base="organisationAssociationType">
                 <xs:sequence>
                    <xs:element name="jobTitle" type="commons:classification" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>
                                        The title of the job. Must be a valid classification from the /dk/atira/pure/person/jobtitles classification.
                                    </xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="jobDescription"
                                type="commons:localized_string_1024"
                                minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>
                                        A free text description of the job.
                                    </xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="purposeOfStay" type="commons:string_512" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>
                                        A free text description of the purpose for the visitor's stay
                                    </xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="visitorFrom"
                                type="externalOrganisationAssociation"
                                minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>
                                        The external organisation the visitor has come from
                                    </xs:documentation>
                       </xs:annotation>
                    </xs:element>
                 </xs:sequence>
              </xs:extension>
           </xs:complexContent>
        </xs:complexType>
 
 

In addition to below items, this element contains all fields as defined by organisationAssociation

XML Attribute/Element

Description

Type

Mandatory

jobTitle

The title of the job. Must be a valid classification from the /dk/atira/pure/person/jobtitles classification.

commons:classification

No

jobDescription

A free text description of the job.

commons:localized_string_1024

No

purposeOfStay

A free text description of the purpose for the visitor's stay

commons:string_512

No

visitorFrom

The external organisation the visitor has come from

externalOrganisationAssociation

No

residencyFlag

XSD Definition

<xs:simpleType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="residencyFlag">
           <xs:restriction base="xs:string">
              <xs:enumeration value="unknown"/>
              <xs:enumeration value="home"/>
              <xs:enumeration value="overseas"/>
           </xs:restriction>
        </xs:simpleType>
 
 

Restricted value: xs:string

Type

Value

Comments

xs:enumeration

unknown

 

xs:enumeration

home

 

xs:enumeration

overseas

 

internalExternalOrganisationAssociation

An association to either and internal or external organisation unit

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema"
                        name="internalExternalOrganisationAssociation">
           <xs:annotation>
              <xs:documentation>An association to either and internal or external organisation unit</xs:documentation>
           </xs:annotation>
           <xs:choice>
              <xs:element name="organisation" type="commons:classifiedIdentification">
                 <xs:annotation>
                    <xs:documentation>An identifier for the organisation</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="externalOrganisationAssociation"
                          type="externalOrganisationAssociation">
                 <xs:annotation>
                    <xs:documentation>Details of an external organisation, either by ID or name.</xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:choice>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

organisation 
(Option Group 1)

An identifier for the organisation

commons:classifiedIdentification

Yes

externalOrganisationAssociation 
(Option Group 2)

Details of an external organisation, either by ID or name.

externalOrganisationAssociation

Yes

externalOrganisationAssociation

An association to an external organisation unit. It can either be associated based on identifiers or by providing the name of the organisation. If it isn't found, one will be created

XML Example

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema"
                        name="externalOrganisationAssociation">
           <xs:annotation>
              <xs:documentation>An association to an external organisation unit. It can either be associated based on identifiers or by providing the name of the organisation. If it isn't found, one will be created</xs:documentation>
           </xs:annotation>
           <xs:choice>
              <xs:element name="identification" type="commons:identification">
                 <xs:annotation>
                    <xs:documentation>An ID for the organisation to perform a lookup on.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="externalOrganisation" type="externalOrganisation">
                 <xs:annotation>
                    <xs:documentation>The details of the organisation, such as name and country. If a match is not found a new record will be created.</xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:choice>
        </xs:complexType>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema"
                        name="externalOrganisationAssociation">
           <xs:annotation>
              <xs:documentation>An association to an external organisation unit. It can either be associated based on identifiers or by providing the name of the organisation. If it isn't found, one will be created</xs:documentation>
           </xs:annotation>
           <xs:choice>
              <xs:element name="identification" type="commons:identification">
                 <xs:annotation>
                    <xs:documentation>An ID for the organisation to perform a lookup on.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="externalOrganisation" type="externalOrganisation">
                 <xs:annotation>
                    <xs:documentation>The details of the organisation, such as name and country. If a match is not found a new record will be created.</xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:choice>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

identification 
(Option Group 1)

An ID for the organisation to perform a lookup on.

commons:identification

Yes

externalOrganisation 
(Option Group 2)

The details of the organisation, such as name and country. If a match is not found a new record will be created.

externalOrganisation

Yes

externalOrganisation

Details of an external organisation. Pure will attempt to match on name. If no match is found, one will be created with the provided details

XML Example

<externalOrganisation xmlns="v1.unified-person-sync.pure.atira.dk"
                              xmlns:cmns="v3.commons.pure.atira.dk">
           <name>IBM</name>
           <type>corporate</type>
           <country>us</country>
        </externalOrganisation>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="externalOrganisation">
           <xs:annotation>
              <xs:documentation>Details of an external organisation. Pure will attempt to match on name. If no match is found, one will be created with the provided details</xs:documentation>
           </xs:annotation>
           <xs:sequence>
              <xs:element name="name" type="commons:string_1024" minOccurs="1">
                 <xs:annotation>
                    <xs:documentation>
                                The name of the external organisation. Pure will attempt to match to an existing organisation using this name. If no match is found a new external organisation will be created.
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="type" type="commons:classification" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Classification scheme /dk/atira/pure/ueoexternalorganisation/ueoexternalorganisationtypes</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="country" type="commons:classification" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Classification scheme /dk/atira/pure/core/countries</xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:sequence>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

name

The name of the external organisation. Pure will attempt to match to an existing organisation using this name. If no match is found a new external organisation will be created.

commons:string_1024

Yes

type

Classification scheme /dk/atira/pure/ueoexternalorganisation/ueoexternalorganisationtypes

commons:classification

No

country

Classification scheme /dk/atira/pure/core/countries

commons:classification

No


Supervisory Relationships

supervisorRelations

A list of supervisorRelation elements of type supervisorRelation 
A collection of supervisor relations related to an organisation association

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="supervisorRelations">
           <xs:annotation>
              <xs:documentation>A collection of supervisor relations related to an organisation association</xs:documentation>
           </xs:annotation>
           <xs:sequence>
              <xs:element name="supervisorRelation"
                          type="supervisorRelation"
                          maxOccurs="unbounded"/>
           </xs:sequence>
        </xs:complexType>
 
 

supervisorRelation

Details of the supervisory relationship of one person to another, it can be matched to an internal person based on ID or an external person using either ID or name matching. If no external person is matched on name then they will be automatically created based on the information provided

XML Example

<supervisorRelation xmlns="v1.unified-person-sync.pure.atira.dk"
                            xmlns:cmns="v3.commons.pure.atira.dk"
                            id="supervisorRelation1">
           <supervisor>
              <cmns:source_id>supervisor1</cmns:source_id>
           </supervisor>
           <supervisionPercentage>1</supervisionPercentage>
           <period>
              <cmns:startDate>18-07-2004</cmns:startDate>
              <cmns:endDate>17-08-2005</cmns:endDate>
           </period>
           <supervisorRole>lead</supervisorRole>
        </supervisorRelation>
 
 

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="supervisorRelation">
           <xs:annotation>
              <xs:documentation>Details of the supervisory relationship of one person to another, it can be matched to an internal person based on ID or an external person using either ID or name matching. If no external person is matched on name then they will be automatically created based on the information provided</xs:documentation>
           </xs:annotation>
           <xs:sequence>
              <xs:choice minOccurs="1">
                 <xs:element name="supervisor" type="commons:classifiedIdentification">
                    <xs:annotation>
                       <xs:documentation>ID of Internal person</xs:documentation>
                    </xs:annotation>
                 </xs:element>
                 <xs:element name="externalSupervisor" type="externalPerson">
                    <xs:annotation>
                       <xs:documentation>External person defined by id or name. If name is provided and no match is found, then a new external person will be created</xs:documentation>
                    </xs:annotation>
                 </xs:element>
              </xs:choice>
              <xs:element name="supervisorOrganisationRelationId"
                          type="commons:string_400"
                          minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Deprecated. Is replaced by supervisorRole, for legacy support this field still exists, but it will be removed in future.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="supervisionPercentage" type="commons:percent" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The percentage of the supervision this person is responsible for. Should be a number between 0 and 1</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="period" type="commons:dateRange">
                 <xs:annotation>
                    <xs:documentation>The period that the supervisory relationship covered. To indicate on ongoing relationship omit the end date element. Note that a person being considered "current" in Pure means having at least one association where the period includes today.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:choice minOccurs="0">
                 <xs:element name="leadSupervisor" type="xs:boolean">
                    <xs:annotation>
                       <xs:documentation>Deprecated. Is replaced by supervisorRole, for legacy support this field still exists, but it will be removed in future.</xs:documentation>
                    </xs:annotation>
                 </xs:element>
                 <xs:element name="supervisorRole" type="commons:classification" minOccurs="0">
                    <xs:annotation>
                       <xs:documentation>The supervisor role. Must be a valid classification from the /dk/atira/pure/person/roles/supervisor classification scheme</xs:documentation>
                    </xs:annotation>
                 </xs:element>
              </xs:choice>
           </xs:sequence>
           <xs:attribute type="commons:string_400" name="id" use="required">
              <xs:annotation>
                 <xs:documentation>Unique identifier of the supervisory relationship. This is used to update appropriate records when values change in the XML while running the Sync job. Not displayed in the editor</xs:documentation>
              </xs:annotation>
           </xs:attribute>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

@id

Unique identifier of the supervisory relationship. This is used to update appropriate records when values change in the XML while running the Sync job. Not displayed in the editor

commons:string_400

Yes

supervisor 
(Option Group 1)

ID of Internal person

commons:classifiedIdentification

Yes

externalSupervisor 
(Option Group 2)

External person defined by id or name. If name is provided and no match is found, then a new external person will be created

externalPerson

Yes

supervisorOrganisationRelationId

Deprecated. Is replaced by supervisorRole, for legacy support this field still exists, but it will be removed in future.

commons:string_400

No

supervisionPercentage

The percentage of the supervision this person is responsible for. Should be a number between 0 and 1

commons:percent

No

period

The period that the supervisory relationship covered. To indicate on ongoing relationship omit the end date element. Note that a person being considered "current" in Pure means having at least one association where the period includes today.

commons:dateRange

Yes

leadSupervisor 
(Option Group 1)

Deprecated. Is replaced by supervisorRole, for legacy support this field still exists, but it will be removed in future.

xsd:boolean

No

supervisorRole 
(Option Group 2)

The supervisor role. Must be a valid classification from the /dk/atira/pure/person/roles/supervisor classification scheme

commons:classification

No

externalPerson

Details of a external person. This can either be matched on ID or details can be provided which will be used to find matches. If a match isn't found a new external person will be created.

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="externalPerson">
           <xs:annotation>
              <xs:documentation>Details of a external person. This can either be matched on ID or details can be provided which will be used to find matches. If a match isn't found a new external person will be created.</xs:documentation>
           </xs:annotation>
           <xs:sequence>
              <xs:choice minOccurs="1">
                 <xs:element name="id" type="commons:identification" minOccurs="1">
                    <xs:annotation>
                       <xs:documentation>ID of external Person will be used for matching against external Persons in Pure.</xs:documentation>
                    </xs:annotation>
                 </xs:element>
                 <xs:sequence>
                    <xs:element name="firstName" type="commons:string_1024" minOccurs="0">
                       <xs:annotation>
                          <xs:documentation>First name of external Person, will be matched against external Persons in Pure, if not found an external Person with the Name will be created.</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                    <xs:element name="lastName" type="commons:string_1024" minOccurs="1">
                       <xs:annotation>
                          <xs:documentation>Last name of external Person, will be matched against external Persons in Pure, if not found an external Person with the Name will be created.</xs:documentation>
                       </xs:annotation>
                    </xs:element>
                 </xs:sequence>
              </xs:choice>
              <xs:element name="country" type="commons:classification" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Country of external Person. Must be a valid classification from the /dk/atira/pure/core/countries
                                                If specified it will be used when matching external person by name and when creating an external person
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:sequence>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

id 
(Option Group 1)

ID of external Person will be used for matching against external Persons in Pure.

commons:identification

Yes

firstName 
(Option Group 2)

First name of external Person, will be matched against external Persons in Pure, if not found an external Person with the Name will be created.

commons:string_1024

No

lastName 
(Option Group 2)

Last name of external Person, will be matched against external Persons in Pure, if not found an external Person with the Name will be created.

commons:string_1024

Yes

country

Country of external Person. Must be a valid classification from the /dk/atira/pure/core/countries If specified it will be used when matching external person by name and when creating an external person

commons:classification

No


Student Funding Associations

fundingAssociations

A list of fundingAssociation elements of type fundingAssociation

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="fundingAssociations">
           <xs:sequence>
              <xs:element name="fundingAssociation"
                          type="fundingAssociation"
                          maxOccurs="unbounded"/>
           </xs:sequence>
        </xs:complexType>
 
 

fundingAssociation

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="fundingAssociation">
           <xs:all>
              <xs:element name="academicYear" type="commons:string_20" minOccurs="0"/>
              <xs:element name="amount" type="xs:double" minOccurs="0"/>
              <xs:element name="amountCurrency" type="commons:classification" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The currency of the amount. Must be a valid classification from the /dk/atira/pure/core/isocurrencies classification scheme</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="costCentreCode" type="commons:string_40" minOccurs="0"/>
              <xs:element name="analysisCode" type="commons:string_40" minOccurs="0"/>
              <xs:element name="percent" type="commons:percent" minOccurs="0"/>
              <xs:element name="funderType" type="funderType" minOccurs="0"/>
              <xs:element name="organisation"
                          type="commons:non_explicit_id_with_hint"
                          minOccurs="0"/>
              <xs:element name="externalOrganisation"
                          type="commons:non_explicit_id_with_hint_for_ext_org"
                          minOccurs="0"/>
              <xs:element name="project"
                          type="commons:non_explicit_id_with_hint"
                          minOccurs="0"/>
           </xs:all>
           <xs:attribute type="commons:string_512" name="id" use="required"/>
        </xs:complexType>
 
 

XML Attribute/Element

Description

Type

Mandatory

@id

 

commons:string_512

Yes

academicYear

 

commons:string_20

No

amount

 

xsd:double

No

amountCurrency

The currency of the amount. Must be a valid classification from the /dk/atira/pure/core/isocurrencies classification scheme

commons:classification

No

costCentreCode

 

commons:string_40

No

analysisCode

 

commons:string_40

No

percent

 

commons:percent

No

funderType

 

funderType

No

organisation

 

commons:non_explicit_id_with_hint

No

externalOrganisation

 

commons:non_explicit_id_with_hint_for_ext_org

No

project

 

commons:non_explicit_id_with_hint

No

funderType

XSD Definition

<xs:simpleType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="funderType">
           <xs:restriction base="xs:string">
              <xs:enumeration value="selffunded"/>
              <xs:enumeration value="internalfunding"/>
              <xs:enumeration value="externalfunding"/>
           </xs:restriction>
        </xs:simpleType>
 
 

Restricted value: xs:string

Type

Value

Comments

xs:enumeration

selffunded

 

xs:enumeration

internalfunding

 

xs:enumeration

externalfunding

 

Published at April 10, 2025

Download
Table of Contents
  1. Overview
  2. Persons
  3. persons
  4. person
  5. user
  6. Titles
  7. titles
  8. title
  9. Leaves of absence
  10. leavesOfAbsence
  11. leaveOfAbsence
  12. Documents
  13. documents
  14. A list of document elements of type document
  15. Photos
  16. personPhotos
  17. personPhoto
  18. dataType
  19. Profile Information
  20. personCustomFields
  21. personCustomField
  22. Name Variants
  23. names
  24. classifiedName
  25. Education/Qualifications
  26. personEducations
  27. personEducation
  28. professionalQualifications
  29. professionalQualification
  30. Positions outside the institution
  31. externalPositions
  32. externalPosition
  33. Organisational Affiliations
  34. organisationAssociations
  35. organisationAssociation
  36. staffOrganisationAssociation
  37. studentOrganisationAssociation
  38. honoraryOrganisationAssociation
  39. visitingOrganisationAssociation
  40. residencyFlag
  41. internalExternalOrganisationAssociation
  42. externalOrganisationAssociation
  43. externalOrganisation
  44. Supervisory Relationships
  45. supervisorRelations
  46. supervisorRelation
  47. externalPerson
  48. Student Funding Associations
  49. fundingAssociations
  50. fundingAssociation
  51. funderType
Related Articles
  • Arto
  • ORCID Integration
  • CabAbstract
  • JISC Publication Router
Keywords
  • xml format
  • person data

Was this article helpful?

Yes
No
Give feedback about this article

    About Pure

  • Announcements

    Additional Support

  • Events
  • Client Community
  • Training

    Need Help?

  • Contact Us
  • Submit a Support Case
  • My Cases
  • Linkedin
  • Twitter
  • Facebook
  • Youtube
Elsevier logo Relx logo

Copyright © 2025 Elsevier, except certain content provided by third parties.

  • Terms & Conditions Terms & Conditions
  • Privacy policyPrivacy policy
  • AccesibilityAccesibility
  • Cookie SettingsCookie Settings
  • Log in to Pure Help CenterLog in to Helpjuice Center

Knowledge Base Software powered by Helpjuice

Expand