Comparisons API

Create comparison with template

POST /api/comparisons/create.json

Parameters

Name : ids - required - Description : Document IDs

Name : email - required - Description : Email addresss

Name : auth_token - required - Description : Auth Token

Name : question Description : Question

Name : batch_id Description : Batch ID

Name : template_id Description : Template ID

Name : template_properties Description : Template Properties

Request

Headers



Route

POST /api/comparisons/create.json

Body

{"question":"Question text","ids":[499,500],"template_id":15,"template_properties":{"extra":"example text 1"},"email":"researcher39@university.edu","auth_token":"T98AU34io9E3zk2pmbEP"}

Response

Headers

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

Status

200 OK

Body

{
  "batch_id": 2213
}