Matriculation number
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents the matriculation number of an applicant.
URI
/api/v10/applicants/ID/matriculationGET Get a matriculation number
Retrieve the matriculation number of an applicant as a JSON-encoded string. The value is enclosed in double quotes and formatted as a JSON string literal. If no matriculation number is defined, the request returns null.
Syntax
GET /api/v10/applicants/123/matriculation
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
Request
curl
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v10/applicants/123/matriculation"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json; charset=utf-8 | The media type of the resource |
Response codes
| Response code | Description |
|---|---|
200 OK | The matriculation number was successfully returned |
Example response
Response
curl
"ABC123"PUT Set a matriculation number
Update the applicant’s matriculation number with the value provided in the request body.
The request body must contain a JSON-encoded string literal that meets the following requirements:
- The value must be enclosed in double quotes, for example,
"ABC123", notABC123. - The allowed length is 3 to 16 characters.
- Allowed characters include lowercase and uppercase letters (
A-Z, a-z), numbers (0-9), periods (.), hyphens (-) and forward slashes (/).
Syntax
PUT /api/v10/applicants/123/matriculation
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
Request
curl
curl \
-X PUT \
-d '"ABC123"' \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v10/applicants/123/matriculation"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | text/plain | The media type of the resource |
Content-Length | 0 | The size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
204 No Content | The matriculation number was successfully updated |
400 Bad Request | The matriculation number is invalid, see the error description for details |