Blog - API

API documentation

API documentation

Account

/campaign_hg/rate_task/<campaign_id> PUT

Rates non-rated task.

Parameters:

<campaign_id>

Campaign ID

Example values: e7162dd17b83

POST data

 

 

id_task

Task ID

rating

[OK|NOK|REVISE]

comment

Explanation to Worker why task wasn't accepted.

This field is mandatory when rating NOK or REVISE.

bonus

Optional bonus you wish to give to worker.

Bonus amount must be in range ("payment per task" x 0.1 .. "payment per task" x 2).

favorite

[add|remove]

Optional

Return values:

SUCCESS

status=SUCCESS, campaign_id=[campaign id], task_id=[task id]

ERROR

status=ERROR, error=[error message*]

*[NO SUCH CAMPAIGN|TASK NOT IN THIS CAMPAIGN|ONLY NOTRATED TASK CAN BE RATED|TASK RATING VALUE CAN ONLY BE OK OR NOK|COMMENT TO WORKER MISSING|CAMPAIGN IS PAUSED_ADMIN|CAMPAIGN IS PENDING_REVIEW]

Code:

cURL:

curl -H "MicroworkersApiKey:YOUR_API_KEY" -X PUT https://api.microworkers.com/campaign_hg/rate_task/<campaign_id> -d "id_task=<id_task>&rating=<rating>&comment=<comment>"

PHP:

<?php

include "includes/RESTClient.php";
define("cAPI_KEY", "YOUR_API_KEY");
define("cAPI_URL", "https://api.microworkers.com");
$client = new RESTClient();
$client->setApiKey(cAPI_KEY);
$client->setUrl(cAPI_URL . "/campaign_hg/rate_task/137956568899");
$client->setMethod("PUT");

$client->setData(
array('id_task' => '1111', 'rating' => 'OK', 'comment' => '')
);

$client->execute();
$response = $client->getLastResponse();
$client->resetClient();
echo $response;

?>

Perl:

use MW_API;
use Data::Dumper qw(Dumper);
my $mw_api = MW_API->new('api_key' => 'YOUR_API_KEY');
my $res = $mw_api->do_request('PUT', '/campaign_hg/rate_task/137956568899', {
  'id_task' => '1111',
  'rating' => 'OK',
  'comment' => ''
});
print Dumper($res);

Python:

from pprint import pprint
from MW_API import MW_API
mw_api = MW_API('YOUR_API_KEY')
res = mw_api.do_request('PUT', '/campaign_hg/rate_task/137956568899', {
  'id_task': '1111',
  'rating': 'OK',
  'comment': ''
})
pprint(res)

C#:

using System;
using MWAPI;
using System.Collections.Specialized;

public class Test
{
  public static void Main (string[] args)
  {
    MW_API MW_API_Client = new MW_API ("YOUR_API_KEY");
    NameValueCollection postData = new NameValueCollection();
    postData.Add("id_task", "1111");
    postData.Add("rating", "OK");
    postData.Add("comment", "");
    string body = MW_API_Client.putRequest("/campaign_hg/rate_task/137956568899", postData);
    Console.WriteLine (body);
  }
}

Examples:

Output (Success):

{
  "status": "SUCCESS",
  "campaign_id": "137956568899",
  "task_id": "2"
}

Output (Error):

{
  "status": "ERROR",
  "campaign_id": "a699bb9b2e7b",
  "error": "NO SUCH CAMPAIGN"
}