- Home
- Our API (Application Programming Interface)
- Web Services
Web Services
Data Formats
Data can be returned in XML, JSON or JSONP format. The default is XML, but if JSON or JSONP is required,
then particular parameters (output and callback) need to be set as described below.
Organisations
Search by a combination of properties
Lookup organisations, using a combination of properties as query parameters.
| Resource |
Query Parameter |
Description |
| http://data.jiscmu.ac.uk/rest/organisations |
id (int) | The organisation MUID |
| officialname (string) | The official name of the organisation |
| status (string) | The status of the organisation: ACTIVE or CLOSED |
| fundedconnection (string) | The janet network connection status of the organisation:
FUNDED or UNFUNDED |
| sector (int) | The sector ID of the organisation |
| country (int) | The country ID of the organisation |
| network (int) | The network ID of the organisation |
| tag (string) | A keyword that the organisation has been tagged with |
| band (string) | The Jisc Collections band of the organisation |
| q (string) | A substring within the organisation name |
Search by a unique property
Lookup an organisation, using a unique property as a path parameter.
Retrieve other properties
Retrieve other properties of an organisation, using the MUID of the organisation as a path parameter.
Historical data
Retrieve the Monitoring Unit's recorded history of changes to a chosen organisation,
using the MUID of the organisation as a path parameter.
| Resource |
Path Parameters |
Examples |
| http://data.jiscmu.ac.uk/rest/organisations/id/$MUID/history/statuses |
$MUID (int, required) |
University of Kent - status history
|
| http://data.jiscmu.ac.uk/rest/organisations/id/$MUID/history/names |
$MUID (int, required) |
University of Kent - name history
|
| http://data.jiscmu.ac.uk/rest/organisations/id/$MUID/history/sectors |
$MUID (int, required) |
University of Kent - sector history
|
| http://data.jiscmu.ac.uk/rest/organisations/id/$MUID/history/bands |
$MUID (int, required) |
University of Kent - Jisc Collections band history
|
| http://data.jiscmu.ac.uk/rest/organisations/id/$MUID/history/jfjc |
$MUID (int, required) |
University of Kent - connection funding history
|
| http://data.jiscmu.ac.uk/rest/organisations/id/$MUID/history/sites |
$MUID (int, required) |
University of Kent - site history
|
| http://data.jiscmu.ac.uk/rest/organisations/id/$MUID/history/identifiers |
$MUID (int, required) |
University of Kent - identifier history
|
| http://data.jiscmu.ac.uk/rest/organisations/id/$MUID/history/parents |
$MUID (int, required) |
The Shakespeare Institute - parent history
|
| http://data.jiscmu.ac.uk/rest/organisations/id/$MUID/history/children |
$MUID (int, required) |
University of Birmingham - child history
|
| http://data.jiscmu.ac.uk/rest/organisations/id/$MUID/history/provision |
$MUID (int, required) |
EDINA - service provision history
|
Sites
Search by a combination of properties
Lookup sites (e.g university campuses), using a combination of properties as query parameters.
| Resource |
Query Parameter |
Description |
| http://data.jiscmu.ac.uk/rest/sites |
id (int) | The site ID |
| organisation (int) | The MUID of the organisation that the site belongs to |
| country (int) | The country ID of the site |
| q (string) | A substring within the site name |
Search by a unique property
Lookup a site, using a unique property as a path parameter. Currently, the only property available is the site ID.
Historical data
Retrieve the Monitoring Unit's recorded history of changes to a chosen site, using the site ID as a path parameter.
Currently, the only type of history that can be obtained for a site is its organisation history.
Identifiers
Search by a combination of properties
Lookup identifiers, using a combination of properties as query parameters.
| Resource |
Query Parameter |
Description |
| http://data.jiscmu.ac.uk/rest/identifiers |
type (int) | The ID of the identifier type. For example, domain name = 4 |
| target (string) | The type of entity that the Identifier identifies: ORGANISATION or SITE |
| q (string) | A substring within the identifier name |
Search by a unique property
Lookup an identifier, using a unique property as a path parameter.
Services
Search by a combination of properties
Lookup services, using a combination of properties as query parameters.
| Resource |
Query Parameter |
Description |
| http://data.jiscmu.ac.uk/rest/services |
status (string) | The status of the service: ACTIVE or CLOSED |
| listed (string) | Can be set to SHOWN, to restrict the result to top level listed services |
| provider (int) | The MUID of the organisation providing the service |
| tag (string) - TO DO | A keyword that the service has been tagged with |
| q (string) | A substring within the service name |
Search by a unique property
Lookup a service, using a unique property as a path parameter.
| Resource |
Path Parameters |
Examples |
| http://data.jiscmu.ac.uk/rest/services/id/$SERVICE |
$SERVICE (int, required) |
SUNCAT - by service ID
|
| http://data.jiscmu.ac.uk/rest/services/id/$NAME |
$NAME (string, required) |
SUNCAT - by service name
|
Retrieve other properties
Retrieve other properties of a service, using the service ID as a path parameter.
| Resource |
Path Parameters |
Examples |
| http://data.jiscmu.ac.uk/rest/services/id/$SERVICE/tags |
$SERVICE (int, required) |
SUNCAT's tags
|
| http://data.jiscmu.ac.uk/rest/services/id/$SERVICE/parent |
$SERVICE (int, required) |
Parent of SUNCAT Open
|
| http://data.jiscmu.ac.uk/rest/services/id/$SERVICE/children |
$SERVICE (int, required) |
Children of SUNCAT
|
| http://data.jiscmu.ac.uk/rest/services/id/$SERVICE/providers |
$SERVICE (int, required) |
SUNCAT's service provider
|
Historical data
Retrieve the Monitoring Unit's recorded history of changes to a chosen service,
using the service ID as a path parameter.
