This document describes the Interinstitutional Agreement Approval CNR API. This API can be implemented by all EWP partners, and will be called by some other EWP partners whenever related IIAs are approved by them. It allows the partners to listen for approvals of their copies of the IIAs.
CNR stands for Change Notification Receiver. For a detailed introduction on how CNR APIs work, please read this page.
- Requests MUST be made with HTTP POST method. Servers MAY reject all other request methods.
Parameters MUST be provided in the regular application/x-www-form-urlencoded
format.
Identifier of the HEI which has recently approved the partner's copy of the IIA and is now sending the notification about this event.
Server implementers SHOULD verify if the request is signed with a proper client certificate bound to this HEI.
Identifier of the HEI which is the owner of the copy of the agreement, that has been approved.
Together with iia_id, uniquely identifies the agreement copy.
Partner's identifier of the IIA which has been approved. Note: this is NOT the ID assigned by the notifier (approving HEI), but by the owner of the copy which has been approved.
This version of this API uses standard EWP Authentication and Security, Version 2. Server implementers choose which security methods they support by declaring them in their Manifest API entry.
-
General error handling rules apply.
-
Servers MUST return a valid (HTTP 200) XML response whenever the request has been properly received. Unless HTTP 200 is received, clients are RECOMMENDED to automatically retry the request after some time.
Servers MUST respond with a valid XML document described by the response.xsd schema. See the schema annotations for further information.
It is NOT guaranteed that all notifications will be delivered to you promptly. Some notifications may also not reach you at all, e.g. due to implementation errors on the sending institution's server.