Groups Application Request

This section covers the API endpoints for managing group application requests in the admin panel.

List Group Application Requests

GET /v1/admin/groups-application-requests

Returns a paginated list of all group application requests.

Query Parameters

Parameter	Type	Description
`search_text`	string	Search in request details
`filter[type]`	string	Filter by request type (student, special_needs, pupils, social_security)
`filter[status]`	string	Filter by status (accept, reject, pending)
`per_page`	integer	Number of items per page. Defaults to 10

Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "current_page": 1,
        "first_page_url": "http://testing-api.sumaya369.net/v1/admin/groups-application-requests?filter%5Btype%5D=pupils&page=1",
        "from": 1,
        "last_page": 9,
        "last_page_url": "http://testing-api.sumaya369.net/v1/admin/groups-application-requests?filter%5Btype%5D=pupils&page=9",
        "links": [
            {
                "url": null,
                "label": "&laquo; السابق",
                "active": false
            },
            {
                "url": "http://testing-api.sumaya369.net/v1/admin/groups-application-requests?filter%5Btype%5D=pupils&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "http://testing-api.sumaya369.net/v1/admin/groups-application-requests?filter%5Btype%5D=pupils&page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "http://testing-api.sumaya369.net/v1/admin/groups-application-requests?filter%5Btype%5D=pupils&page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "http://testing-api.sumaya369.net/v1/admin/groups-application-requests?filter%5Btype%5D=pupils&page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "http://testing-api.sumaya369.net/v1/admin/groups-application-requests?filter%5Btype%5D=pupils&page=5",
                "label": "5",
                "active": false
            },
            {
                "url": "http://testing-api.sumaya369.net/v1/admin/groups-application-requests?filter%5Btype%5D=pupils&page=6",
                "label": "6",
                "active": false
            },
            {
                "url": "http://testing-api.sumaya369.net/v1/admin/groups-application-requests?filter%5Btype%5D=pupils&page=7",
                "label": "7",
                "active": false
            },
            {
                "url": "http://testing-api.sumaya369.net/v1/admin/groups-application-requests?filter%5Btype%5D=pupils&page=8",
                "label": "8",
                "active": false
            },
            {
                "url": "http://testing-api.sumaya369.net/v1/admin/groups-application-requests?filter%5Btype%5D=pupils&page=9",
                "label": "9",
                "active": false
            },
            {
                "url": "http://testing-api.sumaya369.net/v1/admin/groups-application-requests?filter%5Btype%5D=pupils&page=2",
                "label": "التالي &raquo;",
                "active": false
            }
        ],
        "next_page_url": "http://testing-api.sumaya369.net/v1/admin/groups-application-requests?filter%5Btype%5D=pupils&page=2",
        "path": "http://testing-api.sumaya369.net/v1/admin/groups-application-requests",
        "per_page": 10,
        "prev_page_url": null,
        "to": 10,
        "total": 84,
        "groups_application_requests": [
            {
                "id": "a1f46380-f344-11ef-b7d6-9374da080168",
                "type": "pupils",
                "status": "pending",
                "email": "developer@sumaya369.net",
                "avatar": "https://i.ibb.co/YhTw0wR/7-512.png",
                "username": "sumaya_content",
                "fullname": "Hamad Alshabanah",
                "accepted_at": null,
                "created_at": "2025-02-25",
                "customer_id": "9f2ecd22-5c07-48ec-9415-2979deec4493",
                "gar_number": "GAR-2502001270"
            },
            {
                "id": "dabdf840-f312-11ef-bd7a-a938dabb5f8b",
                "type": "pupils",
                "status": "accept",
                "email": "developer@sumaya369.net",
                "avatar": "https://i.ibb.co/YhTw0wR/7-512.png",
                "username": "sumaya_content",
                "fullname": "Hamad Alshabanah",
                "accepted_at": "2025-02-25",
                "created_at": "2025-02-25",
                "customer_id": "9f2ecd22-5c07-48ec-9415-2979deec4493",
                "gar_number": "GAR-2502001269"
            }
        ]
    },
    "status_code": 200
}

Create Group Application Request

POST /v1/admin/groups-application-requests

Create a new group application request.

Request Body

Parameter	Type	Description	Validation Rules
`type`	string	Required. Request type	Must be one of: student, special_needs, pupils, social_security
`customer_id`	string	Required. Customer ID	Must exist in customers table
`status`	string	Optional. Request status	Must be one of: accept, reject, pending
`expiry_date`	string	Required if status is 'accept'	Date format: Y-m-d, must be after current date
`meta`	object	Required. Request metadata	Array of type-specific fields

Student Type Metadata

Parameter	Type	Description	Validation Rules
`university_name`	string	Required	-
`enrollment_year`	string	Required	Date format: Y-m-d, after 1900-01-01
`expected_graduation_year`	string	Required	Date format: Y-m-d, after enrollment_year
`university_card_files`	array	Required	Max 5 files, image/pdf, max 1MB each
`acadimec_regsteration_files`	array	Optional	Max 5 files, image/pdf, max 1MB each
`letter_from_university_files`	array	Optional	Max 5 files, image/pdf, max 1MB each

Special Needs Type Metadata

Parameter	Type	Description	Validation Rules
`organization_name`	string	Required	-
`medical_report_files`	array	Required	Max 5 files, image/pdf, max 1MB each
`identification_files`	array	Required	Max 5 files, image/pdf, max 1MB each

Pupils Type Metadata

Parameter	Type	Description	Validation Rules
`school_name`	string	Required	-
`school_enrollment_year`	string	Required	Date format: Y-m-d, after 1900-01-01
`school_expected_graduation_year`	string	Required	Date format: Y-m-d, after school_enrollment_year
`school_certificate_files`	array	Required	Max 5 files, image/jpg/png, max 1MB each

Parameter	Type	Description	Validation Rules
`provided_for_warranty`	string	Required	Must be: me, another_person
`civil_record`	string	Required	6-12 digits
`security_number`	string	Required	6-12 digits
`proof_kinship`	string	Required if provided_for_warranty is 'another_person'	-
`warranty_certificate_files`	array	Required	Max 5 files, image/pdf, max 1MB each
`proof_kinship_files`	array	Required if provided_for_warranty is 'another_person'	Max 5 files, image/pdf, max 1MB each

Response

{
    "success": true,
    "message": "تم حفظ البيانات بنجاح.",
    "data": {
        "id": "5c197110-0823-11f0-aa74-ed804301184e",
        "type": "special_needs",
        "status": "pending",
        "email": "aalbaiti360@gmail.com",
        "avatar": "https://i.ibb.co/YhTw0wR/7-512.png",
        "username": "aalbaiti360",
        "fullname": "wewdw eewedw",
        "country": "السعودية",
        "accepted_at": null,
        "organization_name": "bootfi",
        "expiry_date": null,
        "created_at": "2025-03-23",
        "identification_files": [
            "https://sumaya369-testing-media.s3.us-east-2.amazonaws.com/23669/Screenshot-from-2025-02-24-13-39-01.png"
        ],
        "medical_report_files": [
            "https://sumaya369-testing-media.s3.us-east-2.amazonaws.com/23670/Screenshot-from-2025-02-24-13-39-01.png"
        ],
        "notes": [],
        "is_employed": null,
        "is_agree_to_terms": null
    },
    "status_code": 200
}

Update Group Application Request

PATCH /v1/admin/groups-application-requests/{id}

Update an existing group application request.

Request Body

Same parameters as Create endpoint, but all fields are optional. Additional parameters:

Parameter	Type	Description	Validation Rules
`deleted_identification_files`	array	URLs of files to delete	Valid URLs
`deleted_medical_report_files`	array	URLs of files to delete	Valid URLs
`deleted_school_certificate_files`	array	URLs of files to delete	Valid URLs
`deleted_proof_kinship_files`	array	URLs of files to delete	Valid URLs
`deleted_warranty_certificate_files`	array	URLs of files to delete	Valid URLs
`deleted_letter_from_university_files`	array	URLs of files to delete	Valid URLs
`deleted_acadimec_regsteration_files`	array	URLs of files to delete	Valid URLs
`deleted_university_card_files`	array	URLs of files to delete	Valid URLs

Response

{
    "success": true,
    "message": "تم تحديث البيانات بنجاح.",
    "data": {
        "id": "5c197110-0823-11f0-aa74-ed804301184e",
        "type": "special_needs",
        "status": "accept",
        "email": "aalbaiti360@gmail.com",
        "avatar": "https://i.ibb.co/YhTw0wR/7-512.png",
        "username": "aalbaiti360",
        "fullname": "wewdw eewedw",
        "country": "السعودية",
        "accepted_at": "2025-03-23",
        "organization_name": "bootfi",
        "expiry_date": "2025-05-13 00:00:00",
        "created_at": "2025-03-23",
        "identification_files": [
            "https://sumaya369-testing-media.s3.us-east-2.amazonaws.com/23669/Screenshot-from-2025-02-24-13-39-01.png"
        ],
        "medical_report_files": [
            "https://sumaya369-testing-media.s3.us-east-2.amazonaws.com/23670/Screenshot-from-2025-02-24-13-39-01.png"
        ],
        "notes": [],
        "is_employed": null,
        "is_agree_to_terms": null
    },
    "status_code": 200
}

Batch Update Status

PATCH /v1/admin/groups-application-requests

Update status for multiple group application requests.

Request Body

Parameter	Type	Description	Validation Rules
`ids`	array	Required. Request IDs to update	Array of UUIDs
`status`	string	Optional	Must be: accept, reject, pending
`expiry_date`	string	Required if status is 'accept'	Date format: Y-m-d, after current date

Response

{
    "success": true,
    "message": "تم تحديث البيانات بنجاح.",
    "data": null,
    "status_code": 200
}

Delete Group Application Requests

DELETE /v1/admin/groups-application-requests

Delete one or more group application requests.

Request Body

Parameter	Type	Description	Validation Rules
`ids`	array	Required. Request IDs to delete	Array of UUIDs

Response

{
    "success": true,
    "message": "تم حذف البيانات بنجاح.",
    "data": null,
    "status_code": 200
}

Download GAR Attachments

GET /v1/admin/groups-application-requests/download-attachment/{id}

Download all attachments associated with a specific group application request as a ZIP file.

URL Parameters

Parameter	Type	Description
`id`	string	Required. The UUID of the group application request

Response

A ZIP file containing all attachments associated with the group application request.

Notes

All file uploads must be images or PDFs between 25KB and 1MB in size
Dates must follow Y-m-d format
Request status can be: accept, reject, or pending
When status is set to 'accept', expiry_date is required
Batch operations support multiple request IDs
File deletion requires valid file URLs

List Group Application Requests​

Query Parameters​

Response​

Create Group Application Request​

Request Body​

Student Type Metadata​

Special Needs Type Metadata​

Pupils Type Metadata​

Social Security Type Metadata​

Response​

Update Group Application Request​

Request Body​

Response​

Batch Update Status​

Request Body​

Response​

Delete Group Application Requests​

Request Body​

Response​

Download GAR Attachments​

URL Parameters​

Response​

Notes​

List Group Application Requests

Query Parameters

Response

Create Group Application Request

Request Body

Student Type Metadata

Special Needs Type Metadata

Pupils Type Metadata

Social Security Type Metadata

Response

Update Group Application Request

Request Body

Response

Batch Update Status

Request Body

Response

Delete Group Application Requests

Request Body

Response

Download GAR Attachments

URL Parameters

Response

Notes