Create Registration Setup | SchoolSet

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

{
  "status": "success",
  "message": "Registration setup retrieved successfully.",
  "data": {
    "id": 102,
    "batch_id": 17,
    "type": "file",
    "name": "Proof of Residency",
    "description": "Upload a recent utility bill or lease agreement as proof of residency.",
    "form_id": 45,
    "requirement_details": {},
    "is_required": true,
    "is_public": true,
    "is_editable": true,
    "relates_to": "student",
    "sort_order": 3,
    "attachments": [
      {
        "id": 501,
        "file_hash": "a1b2c3d4e5f67890",
        "file_name": "residency_proof.pdf",
        "file_original_name": "utility_bill_march.pdf",
        "file_mime_type": "application/pdf",
        "caption": "Utility bill for March 2024",
        "url": "https://app.schoolset.io/uploads/residency_proof.pdf",
        "file_size": 245760,
        "created_by": "admin_user",
        "created_at": "2024-04-10T09:15:00Z",
        "updated_at": "2024-04-10T09:15:00Z",
        "related_to": "registration_requirement",
        "model_name": "RegistrationRequirement",
        "model_id": 102
      }
    ],
    "document_templates": [
      {}
    ],
    "created_by_user_id": 12,
    "created_at": "2024-04-01T08:00:00Z",
    "updated_at": "2024-04-15T12:30:00Z"
  }
}

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.

namestring or nullOptional

name display value.

descriptionstring or nullOptional

description value.

requirement_detailsobject or nullOptional

requirement details object.

is_requiredboolean or nullOptional

is required flag.

is_editableboolean or nullOptional

is editable value.

is_publicboolean or nullOptional

is public value.

relates_toenum or nullOptional

relates to value.

Allowed values:

sort_orderinteger or nullOptional

sort order value.

typeenum or nullOptional

type value.

Allowed values:

fileinteger or nullOptional

file upload or file reference.

document_templateinteger or nullOptional

document template value.

form_idintegerOptional

This field is required when type is form.

Response

Success

statusenum

Allowed values:

messagestring

dataobject