A request with the GET verb returns the JSON-encoded matriculation number for this applicant. Note that the value appear to be a double-quoted value, but is a JSON string literal in the strict sense. If there is no matriculation number, null is returned.
GET /api/applicants/123/matriculation Host: apply.example.edu Authorization: DREAM apikey="..."
Content-Type: application/json Content-Length: 123
200 OK | The matriculation number is returned |
"ABC123"
When making a PUT call, the contents of the request body will be stored as the new matriculation number for the applicant in question.
The body must be a JSON encoded string literal, this means that it has to be double-quoted like “ABC123”, not just ABC123. A minimum of 3 and a maximum 16 characters are allowed and the matriculation number can only contain lowercase and uppercase letters, numbers, dots, dashes and slashes.
Example curl:
curl -v -X PUT --data '"ABC123"' -H "Authorization: DREAM apikey=\"YOUR_API_KEY\"" https://your-da-instance.dreamapply.com/api/applicants/123/matriculation
PUT /api/applicants/123/matriculation Host: apply.example.edu Authorization: DREAM apikey="..."
Content-Type: text/plain Content-Length: 0
204 No Content | The matriculation number was stored successfully |
400 Bad Request | Invalid matriculation number - see the returned text for details |