University Records API Documentation

Manage university records, student data, and upload logs

Table of Contents (server/server) only

GET

/claimed_count

Description

Retrieves the count of claimed student records.

Response

{
  "totalClaimed": 42
}
GET

/records

Description

Retrieves all student uploaded records.

Response

[
  {
    "_id": "507f1f77bcf86cd799439012",
    "filename": "data.csv",
    "studentCount": 1,
    "notes": "",
    "uploadDate": "2025-06-15T16:58:58.529Z",
    "insertedBy": "admin_id",
    "claimedCount": 1,
    "studentDB": "507f1f77bcf86cd799439011",
    "studentDBCSV": "507f1f77bcf86cd799439011",
    "status": "completed"
  }
]
GET

/std_list/:id

Description

Retrieves a specific student list by ID.

Parameters

NameTypeDescription
idstringID of the student list to retrieve

Response

{
  "_id": "507f1f77bcf86cd799439011",
  "insertedBy": "admin",
  "refrenceLogID": "507f1f77bcf86cd799439012",
  "students": [
    {
      "universityId": "uni123",
      "lockValue": "lock123",
      "name": "John Doe",
      "claimed": true,
      "claimedBy": "user123"
    }
  ]
}
POST

/add_record

Description

Adds a new student record.

Request Body

{
  "meta": {
    "filename": "data.csv",
    "studentCount": 1,
    "notes": "string"
  },
  "data": [
    {
      "universityId": "192462",
      "lockValue": "randomString",
      "name": "crytiano ronaldo"
    }
  ]
}

Response

{
  "listId": "list_id",
  "_id": "record_id",
  "total": "number of all students in DB"
}
PATCH

/update_List_item/:id

Description

Updates a specific student List item by ID.

Parameters

NameTypeDescription
idstringID of the student List to update

Request Body

{
  "student": {
    "universityId": "important for successful operation!",
    "claimed": true,
    "claimedBy": "user123"
  }
}

Response

{
  "success": true,
  "message": "Record updated successfully"
}
PATCH

/del_record_item/:id

Description

Deletes a specific student in List by ID.

Parameters

NameTypeDescription
idstringID of the student List to delete

Request Body

{
  "std": {
    "universityId": "1827288",
    "lockValue": "cas54qwc",
    "name": "shady ahmed",
    "claimed": "false",
    "claimedBy": null
  }
}

Response

{
  "success": true,
  "message": "Record item deleted successfully"
}
DELETE

/del_record/:recordId/:listId

Description

Deletes a specific record and associated list.

Parameters

NameTypeDescription
recordIdstringID of the record to delete
listIdstringID of the associated List

Response

{
  "success": true,
  "message": "Record and student deleted successfully"
}

Type Definitions

UniversityBasic

{
  "_id": "string (optional)",
  "ownerId": "string",
  "university": "string",
  "apiURL": "string",
  "apiKey": "string (optional)",
  "slotsTaken": "number",
  "totalStudents": "number",
  "arciveId": "UploadLog['_id'][]",
  "enableReg": "boolean",
  "lastUpdate": "Date"
}

RecordUpdate

{
  "_id": "string",
  "filename": "string (optional)",
  "uploadDate": "string (optional)",
  "insertedBy": "string (optional)",
  "studentCount": "number (optional)",
  "claimedCount": "number (optional)",
  "notes": "string[] (optional)",
  "studentDB": "StudentDB['_id'] (optional)",
  "status": "'completed' | 'in-progress' | 'error' | 'partial' (optional)"
}

UploadRecord

{
  "filename": "string",
  "studentCount": "number",
  "notes": "string (optional)",
  "_id": "string (optional)",
  "uploadDate": "Date",
  "insertedBy": "string",
  "claimedCount": "number",
  "studentDB": "StudentDB['_id']",
  "studentDBCSV": "StudentDbMin['_id']",
  "status": "'completed' | 'in-progress' | 'error' | 'partial'"
}

StudentDBList

{
  "_id": "string (optional)",
  "insertedBy": "string",
  "refrenceLogID": "UploadLog['_id']",
  "students": "ClaimableRecord[]"
}

ClaimableRecord

{
  "universityId": "string",
  "lockValue": "string",
  "name": "string",
  "claimed": "boolean",
  "claimedBy": "string | null"
}

RecordRes

{
  "_id": "string",
  "listId": "string",
  "total": "number"
}