Docs home

Short Student Enrollment in Course by Admin

Enrolls an existing learner in a course as an offline (admin) admission, in one call. Use it when your own system has already taken the learner's admission and you want them added to the course in Edmingle.

POST/admission/walkin/short
Short Student Enrollment in Course by Admin
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/admission/walkin/short' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"bundle_id":1291,"user_id":167139,"organization_id":2,"class_ids":[23]}'
{
  "code": 200,
  "message": "Bundle Joined",
  "bundle": {
    "masterbatch": {
      "master_batch_id": 2301,
      "class_ids": "4331"
    },
    "payment_id": 6440,
    "part_ids": [
      8724
    ],
    "special_fees_ids": [],
    "enrollment_id": 6576,
    "conflicting_students": []
  }
}

Access: Institute admins, plus custom roles that can create admissions or learners.

Request body: form-data with one field, JSONString, containing this JSON:

BodyJSONString
bundle_idintegerrequired
ID of the course.
user_idintegerrequired
ID of the learner to enroll. Must belong to the same institute as the course.
organization_idintegerrequired
Organization to enroll them in. The course must be mapped to it and you must be an active member of it.
class_idsarray of integers
Batch IDs to place the learner in. If left out, the course's default batch in that organization is used.
Currency for the fee. Defaults to the organization's base currency.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Bundle Joined
bundleobject
Show child attributesHide child attributes
master_batch_id and class_ids the learner was added to
Show child attributesHide child attributes
Example: 4331
Example: 6440
One per instalment
Example: 6576

Notes:

  • The fee plan used is the first fee template mapped to the course in that organization. The admission date is the time of the call.
  • Errors: "Invalid Bundle ID" (course not mapped to that organization), "Bundle is not associated with the organization" / "...institution", "Not part of this organization" (you are not an active member), "Already enrolled in this course package.".
  • Rate limit: 120 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI