{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "http:\/\/localhost" } ], "info": { "name": "Laravel API Documentation", "_postman_id": "1ee9d2a9-ca9a-4835-a2b0-19e3940c5cd4", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Classes", "description": "", "item": [ { "name": "Get a list of all classes.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/classes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/classes" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint returns a list of all classes, including their associated grade and staff members." }, "response": [ { "header": [], "code": 200, "body": "{\n\"success\": true,\n\"data\": [\n{\n\"id\": 1,\n\"name\": \"Mathematics\",\n\"grade_id\": 1,\n\"grade\": {\n\"id\": 1,\n\"name\": \"Elementary\"\n},\n\"staff\": [\n{\n\"id\": 1,\n\"name\": \"John Doe\"\n}\n]\n}\n]\n}", "name": "" } ] }, { "name": "Create a new class.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/classes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/classes" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Class A\",\"grade_id\":1,\"staff_ids\":\"[1, 2, 3]\"}" }, "description": "This endpoint allows you to create a new class by providing its name, grade, and an optional list of staff members." }, "response": [ { "header": [], "code": 201, "body": "{\n\"success\": true,\n\"data\": {\n\"name\": \"Class A\",\n\"grade_id\": 1,\n\"updated_at\": \"2025-08-02T01:00:00.000000Z\",\n\"created_at\": \"2025-08-02T01:00:00.000000Z\",\n\"id\": 1\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n\"name\": [\n\"The name field is required.\"\n]\n}\n}", "name": "" } ] }, { "name": "Get details for a specific class.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/classes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/classes\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the class." }, { "id": "class", "key": "class", "value": "1", "description": "The ID of the class." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint returns the details for a single class, including its associated grade and staff members." }, "response": [ { "header": [], "code": 200, "body": "{\n\"success\": true,\n\"data\": {\n\"id\": 1,\n\"name\": \"Mathematics\",\n\"grade_id\": 1,\n\"grade\": {\n\"id\": 1,\n\"name\": \"Elementary\"\n},\n\"staff\": [\n{\n\"id\": 1,\n\"name\": \"John Doe\"\n}\n]\n}\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n\"message\": \"No query results for model [App\\\\Models\\\\ClassModel] 100\"\n}", "name": "" } ] }, { "name": "Update an existing class.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/classes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/classes\/:id", "variable": [ { "id": "id", "key": "id", "value": "consequatur", "description": "The ID of the class." }, { "id": "class", "key": "class", "value": "1", "description": "The ID of the class to update." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Class B\",\"grade_id\":2,\"staff_ids\":\"[4, 5]\"}" }, "description": "This endpoint updates an existing class, including its name, grade, and attached staff members." }, "response": [ { "header": [], "code": 200, "body": "{\n\"success\": true,\n\"data\": {\n\"id\": 1,\n\"name\": \"Class B\",\n\"grade_id\": 2,\n\"updated_at\": \"2025-08-02T01:05:00.000000Z\",\n\"created_at\": \"2025-08-02T01:00:00.000000Z\"\n}\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n\"message\": \"No query results for model [App\\\\Models\\\\ClassModel] 1\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n\"grade_id\": [\n\"The selected grade id is invalid.\"\n]\n}\n}", "name": "" } ] }, { "name": "Delete a class.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/classes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/classes\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the class." }, { "id": "class", "key": "class", "value": "1", "description": "The ID of the class to delete." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deletes a specific class from the database." }, "response": [ { "header": [], "code": 204, "body": "{\n\"success\": true,\n\"message\": \"Class deleted successfully.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n\"message\": \"No query results for model [App\\\\Models\\\\ClassModel] 100\"\n}", "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "POST api\/v1\/register", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/register", "query": [], "raw": "{{baseUrl}}\/api\/v1\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"vmqeopfuudtdsufvyvddq\",\"email\":\"kunde.eloisa@example.com\",\"password\":\"4[*UyPJ\\\"}6\",\"role\":\"admin\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST api\/v1\/login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/login", "query": [], "raw": "{{baseUrl}}\/api\/v1\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"qkunze@example.com\",\"password\":\"O[2UZ5ij-e\\\/dl4m{o,\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST api\/v1\/logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/user", "query": [], "raw": "{{baseUrl}}\/api\/v1\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/attendances", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/attendances", "query": [], "raw": "{{baseUrl}}\/api\/v1\/attendances" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"staff_id\":17}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/attendances", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/attendances", "query": [], "raw": "{{baseUrl}}\/api\/v1\/attendances" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/dashboard", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/dashboard", "query": [], "raw": "{{baseUrl}}\/api\/v1\/dashboard" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/earnings-summary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/earnings-summary", "query": [], "raw": "{{baseUrl}}\/api\/v1\/earnings-summary" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/confirm-password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/confirm-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/confirm-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"password\":\"O[2UZ5ij-e\\\/dl4m{o,\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profile", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profile" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "PUT api\/v1\/profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profile", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profile" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"vmqeopfuudtdsufvyvddq\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST api\/v1\/profile\/update", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profile\/update", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profile\/update" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "vmqeopfuudtdsufvyvddq", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "email", "value": "kunde.eloisa@example.com", "type": "text", "description": "Must be a valid email address." }, { "key": "avatar", "src": [], "type": "file" } ] }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/payments\/class\/{class_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/payments\/class\/:class_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/payments\/class\/:class_id", "variable": [ { "id": "class_id", "key": "class_id", "value": "consequatur", "description": "The ID of the class." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/payments\/suspended\/{studentId}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/payments\/suspended\/:studentId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/payments\/suspended\/:studentId", "variable": [ { "id": "studentId", "key": "studentId", "value": "consequatur", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/payments\/statuses", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/payments\/statuses", "query": [], "raw": "{{baseUrl}}\/api\/v1\/payments\/statuses" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/transactions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/transactions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"student_id\":11613.31890586,\"total_amount\":11613.31890586,\"status\":\"consequatur\",\"payment_method\":\"consequatur\",\"payments\":[{\"id\":\"consequatur\",\"amountToPay\":45,\"remise\":56}]}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/transactions\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:id", "variable": [ { "id": "id", "key": "id", "value": "consequatur", "description": "The ID of the transaction." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get payments for a specific transaction.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:id\/payments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:id\/payments", "variable": [ { "id": "id", "key": "id", "value": "consequatur", "description": "The ID of the transaction." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/school-settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/school-settings", "query": [], "raw": "{{baseUrl}}\/api\/v1\/school-settings" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/school-settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/school-settings", "query": [], "raw": "{{baseUrl}}\/api\/v1\/school-settings" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "vmqeopfuudtdsufvyvddq", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "address", "value": "consequatur", "type": "text", "description": "" }, { "key": "phone", "value": "mqeopfuudtdsufvyv", "type": "text", "description": "Must not be greater than 20 characters." }, { "key": "email", "value": "buckridge.adell@example.org", "type": "text", "description": "Must be a valid email address. Must not be greater than 255 characters." }, { "key": "website", "value": "niihfqcoynlazghdtqtqx", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "logo", "src": [], "type": "file" } ] }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST api\/v1\/school-settings\/logo", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/school-settings\/logo", "query": [], "raw": "{{baseUrl}}\/api\/v1\/school-settings\/logo" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "logo", "src": [], "type": "file" } ] }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/school-settings\/logo", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/school-settings\/logo", "query": [], "raw": "{{baseUrl}}\/api\/v1\/school-settings\/logo" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/school-years", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/school-years", "query": [], "raw": "{{baseUrl}}\/api\/v1\/school-years" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/school-years", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/school-years", "query": [], "raw": "{{baseUrl}}\/api\/v1\/school-years" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"consequatur\",\"start_year\":17,\"end_year\":17,\"is_active\":true}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "FeeTypes", "description": "", "item": [ { "name": "Display a listing of the resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/fee-types", "query": [], "raw": "{{baseUrl}}\/api\/v1\/fee-types" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": 1,\n \"name\": \"Tuition\",\n \"amount\": 500,\n \"frequency\": \"monthly\"\n }\n]", "name": "" } ] }, { "name": "Store a newly created resource in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/fee-types", "query": [], "raw": "{{baseUrl}}\/api\/v1\/fee-types" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Tuition\",\"amount\":\"500\",\"frequency\":\"monthly\",\"description\":\"Dolores dolorum amet iste laborum eius est dolor.\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 1,\n \"name\": \"Tuition\",\n \"amount\": 500,\n \"frequency\": \"monthly\"\n}", "name": "" } ] }, { "name": "Display the specified resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/fee-types\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/fee-types\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the fee type." }, { "id": "feeType", "key": "feeType", "value": "1", "description": "The ID of the fee type." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"name\": \"Tuition\",\n \"amount\": 500,\n \"frequency\": \"monthly\"\n}", "name": "" } ] }, { "name": "Update the specified resource in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/fee-types\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/fee-types\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the fee type." }, { "id": "feeType", "key": "feeType", "value": "1", "description": "The ID of the fee type." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Updated Tuition\",\"amount\":\"600\",\"frequency\":\"annual\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"name\": \"Updated Tuition\",\n \"amount\": 600,\n \"frequency\": \"annual\"\n}", "name": "" } ] }, { "name": "Remove the specified resource from storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/fee-types\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/fee-types\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the fee type." }, { "id": "feeType", "key": "feeType", "value": "1", "description": "The ID of the fee type." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 204, "body": "{\n \"success\": true,\n \"message\": \"FeeType deleted successfully.\"\n}", "name": "" } ] } ] }, { "name": "Grades", "description": "", "item": [ { "name": "Display a listing of the resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/grades", "query": [], "raw": "{{baseUrl}}\/api\/v1\/grades" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"name\": \"Elementary\"\n}", "name": "" } ] }, { "name": "Store a newly created resource in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/grades", "query": [], "raw": "{{baseUrl}}\/api\/v1\/grades" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Elementary\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 1,\n \"name\": \"Elementary\"\n}", "name": "" } ] }, { "name": "Display the specified resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/grades\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/grades\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the grade." }, { "id": "grade", "key": "grade", "value": "1", "description": "The ID of the grade." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"name\": \"Elementary\"\n}", "name": "" } ] }, { "name": "Update the specified resource in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/grades\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/grades\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the grade." }, { "id": "grade", "key": "grade", "value": "1", "description": "The ID of the grade." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Secondary\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"name\": \"Secondary\"\n}", "name": "" } ] }, { "name": "Remove the specified resource from storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/grades\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/grades\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the grade." }, { "id": "grade", "key": "grade", "value": "1", "description": "The ID of the grade." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 204, "body": "{\n \"success\": true,\n \"message\": \"Grade deleted successfully.\"\n}", "name": "" } ] } ] }, { "name": "Guardians", "description": "", "item": [ { "name": "Search guardians by first or last name.\n\nThis endpoint allows you to search for guardians using a partial match of their first or last names.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guardians\/search", "query": [ { "key": "search", "value": "John", "description": "The keyword to search in guardian names.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/guardians\/search?search=John" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Display a listing of the guardians.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guardians", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guardians" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Store a newly created guardian in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guardians", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guardians" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "first_name", "value": "vmqeopfuudtdsufvyvddq", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "last_name", "value": "amniihfqcoynlazghdtqt", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "phone_number", "value": "qxbajwbpilpmufinl", "type": "text", "description": "Must not be greater than 20 characters." }, { "key": "email", "value": "john@example.com", "type": "text", "description": "The email of the guardian." }, { "key": "address", "value": "uydlsmsjuryvojcybzvrb", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "name", "value": "John Doe", "type": "text", "description": "The name of the guardian." }, { "key": "phone", "value": "123-456-7890", "type": "text", "description": "The phone number of the guardian." }, { "key": "cin_front", "src": [], "type": "file" }, { "key": "cin_back", "src": [], "type": "file" } ] }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Display the specified guardian.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guardians\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guardians\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the guardian." }, { "id": "guardian", "key": "guardian", "value": "1", "description": "The ID of the guardian." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update the specified guardian in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guardians\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guardians\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the guardian." }, { "id": "guardian", "key": "guardian", "value": "1", "description": "The ID of the guardian." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "first_name", "value": "vmqeopfuudtdsufvyvddq", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "last_name", "value": "amniihfqcoynlazghdtqt", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "email", "value": "jane@example.com", "type": "text", "description": "The new email of the guardian." }, { "key": "phone_number", "value": "wbpilpmufinllwloa", "type": "text", "description": "Must not be greater than 20 characters." }, { "key": "address", "value": "uydlsmsjuryvojcybzvrb", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "name", "value": "Jane Doe", "type": "text", "description": "The new name of the guardian." }, { "key": "phone", "value": "098-765-4321", "type": "text", "description": "The new phone number of the guardian." }, { "key": "cin_front", "src": [], "type": "file" }, { "key": "cin_back", "src": [], "type": "file" }, { "key": "_method", "value": "PUT", "type": "text" } ] }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Remove the specified guardian from storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guardians\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guardians\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the guardian." }, { "id": "guardian", "key": "guardian", "value": "1", "description": "The ID of the guardian." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get CIN image of a guardian.\n\nReturns the requested CIN image (front or back) of a guardian.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guardians\/:id\/cin\/:side", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guardians\/:id\/cin\/:side", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the guardian." }, { "id": "side", "key": "side", "value": "front", "description": "The side of the CIN image to retrieve. Must be `front` or `back`." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Payments", "description": "", "item": [ { "name": "Get all payments for a specific student.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/students\/:student_id\/payments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/students\/:student_id\/payments", "variable": [ { "id": "student_id", "key": "student_id", "value": "1", "description": "The ID of the student." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": 1,\n \"amount\": 100,\n \"payment_date\": \"2024-09-01\",\n \"status\": \"pending\",\n \"student_id\": 1,\n \"fee_type_id\": 1,\n \"student\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n },\n \"feeType\": {\n \"id\": 1,\n \"name\": \"Tuition\"\n }\n }\n]", "name": "" } ] }, { "name": "Get payments for the current month.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/payments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/payments" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": 1,\n \"amount\": 100,\n \"payment_date\": \"2024-09-01\",\n \"status\": \"pending\",\n \"student_id\": 1,\n \"fee_type_id\": 1,\n \"student\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"code_massar\": \"ABC123\"\n },\n \"feeType\": {\n \"id\": 1,\n \"name\": \"Tuition\"\n }\n }\n]", "name": "" } ] }, { "name": "Store a new payment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/payments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/payments" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"amount\":100,\"payment_date\":\"2024-09-01\",\"status\":\"pending\",\"student_id\":1,\"fee_type_id\":1}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 1,\n \"amount\": 100,\n \"payment_date\": \"2024-09-01\",\n \"status\": \"pending\",\n \"student_id\": 1,\n \"fee_type_id\": 1\n}", "name": "" } ] }, { "name": "Update an existing payment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/payments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/payments\/:id", "variable": [ { "id": "id", "key": "id", "value": "1562", "description": "The ID of the payment." }, { "id": "payment", "key": "payment", "value": "1", "description": "The ID of the payment." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"amount_paid\":73,\"remise\":45,\"amount\":150,\"payment_date\":\"2024-10-01\",\"status\":\"completed\",\"student_id\":2,\"fee_type_id\":2}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"amount\": 150,\n \"payment_date\": \"2024-10-01\",\n \"status\": \"completed\",\n \"student_id\": 2,\n \"fee_type_id\": 2\n}", "name": "" } ] }, { "name": "Generate payments for all students based on their fee types.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/payments\/generate-payments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/payments\/generate-payments" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Payments generated successfully.\"\n}", "name": "" } ] }, { "name": "Get a student's payments by their Massar code.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/payments\/massar\/:code_massar", "query": [ { "key": "school_year_id", "value": "1", "description": "The ID of the school year to filter by.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/payments\/massar\/:code_massar?school_year_id=1", "variable": [ { "id": "code_massar", "key": "code_massar", "value": "%22S123456789%22", "description": "The unique Massar code of the student." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all payments for a specific student using their unique `code_massar`.\nYou can optionally filter the results by a specific school year." }, "response": [ { "header": [], "code": 200, "body": "{\n\"success\": true,\n\"data\": [\n{\n\"id\": 1,\n\"student_id\": 1,\n\"fee_type_id\": 1,\n\"school_year_id\": 1,\n\"amount\": 500.00,\n\"remaining\": 100.00,\n\"payment_date\": \"2025-08-01\",\n\"status\": \"incomplete\",\n\"year\": 2025,\n\"month\": 8,\n\"student\": {\n\"id\": 1,\n\"first_name\": \"Jane\",\n\"last_name\": \"Doe\",\n\"code_massar\": \"S123456789\"\n},\n\"fee_type\": {\n\"id\": 1,\n\"name\": \"Tuition Fee\"\n}\n},\n{\n\"id\": 2,\n\"student_id\": 1,\n\"fee_type_id\": 2,\n\"school_year_id\": 1,\n\"amount\": 200.00,\n\"remaining\": 0.00,\n\"payment_date\": \"2025-07-25\",\n\"status\": \"completed\",\n\"year\": 2025,\n\"month\": 7,\n\"student\": {\n\"id\": 1,\n\"first_name\": \"Jane\",\n\"last_name\": \"Doe\",\n\"code_massar\": \"S123456789\"\n},\n\"fee_type\": {\n\"id\": 2,\n\"name\": \"Books\"\n}\n}\n]\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n\"message\": \"Student not found\"\n}", "name": "" } ] } ] }, { "name": "Staff", "description": "", "item": [ { "name": "Display a listing of the staff members.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/staff", "query": [], "raw": "{{baseUrl}}\/api\/v1\/staff" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1990-01-01\",\n \"gender\": \"male\",\n \"address\": \"123 Main St\",\n \"phone_number\": \"123-456-7890\",\n \"email\": \"john.doe@example.com\",\n \"affectation_date\": \"2021-06-15\",\n \"contrat_type\": \"CDI\",\n \"function\": \"teacher\",\n \"n_cnss\": \"1234567890\",\n \"base_salary\": 3000,\n \"bank_acount_num\": \"123456789\"\n}", "name": "" } ] }, { "name": "Store a newly created staff member in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/staff", "query": [], "raw": "{{baseUrl}}\/api\/v1\/staff" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"phone_number\":\"123-456-7890\",\"email\":\"john.doe@example.com\",\"date_of_birth\":\"1990-01-01\",\"gender\":\"male\",\"address\":\"123 Main St\",\"affectation_date\":\"2021-06-15\",\"contrat_type\":\"CDI\",\"function\":\"teacher\",\"n_cnss\":\"1234567890\",\"base_salary\":3000,\"bank_acount_num\":\"123456789\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1990-01-01\",\n \"gender\": \"male\",\n \"address\": \"123 Main St\",\n \"phone_number\": \"123-456-7890\",\n \"email\": \"john.doe@example.com\",\n \"affectation_date\": \"2021-06-15\",\n \"contrat_type\": \"CDI\",\n \"function\": \"teacher\",\n \"n_cnss\": \"1234567890\",\n \"base_salary\": 3000,\n \"bank_acount_num\": \"123456789\"\n}", "name": "" } ] }, { "name": "Display the specified staff member.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/staff\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/staff\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the staff." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1990-01-01\",\n \"gender\": \"male\",\n \"address\": \"123 Main St\",\n \"phone_number\": \"123-456-7890\",\n \"email\": \"john.doe@example.com\",\n \"affectation_date\": \"2021-06-15\",\n \"contrat_type\": \"CDI\",\n \"function\": \"teacher\",\n \"n_cnss\": \"1234567890\",\n \"base_salary\": 3000,\n \"bank_acount_num\": \"123456789\"\n}", "name": "" } ] }, { "name": "Update the specified staff member in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/staff\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/staff\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the staff." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"date_of_birth\":\"1990-01-01\",\"gender\":\"male\",\"address\":\"123 Main St\",\"phone_number\":\"123-456-7890\",\"email\":\"john.doe@example.com\",\"affectation_date\":\"2021-06-15\",\"contrat_type\":\"CDI\",\"function\":\"teacher\",\"n_cnss\":\"1234567890\",\"base_salary\":3000,\"bank_acount_num\":\"123456789\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1990-01-01\",\n \"gender\": \"male\",\n \"address\": \"123 Main St\",\n \"phone_number\": \"123-456-7890\",\n \"email\": \"john.doe@example.com\",\n \"affectation_date\": \"2021-06-15\",\n \"contrat_type\": \"CDI\",\n \"function\": \"teacher\",\n \"n_cnss\": \"1234567890\",\n \"base_salary\": 3000,\n \"bank_acount_num\": \"123456789\"\n}", "name": "" } ] }, { "name": "Remove the specified staff member from storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/staff\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/staff\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the staff." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Staff deleted successfully\"\n}", "name": "" } ] }, { "name": "Retrieve staff members where the function is 'teacher'.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teachers", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teachers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": 1,\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"function\": \"teacher\"\n }\n]", "name": "" } ] } ] }, { "name": "Students", "description": "", "item": [ { "name": "Assign fee types to a student.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/students\/:student_id\/fee-types", "query": [], "raw": "{{baseUrl}}\/api\/v1\/students\/:student_id\/fee-types", "variable": [ { "id": "student_id", "key": "student_id", "value": "consequatur", "description": "The ID of the student." }, { "id": "student", "key": "student", "value": "1", "description": "The ID of the student." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"fee_type_ids\":[1,2]}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"FeeTypes assigned successfully.\"\n}", "name": "" } ] }, { "name": "List all students with their guardians and class.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/students", "query": [], "raw": "{{baseUrl}}\/api\/v1\/students" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "array", "name": "" } ] }, { "name": "Store a new student.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/students", "query": [], "raw": "{{baseUrl}}\/api\/v1\/students" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "first_name", "value": "John", "type": "text", "description": "The first name of the student." }, { "key": "last_name", "value": "Doe", "type": "text", "description": "The last name of the student." }, { "key": "first_name_arab", "value": "\u062c\u0648\u0646", "type": "text", "description": "The student's first name in Arabic." }, { "key": "last_name_arab", "value": "\u062f\u0648", "type": "text", "description": "The student's last name in Arabic." }, { "key": "gender", "value": "male", "type": "text", "description": "The student's gender." }, { "key": "date_of_birth", "value": "2005-06-15", "type": "text", "description": "The student's date of birth." }, { "key": "address", "value": "123 Main St", "type": "text", "description": "The student's address." }, { "key": "phone_number", "value": "0612345678", "type": "text", "description": "The student's phone number." }, { "key": "code_massar", "value": "123456", "type": "text", "description": "The student's Massar code." }, { "key": "class_id", "value": "1", "type": "text", "description": "The class ID the student belongs to." }, { "key": "image", "src": [], "type": "file" } ] }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"Student created successfully.\",\n \"student\": Student\n}", "name": "" } ] }, { "name": "Get a specific student with guardians.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/students\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/students\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the student." }, { "id": "student", "key": "student", "value": "1", "description": "The ID of the student." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "Student", "name": "" } ] }, { "name": "Update a student.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/students\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/students\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the student." }, { "id": "student", "key": "student", "value": "1", "description": "The ID of the student." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "first_name", "value": "John", "type": "text", "description": "The first name." }, { "key": "last_name", "value": "Doe", "type": "text", "description": "The last name." }, { "key": "first_name_arab", "value": "qxbajwbpilpmufinllwlo", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "last_name_arab", "value": "auydlsmsjuryvojcybzvr", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "date_of_birth", "value": "2025-08-02T01:17:32", "type": "text", "description": "Must be a valid date." }, { "key": "gender", "value": "male", "type": "text", "description": "" }, { "key": "address", "value": "byickznkygloigmkwxphl", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "phone_number", "value": "vazjrcnfbaqywuxhg", "type": "text", "description": "Must not be greater than 20 characters." }, { "key": "code_massar", "value": "jjmzuxjubqouzswiwxtrk", "type": "text", "description": "Must not be greater than 191 characters." }, { "key": "class_id", "value": "17", "type": "text", "description": "The id<\/code> of an existing record in the classes table." }, { "key": "guardians[0]", "value": "consequatur", "type": "text", "description": "" }, { "key": "image", "src": [], "type": "file" }, { "key": "_method", "value": "PUT", "type": "text" } ] }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "Student", "name": "" } ] }, { "name": "Delete a student.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/students\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/students\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the student." }, { "id": "student", "key": "student", "value": "1", "description": "The ID of the student." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 204, "body": "{\n \"message\": \"Student deleted successfully.\"\n}", "name": "" } ] }, { "name": "Get a student's profile image.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/students\/profile-image\/:filename", "query": [], "raw": "{{baseUrl}}\/api\/v1\/students\/profile-image\/:filename", "variable": [ { "id": "filename", "key": "filename", "value": "avatar.jpg", "description": "The name of the image file." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "file Returns the student image file.", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Image not found.\"\n}", "name": "" } ] } ] } ], "auth": { "type": "noauth" } }