Electronic transfer of student records (EMREX)
:: services/emrex module

This is a BETA module. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this module, please let us know. Then, we will work with you and move it out of beta as soon as we can.

EMREX is the solution for electronic transfer of student records between higher education institutions in Europe.

This USOS API module:

  • Provides storage for ELMO XML files used in data transfer.

Methods

delete_elmo BETA Delete an ELMO file. (administrative)
get_elmo BETA Download an ELMO file. (administrative)
put_elmo BETA Upload an ELMO. (administrative)
save_as_document BETA Save ELMO file as document (administrative)

services/emrex/delete_elmo

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: ignored Scopes: n/a SSL: required
https://usosapps.amu.edu.pl/services/emrex/delete_elmo

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Delete an ELMO file.

blob_id required Blob ID.
format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Token is not required.

Returned value:

Same response as services/blobbox/delete method

services/emrex/get_elmo

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: ignored Scopes: n/a SSL: required
https://usosapps.amu.edu.pl/services/emrex/get_elmo

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Download an ELMO file.

blob_id required Blob ID.
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Token is not required.

Returned value:

Same response as services/blobbox/put_text method

services/emrex/put_elmo

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: ignored Scopes: n/a SSL: required
https://usosapps.amu.edu.pl/services/emrex/put_elmo

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Upload an ELMO.

elmo required XML in ELMO format.
format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Token is not required.

Returned value:

Same response as services/blobbox/put_text method

services/emrex/save_as_document

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: required Scopes: n/a SSL: required
https://usosapps.amu.edu.pl/services/emrex/save_as_document

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Save ELMO file as document

blob_id required Blob ID
signature required Signature of document
release_date required Release date of document
description required Description of document
format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A dictionary of following fields and their values:

  • document_id - ID of created document.

Thrown errors:

  • object_not_found - blob could not be found; param_name is equal to blob_id.

USOS API ver. 6.5.1.0-3, ba8933a5 (2019-11-26)