This is an old revision of the document!


/api/scoresheets/ID/scores

HEAD, GET

Return scores list for the scoresheet

Syntax

GET /api/scoresheets/123/scores
Host: apply.example.edu
Authorization: DREAM apikey="..."

Parameters

Name Description Notes
byAcademicTermID Required The academic term to filter by.

Response headers

Content-Type: application/json
Content-Length: 1456
X-Count: 15

Response example

{
    "1": {
        "scored": "2019-03-05T14:57:36+00:00",
        "application": "/api/applications/2",
        "scoresheet": "/api/scoresheets/1",
        "points": "20.00",
        "comments": "One"
    },
    "5": {
        "scored": "2019-03-05T14:57:33+00:00",
        "application": "/api/applications/3",
        "scoresheet": "/api/scoresheets/1",        
        "points": "40.00",
        "comments": "Two"
    },
    "9": {
        "scored": "2019-03-05T14:57:30+00:00",
        "application": "/api/applications/4",
        "scoresheet": "/api/scoresheets/1",        
        "points": "60.00",
        "comments": "Three"
    },
    "13": {
        "scored": "2019-03-05T14:57:27+00:00",
        "application": "/api/applications/7",
        "scoresheet": "/api/scoresheets/1",        
        "points": "80.00",
        "comments": "Good"
    },
    "17": {
        "scored": "2019-03-05T14:57:23+00:00",
        "application": "/api/applications/8",
        "scoresheet": "/api/scoresheets/1",        
        "points": "100.00",
        "comments": "Awesome"
    }
}

POST

Append an application to the scoresheet in question. If the application is already on this scoresheet, it will just update the score (and optionally, the comments).

Syntax

POST /api/scoresheets/123/scores
Host: apply.example.edu
Authorization: DREAM apikey="..."

Parameters

Name Description
application Required An application ID to add
points Required The points to set for this scoresheet score. Validation depends on the scoresheet settings. In case of a mapped-type value, it takes the numeric equivalent.
comments Optional Up to 512 characters of comments. May be omitted or left empty in which case it has no effect (including leaving any existing comments in place).

Response headers

Content-Type: application/json
Content-Length: 0

Response codes

201 Created New applicant/lead was created