Create Registration Setup Mapping | SchoolSet

curl -X POST https://app.schoolset.io/app/api/v2/registration/setup/mapping/create \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "batch_id": 2023,
  "registration_status_id": 3,
  "student_status_id": "2"
}'

{
  "status": "success",
  "message": "Registration setup mapping created successfully.",
  "data": {
    "item": {
      "id": 45,
      "batch_id": 2023,
      "registration_status_id": 3,
      "student_status_id": 2,
      "academic_year": {
        "id": 2023,
        "title": "Academic Year 2023-2024",
        "slug": "academic-year-2023-2024",
        "start_at": "2023-08-01T00:00:00Z",
        "end_at": "2024-07-31T23:59:59Z",
        "active": true,
        "is_visible": true,
        "created_by": "admin_user",
        "created_at": "2023-01-15T10:00:00Z",
        "updated_at": "2023-06-01T12:00:00Z"
      },
      "registration_status": {},
      "student_status": {}
    },
    "registration_active": true
  }
}

Creates, updates, or returns registration setup requirements for the selected academic year.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Request

This endpoint expects an object.

batch_idintegerRequired

batch ID identifier.

registration_status_idintegerRequired

registration status ID status value.

student_status_idstringRequired

student status ID status value.

update_is_activeboolean or nullOptional

update is active date value.

registration_activeboolean or nullOptional

registration active flag.

Response

Success

statusenum

Allowed values:

messagestring

dataobject