GET user/review

Performs a fake review that creates a perfect agreement. Used for testing.

Endpoint

GET http(s)://hostname/api/user/review

Request Parameters

Header field	Type	Value
X-Api-Key	string	Required. A valid access token from a registered MT-EQuAl account. The access token must have been issued on behalf of the current user.

Request parameters	Type	Value
id	string	Required. The project id.

Response

On success, the HTTP status code in the response header is 200 (OK) and the response is structured in JSON as follow:

{
  "header": {
    "date": "Date and time of the response generation process",
    "description": "Description of the invoked method or error message",
    "status": "status/error code"
  },
  "result": {
        "project" : "the project id",
        "username" : "the user name",
        "reviews" : [ {
            "i" : "the evaluation id",
            "output_id" : "the TU id",
            "num" : "the sentence id",
            "text" : "Translation TU 1 Sys 1",
            "isintra": ">1 if the TU is used to calculate the the intra-annotator agreement; 0 or 1 otherwise",
            "project" : "the project id",
            "type" : "evaluation type",
            "min" : "the evaluation min value",
            "max" : "the evaluation max value"
            "evaluations" : "all evaluations and review for the sentence"
        ...
}

On error, the header status and description fields contain the error code and message, respectively.

Example

curl -X GET "https://hostname/api/user/review?id=1" -H "X-Api-Key: {user access token}"

{
	"header": {
		"date": "Wednesday, 2016-06-08 12:00:44 Europe\/Paris",
		"description": "Performs a fake review that creates a perfect agreement. Used for testing.",
		"status": "200"
	},
	"result": {
        "project" : "7",
        "username" : "ellen",
        "reviews" : [ {
            "i" : 1,
            "output_id" : "1",
            "num" : 2149,
            "text" : "Translation TU 1 Sys 1",
            "isintra" : 0,
            "project" : 7,
            "type" : "binary",
            "min" : 1,
            "max" : 2,
            "evaluations" : [ {
                "evaluator" : {
                "id" : 16,
                "name" : "tom"
                },
              "eval" : "2",
                "label" : "good",
                "confirmed" : {
                "date" : "2016-12-02 08:11:04.000000",
                "timezone_type" : 3,
                "timezone" : "Europe/Paris"
                },
                "modified" : {
                "date" : "2016-12-02 08:11:04.000000",
                "timezone_type" : 3,
                "timezone" : "Europe/Paris"
                }
            }, {
                "reviewer" : {
                "id" : 15,
                "name" : "ellen"
            },
            "new-eval" : 2,
            "new-label" : "good",
            "evaluator" : {
                "id" : 17,
                "name" : "mark"
            },
            "eval" : "1",
            "label" : "bad",
            "confirmed" : {
                "date" : "2016-12-02 08:10:43.000000",
                "timezone_type" : 3,
                "timezone" : "Europe/Paris"
            },
            "modified" : {
                "date" : "2016-12-02 08:10:43.000000",
                "timezone_type" : 3,
                "timezone" : "Europe/Paris"
                }
            },
            ...
}