OBSOLETE - Interinstitutional Agreement Search API

• What is the status of this document?
• See the index of all other EWP Specifications

Summary

OBSOLETE: This proposal was replaced by IIAs API.

This document describes the Interinstitutional Agreement Search API. This API is implemented by the EWP IIA Repository only. All other EWP partners will only be using it (not serving it). This API allows EWP partners to search through all agreements (IIAs) stored in the IIA Repository.

Request method

• Requests MUST be made with either HTTP GET or HTTP POST method. Servers MUST support both these methods. Servers SHOULD reject all other request methods.

• Clients are advised to use POST when passing large number of parameters (servers MAY set a limit on their GET query string length).

Request parameters

Parameters MUST be provided either in a query string (for GET requests), or in the application/x-www-form-urlencoded format (for POST requests).

hei_id (repeatable, optional)

A list of institution identifiers. If given, then the results returned MUST contain only these IIAs which are related to all of these institutions.

This parameter is repeatable, so the request MAY contain multiple occurrences of it. The server is REQUIRED to process all of them.

Permissions

All requests from the EWP Network MUST be allowed access to this API. Consult the Echo API specs for details on handling unprivileged requests.

Handling of invalid parameters

• General error handling rules apply.

• If invalid (or unknown) hei_id values are passed, then server MUST respond with a HTTP 400 error response.

Response

Servers MUST respond with a valid XML document described by the [response.xsd] (response.xsd) schema. See the schema annotations for further information.