MT-EQuAl REST API
The REST APIs provide programmatic access to create and manage MT-Equal projects, invite users, specify evaluation formats, import evaluation data, and more. The REST API identifies client applications using an authorization token; responses are available in JSON.
The REST API is based on REST principles: data resources are accessed via standard HTTPS requests in UTF-8 format to an API endpoint.
The public address of the API is http://mtequal.futuro.media/. There are several endpoints at that address, each with its own unique path.
Requests
The following list shows the available methods.
- GET user/create
- GET user/update
- GET user/show
- GET user/delete
- GET user/list
- GET user/invite
- GET user/revoke
- GET user/requests
- GET user/replyInvitation
- GET user/search
- GET user/evaluate
- GET user/evaluations
- GET user/review
- GET project/list
- GET project/show
- POST project/create
- GET project/delete
- POST project/update
- POST project/evalformat
- POST project/instructions
- POST project/specifications
- POST project/import
- GET project/export
- GET project/report
- POST corpus/import
- GET corpus/delete
- GET corpus/show
- GET task/show
- GET task/dueBy
- GET task/done
- GET task/undone
- GET admin/remove
- GET admin/show
Response Status Codes
The API uses the following response status codes, as defined in the RFC 2616 and RFC 6585 :
| Status Code | Description |
|---|---|
| 200 | OK - The request has succeeded. The client can read the result of the request in the body and the headers of the response. |
| 201 | Created - The request has been fulfilled and resulted in a new resource being created. |
| 204 | No Content - The request has succeeded but returns no message body. |
| 304 | Not Modified (not used). |
| 400 | Bad Request - The request could not be understood by the server due to malformed syntax. |
| 401 | Unauthorized - The request requires user authentication or, if the request included authorization credentials, authorization has been refused for those credentials. |
| 403 | Forbidden - The server understood the request, but is refusing to fulfill it. |
| 404 | Not Found - The requested resource could not be found. This error can be due to a temporary or permanent condition. |
| 429 | Too Many Requests - To make the API fast for everybody, rate limits apply. If you get status code 429, it means that you have sent too many requests. |
| 500 | Internal Server Error. You should never receive this error but if yuo are so unlucky send a feedback to the system adminitrator for ckecking the problem. |
| 502 | Bad Gateway - The server was acting as a gateway or proxy and received an invalid response from the upstream server. |
| 503 | Service Unavailable - The server is currently unable to handle the request due to a temporary condition which will be alleviated after some delay. You can choose to resend the request again. |