Reenrollments

This page describes all the APIs relating to reenrollments.

Get all Student's Reenrollments

get

Authorizations

bearerAuth

Path parameters

idintegerRequired

Serial database ID used to refer to a unique student record in OpenApply

Query parameters

yearstringOptional

Responses

200

successful

application/json

get

HTTPcURLJavaScriptPython

GET /api/v3/students/{student_id}/reenrollments HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

successful

{
  "reenrollments": [
    {
      "id": 59,
      "created_at": "2015-09-07T02:13:29.000Z",
      "updated_at": "2015-09-07T02:13:29.000Z",
      "deleted_at": null,
      "form": {
        "id": 59
      },
      "student": {
        "id": 11,
        "custom_id": "10",
        "application_id": "00000010",
        "serial_number": 10,
        "status": "Enrolled",
        "status_level": null
      },
      "status": {
        "name": "Confirmed",
        "updated_at": "2015-09-07T02:13:29.000Z"
      },
      "year": 2019,
      "grade": 9,
      "active": true,
      "acceptance_date": "2014-03-13",
      "fee": {
        "amount": "550.0"
      },
      "ignored_deadline": false
    }
  ],
  "meta": {
    "page": 1,
    "pages": 1,
    "per_page": 50
  }
}

Get All Reenrollments

get

Retrieves a list of all reenrollments. Results are paginated. Use the page and per_page query parameters to control pagination.

Authorizations

bearerAuth

Query parameters

pageinteger · min: 1Optional

The page number of results to return.

Default: 1

per_pageinteger · min: 1 · max: 200Optional

Request for how many records to return.

Default: 50

countintegerOptional

Synonym for per_page

decision_datestringOptional

statusstringOptional

yearstringOptional

Responses

200

successful

application/json

get

HTTPcURLJavaScriptPython

GET /api/v3/reenrollments HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

successful

{
  "reenrollments": [
    {
      "id": 138,
      "created_at": "2016-06-12T00:00:00.000Z",
      "updated_at": "2016-06-12T00:00:00.000Z",
      "deleted_at": null,
      "form": {
        "id": 138
      },
      "student": {
        "id": 459,
        "custom_id": "314",
        "application_id": "00000314",
        "serial_number": 314,
        "status": "Enrolled",
        "status_level": null
      },
      "status": {
        "name": "Pending",
        "updated_at": "2016-06-12T00:00:00.000Z"
      },
      "year": 2019,
      "grade": 9,
      "active": true,
      "acceptance_date": "2017-06-12",
      "fee": {
        "amount": "550.0"
      },
      "ignored_deadline": false
    },
    {
      "id": 141,
      "created_at": "2016-06-25T00:00:00.000Z",
      "updated_at": "2016-06-25T00:00:00.000Z",
      "deleted_at": null,
      "form": {
        "id": 141
      },
      "student": {
        "id": 460,
        "custom_id": "315",
        "application_id": "00000315",
        "serial_number": 315,
        "status": "Enrolled",
        "status_level": null
      },
      "status": {
        "name": "Pending",
        "updated_at": "2016-06-25T00:00:00.000Z"
      },
      "year": 2019,
      "grade": 9,
      "active": true,
      "acceptance_date": "2017-06-25",
      "fee": {
        "amount": "550.0"
      },
      "ignored_deadline": false
    }
  ],
  "meta": {
    "page": 1,
    "pages": 1,
    "per_page": 50
  }
}

update reenrollment

put

Authorizations

bearerAuth

Path parameters

idstringRequired

Header parameters

AuthorizationstringOptional

Body

application/json

statusstringOptional

gradeintegerOptional

status_updated_atstringOptional

Responses

200

successful

application/json

422

unprocessable entity

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v3/reenrollments/{id} HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "status": "Confirmed",
  "grade": 10,
  "status_updated_at": "2023-10-01T00:00:00Z"
}

{
  "reenrollment": {
    "id": 59,
    "created_at": "2015-09-07T02:13:29.000Z",
    "updated_at": "2015-09-07T02:13:29.000Z",
    "deleted_at": null,
    "form": {
      "id": 59
    },
    "student": {
      "id": 11,
      "custom_id": "10",
      "application_id": "00000010",
      "serial_number": 10,
      "status": "Enrolled",
      "status_level": null
    },
    "status": {
      "name": "Confirmed",
      "updated_at": "2015-09-07T02:13:29.000Z"
    },
    "year": 2019,
    "grade": 9,
    "active": true,
    "acceptance_date": "2014-03-13",
    "fee": {
      "amount": "550.0"
    },
    "ignored_deadline": false
  }
}