Differences

This shows you the differences between two versions of the page.

Link to this comparison view

api:api_scoresheets [2019/03/05 14:41] (current)
Anton Smirnov created
Line 1: Line 1:
 +====== /api/scoresheets ======
  
 +===== HEAD, GET =====
 +
 +List scoresheets that are available via the API. The number of scoresheets is represented in the ''X-Count'' header - use the ''HEAD'' request to simply count the number of scoresheets available. Use the ''GET'' request to actually fetch the list of scoresheets.
 +
 +==== Syntax ====
 +
 +  GET /api/scoresheets
 +  Host: apply.example.edu
 +  Authorization: DREAM apikey="..."
 +  
 +==== Response headers ====
 +
 +  Content-Type: application/json
 +  Content-Length: 1234
 +  X-Count: 4
 +  
 +==== Response example ====
 +
 +<code javascript>
 +{
 +  "1": {
 +    "created": "2018-01-03T17:20:00+00:00",
 +    "scored": null,
 +    "confirmed": null,
 +    "name": "Skype interview",
 +    "type": "Number",
 +    "range_min": "0.00",
 +    "range_max": "100.00",
 +    "scale": 2,
 +    "instructions": "Please write the points for the Skype interview from 0..100 according to the evaluation rules."
 +  },
 +  "2": {
 +    "created": "2018-01-03T17:20:00+00:00",
 +    "scored": null,
 +    "confirmed": null,
 +    "name": "Department review",
 +    "type": "Mapped",
 +    "range_min": "0.00",
 +    "range_max": "100.00",
 +    "scale": 2,
 +    "instructions": "Please give points to the application from 0 to 5."
 +  }
 +}
 +</code>