Annual Collection API

This example shows how to nominate a publication for an Annual Collection. Publication's reporting date must be in the Collection year (2017 in this example). The command will return the created nomination data.

If the publication is already nominated, the command will return the existing nomination data.

The URL and Authorisation header shown here are for illustration only - you should replace them with appropriate values for your system and the task you wish to perform.

HTTP verb: POST

Example URL: https://server-name:8091/secure-api/v5.5/herdc/returns/2017/nominations

Header: 

Content-Type:text/xml

Authorization:Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Request body: 

<?xml version="1.0" encoding="utf-8"?>
<herdc-create-nomination xmlns="http://www.symplectic.co.uk/publications/api">
  <!-- publication ID of a publication being nominated -->
  <publication>1566</publication>
</herdc-create-nomination>

This example shows how to update an existing nomination status. The command will return the updated nomination data.

You can specify the nomination either using the nomination ID or by specifying nominated publication's object identifier. 

The URL and Authorisation header shown here are for illustration only - you should replace them with appropriate values for your system and the task you wish to perform.

HTTP verb: PUT

Example URL:

https://server-name:8091/secure-api/v5.5/herdc/returns/2017/nominations/157 
https://server-name:8091/secure-api/v5.5/herdc/returns/2017/nominations/publication(1566) 

Header: 

Content-Type:text/xml
Authorization:Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Request body: 

<?xml version="1.0" encoding="utf-8"?>
<herdc-update-nomination xmlns="http://www.symplectic.co.uk/publications/api">
  <nomination-status>accepted</nomination-status>
</herdc-update-nomination>

Note: The API doesn't support deleting an existing nomination, or changing it to not-nominated but the nomination can be updated to one of the following statuses: 

• accepted

• accepted-no-points

• declined

• nominated

• pending-response

• under-appeal

• under-review

• withdrawn

This example shows how to update comments. The command will return the updated nomination data.

You can specify the nomination either using the nomination ID or by specifying nominated publication's object identifier.

The URL and Authorisation header shown here are for illustration only - you should replace them with appropriate values for your system and the task you wish to perform.

HTTP verb: PUT

Example URL:

https://server-name:8091/secure-api/v5.5/herdc/returns/2017/nominations/157
https://server-name:8091/secure-api/v5.5/herdc/returns/2017/nominations/publication(1566) 

Header: 

Content-Type:text/xml
Authorization:Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Request body: 

<?xml version="1.0" encoding="utf-8"?>
<herdc-update-nomination xmlns="http://www.symplectic.co.uk/publications/api">
    <nomination-status>accepted</nomination-status>
    <history-comment>some sort of comment here</history-comment>
</herdc-update-nomination>