Comparisons API

Create multiple comparisons for the same HIT

POST /api/comparisons/create_multiple_for_hit.json

Use this endpoint if you want to control how Comparisons are grouped into the same HIT

Parameters

Name : comparisons - required - Description : Document IDs

Name : email - required - Description : Email addresss

Name : auth_token - required - Description : Auth Token

Name : batch_id - required - Description : Batch ID

Name : document_ids - required - Description : Document IDs

Name : question - required - Description : Question

Name : template_id Description : Template ID

Name : template_properties Description : Template Properties

Request

Headers



Route

POST /api/comparisons/create_multiple_for_hit.json

Body

{"comparisons":[{"question":"Question A","document_ids":[1049,1050],"template_id":58,"template_properties":{"extra":"example text 1"}},{"question":"Question B","document_ids":[1051,1052]}],"batch_id":3302,"email":"researcher48@university.edu","auth_token":"E_QdgHnQz5wTQqgGyySV"}

Response

Headers

Content-Type: application/json; charset=utf-8

Status

200 OK

Body

{
  "batch_id": 3302
}