Reference of all API calls available. Consult also the concepts documentation and the Swagger documentation available for the interactive version of the API.

Teams allow to group clickworkers and include or exclude them from your projects. Teams are typically used in the following scenarios:

  • Excluding clickworkers that have already participated in a previous survey.
  • Only addressing specific clickworkers with a survey for follow up surveys
  • Excluding authors from your text project (blacklisting)
  • Assigning text projects to a list of known authors that have worked for you previously
Name Type Access Description
id Integer r/- The Team identifier
name String r/w The Team’s unique resource identifier
note String r/w Notes describing the team
hide Boolean r/w When true, the team is hidden from drop-down lists in the marketplace (e.g. in order to hide teams no longer used)

Operations

Create Team

Request

Request line:

POST [context]/customers/teams

Request parameter:

Name Type Synopsis Mandatory
name String The team name Yes
note String A note describing the team No
hide Boolean Hide team from drop down lists when true No

Request Body:

  • XML Example
<team>
  <name>My first team</name> 
  <note>This is my first team</note> 
  <hide>false</hide>
</team>
  • JSON Example
team: {
  name: “My first team”,
  note: “This is my first team”, 
  hide: “false”
}

Response

Response status

  • 200, if the request could be successfully handled (even if no tasks were found)

  • 201, if the team has successfully been created

Response body

(See example in section “View Team”)

Delete Team

Request

Request line

DELETE [context]/customer/teams/${id}

or

POST [context]/customer/teams/${id}_method=DELETE

Request Parameter

Name Type Synopsis Mandatory
id Integer The auto-computed Team id as returned by the Create Team option Yes

Request Body

(empty)

Response

Response status:

  • 204, if the request could be successfully handled
  • 404, if the given resource was not found
  • 409, if the task cound not be deleted

Response body:

(empty)

Update team details

Request

Request line:

PUT [context]/customer/teams/${id}

Request parameter:

(Common only)

Request body:

  • XML Example
<team>
  <name>My first team</name> 
  <note>This is my first team</note> 
  <hide>false</hide>
</team>
  • JSON Example
team: {
  name: “My first team”,
  note: “This is my first team”, 
  hide: “false”
}

Response body:

Response status

  • 200, if the request could be successfully handled (even if no tasks were found)

Response body

  • (See example in section “View Team Details”)

List Teams

Request

Request line:

GET [context]/customer/teams/

Request parameter:

(Common only)

Response

Response body:

  • XML Example
<teams_response> 
  <request_status>
    <id>wybSKEcLKGBNbd+LKX7zXIsvVJc=</id> 
    <valid>true</valid> 
    <status_code>200</status_code> 
    <status_text>OK</status_text> 
    <total_count>5</total_count> 
    <page_num>1</page_num> 
    <page_size>50</page_size>
  </request_status> 
  <teams>
    <id>12242</id>
    <name>Content Managers</name> 
  </teams>
  <teams>
    <id>232304</id> 
    <name>Interpreters</name>
  </teams> 
</teams_response>
  • JSON Representation
teams_response: { 
  request_status: ... , 
  teams: [{
    link: [{
      href: “[context]/customer/teams/12242“, 
      rel: “team”,
      type: “application/json”
    }],
    name: “Content Managers”
    created_at: “2012-08-28T12:56:08+01:00”
  },{
  link: [{
    href: “[context]/customer/teams/232304“, 
    rel: “team”,
    type: “application/json”
  }],
  name: “Interpreters”
  created_at: “2012-08-28T12:56:08+01:00”
}

Response status

  • 200, if the request could be successfully handled (even if no teams were found)

Add clickworkers to a team

Request

Request line:

PUT [context]/customer/teams/${id}

Request parameter (Common only)

Request body

  • XML Example
<team> 
  <add_user_ids>[USER_ID1]</add_user_ids> 
  <add_user_ids>[USER_ID2]</add_user_ids> 
  <add_user_ids>[USER_ID3]</add_user_ids>
</team>
  • JSON Representation
team: [{ 
add_user_ids: [
  USER_ID1, USER_ID2, USER_ID3
  ] 
}]

Response status

  • 200, if the request could be successfully handled (even if no teams were found)

Remove clickworkers from a team

Request

Request line:

PUT [context]/customer/teams/${id}

Request parameter:

(Common only)

Request body:

  • XML Example
<team> 
  <remove_user_ids>[USER_ID1]</remove_user_ids>
  <remove_user_ids>[USER_ID2]</remove_user_ids>
  <remove_user_ids>[USER_ID3]</remove_user_ids>
</team>
  • JSON Representation
team: [{ 
remove_user_ids: [
  USER_ID1, USER_ID2, USER_ID3  
  ] 
}]

Response status:

  • 200, if the request could be successfully handled (even if no teams were found)
Tags: