How Can We Help?

Publisher XMLPublisher XML

Overview

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

Below is the xsd for the Publisher 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 Publisher 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 Publisher content type holds information about the organisations who publish research outputs.

Below are a series of attachments for your reference:

Simple Example XML - This shows only the mandatory fields that need to be populated
Advanced Example XML - This shows all fields that can be used. Snippets of this file are shown with their related elements below.
XSD (Xml Schema Definition) - This is a definition of what structure the XML must follow. This page has been generated based on the contents of the xsd file, and snippets of the definition are shown with their relevant element below
Editor Example PNG - This image shows the result of loading the advanced example xml into Pure, to allow for easy reference of which fields in Pure point to which elements in the XML. Note that the way the data is presented within your Pure instance may be different due to different configuration
Webservice Example Response - This shows an example response of retrieving the record generated via this xml via the webservice
Pure API Example Response - This shows an example response of retrieving the record generated via this xml via the Pure API. Note as the Pure API allows for creation of records, this format could also be used to create a new record with these details, but some fields would be ignored in that case (such as audit fields like created/modified by and internal Pure identifiers like UUID and Pure ID which wouldn't exist yet). UUIDs for related content (such as organisational units) would need to be updated as well.

Download All

Publishers

publishers

A list of publisher elements of type publisher
The ROOT element of the xml

XML Example

<publishers xmlns="v1.publisher.pure.atira.dk"><!-- Type should be defined in the "Publisher" classification scheme -->
           <publisher id="publisher1" type="publisher/publisher" managedInPure="true"><!-- Publisher Name -->
              <name>Publisher Name</name>
              <!-- Alternative Names -->
              <alternativeNames>
                 <name>Alternative name</name>
              </alternativeNames>
              <!-- Countries should be 2 letter names as defined in the Countries classification scheme -->
              <countries>
                 <country>dk</country>
                 <country>gb</country>
              </countries>
              <workflow>approved</workflow>
           </publisher>
        </publishers>

XSD Definition

<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="publishers">
           <xs:annotation>
              <xs:documentation>The ROOT element of the xml</xs:documentation>
           </xs:annotation>
           <xs:complexType>
              <xs:sequence>
                 <xs:element ref="publisher" 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>

publisher

There should be one entry of this element for every publisher you want created in Pure

XML Example

<publisher xmlns="v1.publisher.pure.atira.dk"
                   id="publisher1"
                   type="publisher/publisher"
                   managedInPure="true"><!-- Publisher Name -->
           <name>Publisher Name</name>
           <!-- Alternative Names -->
           <alternativeNames>
              <name>Alternative name</name>
           </alternativeNames>
           <!-- Countries should be 2 letter names as defined in the Countries classification scheme -->
           <countries>
              <country>dk</country>
              <country>gb</country>
           </countries>
           <workflow>approved</workflow>
        </publisher>

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="publisherType">
           <xs:annotation>
              <xs:documentation>There should be one entry of this element for every publisher you want created in Pure</xs:documentation>
           </xs:annotation>
           <xs:all>
              <xs:element name="name" type="commons:string_1024" minOccurs="1">
                 <xs:annotation>
                    <xs:documentation>
                                Primary name of the publisher.
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element ref="alternativeNames" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>
                                Alternative names of the publisher.
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element ref="countries" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>
                                Countries of the publisher.
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="workflow" type="xs:string" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>
                                Used to set the workflow state of the journal (workflow states: forApproval and approved (If enabled in the Pure backend))
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:all>
           <xs:attribute type="commons:string_400" name="id" use="required">
              <xs:annotation>
                 <xs:documentation>
                            The external ID of the publisher, this must be an unique value
                        </xs:documentation>
              </xs:annotation>
           </xs:attribute>
           <xs:attribute type="commons:classification" name="type" use="required">
              <xs:annotation>
                 <xs:documentation>
                            Classifications from the scheme: /dk/atira/pure/publisher/publishertype. Only use the last part of
                            the uri (token)
                        </xs:documentation>
              </xs:annotation>
           </xs:attribute>
           <xs:attribute type="xs:boolean" name="managedInPure" use="optional">
              <xs:annotation>
                 <xs:documentation>Determines whether the journal is managed in Pure, if set to to true the journal will be fully editable and deletable in Pure</xs:documentation>
              </xs:annotation>
           </xs:attribute>
        </xs:complexType>

XML Attribute/Element	Description	Type	Mandatory
@id	The external ID of the publisher, this must be an unique value	commons:string_400	Yes
@type	Classifications from the scheme: /dk/atira/pure/publisher/publishertype. Only use the last part of the uri (token)	commons:classification	Yes
@managedInPure	Determines whether the journal is managed in Pure, if set to to true the journal will be fully editable and deletable in Pure	xsd:boolean	Yes
name	Primary name of the publisher.	commons:string_1024	Yes
alternativeNames	Alternative names of the publisher.	alternativeNames	No
countries	Countries of the publisher.	countries	No
workflow	Used to set the workflow state of the journal (workflow states: forApproval and approved (If enabled in the Pure backend))	xsd:string	No

countries

XML Example

<countries xmlns="v1.publisher.pure.atira.dk">
           <country>dk</country>
           <country>gb</country>
        </countries>

XSD Definition

<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="countries">
           <xs:complexType>
              <xs:sequence maxOccurs="unbounded" minOccurs="1">
                 <xs:element name="country" type="commons:classification">
                    <xs:annotation>
                       <xs:documentation>Value should be a two-letter ISO country code as defined in the /dk/atira/pure/core/countries classification scheme</xs:documentation>
                    </xs:annotation>
                 </xs:element>
              </xs:sequence>
           </xs:complexType>
        </xs:element>

XML Attribute/Element	Description	Type	Mandatory
country	Value should be a two-letter ISO country code as defined in the /dk/atira/pure/core/countries classification scheme	commons:classification	Yes

alternativeNames

XML Example

<alternativeNames xmlns="v1.publisher.pure.atira.dk">
           <name>Alternative name</name>
        </alternativeNames>

XSD Definition

<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="alternativeNames">
           <xs:complexType>
              <xs:sequence maxOccurs="unbounded" minOccurs="1">
                 <xs:element name="name" type="commons:string_1024">
                    <xs:annotation>
                       <xs:documentation>One or more alternative names for the publisher</xs:documentation>
                    </xs:annotation>
                 </xs:element>
              </xs:sequence>
           </xs:complexType>
        </xs:element>

XML Attribute/Element	Description	Type	Mandatory
name	One or more alternative names for the publisher	commons:string_1024	Yes

Updated at July 27, 2024

How Can We Help?

Search Results

Filter By Category

Contact Us

Publisher XMLPublisher XML

Overview

Publishers

publishers

XML Example

XSD Definition

publisher

XML Example

XSD Definition

countries

XML Example

XSD Definition

alternativeNames

XML Example

XSD Definition