API documentation

API documentation

Account

/campaign_hg/groups_list GET

Returns list of groups.

Parameters:

none

 

 

Return values:

SUCCESS

status=SUCCESS, count=[nr of groups], groups=[array of array of (id,title,mw_group)]

ERROR

status=ERROR, error=[error message*]

*[NO GROUPS]

Code:

cURL:

curl -H "MicroworkersApiKey:YOUR_API_KEY" -X GET https://api.microworkers.com/campaign_hg/groups_list

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/groups_list");
$client->setMethod("GET");
$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('GET', '/campaign_hg/groups_list');
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('GET', '/campaign_hg/groups_list')
pprint(res)

C#:

using System;
using MWAPI;

public class Test
{
  public static void Main (string[] args)
  {
    MW_API MW_API_Client = new MW_API ("YOUR_API_KEY");
    string body = MW_API_Client.getRequest("/campaign_hg/groups_list");
    Console.WriteLine (body);
  }
}

Examples:

Output (Success):

https://api.microworkers.com/campaign_hg/groups_list

{
  "status": "SUCCESS",
  "count": 4,
  "groups": [
    "{
      "id": "6cb37fa510f0",
      "mw_group": 0,
      "title": "Bookmarking",
      "workers": "5"
    },
    {
      "id": "6cb3805be6f5",
      "mw_group": 0,
      "title": "Facebook Workers",
      "workers": "20"
    },
    {
      "id": "6cb3a0f34af1",
      "mw_group": 0,
      "itle": "Good Writers",
      "workers": "12"
    },
    {
      "id": "18f555427770",
      "mw_group": 1,
      "title": "MW: ALL UK Workers",
      "workers": "10000"
    }
  ]
}

Output (Error):

https://api.microworkers.com/campaign_hg/groups_list

{
  "status": "ERROR",
  "error": "NO GROUPS"
}