Blog - API

API documentation

API documentation

Account

/campaign_hg/lock_task/<campaign_id> PUT

Lock task for worker.

Parameters:

<campaign_id>

Campaign ID

Example values: e7162dd17b83

PUT data

 

 

user_id

Worker's ID

Return values:

SUCCESS

status=SUCCESS, campaign_id=[campaign id], random_key=[random key]

ERROR

status=ERROR, campaign_id=[campaign id], error=[error message*], errors_list=[errors list**]

*[NO SUCH CAMPAIGN|UNKNOWN WORKER|SYSTEM ERROR|INPUT_DATA|Account banned from work|User needs sms verification|Worker is not allowed to work on this campaign|Campaign is not running|Worker does not belong to a group|Worker took all positions he was allowed to take|All positions for this campaign have been submitted or locked]

**[User ID is required|User ID can contain alphanumeric characters only]

Code:

cURL:

curl -H "MicroworkersApiKey:YOUR_API_KEY" -X PUT https://api.microworkers.com/campaign_hg/lock_task/<campaign_id> -d "user_id=<user_id>"

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/lock_task/e7162dd17b83");
$client->setMethod("PUT");

$client->setData(
  array('user_id' => '123456')
);

$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/lock_task/e7162dd17b83', { 'user_id' => '123456'});
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/lock_task/e7162dd17b83', { 'user_id': '123456' })
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("user_id", "123456");
    string body = MW_API_Client.putRequest("/campaign_hg/lock_task/e7162dd17b83", postData);
    Console.WriteLine (body);
  }
}

Examples:

Output (Success):

{
  "status": "SUCCESS",
  "campaign_id": "a699bb9b2e7b",
  "random_key": "1234567890",
  "time_left": "600"
}

Output (Error):

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