MT-EQuAl REST API
GET user/replyInvitation
Accepts or declines an invitation to work on the specified project.
Endpoint
GET http(s)://hostname/api/user/replyInvitation
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 |
---|---|---|
hash | string | Required. The hash code associated with the request. |
action | {accepted,declined} | Required. accepted: to accept the invitation; declined otherwise. |
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": {
"role": "The type of role",
"project": "The project identifier",
"user": "The user identifier",
"role_status": "The status of the role",
"hash": "The new hash code associated to this role"
}
}
On error, the header status and description fields contain the error code and message, respectively.
Example
curl -X GET "https://hostname/api/user/replyInvitation?hash=9a9e42e071b4e1247b45ec8c4bd45887&action=accepted" -H "X-Api-Key: {user access token}"
{
"header": {
"date": "Wednesday, 2016-06-08 12:00:44 Europe\/Paris",
"description": "Accepts or declines an invitation to work on the specified project.",
"status": "200"
},
"result": {
"role": "evaluator",
"project": 8,
"user": 3,
"role_status": "accepted",
"hash": "9a9e42e071b4e1247b45ec8c4bd45887"
}
}