Incoming Mobility Transcripts of Records API

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

Summary

This document describes the Incoming Mobility Transcripts of Records API. This API is implemented by the receiving institution. It allows the sending institution to retrieve Transcripts of Records issued by the receiving institution for a given set of mobility IDs.

If HEI provides any API from the following group:

• Incoming Mobilities ToRs
• Incoming Mobilities ToRs CNR
• Incoming Mobilities ToRs Stats

it MUST provide all APIs from this group.

Business requirements and processes

Business requirements and processes document clarifies the requirements for the technical solutions developed under EWP and in the local implementation that should adequately support the business processes related to ToRs at Higher Education Institutions.

Security and permissions

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 handles data which is considered private. Server implementers are allowed to forbid less-secure methods of authentication and encryption for this API (by dropping support for them). Currently, we leave it for the server implementers to decide which methods are "secure enough". These recommendations MAY change in the future.

Only selected Transcripts of Records should be accessible to the caller:

• If a ToR has not been approved as "ready for recognition" yet, then it SHOULD NOT be accessible via this API (see discussion here).

• If the caller covers the sending HEI of the given mobility, then he MUST be allowed read access to the mobility's corresponding ToR.

• If the caller covers the receiving HEI (yourself) of the given mobility, then he MAY be allowed read access to the mobility's corresponding ToR. (It seems reasonable to do so, but we leave this decision to your team.)

• All other callers SHOULD NOT be allowed to view the ToR.

• Note that servers will need to verify these access rights for each ID on the omobility_id list. It is possible that the caller has access to only some mobilities. (If this seems problematic, then you can always set your <max-omobility-ids> to 1.)

Endpoints to be implemented

Server implementers MUST:

• Implement the get endpoint.
• Implement the index endpoint.
• Put the URLs of these endpoints in their manifest file, as described in manifest-entry.xsd.

The details on each of these endpoints are described on separate pages of this API specification (use the links above).

Data model entities involved in the response

• Mobility
• Learning Agreement
• Learning Agreement Component
• Learning Opportunity Specification
• Learning Opportunity Instance
• Result Distribution
• Academic Term