Skip to content
Specifications of EWP's Outgoing Mobility CNR API.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
CHANGELOG.md
README.md
manifest-entry.xsd
response.xsd

README.md

Outgoing Mobility CNR API

Summary

This document describes the Outgoing Mobility CNR API. This API is implemented by the receiving institution if it wants to be notified whenever mobilities kept on their partner institutions' servers are changed.

CNR stands for Change Notification Receiver. For a detailed introduction on how CNR APIs work, please read this page.

Request method

  • Requests MUST be made with HTTP POST method. Servers MAY reject all other request methods.

Request parameters

Parameters MUST be provided in the application/x-www-form-urlencoded format.

sending_hei_id (required)

Identifier of the sending HEI - the master of the Outgoing Mobility objects which just have been changed.

omobility_id (repeatable, required)

A list of identifiers of Outgoing Mobility objects (no more than <max-omobility-ids> items). These are the Mobility objects which have been recently updated (or created) on the caller's side. Please note, that the sending institution SHOULD send this notification to you even when it is you who actually initiated the update (e.g. via the update endpoint of Outgoing Mobilities API).

This parameter is repeatable, so the request MAY contain multiple occurrences of it. The server SHOULD process all of them. Server implementers provide their own chosen value of <max-omobility-ids> via their manifest entry (see manifest-entry.xsd). Clients SHOULD parse this value (or assume it's equal to 1).

Security

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.

This API does not expose any sensitive data, it only notifies the server that it should reload portions of its data. For this reason, it is RECOMMENDED for server implementers to not be overly strict on security methods they require (i.e. it is RECOMMENDED to not require extra layers of encryption in requests and responses - TLS seems more than enough).

Handling of invalid parameters

  • General error handling rules apply.

  • Please note, that receiving unknown omobility_id values is NOT an error. This usually indicates that a new Outgoing Mobility has been created, and you probably want to fetch it (a new student has been nominated for the mobility).

  • 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.

Response

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

Safety measures

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, or the fact that no Notification Sender daemon has been implemented there (see <sends-notifications> element in Outgoing Mobilities API's manifest-entry.xsd).

Therefore, you SHOULD periodically verify if your copies are up-to-date (or, simply, choose to not store these copies). Proper caching techniques and/or periodical use of index endpoint of Outgoing Mobilities API can help you with that.

You can’t perform that action at this time.