Introduction

The Falcon Management ERP System is a fully integrated platform designed specifically for businesses that manage falcon feeding, medical care, training operations, and cost management. The system centralizes all operational data, automates workflows, and provides a unified dashboard that enables managers, veterinarians, trainers, and finance teams to collaborate seamlessly.


Built to support precision, traceability, and efficiency, the ERP ensures every falcon receives optimal care while giving management full visibility across all departments.


The Falcon Management ERP System empowers organizations to professionally manage every stage of falcon care—from feeding and health treatment to training and financial analysis. It improves efficiency, reduces operational errors, supports cost control, and ensures that each falcon receives the best possible care in a structured, measurable way.


The Falcon ERP API provides unified access to all operations related to feeding, medical care, training, and costing.


It allows external systems to manage falcon profiles, record daily activities, track medical treatments, schedule training sessions, and calculate operational costs.


This API ensures consistent data flow across all departments and supports smooth integration with mobile apps, dashboards, and third-party services.



Access Requirements


Before using this API, you must obtain your App Key, Secret Key, and the implementation details for X-SIGNATURE from the system administrator.

All API requests must include these credentials; any request without them will be rejected.

Base API URL 
https://falcon-erp-backend-beta.dafagate.com/api/v1

Common Errors

A guide to consistent error response formats used across all endpoints.

Error 401 – Unauthorized

The request requires authentication. The user is either not logged in or does not have a valid access token.

Error Response 
{
    "message": "Unauthorized",
    "success": false
}

Error 403 – Forbidden

The request was understood, but the server refuses to authorize it. The user does not have permission to perform this action.

Error Response 
{
    "message": "You are not allowed to perform this action",
    "success": false
}

Error 404 – Not Found

The requested resource could not be found on the server. It may have been moved or deleted.

Error Response 
{
    "message": "Resource not found",
    "success": false
}

Error 405 – Method Not Allowed

The HTTP method used is not supported for this endpoint. Check the allowed request methods.

Error Response 
{
    "message": "Method not allowed",
    "success": false
}

Error 419 – Page Expired

The session or CSRF token has expired. Please refresh the page and try again.

Error Response 
{
    "message": "Page Expired",
    "success": false
}

Error 422 – Unprocessable Entity

The server understood the request, but the submitted data was invalid. Please review and correct the errors.(Errors may be return array or string)

Error Response 
{
    "errors": [],
    "message": "Validation Error",
    "success": false
}

Error 500 – Internal Server Error

An unexpected error occurred on the server. Please try again later or contact support.

Error Response 
{
    "message": "Server Error",
    "success": false
}
POST /api/v1/login

Admin Login

Authentication

Admin Login

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json

Request Body

Field/Name Type Examples
step integer 1
email string admin@base.com
password string P@ssw0rd

Request Validations Or Notes

Field/Name Examples
step required, integer, allowed: 1, 2
email required, valid email
password required if step = 1
otp required if step = 2, 6 digits
Success (200 OK) 
{
    "success": true,
    "message": "Welcome Admin",
    "data": {
        "id": 1,
        "name": "Admin",
        "email": "admin@base.com",
        "phone": "000000000000",
        "avatar": null,
        "roles": [
            {
                "id": 1,
                "name": "Default Role"
            },
            {
                "id": 2,
                "name": "Super Admin Role "
            }
        ],
        "is_active": 1,
        "permissions": [
            "dashboard-fetch",
            "roles-fetch",
            "roles-create",
            "roles-read",
            "roles-update",
            "roles-delete",
            "admins-fetch",
            "admins-create",
            "admins-read",
            "admins-update",
            "admins-delete"
        ],
        "created_at": "2026-05-04",
        "token": "2|AELUSt6R5SyFMcGAECzQWpZIjqrPa0JziO5bpbvzd4d65998",
        "token_type": "Bearer",
        "expires_in": null
    }
}
POST /api/v1/logout

Admin Logout

Authentication

Admin Logout

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Good by.",
    "data": []
}
POST /api/v1/forget-password

Forget Password Request

Authentication

Forget Password Request

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json

Request Body

Field/Name Type Examples
email string admin@base.com

Request Validations Or Notes

Field/Name Examples
email required, valid email, exists admins,email
Success (200 OK) 
{
    "success": true,
    "message": "Please check your email",
    "data": {
        "token": "SJXwJKTiW6hxnFSn7i7IyScUUYpIQSCM9o5L4qmZBgcHlaNBzQKpe05QPKNrbPIw"
    }
}
POST /api/v1/verify-forget-password-otp

Verify OTP

Authentication

Verify OTP

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json

Request Body

Field/Name Type Examples
email string admin@base.com
otp string 123456
token string token Key

Request Validations Or Notes

Field/Name Examples
email required, valid email, exists admins,email
otp required, 6 digits
token required, exists admins,change_password_token
Success (200 OK) 
{
    "success": true,
    "message": "Your Otp Verified successfully.",
    "data": []
}
POST /api/v1/reset-password

Reset Password

Authentication

Reset Password

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json

Request Body

Field/Name Type Examples
email string admin@base.com
otp string 123456
token string token Key
password string P@ssw0rd
password_confirm string P@ssw0rd

Request Validations Or Notes

Field/Name Examples
email required, valid email, exists admins,email
password required, StrongPassword
password_confirm required, same
otp required, 6 digits
token required, exists admins,change_password_token
Success (200 OK) 
{
    "success": true,
    "message": "Password reset successfully.",
    "data": []
}
POST /api/v1/admins

Create Admin

Create a new Admin.

Creates a new Admin in the system using the provided data. The request validates the required fields before storing the resource in the database. Upon successful creation, the system returns the newly created record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name string Admin 2
email string admin2@gmail.com
phone string 01112226666
password string P@ss0rd
roles array [ { "role_id": 1 }, { "role_id": 2 } ]

Request Validations Or Notes

Field/Name Examples
name required, string, max 255
email required, string, max 255, valid email, unique admins,email
phone required, string, min 7, max 15, regex, unique admins,phone
password required, StrongPassword
avatar optional, image, types: jpeg,png,jpg, max 2048
is_active optional, true/false
roles required, array, min 1
roles[].role_id required, integer, exists roles,id
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 2,
        "name": "Admin 2",
        "email": "admin2@gmail.com",
        "phone": "01112226666",
        "avatar": null,
        "roles": [
            {
                "id": 1,
                "name": "Default Role"
            },
            {
                "id": 2,
                "name": "Super Admin Role "
            }
        ],
        "is_active": null,
        "permissions": [],
        "created_at": "2026-05-04"
    }
}
GET /api/v1/admins

Get Admin List

Retrieve a list of Admin.

Retrieves a list of Admin records from the system. The response may support pagination, filtering, and sorting based on the provided request parameters.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "Admin",
            "email": "admin@base.com",
            "phone": "000000000000",
            "avatar": null,
            "roles": [
                {
                    "id": 1,
                    "name": "Default Role"
                },
                {
                    "id": 2,
                    "name": "Super Admin Role "
                }
            ],
            "is_active": 1,
            "permissions": [
                "dashboard-fetch",
                "roles-fetch",
                "roles-create",
                "roles-read",
                "roles-update",
                "roles-delete",
                "admins-fetch",
                "admins-create",
                "admins-read",
                "admins-update",
                "admins-delete"
            ],
            "created_at": "2026-05-04"
        },
        {
            "id": 2,
            "name": "Admin 2",
            "email": "admin2@gmail.com",
            "phone": "01112226666",
            "avatar": null,
            "roles": [
                {
                    "id": 1,
                    "name": "Default Role"
                },
                {
                    "id": 2,
                    "name": "Super Admin Role "
                }
            ],
            "is_active": 1,
            "permissions": [
                "dashboard-fetch",
                "roles-fetch",
                "roles-create",
                "roles-read",
                "roles-update",
                "roles-delete",
                "admins-fetch",
                "admins-create",
                "admins-read",
                "admins-update",
                "admins-delete"
            ],
            "created_at": "2026-05-04"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 2,
        "last_page": 1
    }
}
GET /api/v1/admins/2

Get Admin Details

Retrieve Admin details.

Retrieves detailed information about a specific Admin using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 2,
        "name": "Admin 2",
        "email": "admin2@gmail.com",
        "phone": "01112226666",
        "avatar": null,
        "roles": [
            {
                "id": 1,
                "name": "Default Role"
            },
            {
                "id": 2,
                "name": "Super Admin Role "
            }
        ],
        "is_active": 1,
        "permissions": [
            "dashboard-fetch",
            "roles-fetch",
            "roles-create",
            "roles-read",
            "roles-update",
            "roles-delete",
            "admins-fetch",
            "admins-create",
            "admins-read",
            "admins-update",
            "admins-delete"
        ],
        "created_at": "2026-05-04"
    }
}
PUT /api/v1/admins/2

Update Admin

Update an existing Admin.

Updates the specified Admin with the provided data. The system validates the request and applies the changes to the existing record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name string Admin 2
email string admin2@gmail.com
phone string 01112226666
password string P@ss0rd
roles array [ { "role_id": 1 }, { "role_id": 2 } ]
id integer 2

Request Validations Or Notes

Field/Name Examples
id required, integer, exists admins,id
name required, string, max 255
email required, valid email, unique admins,email,
phone required, string, max 15, unique admins,phone,
password optional, StrongPassword
avatar optional, image, types: jpeg,png,jpg,gif, max 2048
is_active optional, true/false
roles required, array, min 1
roles[].role_id required, integer, exists roles,id
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 2,
        "name": "Admin 2",
        "email": "admin2@gmail.com",
        "phone": "01112226666",
        "avatar": null,
        "roles": [
            {
                "id": 1,
                "name": "Default Role"
            },
            {
                "id": 2,
                "name": "Super Admin Role "
            }
        ],
        "is_active": 1,
        "permissions": [],
        "created_at": "2026-05-04"
    }
}
PATCH /api/v1/admins/2/toggle-active

Toggle Admin Status

Switch the Admin status between active and inactive.

Updates the status of the specified Admin by toggling it between active and inactive. This operation allows enabling or disabling the resource without deleting it from the system.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 2,
        "name": "Admin 2",
        "email": "admin2@gmail.com",
        "phone": "01112226666",
        "avatar": null,
        "roles": [
            {
                "id": 1,
                "name": "Default Role"
            },
            {
                "id": 2,
                "name": "Super Admin Role "
            }
        ],
        "is_active": false,
        "permissions": [],
        "created_at": "2026-05-04"
    }
}
DELETE /api/v1/admins/2

Delete Admin

Delete a Admin.

Deletes the specified Admin from the system using its unique identifier. Depending on the system configuration, the deletion may be permanent or soft deleted.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
GET /api/v1/admins/trash

Get Deleted Admin

List deleted Admin.

Retrieve a list of soft-deleted Admin records from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 2,
            "name": "Admin 2",
            "email": "admin2@gmail.com",
            "phone": "01112226666",
            "avatar": null,
            "roles": [
                {
                    "id": 1,
                    "name": "Default Role"
                },
                {
                    "id": 2,
                    "name": "Super Admin Role "
                }
            ],
            "is_active": 0,
            "permissions": [
                "dashboard-fetch",
                "roles-fetch",
                "roles-create",
                "roles-read",
                "roles-update",
                "roles-delete",
                "admins-fetch",
                "admins-create",
                "admins-read",
                "admins-update",
                "admins-delete"
            ],
            "created_at": "2026-05-04"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
PATCH /api/v1/admins/2/restore

Restore Admin

Restore deleted Admin.

Restore a previously deleted Admin record from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 2,
        "name": "Admin 2",
        "email": "admin2@gmail.com",
        "phone": "01112226666",
        "avatar": null,
        "roles": [
            {
                "id": 1,
                "name": "Default Role"
            },
            {
                "id": 2,
                "name": "Super Admin Role "
            }
        ],
        "is_active": 0,
        "permissions": [],
        "created_at": "2026-05-04"
    }
}
DELETE /api/v1/admins/2/force-delete

Permanently Delete Admin

Force delete Admin.

Permanently remove the Admin record from the system. This action cannot be undone.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/roles

Create Role

Create a new Role.

Creates a new Role in the system using the provided data. The request validates the required fields before storing the resource in the database. Upon successful creation, the system returns the newly created record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name array { "ar": "أختبار", "en": "Test Role" }
permissions array [ { "permission_id": 1, "model_id": 1 } ]

Request Validations Or Notes

Field/Name Examples
name required
name.ar required, ArabicRoleName, UniqueTranslationName
name.en required, EnglishRoleName, UniqueTranslationName
permissions required, array, min 1
permissions[].permission_id required, integer, exists permissions,id
permissions[].model_id required, integer, CheckPermissionInModule
permissions[].name optional, string
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "updated_at": "2026-05-04T12:58:24.000000Z",
        "created_at": "2026-05-04T12:58:24.000000Z",
        "id": 3
    }
}
GET /api/v1/roles

Get Role List

Retrieve a list of Role.

Retrieves a list of Role records from the system. The response may support pagination, filtering, and sorting based on the provided request parameters.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "Default Role",
            "permissions": [
                {
                    "id": 1,
                    "name": "dashboard-fetch"
                },
                {
                    "id": 2,
                    "name": "roles-fetch"
                },
                {
                    "id": 3,
                    "name": "roles-create"
                },
                {
                    "id": 4,
                    "name": "roles-read"
                },
                {
                    "id": 5,
                    "name": "roles-update"
                },
                {
                    "id": 6,
                    "name": "roles-delete"
                },
                {
                    "id": 7,
                    "name": "admins-fetch"
                },
                {
                    "id": 8,
                    "name": "admins-create"
                },
                {
                    "id": 9,
                    "name": "admins-read"
                },
                {
                    "id": 10,
                    "name": "admins-update"
                },
                {
                    "id": 11,
                    "name": "admins-delete"
                }
            ],
            "is_active": true,
            "created_at": "2026-05-04T12:58:21.000000Z"
        },
        {
            "id": 2,
            "name": "Super Admin Role ",
            "permissions": [
                {
                    "id": 12,
                    "name": "dashboard-fetch"
                },
                {
                    "id": 13,
                    "name": "roles-fetch"
                },
                {
                    "id": 14,
                    "name": "roles-create"
                },
                {
                    "id": 15,
                    "name": "roles-read"
                },
                {
                    "id": 16,
                    "name": "roles-update"
                },
                {
                    "id": 17,
                    "name": "roles-delete"
                },
                {
                    "id": 18,
                    "name": "admins-fetch"
                },
                {
                    "id": 19,
                    "name": "admins-create"
                },
                {
                    "id": 20,
                    "name": "admins-read"
                },
                {
                    "id": 21,
                    "name": "admins-update"
                },
                {
                    "id": 22,
                    "name": "admins-delete"
                }
            ],
            "is_active": true,
            "created_at": "2026-05-04T12:58:21.000000Z"
        },
        {
            "id": 3,
            "name": "Test Role",
            "permissions": [
                {
                    "id": 23,
                    "name": "dashboard_fetch"
                }
            ],
            "is_active": true,
            "created_at": "2026-05-04T12:58:24.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 3,
        "last_page": 1
    }
}
GET /api/v1/roles/3

Get Role Details

Retrieve Role details.

Retrieves detailed information about a specific Role using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 3,
        "translate": [
            {
                "id": 5,
                "role_id": 3,
                "name": "أختبار",
                "lang": "ar",
                "deleted_at": null,
                "created_at": "2026-05-04T12:58:24.000000Z",
                "updated_at": "2026-05-04T12:58:24.000000Z"
            },
            {
                "id": 6,
                "role_id": 3,
                "name": "Test Role",
                "lang": "en",
                "deleted_at": null,
                "created_at": "2026-05-04T12:58:24.000000Z",
                "updated_at": "2026-05-04T12:58:24.000000Z"
            }
        ],
        "permissions": [
            {
                "id": 23,
                "role_id": 3,
                "model_id": 1,
                "permission_id": 1,
                "name": "dashboard_fetch",
                "deleted_at": null,
                "created_at": "2026-05-04T12:58:24.000000Z",
                "updated_at": "2026-05-04T12:58:24.000000Z"
            }
        ],
        "is_active": 1,
        "created_at": "2026-05-04T12:58:24.000000Z"
    }
}
PUT /api/v1/roles/3

Update Role

Update an existing Role.

Updates the specified Role with the provided data. The system validates the request and applies the changes to the existing record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
id integer 3
name array { "ar": "أختبار", "en": "Test Role" }
permissions array [ { "permission_id": 1, "model_id": 1 } ]

Request Validations Or Notes

Field/Name Examples
id required, exists roles,id
name required
name.ar required, ArabicRoleName, UniqueTranslationName
name.en required, EnglishRoleName, UniqueTranslationName
permissions required, array, min 1
permissions[].permission_id required, integer, exists permissions,id
permissions[].model_id required, integer, CheckPermissionInModule
permissions[].name optional, string
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 3,
        "is_active": 1,
        "deleted_at": null,
        "created_at": "2026-05-04T12:58:24.000000Z",
        "updated_at": "2026-05-04T12:58:24.000000Z"
    }
}
PATCH /api/v1/roles/3/toggle-active

Toggle Role Status

Switch the Role status between active and inactive.

Updates the status of the specified Role by toggling it between active and inactive. This operation allows enabling or disabling the resource without deleting it from the system.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 3,
        "is_active": false,
        "deleted_at": null,
        "created_at": "2026-05-04T12:58:24.000000Z",
        "updated_at": "2026-05-04T12:59:26.000000Z"
    }
}
DELETE /api/v1/roles/3

Delete Role

Delete a Role.

Deletes the specified Role from the system using its unique identifier. Depending on the system configuration, the deletion may be permanent or soft deleted.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
GET /api/v1/roles/trash

Get Deleted Role

List deleted Role.

Retrieve a list of soft-deleted Role records from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 3,
            "name": "Test Role",
            "permissions": [
                {
                    "id": 23,
                    "name": "dashboard_fetch"
                }
            ],
            "is_active": false,
            "created_at": "2026-05-04T12:58:24.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
PATCH /api/v1/roles/1/restore

Restore Role

Restore deleted Role.

Restore a previously deleted Role record from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "is_active": 1,
        "deleted_at": null,
        "created_at": "2026-05-04T12:58:21.000000Z",
        "updated_at": "2026-05-04T12:58:21.000000Z"
    }
}
DELETE /api/v1/roles/1/force-delete

Permanently Delete Role

Force delete Role.

Permanently remove the Role record from the system. This action cannot be undone.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
GET /api/v1/models

Get Model List

Retrieve a list of Model.

Retrieves a list of Model records from the system. The response may support pagination, filtering, and sorting based on the provided request parameters.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "title": "Dashboard",
            "permissions": [
                {
                    "id": 1,
                    "title": "Fetch Data",
                    "name": "fetch"
                }
            ]
        },
        {
            "id": 2,
            "title": "Roles",
            "permissions": [
                {
                    "id": 1,
                    "title": "Fetch Data",
                    "name": "fetch"
                },
                {
                    "id": 2,
                    "title": "Create Data",
                    "name": "create"
                },
                {
                    "id": 3,
                    "title": "Read Data",
                    "name": "read"
                },
                {
                    "id": 4,
                    "title": "Update Data",
                    "name": "update"
                },
                {
                    "id": 5,
                    "title": "Delete Data",
                    "name": "delete"
                }
            ]
        },
        {
            "id": 3,
            "title": "Admins",
            "permissions": [
                {
                    "id": 1,
                    "title": "Fetch Data",
                    "name": "fetch"
                },
                {
                    "id": 2,
                    "title": "Create Data",
                    "name": "create"
                },
                {
                    "id": 3,
                    "title": "Read Data",
                    "name": "read"
                },
                {
                    "id": 4,
                    "title": "Update Data",
                    "name": "update"
                },
                {
                    "id": 5,
                    "title": "Delete Data",
                    "name": "delete"
                }
            ]
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 3,
        "last_page": 1
    }
}
GET /api/v1/models/1

Get Model Details

Retrieve Model details.

Retrieves detailed information about a specific Model using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": []
}
POST /api/v1/system-setup/general

Add System Setup — GENERAL

System setup — GENERAL (POST)

Persist validated payload for this setup group.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
system_name string Falcon ERP
system_version string 1.0.0
date_format string Y-m-d
time_format string H:i
default_timezone string Africa/Cairo
default_language string en
default_currency string EGP
maintenance_mode boolean

Request Validations Or Notes

Field/Name Examples
system_name required, string, max 255
system_version optional, string, max 100
date_format required, string, In
time_format required, string, In
default_timezone required, string, timezone
default_language required, string, In
default_currency required, string, In
maintenance_mode required, true/false
system_logo optional, image, types: jpg,jpeg,png,webp,svg, max 2048
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "date_format": "Y-m-d",
        "default_currency": "EGP",
        "default_language": "en",
        "default_timezone": "Africa\/Cairo",
        "maintenance_mode": false,
        "system_name": "Falcon ERP",
        "system_version": "1.0.0",
        "time_format": "H:i"
    }
}
POST /api/v1/system-setup/localization

Add System Setup — LOCALIZATION

System setup — LOCALIZATION (POST)

Persist validated payload for this setup group.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
number_format string #,##0.00
currency_position string before
language_toggle boolean 1
default_language string ar

Request Validations Or Notes

Field/Name Examples
number_format required, string, max 50
currency_position required, string, In
language_toggle required, true/false
default_language required, string, In
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "currency_position": "before",
        "default_language": "ar",
        "language_toggle": true,
        "number_format": "#,##0.00"
    }
}
POST /api/v1/system-setup/id-rule

Add System Setup — ID_RULE

System setup — ID_RULE (POST)

Persist validated payload for this setup group.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
rules array [ { "entity_type": "falcon", "prefix": "Ab0", "sequence_start": 0, "auto_increment": true }, { "entity_type": "egg", "prefix": "Ab1", "sequence_start": 1, "auto_increment": true } ]

Request Validations Or Notes

Field/Name Examples
rules required, array, size
rules[].entity_type required, string, In, distinct
rules[].prefix required, string, min 2, max 20, regex
rules[].sequence_start required
rules[].auto_increment required, true/false
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "rules": [
            {
                "entity_type": "falcon",
                "prefix": "Ab0",
                "sequence_start": 0,
                "auto_increment": true
            },
            {
                "entity_type": "egg",
                "prefix": "Ab1",
                "sequence_start": 1,
                "auto_increment": true
            }
        ]
    }
}
POST /api/v1/system-setup/automation

Add System Setup — AUTOMATION

System setup — AUTOMATION (POST)

Persist validated payload for this setup group.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
jobs array [ { "key": "data_backup", "name": "Nightly backup", "frequency": "daily", "status": "idle", "email": "automation@example.com", "is_active": true } ]

Request Validations Or Notes

Field/Name Examples
jobs required, array, min 1
jobs[].key required, string, In, distinct
jobs[].name required, string, max 255
jobs[].frequency required, string, max 100
jobs[].status optional, string, max 50
jobs[].email required, valid email, max 255
jobs[].is_active required, true/false
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "jobs": [
            {
                "key": "data_backup",
                "name": "Nightly backup",
                "frequency": "daily",
                "status": "idle",
                "email": "automation@example.com",
                "is_active": true
            }
        ]
    }
}
POST /api/v1/system-setup/security

Add System Setup — SECURITY

System setup — SECURITY (POST)

Persist validated payload for this setup group.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
min_password_length integer 8
session_timeout integer 60
login_attempt_limit integer 5
account_lock_duration integer 30
require_numbers boolean 1
require_uppercase boolean 1
require_special_chars boolean

Request Validations Or Notes

Field/Name Examples
min_password_length required, integer, min 6, max 128
session_timeout required, integer, min 1, max 1440
login_attempt_limit required, integer, min 1, max 10
account_lock_duration required, integer, min 1, max 1440
require_numbers required, true/false
require_uppercase required, true/false
require_special_chars required, true/false
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "account_lock_duration": 30,
        "login_attempt_limit": 5,
        "min_password_length": 8,
        "require_numbers": true,
        "require_special_chars": false,
        "require_uppercase": true,
        "session_timeout": 60
    }
}
POST /api/v1/system-setup/integrations

Add System Setup — INTEGRATIONS

System setup — INTEGRATIONS (POST)

Persist validated payload for this setup group.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
services array [ { "key": "blockchain_rox", "endpoint_url": "https:\/\/api.example.com\/hook", "api_key": "sample-api-key" } ]

Request Validations Or Notes

Field/Name Examples
services required, array, min 1
services[].key required, string, In, distinct
services[].endpoint_url required, url, max 1000
services[].api_key required, string, max 500
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "services": [
            {
                "key": "blockchain_rox",
                "endpoint_url": "https:\/\/api.example.com\/hook",
                "api_key": "sample-api-key"
            }
        ]
    }
}
POST /api/v1/system-setup/notifications

Add System Setup — NOTIFICATIONS

System setup — NOTIFICATIONS (POST)

Persist validated payload for this setup group.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
alerts array [ { "alert_type": "health_alert", "email": true, "sms": false, "in_app": true } ]

Request Validations Or Notes

Field/Name Examples
alerts required, array, min 1
alerts[].alert_type required, string, In
alerts[].email required, true/false
alerts[].sms required, true/false
alerts[].in_app required, true/false
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "alerts": [
            {
                "alert_type": "health_alert",
                "email": true,
                "sms": false,
                "in_app": true
            }
        ]
    }
}
GET /api/v1/system-setup/general

Get System Setup — GENERAL

System setup — GENERAL (GET)

Read saved system setup rows for this group.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "system_name": "Falcon ERP",
        "system_version": "1.0.0",
        "date_format": "Y-m-d",
        "time_format": "H:i",
        "default_timezone": "Africa\/Cairo",
        "default_language": "en",
        "default_currency": "EGP",
        "maintenance_mode": false
    }
}
GET /api/v1/system-setup/localization

Get System Setup — LOCALIZATION

System setup — LOCALIZATION (GET)

Read saved system setup rows for this group.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "currency_position": "before",
        "default_language": "ar",
        "language_toggle": true,
        "number_format": "#,##0.00"
    }
}
GET /api/v1/system-setup/id-rule

Get System Setup — ID_RULE

System setup — ID_RULE (GET)

Read saved system setup rows for this group.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "rules": [
            {
                "entity_type": "falcon",
                "prefix": "Ab0",
                "sequence_start": 0,
                "auto_increment": true
            },
            {
                "entity_type": "egg",
                "prefix": "Ab1",
                "sequence_start": 1,
                "auto_increment": true
            }
        ]
    }
}
GET /api/v1/system-setup/automation

Get System Setup — AUTOMATION

System setup — AUTOMATION (GET)

Read saved system setup rows for this group.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "jobs": [
            {
                "key": "data_backup",
                "name": "Nightly backup",
                "frequency": "daily",
                "status": "idle",
                "email": "automation@example.com",
                "is_active": true
            }
        ]
    }
}
GET /api/v1/system-setup/security

Get System Setup — SECURITY

System setup — SECURITY (GET)

Read saved system setup rows for this group.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "account_lock_duration": 30,
        "login_attempt_limit": 5,
        "min_password_length": 8,
        "require_numbers": true,
        "require_special_chars": false,
        "require_uppercase": true,
        "session_timeout": 60
    }
}
GET /api/v1/system-setup/integrations

Get System Setup — INTEGRATIONS

System setup — INTEGRATIONS (GET)

Read saved system setup rows for this group.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "services": [
            {
                "key": "blockchain_rox",
                "endpoint_url": "https:\/\/api.example.com\/hook",
                "api_key": "sample-api-key"
            }
        ]
    }
}
GET /api/v1/system-setup/notifications

Get System Setup — NOTIFICATIONS

System setup — NOTIFICATIONS (GET)

Read saved system setup rows for this group.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "alerts": [
            {
                "alert_type": "health_alert",
                "email": true,
                "sms": false,
                "in_app": true
            }
        ]
    }
}
POST /api/v1/settings/eggs-health-status

Create eggs health status

Create eggs health status

Store a new eggs health status entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string eggs-261
name_ar string أختبار للاعدادات904

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 1,
        "name": "eggs-261"
    }
}
GET /api/v1/settings/eggs-health-status

Get eggs health status List

Get eggs health status List

This API retrieves a paginated list of eggs health status.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "eggs-261",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/eggs-health-status/1

Show Single eggs health status

Show Single eggs health status

Get Single eggs health status

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 1,
        "name": "eggs-261",
        "is_active": 1
    }
}
PUT /api/v1/settings/eggs-health-status/1

Update eggs health status

Update eggs health status

Update eggs health status entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string eggs-395
name_ar string أختبار للاعدادات708
id integer 1

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,eggs-health-status
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "eggs-395"
    }
}
PATCH /api/v1/settings/eggs-health-status/1

Active Or InActive eggs health status

Update eggs health status

Update eggs health status entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "eggs-395"
    }
}
DELETE /api/v1/settings/eggs-health-status/1

Delete eggs health status

Delete eggs health status

Delete eggs health status entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/eggs-reason

Create eggs reason

Create eggs reason

Store a new eggs reason entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string eggs-446
name_ar string أختبار للاعدادات151

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 2,
        "name": "eggs-446"
    }
}
GET /api/v1/settings/eggs-reason

Get eggs reason List

Get eggs reason List

This API retrieves a paginated list of eggs reason.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 2,
            "name": "eggs-446",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/eggs-reason/2

Show Single eggs reason

Show Single eggs reason

Get Single eggs reason

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 2,
        "name": "eggs-446",
        "is_active": 1
    }
}
PUT /api/v1/settings/eggs-reason/2

Update eggs reason

Update eggs reason

Update eggs reason entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string eggs-762
name_ar string أختبار للاعدادات520
id integer 2

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,eggs-reason
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 2,
        "name": "eggs-762"
    }
}
PATCH /api/v1/settings/eggs-reason/2

Active Or InActive eggs reason

Update eggs reason

Update eggs reason entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 2,
        "name": "eggs-762"
    }
}
DELETE /api/v1/settings/eggs-reason/2

Delete eggs reason

Delete eggs reason

Delete eggs reason entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/falcon-species

Create falcon species

Create falcon species

Store a new falcon species entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string falc-104
name_ar string أختبار للاعدادات667

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 3,
        "name": "falc-104"
    }
}
GET /api/v1/settings/falcon-species

Get falcon species List

Get falcon species List

This API retrieves a paginated list of falcon species.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 3,
            "name": "falc-104",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/falcon-species/3

Show Single falcon species

Show Single falcon species

Get Single falcon species

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 3,
        "name": "falc-104",
        "is_active": 1
    }
}
PUT /api/v1/settings/falcon-species/3

Update falcon species

Update falcon species

Update falcon species entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string falc-369
name_ar string أختبار للاعدادات808
id integer 3

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,falcon-species
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 3,
        "name": "falc-369"
    }
}
PATCH /api/v1/settings/falcon-species/3

Active Or InActive falcon species

Update falcon species

Update falcon species entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 3,
        "name": "falc-369"
    }
}
DELETE /api/v1/settings/falcon-species/3

Delete falcon species

Delete falcon species

Delete falcon species entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/falcon-gender

Create falcon gender

Create falcon gender

Store a new falcon gender entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string falc-506
name_ar string أختبار للاعدادات191

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 4,
        "name": "falc-506"
    }
}
GET /api/v1/settings/falcon-gender

Get falcon gender List

Get falcon gender List

This API retrieves a paginated list of falcon gender.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 4,
            "name": "falc-506",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/falcon-gender/4

Show Single falcon gender

Show Single falcon gender

Get Single falcon gender

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 4,
        "name": "falc-506",
        "is_active": 1
    }
}
PUT /api/v1/settings/falcon-gender/4

Update falcon gender

Update falcon gender

Update falcon gender entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string falc-990
name_ar string أختبار للاعدادات621
id integer 4

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,falcon-gender
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 4,
        "name": "falc-990"
    }
}
PATCH /api/v1/settings/falcon-gender/4

Active Or InActive falcon gender

Update falcon gender

Update falcon gender entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 4,
        "name": "falc-990"
    }
}
DELETE /api/v1/settings/falcon-gender/4

Delete falcon gender

Delete falcon gender

Delete falcon gender entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/falcon-age

Create falcon age

Create falcon age

Store a new falcon age entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string falc-202
name_ar string أختبار للاعدادات578

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 5,
        "name": "falc-202"
    }
}
GET /api/v1/settings/falcon-age

Get falcon age List

Get falcon age List

This API retrieves a paginated list of falcon age.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 5,
            "name": "falc-202",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/falcon-age/5

Show Single falcon age

Show Single falcon age

Get Single falcon age

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 5,
        "name": "falc-202",
        "is_active": 1
    }
}
PUT /api/v1/settings/falcon-age/5

Update falcon age

Update falcon age

Update falcon age entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string falc-261
name_ar string أختبار للاعدادات284
id integer 5

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,falcon-age
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 5,
        "name": "falc-261"
    }
}
PATCH /api/v1/settings/falcon-age/5

Active Or InActive falcon age

Update falcon age

Update falcon age entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 5,
        "name": "falc-261"
    }
}
DELETE /api/v1/settings/falcon-age/5

Delete falcon age

Delete falcon age

Delete falcon age entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/falcon-id

Create falcon id

Create falcon id

Store a new falcon id entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string falc-102
name_ar string أختبار للاعدادات164

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 7,
        "name": "falc-102"
    }
}
GET /api/v1/settings/falcon-id

Get falcon id List

Get falcon id List

This API retrieves a paginated list of falcon id.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 7,
            "name": "falc-102",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/falcon-id/7

Show Single falcon id

Show Single falcon id

Get Single falcon id

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 7,
        "name": "falc-102",
        "is_active": 1
    }
}
PUT /api/v1/settings/falcon-id/7

Update falcon id

Update falcon id

Update falcon id entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string falc-918
name_ar string أختبار للاعدادات202
id integer 7

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,falcon-id
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 7,
        "name": "falc-918"
    }
}
PATCH /api/v1/settings/falcon-id/7

Active Or InActive falcon id

Update falcon id

Update falcon id entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 7,
        "name": "falc-918"
    }
}
DELETE /api/v1/settings/falcon-id/7

Delete falcon id

Delete falcon id

Delete falcon id entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/falcon-color

Create falcon color

Create falcon color

Store a new falcon color entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string falc-803
name_ar string أختبار للاعدادات132

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 8,
        "name": "falc-803"
    }
}
GET /api/v1/settings/falcon-color

Get falcon color List

Get falcon color List

This API retrieves a paginated list of falcon color.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 8,
            "name": "falc-803",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/falcon-color/8

Show Single falcon color

Show Single falcon color

Get Single falcon color

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 8,
        "name": "falc-803",
        "is_active": 1
    }
}
PUT /api/v1/settings/falcon-color/8

Update falcon color

Update falcon color

Update falcon color entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string falc-228
name_ar string أختبار للاعدادات294
id integer 8

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,falcon-color
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 8,
        "name": "falc-228"
    }
}
PATCH /api/v1/settings/falcon-color/8

Active Or InActive falcon color

Update falcon color

Update falcon color entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 8,
        "name": "falc-228"
    }
}
DELETE /api/v1/settings/falcon-color/8

Delete falcon color

Delete falcon color

Delete falcon color entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/falcon-behavior

Create falcon behavior

Create falcon behavior

Store a new falcon behavior entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string falc-421
name_ar string أختبار للاعدادات641

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 9,
        "name": "falc-421"
    }
}
GET /api/v1/settings/falcon-behavior

Get falcon behavior List

Get falcon behavior List

This API retrieves a paginated list of falcon behavior.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 9,
            "name": "falc-421",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/falcon-behavior/9

Show Single falcon behavior

Show Single falcon behavior

Get Single falcon behavior

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 9,
        "name": "falc-421",
        "is_active": 1
    }
}
PUT /api/v1/settings/falcon-behavior/9

Update falcon behavior

Update falcon behavior

Update falcon behavior entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string falc-370
name_ar string أختبار للاعدادات995
id integer 9

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,falcon-behavior
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 9,
        "name": "falc-370"
    }
}
PATCH /api/v1/settings/falcon-behavior/9

Active Or InActive falcon behavior

Update falcon behavior

Update falcon behavior entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 9,
        "name": "falc-370"
    }
}
DELETE /api/v1/settings/falcon-behavior/9

Delete falcon behavior

Delete falcon behavior

Delete falcon behavior entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/falcon-reason

Create falcon reason

Create falcon reason

Store a new falcon reason entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string falc-862
name_ar string أختبار للاعدادات646

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 11,
        "name": "falc-862"
    }
}
GET /api/v1/settings/falcon-reason

Get falcon reason List

Get falcon reason List

This API retrieves a paginated list of falcon reason.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 11,
            "name": "falc-862",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/falcon-reason/11

Show Single falcon reason

Show Single falcon reason

Get Single falcon reason

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 11,
        "name": "falc-862",
        "is_active": 1
    }
}
PUT /api/v1/settings/falcon-reason/11

Update falcon reason

Update falcon reason

Update falcon reason entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string falc-807
name_ar string أختبار للاعدادات225
id integer 11

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,falcon-reason
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 11,
        "name": "falc-807"
    }
}
PATCH /api/v1/settings/falcon-reason/11

Active Or InActive falcon reason

Update falcon reason

Update falcon reason entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 11,
        "name": "falc-807"
    }
}
DELETE /api/v1/settings/falcon-reason/11

Delete falcon reason

Delete falcon reason

Delete falcon reason entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/feedings/items

Create Item

Create a new Item.

Creates a new Item in the system using the provided data. The request validates the required fields before storing the resource in the database. Upon successful creation, the system returns the newly created record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name string test-item
category_id integer 12
unit_id integer 13
cost_per_unit integer 100
calories integer 100
note string test-note
is_active boolean 1
supports array [ { "support_id": 3 } ]
ages array [ { "age_id": 5 } ]

Request Validations Or Notes

Field/Name Examples
name required, unique feeding_items,name, string, max 255
category_id required, integer, exists settings,id,type,feeding-category
unit_id required, integer, exists settings,id,type,feeding-unit
cost_per_unit required, numeric
calories required, numeric
note optional, string
is_active optional, true/false
supports required, array, min 1
supports[].support_id required, integer, exists settings,id,type,falcon-species
ages required, array, min 1
ages[].age_id required, integer, exists settings,id,type,falcon-age
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 1,
        "name": "test-item",
        "calories": 100,
        "unit": {
            "id": 13,
            "name": "feed-158"
        },
        "is_active": true
    }
}
GET /api/v1/feedings/items

Get Item List

Retrieve a list of Item.

Retrieves a list of Item records from the system. The response may support pagination, filtering, and sorting based on the provided request parameters.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "test-item",
            "calories": "100.00",
            "unit": {
                "id": 13,
                "name": "feed-158"
            },
            "is_active": true
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
PUT /api/v1/feedings/items/1

Update Item

Update an existing Item.

Updates the specified Item with the provided data. The system validates the request and applies the changes to the existing record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name string test-item
category_id integer 12
unit_id integer 13
cost_per_unit integer 100
calories integer 100
note string test-note
is_active boolean 1
supports array [ { "support_id": 3 } ]
ages array [ { "age_id": 5 } ]
id integer 1

Request Validations Or Notes

Field/Name Examples
id required, integer, exists feeding_items,id
name required, string, max 255, unique feeding_items,name,
category_id required, integer, exists settings,id,type,feeding-category
unit_id required, integer, exists settings,id,type,feeding-unit
cost_per_unit required, numeric
calories required, numeric
note optional, string
is_active optional, true/false
supports required, array, min 1
supports[].support_id required, integer, exists settings,id,type,falcon-species
ages required, array, min 1
ages[].age_id required, integer, exists settings,id,type,falcon-age
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "test-item",
        "calories": 100,
        "unit": {
            "id": 13,
            "name": "feed-158"
        },
        "is_active": true
    }
}
DELETE /api/v1/feedings/items/1

Delete Item

Delete a Item.

Deletes the specified Item from the system using its unique identifier. Depending on the system configuration, the deletion may be permanent or soft deleted.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
GET /api/v1/feedings/items/trash

Get Deleted Item

List deleted Item.

Retrieve a list of soft-deleted Item records from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "test-item",
            "calories": "100.00",
            "unit": {
                "id": 13,
                "name": "feed-566"
            },
            "is_active": false
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
PATCH /api/v1/feedings/items/1/restore

Restore Item

Restore deleted Item.

Restore a previously deleted Item record from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "test-item",
        "calories": "100.00",
        "unit": {
            "id": 13,
            "name": "feed-566"
        },
        "is_active": false
    }
}
DELETE /api/v1/feedings/items/1/force-delete

Permanently Delete Item

Force delete Item.

Permanently remove the Item record from the system. This action cannot be undone.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/feedings/meals

Create Meal

Create a new Meal.

Creates a new Meal in the system using the provided data. The request validates the required fields before storing the resource in the database. Upon successful creation, the system returns the newly created record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name string test-item
category_id integer 12
cost_per_unit integer 100
calories integer 100
note string test-note
is_active boolean 1
supports array [ { "support_id": 3 } ]
ages array [ { "age_id": 5 } ]
items array [ { "item_id": 1, "quantity": 1 } ]

Request Validations Or Notes

Field/Name Examples
name required, string, unique feeding_meals,name, max 255
category_id required, integer, exists settings,id,type,feeding-category
note optional, string
is_active optional, true/false
supports required, array, min 1
supports[].support_id required, integer, exists settings,id,type,falcon-species
ages required, array, min 1
ages[].age_id required, integer, exists settings,id,type,falcon-age
items required, array, min 1
items[].item_id required, integer, exists feeding_items,id
items[].quantity required, integer, min 1
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 1,
        "name": "test-item",
        "is_active": true,
        "note": "test-note",
        "created_at": "2026-05-04T12:59:08.000000Z",
        "category": {
            "id": 12,
            "name": "feed-507"
        },
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "items": [
            {
                "id": 1,
                "name": "test-item",
                "calories": "100.00",
                "unit": {
                    "id": 13,
                    "name": "feed-158"
                },
                "is_active": true,
                "category": {
                    "id": 12,
                    "name": "feed-507"
                },
                "cost_per_unit": "100.00",
                "note": "test-note",
                "supports": [
                    {
                        "id": 3,
                        "name": "falc-104"
                    }
                ],
                "ages": [
                    {
                        "id": 5,
                        "name": "falc-202"
                    }
                ]
            }
        ]
    }
}
GET /api/v1/feedings/meals

Get Meal List

Retrieve a list of Meal.

Retrieves a list of Meal records from the system. The response may support pagination, filtering, and sorting based on the provided request parameters.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "test-item",
            "is_active": 1,
            "note": "test-note",
            "created_at": "2026-05-04T12:59:08.000000Z",
            "category": {
                "id": 12,
                "name": "feed-507"
            },
            "supports": [
                {
                    "id": 3,
                    "name": "falc-104"
                }
            ],
            "ages": [
                {
                    "id": 5,
                    "name": "falc-202"
                }
            ],
            "items": [
                {
                    "id": 1,
                    "name": "test-item",
                    "calories": "100.00",
                    "unit": {
                        "id": 13,
                        "name": "feed-158"
                    },
                    "is_active": true,
                    "category": {
                        "id": 12,
                        "name": "feed-507"
                    },
                    "cost_per_unit": "100.00",
                    "note": "test-note",
                    "supports": [
                        {
                            "id": 3,
                            "name": "falc-104"
                        }
                    ],
                    "ages": [
                        {
                            "id": 5,
                            "name": "falc-202"
                        }
                    ]
                }
            ]
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
PUT /api/v1/feedings/meals/1

Update Meal

Update an existing Meal.

Updates the specified Meal with the provided data. The system validates the request and applies the changes to the existing record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name string test-item
category_id integer 12
note string test-note
is_active boolean 1
supports array [ { "support_id": 3 } ]
ages array [ { "age_id": 5 } ]
items array [ { "item_id": 1, "quantity": 1 } ]
id integer 1

Request Validations Or Notes

Field/Name Examples
id required, integer, exists feeding_meals,id
name required, string, max 255, unique feeding_meals,name,
category_id required, integer, exists settings,id,type,feeding-category
note optional, string
is_active optional, true/false
supports required, array, min 1
supports[].support_id required, integer, exists settings,id,type,falcon-species
ages required, array, min 1
ages[].age_id required, integer, exists settings,id,type,falcon-age
items required, array, min 1
items[].item_id required, integer, exists feeding_items,id
items[].quantity required, integer, min 1
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "test-item",
        "is_active": true,
        "note": "test-note",
        "created_at": "2026-05-04T12:59:08.000000Z",
        "category": {
            "id": 12,
            "name": "feed-507"
        },
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "items": [
            {
                "id": 1,
                "name": "test-item",
                "calories": "100.00",
                "unit": {
                    "id": 13,
                    "name": "feed-158"
                },
                "is_active": false,
                "category": {
                    "id": 12,
                    "name": "feed-507"
                },
                "cost_per_unit": "100.00",
                "note": "test-note",
                "supports": [
                    {
                        "id": 3,
                        "name": "falc-104"
                    }
                ],
                "ages": [
                    {
                        "id": 5,
                        "name": "falc-202"
                    }
                ]
            }
        ]
    }
}
DELETE /api/v1/feedings/meals/1

Delete Meal

Delete a Meal.

Deletes the specified Meal from the system using its unique identifier. Depending on the system configuration, the deletion may be permanent or soft deleted.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
GET /api/v1/feedings/meals/trash

Get Deleted Meal

List deleted Meal.

Retrieve a list of soft-deleted Meal records from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "test-item",
            "is_active": 0,
            "note": "test-note",
            "created_at": "2026-05-04T12:59:08.000000Z",
            "category": {
                "id": 12,
                "name": "feed-391"
            },
            "supports": [
                {
                    "id": 3,
                    "name": "falc-369"
                }
            ],
            "ages": [
                {
                    "id": 5,
                    "name": "falc-261"
                }
            ],
            "items": [
                {
                    "id": 1,
                    "name": "test-item",
                    "calories": "100.00",
                    "unit": {
                        "id": 13,
                        "name": "feed-566"
                    },
                    "is_active": false,
                    "category": {
                        "id": 12,
                        "name": "feed-391"
                    },
                    "cost_per_unit": "100.00",
                    "note": "test-note",
                    "supports": [
                        {
                            "id": 3,
                            "name": "falc-369"
                        }
                    ],
                    "ages": [
                        {
                            "id": 5,
                            "name": "falc-261"
                        }
                    ]
                }
            ]
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
PATCH /api/v1/feedings/meals/1/restore

Restore Meal

Restore deleted Meal.

Restore a previously deleted Meal record from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "test-item",
        "is_active": 0,
        "note": "test-note",
        "created_at": "2026-05-04T12:59:08.000000Z",
        "category": {
            "id": 12,
            "name": "feed-391"
        },
        "supports": [
            {
                "id": 3,
                "name": "falc-369"
            }
        ],
        "ages": [
            {
                "id": 5,
                "name": "falc-261"
            }
        ],
        "items": [
            {
                "id": 1,
                "name": "test-item",
                "calories": "100.00",
                "unit": {
                    "id": 13,
                    "name": "feed-566"
                },
                "is_active": false,
                "category": {
                    "id": 12,
                    "name": "feed-391"
                },
                "cost_per_unit": "100.00",
                "note": "test-note",
                "supports": [
                    {
                        "id": 3,
                        "name": "falc-369"
                    }
                ],
                "ages": [
                    {
                        "id": 5,
                        "name": "falc-261"
                    }
                ]
            }
        ]
    }
}
DELETE /api/v1/feedings/meals/1/force-delete

Permanently Delete Meal

Force delete Meal.

Permanently remove the Meal record from the system. This action cannot be undone.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/feedings/plans

Create Plan

Create a new Plan.

Creates a new Plan in the system using the provided data. The request validates the required fields before storing the resource in the database. Upon successful creation, the system returns the newly created record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name string Falcon Monthly Plan 1
type string monthly
note string Monthly feeding plan
is_active boolean 1
supports array [ { "support_id": 3 } ]
ages array [ { "age_id": 5 } ]
meals array [ { "meal_id": 1, "quantity": 2, "days": [], "timing": "08:30" } ]

Request Validations Or Notes

Field/Name Examples
name required, string, unique feeding_plans,name, max 255
type required, enum
note optional, string
is_active optional, true/false
supports required, array, min 1
supports[].support_id required, integer, exists settings,id,type,falcon-species
ages required, array, min 1
ages[].age_id required, integer, exists settings,id,type,falcon-age
meals required, array, min 1
meals[].meal_id required, integer, exists feeding_meals,id
meals[].quantity required, integer, min 1
meals[].timing required, date_format
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 1,
        "name": "Falcon Monthly Plan 1",
        "type": "monthly",
        "note": "Monthly feeding plan",
        "is_active": true,
        "created_at": "2026-05-04T12:59:08.000000Z",
        "supports": [
            {
                "id": 1,
                "plan_id": 1,
                "support_type": "settings",
                "support_id": 3,
                "created_at": "2026-05-04T12:59:08.000000Z",
                "updated_at": "2026-05-04T12:59:08.000000Z"
            }
        ],
        "ages": [
            {
                "id": 1,
                "plan_id": 1,
                "age_type": "settings",
                "age_id": 5,
                "created_at": "2026-05-04T12:59:08.000000Z",
                "updated_at": "2026-05-04T12:59:08.000000Z"
            }
        ],
        "meals": [
            {
                "id": 1,
                "plan_id": 1,
                "meal_id": 1,
                "quantity": "2.00",
                "timing": "08:30:00",
                "created_at": "2026-05-04T12:59:08.000000Z",
                "updated_at": "2026-05-04T12:59:08.000000Z"
            }
        ]
    }
}
GET /api/v1/feedings/plans

Get Plan List

Retrieve a list of Plan.

Retrieves a list of Plan records from the system. The response may support pagination, filtering, and sorting based on the provided request parameters.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "Falcon Monthly Plan 1",
            "type": "monthly",
            "note": "Monthly feeding plan",
            "is_active": 1,
            "created_at": "2026-05-04T12:59:08.000000Z",
            "supports": [
                {
                    "id": 3,
                    "name": "falc-104"
                }
            ],
            "ages": [
                {
                    "id": 5,
                    "name": "falc-202"
                }
            ],
            "meals": [
                {
                    "id": 1,
                    "name": "test-item"
                }
            ]
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
PUT /api/v1/feedings/plans/1

Update Plan

Update an existing Plan.

Updates the specified Plan with the provided data. The system validates the request and applies the changes to the existing record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name string Falcon Monthly Plan 1
type string monthly
note string Monthly feeding plan
is_active boolean 1
supports array [ { "support_id": 3 } ]
ages array [ { "age_id": 5 } ]
meals array [ { "meal_id": 1, "quantity": 2, "days": [], "timing": "08:30" } ]
id integer 1

Request Validations Or Notes

Field/Name Examples
id required, integer, exists feeding_plans,id
name required, string, max 255, unique feeding_plans,name,
type required, enum
note optional, string
is_active optional, true/false
supports required, array, min 1
supports[].support_id required, integer, exists settings,id,type,falcon-species
ages required, array, min 1
ages[].age_id required, integer, exists settings,id,type,falcon-age
meals required, array, min 1
meals[].meal_id required, integer, exists feeding_meals,id
meals[].quantity required, integer, min 1
meals[].timing required, date_format
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Falcon Monthly Plan 1",
        "type": "monthly",
        "note": "Monthly feeding plan",
        "is_active": true,
        "created_at": "2026-05-04T12:59:08.000000Z",
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "meals": [
            {
                "id": 1,
                "name": "test-item"
            }
        ]
    }
}
DELETE /api/v1/feedings/plans/1

Delete Plan

Delete a Plan.

Deletes the specified Plan from the system using its unique identifier. Depending on the system configuration, the deletion may be permanent or soft deleted.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
GET /api/v1/feedings/plans/trash

Get Deleted Plan

List deleted Plan.

Retrieve a list of soft-deleted Plan records from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "Falcon Monthly Plan 1",
            "type": "monthly",
            "note": "Monthly feeding plan",
            "is_active": 0,
            "created_at": "2026-05-04T12:59:08.000000Z",
            "supports": [
                {
                    "id": 3,
                    "name": "falc-369"
                }
            ],
            "ages": [
                {
                    "id": 5,
                    "name": "falc-261"
                }
            ],
            "meals": [
                {
                    "id": 1,
                    "name": "test-item"
                }
            ]
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
PATCH /api/v1/feedings/plans/1/restore

Restore Plan

Restore deleted Plan.

Restore a previously deleted Plan record from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Falcon Monthly Plan 1",
        "type": "monthly",
        "note": "Monthly feeding plan",
        "is_active": 0,
        "created_at": "2026-05-04T12:59:08.000000Z",
        "supports": [
            {
                "id": 3,
                "name": "falc-369"
            }
        ],
        "ages": [
            {
                "id": 5,
                "name": "falc-261"
            }
        ],
        "meals": [
            {
                "id": 1,
                "name": "test-item"
            }
        ]
    }
}
DELETE /api/v1/feedings/plans/1/force-delete

Permanently Delete Plan

Force delete Plan.

Permanently remove the Plan record from the system. This action cannot be undone.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/feeding-category

Create feeding category

Create feeding category

Store a new feeding category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string feed-507
name_ar string أختبار للاعدادات917

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 12,
        "name": "feed-507"
    }
}
GET /api/v1/settings/feeding-category

Get feeding category List

Get feeding category List

This API retrieves a paginated list of feeding category.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 12,
            "name": "feed-507",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/feeding-category/12

Show Single feeding category

Show Single feeding category

Get Single feeding category

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 12,
        "name": "feed-507",
        "is_active": 1
    }
}
PUT /api/v1/settings/feeding-category/12

Update feeding category

Update feeding category

Update feeding category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string feed-391
name_ar string أختبار للاعدادات121
id integer 12

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,feeding-category
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 12,
        "name": "feed-391"
    }
}
PATCH /api/v1/settings/feeding-category/12

Active Or InActive feeding category

Update feeding category

Update feeding category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 12,
        "name": "feed-391"
    }
}
DELETE /api/v1/settings/feeding-category/12

Delete feeding category

Delete feeding category

Delete feeding category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/feeding-meals-type

Create feeding meals type

Create feeding meals type

Store a new feeding meals type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string feed-678
name_ar string أختبار للاعدادات623

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 14,
        "name": "feed-678"
    }
}
GET /api/v1/settings/feeding-meals-type

Get feeding meals type List

Get feeding meals type List

This API retrieves a paginated list of feeding meals type.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 14,
            "name": "feed-678",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/feeding-meals-type/14

Show Single feeding meals type

Show Single feeding meals type

Get Single feeding meals type

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 14,
        "name": "feed-678",
        "is_active": 1
    }
}
PUT /api/v1/settings/feeding-meals-type/14

Update feeding meals type

Update feeding meals type

Update feeding meals type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string feed-407
name_ar string أختبار للاعدادات988
id integer 14

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,feeding-meals-type
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 14,
        "name": "feed-407"
    }
}
PATCH /api/v1/settings/feeding-meals-type/14

Active Or InActive feeding meals type

Update feeding meals type

Update feeding meals type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 14,
        "name": "feed-407"
    }
}
DELETE /api/v1/settings/feeding-meals-type/14

Delete feeding meals type

Delete feeding meals type

Delete feeding meals type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/feeding-unit

Create feeding unit

Create feeding unit

Store a new feeding unit entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string feed-158
name_ar string أختبار للاعدادات830

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 13,
        "name": "feed-158"
    }
}
GET /api/v1/settings/feeding-unit

Get feeding unit List

Get feeding unit List

This API retrieves a paginated list of feeding unit.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 13,
            "name": "feed-158",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/feeding-unit/13

Show Single feeding unit

Show Single feeding unit

Get Single feeding unit

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 13,
        "name": "feed-158",
        "is_active": 1
    }
}
PUT /api/v1/settings/feeding-unit/13

Update feeding unit

Update feeding unit

Update feeding unit entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string feed-566
name_ar string أختبار للاعدادات848
id integer 13

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,feeding-unit
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 13,
        "name": "feed-566"
    }
}
PATCH /api/v1/settings/feeding-unit/13

Active Or InActive feeding unit

Update feeding unit

Update feeding unit entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 13,
        "name": "feed-566"
    }
}
DELETE /api/v1/settings/feeding-unit/13

Delete feeding unit

Delete feeding unit

Delete feeding unit entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/medical-category

Create medical category

Create medical category

Store a new medical category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string medi-249
name_ar string أختبار للاعدادات182

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 15,
        "name": "medi-249"
    }
}
GET /api/v1/settings/medical-category

Get medical category List

Get medical category List

This API retrieves a paginated list of medical category.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 15,
            "name": "medi-249",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/medical-category/15

Show Single medical category

Show Single medical category

Get Single medical category

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 15,
        "name": "medi-249",
        "is_active": 1
    }
}
PUT /api/v1/settings/medical-category/15

Update medical category

Update medical category

Update medical category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string medi-369
name_ar string أختبار للاعدادات958
id integer 15

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,medical-category
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 15,
        "name": "medi-369"
    }
}
PATCH /api/v1/settings/medical-category/15

Active Or InActive medical category

Update medical category

Update medical category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 15,
        "name": "medi-369"
    }
}
DELETE /api/v1/settings/medical-category/15

Delete medical category

Delete medical category

Delete medical category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/medical-unit

Create medical unit

Create medical unit

Store a new medical unit entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string medi-507
name_ar string أختبار للاعدادات217

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 16,
        "name": "medi-507"
    }
}
GET /api/v1/settings/medical-unit

Get medical unit List

Get medical unit List

This API retrieves a paginated list of medical unit.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 16,
            "name": "medi-507",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/medical-unit/16

Show Single medical unit

Show Single medical unit

Get Single medical unit

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 16,
        "name": "medi-507",
        "is_active": 1
    }
}
PUT /api/v1/settings/medical-unit/16

Update medical unit

Update medical unit

Update medical unit entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string medi-789
name_ar string أختبار للاعدادات737
id integer 16

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,medical-unit
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 16,
        "name": "medi-789"
    }
}
PATCH /api/v1/settings/medical-unit/16

Active Or InActive medical unit

Update medical unit

Update medical unit entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 16,
        "name": "medi-789"
    }
}
DELETE /api/v1/settings/medical-unit/16

Delete medical unit

Delete medical unit

Delete medical unit entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/medical-medicine-category

Create medical medicine category

Create medical medicine category

Store a new medical medicine category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string medi-348
name_ar string أختبار للاعدادات889

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 17,
        "name": "medi-348"
    }
}
GET /api/v1/settings/medical-medicine-category

Get medical medicine category List

Get medical medicine category List

This API retrieves a paginated list of medical medicine category.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 17,
            "name": "medi-348",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/medical-medicine-category/17

Show Single medical medicine category

Show Single medical medicine category

Get Single medical medicine category

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 17,
        "name": "medi-348",
        "is_active": 1
    }
}
PUT /api/v1/settings/medical-medicine-category/17

Update medical medicine category

Update medical medicine category

Update medical medicine category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string medi-513
name_ar string أختبار للاعدادات952
id integer 17

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,medical-medicine-category
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 17,
        "name": "medi-513"
    }
}
PATCH /api/v1/settings/medical-medicine-category/17

Active Or InActive medical medicine category

Update medical medicine category

Update medical medicine category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 17,
        "name": "medi-513"
    }
}
DELETE /api/v1/settings/medical-medicine-category/17

Delete medical medicine category

Delete medical medicine category

Delete medical medicine category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/medical-medicine-form

Create medical medicine form

Create medical medicine form

Store a new medical medicine form entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string medi-591
name_ar string أختبار للاعدادات791

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 18,
        "name": "medi-591"
    }
}
GET /api/v1/settings/medical-medicine-form

Get medical medicine form List

Get medical medicine form List

This API retrieves a paginated list of medical medicine form.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 18,
            "name": "medi-591",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/medical-medicine-form/18

Show Single medical medicine form

Show Single medical medicine form

Get Single medical medicine form

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 18,
        "name": "medi-591",
        "is_active": 1
    }
}
PUT /api/v1/settings/medical-medicine-form/18

Update medical medicine form

Update medical medicine form

Update medical medicine form entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string medi-343
name_ar string أختبار للاعدادات198
id integer 18

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,medical-medicine-form
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 18,
        "name": "medi-343"
    }
}
PATCH /api/v1/settings/medical-medicine-form/18

Active Or InActive medical medicine form

Update medical medicine form

Update medical medicine form entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 18,
        "name": "medi-343"
    }
}
DELETE /api/v1/settings/medical-medicine-form/18

Delete medical medicine form

Delete medical medicine form

Delete medical medicine form entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/medical-severity

Create medical severity

Create medical severity

Store a new medical severity entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string medi-547
name_ar string أختبار للاعدادات312

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 19,
        "name": "medi-547"
    }
}
GET /api/v1/settings/medical-severity

Get medical severity List

Get medical severity List

This API retrieves a paginated list of medical severity.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 19,
            "name": "medi-547",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/medical-severity/19

Show Single medical severity

Show Single medical severity

Get Single medical severity

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 19,
        "name": "medi-547",
        "is_active": 1
    }
}
PUT /api/v1/settings/medical-severity/19

Update medical severity

Update medical severity

Update medical severity entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string medi-807
name_ar string أختبار للاعدادات151
id integer 19

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,medical-severity
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 19,
        "name": "medi-807"
    }
}
PATCH /api/v1/settings/medical-severity/19

Active Or InActive medical severity

Update medical severity

Update medical severity entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 19,
        "name": "medi-807"
    }
}
DELETE /api/v1/settings/medical-severity/19

Delete medical severity

Delete medical severity

Delete medical severity entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/medications

Create Medication

Create a new Medication.

Creates a new Medication in the system using the provided data. The request validates the required fields before storing the resource in the database. Upon successful creation, the system returns the newly created record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name array { "en": "Amoxicillin Antibiotic 500mg", "ar": "مضاد حيوي أموكسيسيلين 500 ملغ" }
cost_per_unit double 15.5
notes string Administer after meals to strictly avoid any gastrointestinal discomfort
categories array [ { "category_id": 17 } ]
form_id integer 18
unit_id integer 16
is_active boolean 1
supports array [ { "support_id": 3 } ]
ages array [ { "age_id": 5 } ]

Request Validations Or Notes

Field/Name Examples
name required, array
name.ar required, string, max 255
name.en required, string, max 255
unit_id required, exists settings,id,type,medical-unit
form_id required, exists settings,id,type,medical-medicine-form
supports required, array, min 1
supports[].support_id required, integer, exists settings,id,type,falcon-species
ages required, array, min 1
ages[].age_id required, integer, exists settings,id,type,falcon-age
categories required, array, min 1
categories[].category_id required, integer, exists settings,id,type,medical-medicine-category
cost_per_unit required, numeric, min 0
notes optional, string, max 255
is_active required, true/false
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 1,
        "name": "Amoxicillin Antibiotic 500mg",
        "cost_per_unit": 15.5,
        "note": null,
        "unit": {
            "id": 16,
            "name": "medi-507"
        },
        "form": {
            "id": 18,
            "name": "medi-591"
        },
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "categories": [
            {
                "id": 17,
                "name": "medi-348"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:16.000000Z"
    }
}
GET /api/v1/medications

Get Medication List

Retrieve a list of Medication.

Retrieves a list of Medication records from the system. The response may support pagination, filtering, and sorting based on the provided request parameters.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "Amoxicillin Antibiotic 500mg",
            "cost_per_unit": "15.50",
            "note": null,
            "unit": {
                "id": 16,
                "name": "medi-507"
            },
            "form": {
                "id": 18,
                "name": "medi-591"
            },
            "supports": [
                {
                    "id": 3,
                    "name": "falc-104"
                }
            ],
            "ages": [
                {
                    "id": 5,
                    "name": "falc-202"
                }
            ],
            "categories": [
                {
                    "id": 17,
                    "name": "medi-348"
                }
            ],
            "is_active": true,
            "created_at": "2026-05-04T12:59:16.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/medications/1

Get Medication Details

Retrieve Medication details.

Retrieves detailed information about a specific Medication using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 1,
        "name": "Amoxicillin Antibiotic 500mg",
        "cost_per_unit": "15.50",
        "note": null,
        "unit": {
            "id": 16,
            "name": "medi-507"
        },
        "form": {
            "id": 18,
            "name": "medi-591"
        },
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "categories": [
            {
                "id": 17,
                "name": "medi-348"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:16.000000Z"
    }
}
PUT /api/v1/medications/1

Update Medication

Update an existing Medication.

Updates the specified Medication with the provided data. The system validates the request and applies the changes to the existing record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name array { "en": "Amoxicillin Antibiotic 500mg (Updated)", "ar": "مضاد حيوي أموكسيسيلين 500 ملغ (محدث)" }
cost_per_unit integer 18
notes string Updated notes: Keep refrigerated after opening
categories array [ { "category_id": 17 } ]
form_id integer 18
unit_id integer 16
is_active boolean 1
supports array [ { "support_id": 3 } ]
ages array [ { "age_id": 5 } ]
id integer 1

Request Validations Or Notes

Field/Name Examples
target_type sometimes, string
target_id sometimes, integer
severity_type sometimes, string
severity_id sometimes, integer, exists settings,id,type,medical-severity
status sometimes, string, max 255
note optional, string, max 255
requested_by optional, exists admins,id
is_active sometimes, true/false
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Amoxicillin Antibiotic 500mg (Updated)",
        "cost_per_unit": "15.50",
        "note": null,
        "unit": {
            "id": 16,
            "name": "medi-507"
        },
        "form": {
            "id": 18,
            "name": "medi-591"
        },
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "categories": [
            {
                "id": 17,
                "name": "medi-348"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:16.000000Z"
    }
}
PATCH /api/v1/medications/1/toggle-active

Toggle Medication Status

Switch the Medication status between active and inactive.

Updates the status of the specified Medication by toggling it between active and inactive. This operation allows enabling or disabling the resource without deleting it from the system.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Amoxicillin Antibiotic 500mg (Updated)",
        "cost_per_unit": "15.50",
        "note": null,
        "unit": {
            "id": 16,
            "name": "medi-507"
        },
        "form": {
            "id": 18,
            "name": "medi-591"
        },
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "categories": [
            {
                "id": 17,
                "name": "medi-348"
            }
        ],
        "is_active": false,
        "created_at": "2026-05-04T12:59:16.000000Z"
    }
}
DELETE /api/v1/medications/1

Delete Medication

Delete a Medication.

Deletes the specified Medication from the system using its unique identifier. Depending on the system configuration, the deletion may be permanent or soft deleted.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
GET /api/v1/medications/trash

Get Deleted Medication

List deleted Medication.

Retrieve a list of soft-deleted Medication records from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "Amoxicillin Antibiotic 500mg (Updated)",
            "cost_per_unit": "15.50",
            "note": null,
            "unit": null,
            "form": null,
            "supports": [
                {
                    "id": 1,
                    "name": null
                }
            ],
            "ages": [
                {
                    "id": 1,
                    "name": null
                }
            ],
            "categories": [
                {
                    "id": 1,
                    "name": null
                }
            ],
            "is_active": false,
            "created_at": "2026-05-04T12:59:16.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
PATCH /api/v1/medications/1/restore

Restore Medication

Restore deleted Medication.

Restore a previously deleted Medication record from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Amoxicillin Antibiotic 500mg (Updated)",
        "cost_per_unit": "15.50",
        "note": null,
        "unit": null,
        "form": null,
        "supports": [
            {
                "id": 1,
                "name": null
            }
        ],
        "ages": [
            {
                "id": 1,
                "name": null
            }
        ],
        "categories": [
            {
                "id": 1,
                "name": null
            }
        ],
        "is_active": false,
        "created_at": "2026-05-04T12:59:16.000000Z"
    }
}
DELETE /api/v1/medications/1/force-delete

Permanently Delete Medication

Force delete Medication.

Permanently remove the Medication record from the system. This action cannot be undone.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/procedures

Create Procedure

Create a new Procedure.

Creates a new Procedure in the system using the provided data. The request validates the required fields before storing the resource in the database. Upon successful creation, the system returns the newly created record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name array { "en": "Complete Blood Count (CBC) Analysis", "ar": "تحليل صورة الدم الكاملة (CBC)" }
category_id integer 15
cost integer 120
notes string Patient must fast for 8 hours prior to the blood test
is_active boolean 1

Request Validations Or Notes

Field/Name Examples
name required, array
name.ar required, string, max 255
name.en required, string, max 255
category_id required, exists settings,id,type,medical-category
cost required, numeric
notes optional, string, max 255
is_active required, true/false
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 1,
        "name": "Complete Blood Count (CBC) Analysis",
        "cost": 120,
        "note": null,
        "category": null,
        "is_active": true,
        "created_at": "2026-05-04T12:59:16.000000Z"
    }
}
GET /api/v1/procedures

Get Procedure List

Retrieve a list of Procedure.

Retrieves a list of Procedure records from the system. The response may support pagination, filtering, and sorting based on the provided request parameters.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "Complete Blood Count (CBC) Analysis",
            "cost": "120.00",
            "note": null,
            "category": {
                "id": 15,
                "name": "medi-249"
            },
            "is_active": true,
            "created_at": "2026-05-04T12:59:16.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/procedures/1

Get Procedure Details

Retrieve Procedure details.

Retrieves detailed information about a specific Procedure using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 1,
        "name": "Complete Blood Count (CBC) Analysis",
        "cost": "120.00",
        "note": null,
        "category": null,
        "is_active": true,
        "created_at": "2026-05-04T12:59:16.000000Z"
    }
}
PUT /api/v1/procedures/1

Update Procedure

Update an existing Procedure.

Updates the specified Procedure with the provided data. The system validates the request and applies the changes to the existing record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name array { "en": "Comprehensive Metabolic Panel (CMP)", "ar": "لوحة التمثيل الغذائي الشاملة" }
category_id integer 15
cost integer 150
notes string Updated: Requires detailed lab reporting
is_active boolean
id integer 1

Request Validations Or Notes

Field/Name Examples
name sometimes, array
name.ar required_with, string, max 255
name.en required_with, string, max 255
category_id optional, exists settings,id,type,medical-category
cost optional, numeric
notes optional, string, max 255
is_active optional, true/false
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Comprehensive Metabolic Panel (CMP)",
        "cost": 150,
        "note": null,
        "category": null,
        "is_active": false,
        "created_at": "2026-05-04T12:59:16.000000Z"
    }
}
PATCH /api/v1/procedures/1/toggle-active

Toggle Procedure Status

Switch the Procedure status between active and inactive.

Updates the status of the specified Procedure by toggling it between active and inactive. This operation allows enabling or disabling the resource without deleting it from the system.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Comprehensive Metabolic Panel (CMP)",
        "cost": "150.00",
        "note": null,
        "category": null,
        "is_active": true,
        "created_at": "2026-05-04T12:59:16.000000Z"
    }
}
DELETE /api/v1/procedures/1

Delete Procedure

Delete a Procedure.

Deletes the specified Procedure from the system using its unique identifier. Depending on the system configuration, the deletion may be permanent or soft deleted.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
GET /api/v1/procedures/trash

Get Deleted Procedure

List deleted Procedure.

Retrieve a list of soft-deleted Procedure records from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "Comprehensive Metabolic Panel (CMP)",
            "cost": "150.00",
            "note": null,
            "category": null,
            "is_active": true,
            "created_at": "2026-05-04T12:59:16.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
PATCH /api/v1/procedures/1/restore

Restore Procedure

Restore deleted Procedure.

Restore a previously deleted Procedure record from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Comprehensive Metabolic Panel (CMP)",
        "cost": "150.00",
        "note": null,
        "category": null,
        "is_active": true,
        "created_at": "2026-05-04T12:59:16.000000Z"
    }
}
DELETE /api/v1/procedures/1/force-delete

Permanently Delete Procedure

Force delete Procedure.

Permanently remove the Procedure record from the system. This action cannot be undone.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/medical-actions

Create Medical-action

Create a new Medical-action.

Creates a new Medical-action in the system using the provided data. The request validates the required fields before storing the resource in the database. Upon successful creation, the system returns the newly created record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
request_id NULL
targets array [ { "target_id": 15 } ]
diagnosis array { "diagnosis": "Test Diagnosis", "category_id": 15, "severity_id": 19, "note": "Test Diagnosis Note" }
procedures array { "items": [ { "procedure_id": 1, "date": "2026-04-01", "time": "10:00" } ] }
medication_plan array { "start_date": "2026-05-04", "end_date": "2026-05-07", "note": "Test Medication Plan", "items": [ { "medication_id": 1, "dose": "1 pill", "doses_per_day": 2, "repeat_every_days": 1, "times": [ "08:00", "20:00" ] } ] }

Request Validations Or Notes

Field/Name Examples
request_id optional, exists medical_requests,id
targets required, array, min 1
targets[].target_id required, integer
diagnosis sometimes, array
diagnosis.diagnosis required_with, string
diagnosis.category_id required_with, exists settings,id,type,medical-category
diagnosis.severity_id required_with, exists settings,id,type,medical-severity
diagnosis.note optional, string
procedures sometimes, array
procedures.note optional, string
procedures.items required_with, array, min 1
procedures.items[].procedure_id required, exists medical_procedures,id
procedures.items[].date required, date
procedures.items[].time optional, date_format
medication_plan sometimes, array
medication_plan.start_date required_with, date
medication_plan.end_date optional, date, after_or_equal, MedicationPlanDurationRule
medication_plan.note optional, string
medication_plan.items required_with, array, min 1
medication_plan.items[].medication_id required, exists medical_medications,id
medication_plan.items[].dose required, string
medication_plan.items[].doses_per_day required, integer, min 1
medication_plan.items[].repeat_every_days required, integer, min 1
medication_plan.items[].times required, array, MedicationPlanTimesRule
medication_plan.items[].times.* date_format:H:i
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": [
        {
            "id": 1,
            "request_id": null,
            "action_type": "diagnosis",
            "action_code": "MED-20260504-125917-AVUCUH",
            "note": "Test Diagnosis Note",
            "action_by": 1,
            "is_active": true,
            "created_at": "2026-05-04T12:59:17.000000Z",
            "diagnoses": [
                {
                    "id": 1,
                    "diagnosis": "Test Diagnosis",
                    "category": {
                        "id": 15,
                        "name": "medi-249"
                    },
                    "severity": {
                        "id": 19,
                        "name": "medi-547"
                    }
                }
            ],
            "targets": [
                {
                    "id": 1,
                    "target_id": 15
                }
            ]
        },
        {
            "id": 2,
            "request_id": null,
            "action_type": "procedure",
            "action_code": "MED-20260504-125917-AVUCUH",
            "note": null,
            "action_by": 1,
            "is_active": true,
            "created_at": "2026-05-04T12:59:17.000000Z",
            "procedures": [
                {
                    "id": 1,
                    "procedure": {
                        "id": 1,
                        "name": "Complete Blood Count (CBC) Analysis"
                    },
                    "date": "2026-04-01",
                    "time": "10:00:00"
                }
            ],
            "targets": [
                {
                    "id": 2,
                    "target_id": 15
                }
            ]
        },
        {
            "id": 3,
            "request_id": null,
            "action_type": "medication",
            "action_code": "MED-20260504-125917-AVUCUH",
            "note": "Test Medication Plan",
            "action_by": 1,
            "is_active": true,
            "created_at": "2026-05-04T12:59:17.000000Z",
            "medication_plans": [
                {
                    "id": 1,
                    "status": "active",
                    "start_date": "2026-05-04",
                    "end_date": "2026-05-07",
                    "items": [
                        {
                            "id": 1,
                            "medication": {
                                "id": 1,
                                "name": "Amoxicillin Antibiotic 500mg"
                            },
                            "dose": "1 pill",
                            "doses_per_day": 2,
                            "repeat_every_days": 1,
                            "times": [
                                "08:00",
                                "20:00"
                            ]
                        }
                    ]
                }
            ],
            "targets": [
                {
                    "id": 3,
                    "target_id": 15
                }
            ]
        }
    ]
}
GET /api/v1/medical-actions

Get Medical-action List

Retrieve a list of Medical-action.

Retrieves a list of Medical-action records from the system. The response may support pagination, filtering, and sorting based on the provided request parameters.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "request_id": null,
            "action_type": "diagnosis",
            "action_code": "MED-20260504-125917-AVUCUH",
            "note": "Test Diagnosis Note",
            "action_by": 1,
            "is_active": true,
            "created_at": "2026-05-04T12:59:17.000000Z",
            "diagnoses": [
                {
                    "id": 1,
                    "diagnosis": "Test Diagnosis",
                    "category": {
                        "id": 15,
                        "name": "medi-249"
                    },
                    "severity": {
                        "id": 19,
                        "name": "medi-547"
                    }
                }
            ],
            "targets": [
                {
                    "id": 1,
                    "target_id": 15
                }
            ]
        },
        {
            "id": 2,
            "request_id": null,
            "action_type": "procedure",
            "action_code": "MED-20260504-125917-AVUCUH",
            "note": null,
            "action_by": 1,
            "is_active": true,
            "created_at": "2026-05-04T12:59:17.000000Z",
            "procedures": [
                {
                    "id": 1,
                    "procedure": {
                        "id": 1,
                        "name": "Complete Blood Count (CBC) Analysis"
                    },
                    "date": "2026-04-01",
                    "time": "10:00:00"
                }
            ],
            "targets": [
                {
                    "id": 2,
                    "target_id": 15
                }
            ]
        },
        {
            "id": 3,
            "request_id": null,
            "action_type": "medication",
            "action_code": "MED-20260504-125917-AVUCUH",
            "note": "Test Medication Plan",
            "action_by": 1,
            "is_active": true,
            "created_at": "2026-05-04T12:59:17.000000Z",
            "medication_plans": [
                {
                    "id": 1,
                    "status": "active",
                    "start_date": "2026-05-04",
                    "end_date": "2026-05-07",
                    "items": [
                        {
                            "id": 1,
                            "medication": {
                                "id": 1,
                                "name": "Amoxicillin Antibiotic 500mg"
                            },
                            "dose": "1 pill",
                            "doses_per_day": 2,
                            "repeat_every_days": 1,
                            "times": [
                                "08:00",
                                "20:00"
                            ]
                        }
                    ]
                }
            ],
            "targets": [
                {
                    "id": 3,
                    "target_id": 15
                }
            ]
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 3,
        "last_page": 1
    }
}
GET /api/v1/medical-actions/1

Get Medical-action Details

Retrieve Medical-action details.

Retrieves detailed information about a specific Medical-action using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 1,
        "request_id": null,
        "action_type": "diagnosis",
        "action_code": "MED-20260504-125917-AVUCUH",
        "note": "Test Diagnosis Note",
        "action_by": 1,
        "is_active": true,
        "created_at": "2026-05-04T12:59:17.000000Z",
        "diagnoses": [
            {
                "id": 1,
                "diagnosis": "Test Diagnosis",
                "category": {
                    "id": 15,
                    "name": "medi-249"
                },
                "severity": {
                    "id": 19,
                    "name": "medi-547"
                }
            }
        ],
        "targets": [
            {
                "id": 1,
                "target_id": 15
            }
        ]
    }
}
PATCH /api/v1/medical-actions/1/toggle-active

Toggle Medical-action Status

Switch the Medical-action status between active and inactive.

Updates the status of the specified Medical-action by toggling it between active and inactive. This operation allows enabling or disabling the resource without deleting it from the system.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "request_id": null,
        "action_type": "diagnosis",
        "action_code": "MED-20260504-125917-AVUCUH",
        "note": "Test Diagnosis Note",
        "action_by": 1,
        "is_active": false,
        "created_at": "2026-05-04T12:59:17.000000Z",
        "diagnoses": [
            {
                "id": 1,
                "diagnosis": "Test Diagnosis",
                "category": {
                    "id": 15,
                    "name": "medi-249"
                },
                "severity": {
                    "id": 19,
                    "name": "medi-547"
                }
            }
        ],
        "targets": [
            {
                "id": 1,
                "target_id": 15
            }
        ]
    }
}
DELETE /api/v1/medical-actions/1

Delete Medical-action

Delete a Medical-action.

Deletes the specified Medical-action from the system using its unique identifier. Depending on the system configuration, the deletion may be permanent or soft deleted.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
GET /api/v1/medical-actions/trash

Get Deleted Medical-action

List deleted Medical-action.

Retrieve a list of soft-deleted Medical-action records from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "request_id": null,
            "action_type": "diagnosis",
            "action_code": "MED-20260504-125917-AVUCUH",
            "note": "Test Diagnosis Note",
            "action_by": 1,
            "is_active": false,
            "created_at": "2026-05-04T12:59:17.000000Z",
            "diagnoses": [
                {
                    "id": 1,
                    "diagnosis": "Test Diagnosis",
                    "category": null,
                    "severity": null
                }
            ],
            "targets": [
                {
                    "id": 1,
                    "target_id": 15
                }
            ]
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
PATCH /api/v1/medical-actions/1/restore

Restore Medical-action

Restore deleted Medical-action.

Restore a previously deleted Medical-action record from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "request_id": null,
        "action_type": "diagnosis",
        "action_code": "MED-20260504-125917-AVUCUH",
        "note": "Test Diagnosis Note",
        "action_by": 1,
        "is_active": false,
        "created_at": "2026-05-04T12:59:17.000000Z",
        "diagnoses": [
            {
                "id": 1,
                "diagnosis": "Test Diagnosis",
                "category": null,
                "severity": null
            }
        ],
        "targets": [
            {
                "id": 1,
                "target_id": 15
            }
        ]
    }
}
DELETE /api/v1/medical-actions/1/force-delete

Permanently Delete Medical-action

Force delete Medical-action.

Permanently remove the Medical-action record from the system. This action cannot be undone.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/training-category

Create training category

Create training category

Store a new training category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string trai-799
name_ar string أختبار للاعدادات302

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 20,
        "name": "trai-799"
    }
}
GET /api/v1/settings/training-category

Get training category List

Get training category List

This API retrieves a paginated list of training category.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 20,
            "name": "trai-799",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/training-category/20

Show Single training category

Show Single training category

Get Single training category

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 20,
        "name": "trai-799",
        "is_active": 1
    }
}
PUT /api/v1/settings/training-category/20

Update training category

Update training category

Update training category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string trai-249
name_ar string أختبار للاعدادات687
id integer 20

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,training-category
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 20,
        "name": "trai-249"
    }
}
PATCH /api/v1/settings/training-category/20

Active Or InActive training category

Update training category

Update training category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 20,
        "name": "trai-249"
    }
}
DELETE /api/v1/settings/training-category/20

Delete training category

Delete training category

Delete training category entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/training-rate

Create training rate

Create training rate

Store a new training rate entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string trai-487
name_ar string أختبار للاعدادات480

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 21,
        "name": "trai-487"
    }
}
GET /api/v1/settings/training-rate

Get training rate List

Get training rate List

This API retrieves a paginated list of training rate.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 21,
            "name": "trai-487",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/training-rate/21

Show Single training rate

Show Single training rate

Get Single training rate

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 21,
        "name": "trai-487",
        "is_active": 1
    }
}
PUT /api/v1/settings/training-rate/21

Update training rate

Update training rate

Update training rate entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string trai-754
name_ar string أختبار للاعدادات557
id integer 21

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,training-rate
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 21,
        "name": "trai-754"
    }
}
PATCH /api/v1/settings/training-rate/21

Active Or InActive training rate

Update training rate

Update training rate entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 21,
        "name": "trai-754"
    }
}
DELETE /api/v1/settings/training-rate/21

Delete training rate

Delete training rate

Delete training rate entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/trainings

Create Training

Create a new Training.

Creates a new Training in the system using the provided data. The request validates the required fields before storing the resource in the database. Upon successful creation, the system returns the newly created record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name array { "en": "Basic Falcon Handling", "ar": "التعامل الأساسي مع الصقر" }
supports array [ { "support_id": 3 } ]
categories array [ { "category_id": 20 } ]
ages array [ { "age_id": 5 } ]
trainers array [ { "trainer_id": 2 } ]
cost_per_session double 75.5
duration integer 60
notes string Introductory session for new falcons.
is_active boolean 1

Request Validations Or Notes

Field/Name Examples
name required, array
name.ar required, string, max 255
name.en required, string, max 255
supports required, array, min 1
supports[].support_id required, integer, exists settings,id,type,falcon-species
categories required, array, min 1
categories[].category_id required, integer, exists settings,id,type,training-category
ages required, array, min 1
ages[].age_id required, integer, exists settings,id,type,falcon-age
trainers required, array, min 1
trainers[].trainer_id required, integer, exists admins,id
cost_per_session optional, numeric, min 0
duration optional, integer, min 1
notes optional, string, max 255
is_active required, true/false
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 1,
        "name": "Basic Falcon Handling",
        "cost_per_session": 75.5,
        "duration": 60,
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "categories": [
            {
                "id": 20,
                "name": "trai-799"
            }
        ],
        "trainers": [
            {
                "id": 2,
                "name": "Admin 2"
            }
        ],
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "note": null,
        "is_active": true,
        "created_at": "2026-05-04T12:59:18.000000Z"
    }
}
GET /api/v1/trainings

Get Training List

Retrieve a list of Training.

Retrieves a list of Training records from the system. The response may support pagination, filtering, and sorting based on the provided request parameters.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "Basic Falcon Handling",
            "cost_per_session": "75.50",
            "duration": 60,
            "ages": [
                {
                    "id": 5,
                    "name": "falc-202"
                }
            ],
            "categories": [
                {
                    "id": 20,
                    "name": "trai-799"
                }
            ],
            "trainers": [
                {
                    "id": 2,
                    "name": "Admin 2"
                }
            ],
            "supports": [
                {
                    "id": 3,
                    "name": "falc-104"
                }
            ],
            "note": null,
            "is_active": true,
            "created_at": "2026-05-04T12:59:18.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/trainings/1

Get Training Details

Retrieve Training details.

Retrieves detailed information about a specific Training using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 1,
        "name": "Basic Falcon Handling",
        "cost_per_session": "75.50",
        "duration": 60,
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "categories": [
            {
                "id": 20,
                "name": "trai-799"
            }
        ],
        "trainers": [
            {
                "id": 2,
                "name": null
            }
        ],
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "note": null,
        "is_active": true,
        "created_at": "2026-05-04T12:59:18.000000Z"
    }
}
PUT /api/v1/trainings/1

Update Training

Update an existing Training.

Updates the specified Training with the provided data. The system validates the request and applies the changes to the existing record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name array { "en": "Basic Falcon Handling (updated)", "ar": "التعامل الأساسي مع الصقر (محدث)" }
supports array [ { "support_id": 3 } ]
categories array [ { "category_id": 20 } ]
ages array [ { "age_id": 5 } ]
trainers array [ { "trainer_id": 2 } ]
cost_per_session integer 85
notes string Updated notes for documentation.
is_active boolean 1
id integer 1

Request Validations Or Notes

Field/Name Examples
name required, array
name.ar required, string, max 255
name.en required, string, max 255
supports optional, array, min 1
supports[].support_id required, integer, exists settings,id,type,falcon-species
categories optional, array, min 1
categories[].category_id required, integer, exists settings,id,type,training-category
ages optional, array, min 1
ages[].age_id required, integer, exists settings,id,type,falcon-age
trainers optional, array, min 1
trainers[].trainer_id required, integer, exists admins,id
cost_per_session required, numeric, min 0
notes optional, string, max 255
is_active required, true/false
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Basic Falcon Handling (updated)",
        "cost_per_session": 85,
        "duration": 60,
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "categories": [
            {
                "id": 20,
                "name": "trai-799"
            }
        ],
        "trainers": [
            {
                "id": 2,
                "name": null
            }
        ],
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "note": null,
        "is_active": true,
        "created_at": "2026-05-04T12:59:18.000000Z"
    }
}
PATCH /api/v1/trainings/1/toggle-active

Toggle Training Status

Switch the Training status between active and inactive.

Updates the status of the specified Training by toggling it between active and inactive. This operation allows enabling or disabling the resource without deleting it from the system.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Basic Falcon Handling (updated)",
        "cost_per_session": "85.00",
        "duration": 60,
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "categories": [
            {
                "id": 20,
                "name": "trai-799"
            }
        ],
        "trainers": [
            {
                "id": 2,
                "name": null
            }
        ],
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "note": null,
        "is_active": false,
        "created_at": "2026-05-04T12:59:18.000000Z"
    }
}
DELETE /api/v1/trainings/1

Delete Training

Delete a Training.

Deletes the specified Training from the system using its unique identifier. Depending on the system configuration, the deletion may be permanent or soft deleted.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/training-plans

Create Training-plan

Create a new Training-plan.

Creates a new Training-plan in the system using the provided data. The request validates the required fields before storing the resource in the database. Upon successful creation, the system returns the newly created record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name array { "en": "Weekly conditioning plan", "ar": "خطة تكييف أسبوعية" }
supports array [ { "support_id": 3 } ]
ages array [ { "age_id": 5 } ]
notes string Plan used for API documentation samples.
is_active boolean 1
items array [ { "training_id": 1, "trainer_id": 2, "repeat_every_days": 1, "times_per_day": 2, "times": [ "08:00", "16:00" ] } ]

Request Validations Or Notes

Field/Name Examples
name required, array
name.ar required, string, max 255
name.en required, string, max 255
supports required, array
supports[].support_id required, exists settings,id,type,falcon-species
ages required, array
ages[].age_id required, exists settings,id,type,falcon-age
notes optional, string, max 255
is_active required, true/false
items required, array
items[].training_id required, exists training,id
items[].trainer_id required, exists admins,id
items[].repeat_every_days required, integer, min 1
items[].times_per_day required, integer, min 1
items[].times required, array, TrainingPlanTimesRule
items[].times.* required, date_format
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 1,
        "name": "Weekly conditioning plan",
        "items": [
            {
                "id": 1,
                "training": {
                    "id": 1,
                    "name": "Basic Falcon Handling"
                },
                "repeat_every_days": 1,
                "times_per_day": 2,
                "times": [
                    "08:00",
                    "16:00"
                ],
                "trainer": {
                    "id": 2,
                    "name": "Admin 2",
                    "email": "admin2@gmail.com",
                    "phone": "01112226666",
                    "avatar": null,
                    "roles": [
                        {
                            "id": 1,
                            "name": "Default Role"
                        },
                        {
                            "id": 2,
                            "name": "Super Admin Role "
                        }
                    ],
                    "is_active": 1,
                    "permissions": [],
                    "created_at": "2026-05-04"
                },
                "is_active": true,
                "created_at": "2026-05-04T12:59:19.000000Z"
            }
        ],
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "note": null,
        "is_active": true,
        "created_at": "2026-05-04T12:59:19.000000Z"
    }
}
GET /api/v1/training-plans

Get Training-plan List

Retrieve a list of Training-plan.

Retrieves a list of Training-plan records from the system. The response may support pagination, filtering, and sorting based on the provided request parameters.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "Weekly conditioning plan",
            "items": [
                {
                    "id": 1,
                    "training": {
                        "id": 1,
                        "name": "Basic Falcon Handling"
                    },
                    "repeat_every_days": 1,
                    "times_per_day": 2,
                    "times": [
                        "08:00",
                        "16:00"
                    ],
                    "trainer": {
                        "id": 2,
                        "name": "Admin 2",
                        "email": "admin2@gmail.com",
                        "phone": "01112226666",
                        "avatar": null,
                        "roles": [
                            {
                                "id": 1,
                                "name": "Default Role"
                            },
                            {
                                "id": 2,
                                "name": "Super Admin Role "
                            }
                        ],
                        "is_active": 1,
                        "permissions": [],
                        "created_at": "2026-05-04"
                    },
                    "is_active": true,
                    "created_at": "2026-05-04T12:59:19.000000Z"
                }
            ],
            "ages": [
                {
                    "id": 5,
                    "name": "falc-202"
                }
            ],
            "supports": [
                {
                    "id": 3,
                    "name": "falc-104"
                }
            ],
            "note": null,
            "is_active": true,
            "created_at": "2026-05-04T12:59:19.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/training-plans/1

Get Training-plan Details

Retrieve Training-plan details.

Retrieves detailed information about a specific Training-plan using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 1,
        "name": "Weekly conditioning plan",
        "items": [
            {
                "id": 1,
                "training": null,
                "repeat_every_days": 1,
                "times_per_day": 2,
                "times": [
                    "08:00",
                    "16:00"
                ],
                "trainer": null,
                "is_active": true,
                "created_at": "2026-05-04T12:59:19.000000Z"
            }
        ],
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "note": null,
        "is_active": true,
        "created_at": "2026-05-04T12:59:19.000000Z"
    }
}
PUT /api/v1/training-plans/1

Update Training-plan

Update an existing Training-plan.

Updates the specified Training-plan with the provided data. The system validates the request and applies the changes to the existing record.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name array { "en": "Weekly conditioning plan (updated)", "ar": "خطة تكييف أسبوعية (محدثة)" }
supports array [ { "support_id": 3 } ]
ages array [ { "age_id": 5 } ]
notes string Updated plan notes.
is_active boolean 1
items array [ { "training_id": 1, "trainer_id": 2, "repeat_every_days": 2, "times_per_day": 1, "times": [ "09:00" ] } ]
id integer 1

Request Validations Or Notes

Field/Name Examples
name sometimes, array
name.ar sometimes, string, max 255
name.en sometimes, string, max 255
supports optional, array
supports[] optional, exists settings,id,type,falcon-species
ages optional, array
ages[] optional, exists settings,id,type,falcon-age
notes optional, string, max 255
is_active sometimes, true/false
items optional, array
items[].training_id required_with, exists training,id
items[].trainer_id required_with, exists admins,id
items[].repeat_every_days required_with, integer, min 1
items[].times_per_day required_with, integer, min 1
items[].times required_with, array, TrainingPlanTimesRule
items[].times.* required_with, date_format
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Weekly conditioning plan (updated)",
        "items": [
            {
                "id": 1,
                "training": null,
                "repeat_every_days": 2,
                "times_per_day": 1,
                "times": [
                    "09:00"
                ],
                "trainer": null,
                "is_active": true,
                "created_at": "2026-05-04T12:59:19.000000Z"
            }
        ],
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "note": null,
        "is_active": true,
        "created_at": "2026-05-04T12:59:19.000000Z"
    }
}
PATCH /api/v1/training-plans/1/toggle-active

Toggle Training-plan Status

Switch the Training-plan status between active and inactive.

Updates the status of the specified Training-plan by toggling it between active and inactive. This operation allows enabling or disabling the resource without deleting it from the system.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Weekly conditioning plan (updated)",
        "items": [
            {
                "id": 1,
                "training": null,
                "repeat_every_days": 2,
                "times_per_day": 1,
                "times": [
                    "09:00"
                ],
                "trainer": null,
                "is_active": true,
                "created_at": "2026-05-04T12:59:19.000000Z"
            }
        ],
        "ages": [
            {
                "id": 5,
                "name": "falc-202"
            }
        ],
        "supports": [
            {
                "id": 3,
                "name": "falc-104"
            }
        ],
        "note": null,
        "is_active": false,
        "created_at": "2026-05-04T12:59:19.000000Z"
    }
}
DELETE /api/v1/training-plans/1

Delete Training-plan

Delete a Training-plan.

Deletes the specified Training-plan from the system using its unique identifier. Depending on the system configuration, the deletion may be permanent or soft deleted.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/locations-country

Create locations country

Create locations country

Store a new locations country entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string loca-686
name_ar string أختبار للاعدادات884

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 22,
        "name": "loca-686"
    }
}
GET /api/v1/settings/locations-country

Get locations country List

Get locations country List

This API retrieves a paginated list of locations country.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 22,
            "name": "loca-686",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/locations-country/22

Show Single locations country

Show Single locations country

Get Single locations country

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 22,
        "name": "loca-686",
        "is_active": 1
    }
}
PUT /api/v1/settings/locations-country/22

Update locations country

Update locations country

Update locations country entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string loca-275
name_ar string أختبار للاعدادات222
id integer 22

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,locations-country
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 22,
        "name": "loca-275"
    }
}
PATCH /api/v1/settings/locations-country/22

Active Or InActive locations country

Update locations country

Update locations country entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 22,
        "name": "loca-275"
    }
}
DELETE /api/v1/settings/locations-country/22

Delete locations country

Delete locations country

Delete locations country entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/locations-city

Create locations city

Create locations city

Store a new locations city entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string loca-275
name_ar string أختبار للاعدادات211
parent_id integer 22

Request Validations Or Notes

Field/Name Examples
parent_id required, integer, ParentTypeRule
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 23,
        "name": "loca-275"
    }
}
GET /api/v1/settings/locations-city

Get locations city List

Get locations city List

This API retrieves a paginated list of locations city.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 23,
            "name": "loca-275",
            "is_active": 1,
            "parent": {
                "id": 22,
                "name": "loca-686"
            }
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/locations-city/23

Show Single locations city

Show Single locations city

Get Single locations city

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 23,
        "name": "loca-275",
        "is_active": 1,
        "parent": {
            "id": 22,
            "name": "loca-275"
        }
    }
}
PUT /api/v1/settings/locations-city/23

Update locations city

Update locations city

Update locations city entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string loca-866
name_ar string أختبار للاعدادات634
id integer 23

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,locations-city
parent_id optional, integer, ParentTypeRule
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 23,
        "name": "loca-866"
    }
}
PATCH /api/v1/settings/locations-city/23

Active Or InActive locations city

Update locations city

Update locations city entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 23,
        "name": "loca-866"
    }
}
DELETE /api/v1/settings/locations-city/23

Delete locations city

Delete locations city

Delete locations city entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/locations-type

Create locations type

Create locations type

Store a new locations type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string loca-330
name_ar string أختبار للاعدادات795

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 24,
        "name": "loca-330"
    }
}
GET /api/v1/settings/locations-type

Get locations type List

Get locations type List

This API retrieves a paginated list of locations type.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 24,
            "name": "loca-330",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/locations-type/24

Show Single locations type

Show Single locations type

Get Single locations type

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 24,
        "name": "loca-330",
        "is_active": 1
    }
}
PUT /api/v1/settings/locations-type/24

Update locations type

Update locations type

Update locations type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string loca-111
name_ar string أختبار للاعدادات951
id integer 24

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,locations-type
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 24,
        "name": "loca-111"
    }
}
PATCH /api/v1/settings/locations-type/24

Active Or InActive locations type

Update locations type

Update locations type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 24,
        "name": "loca-111"
    }
}
DELETE /api/v1/settings/locations-type/24

Delete locations type

Delete locations type

Delete locations type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/locations-subunit-type

Create locations subunit type

Create locations subunit type

Store a new locations subunit type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string loca-454
name_ar string أختبار للاعدادات797

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 25,
        "name": "loca-454"
    }
}
GET /api/v1/settings/locations-subunit-type

Get locations subunit type List

Get locations subunit type List

This API retrieves a paginated list of locations subunit type.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 25,
            "name": "loca-454",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/locations-subunit-type/25

Show Single locations subunit type

Show Single locations subunit type

Get Single locations subunit type

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 25,
        "name": "loca-454",
        "is_active": 1
    }
}
PUT /api/v1/settings/locations-subunit-type/25

Update locations subunit type

Update locations subunit type

Update locations subunit type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string loca-737
name_ar string أختبار للاعدادات152
id integer 25

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,locations-subunit-type
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 25,
        "name": "loca-737"
    }
}
PATCH /api/v1/settings/locations-subunit-type/25

Active Or InActive locations subunit type

Update locations subunit type

Update locations subunit type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 25,
        "name": "loca-737"
    }
}
DELETE /api/v1/settings/locations-subunit-type/25

Delete locations subunit type

Delete locations subunit type

Delete locations subunit type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/settings/locations-subunit-sub-type

Create locations subunit sub type

Create locations subunit sub type

Store a new locations subunit sub type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string loca-926
name_ar string أختبار للاعدادات370
parent_id integer 25

Request Validations Or Notes

Field/Name Examples
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
parent_id required, integer, ParentTypeRule
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 26,
        "name": "loca-926"
    }
}
GET /api/v1/settings/locations-subunit-sub-type

Get locations subunit sub type List

Get locations subunit sub type List

This API retrieves a paginated list of locations subunit sub type.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Query Parameters

Field/Name Type Examples
page integer 1
per_page integer 10
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 26,
            "name": "loca-926",
            "is_active": 1,
            "parent": {
                "id": 25,
                "name": "loca-454"
            }
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/settings/locations-subunit-sub-type/26

Show Single locations subunit sub type

Show Single locations subunit sub type

Get Single locations subunit sub type

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 26,
        "name": "loca-926",
        "is_active": 1,
        "parent": {
            "id": 25,
            "name": "loca-737"
        }
    }
}
PUT /api/v1/settings/locations-subunit-sub-type/26

Update locations subunit sub type

Update locations subunit sub type

Update locations subunit sub type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name_en string loca-659
name_ar string أختبار للاعدادات478
id integer 26

Request Validations Or Notes

Field/Name Examples
id required, integer, exists settings,id,type,locations-subunit-sub-type
name_ar required, string, max 255, ArabicRoleName, UniqueSettingName
name_en required, string, max 255, EnglishRoleName, UniqueSettingName
parent_id optional, integer, ParentTypeRule
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 26,
        "name": "loca-659"
    }
}
PATCH /api/v1/settings/locations-subunit-sub-type/26

Active Or InActive locations subunit sub type

Update locations subunit sub type

Update locations subunit sub type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 26,
        "name": "loca-659"
    }
}
DELETE /api/v1/settings/locations-subunit-sub-type/26

Delete locations subunit sub type

Delete locations subunit sub type

Delete locations subunit sub type entry

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/locations/facilities

Create Location Facilities

Create a new Location Facilities.

Creates a new Location Facilities in the system using the provided data.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name array { "ar": "منشأة اختبار", "en": "Test Facility" }
notes string Facility created by docs tests
type_id integer 24
city_id integer 23
is_active boolean 1
links array [ { "name": "Map", "url": "https:\/\/example.com\/map" } ]

Request Validations Or Notes

Field/Name Examples
name required, array
name.ar required, string, max 255
name.en required, string, max 255
notes optional, string
type_id required, exists settings,id,type,locations-type
city_id required, exists settings,id,type,locations-city
is_active optional, true/false
links optional, array
links[].name required, string, max 255
links[].url required, url, max 2048
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 1,
        "name": "Test Facility",
        "notes": "Facility created by docs tests",
        "city": {
            "id": 23,
            "name": "loca-275"
        },
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "links": [
            {
                "id": 1,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:12.000000Z",
        "updated_at": "2026-05-04T12:59:12.000000Z"
    }
}
GET /api/v1/locations/facilities

Get Location Facilities List

Retrieve a list of Location Facilities.

Retrieves a list of Location Facilities records from the system.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 1,
            "name": "Test Facility",
            "notes": "Facility created by docs tests",
            "city": {
                "id": 23,
                "name": "loca-275"
            },
            "type": {
                "id": 24,
                "name": "loca-330"
            },
            "links": [
                {
                    "id": 1,
                    "name": "Map",
                    "url": "https:\/\/example.com\/map"
                }
            ],
            "is_active": true,
            "created_at": "2026-05-04T12:59:12.000000Z",
            "updated_at": "2026-05-04T12:59:12.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/locations/facilities/1

Get Location Facilities Details

Retrieve Location Facilities details.

Retrieves detailed information about a specific Location Facilities using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 1,
        "name": "Test Facility",
        "notes": "Facility created by docs tests",
        "city": {
            "id": 23,
            "name": "loca-275"
        },
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "links": [
            {
                "id": 1,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:12.000000Z",
        "updated_at": "2026-05-04T12:59:12.000000Z"
    }
}
PUT /api/v1/locations/facilities/1

Update Location Facilities

Update an existing Location Facilities.

Updates the specified Location Facilities with the provided data.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
id integer 1
name array { "ar": "منشأة اختبار محدثة", "en": "Test Facility Updated" }
notes string Updated by docs tests
type_id integer 24
city_id integer 23
is_active boolean 1
links array [ { "name": "Map", "url": "https:\/\/example.com\/map" } ]

Request Validations Or Notes

Field/Name Examples
id required, integer, exists locations,id
name required, array
name.ar required, string, max 255
name.en required, string, max 255
notes optional, string
parent_id optional, exists locations,id
type_id required, exists settings,id
city_id required, exists settings,id
is_active optional, true/false
links optional, array
links[].name required, string, max 255
links[].url required, url, max 2048
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Test Facility Updated",
        "notes": "Updated by docs tests",
        "city": {
            "id": 23,
            "name": "loca-275"
        },
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "links": [
            {
                "id": 1,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:12.000000Z",
        "updated_at": "2026-05-04T12:59:38.000000Z"
    }
}
PATCH /api/v1/locations/facilities/1

Toggle Location Facilities Status

Switch the Location Facilities status between active and inactive.

Updates the status of the specified Location Facilities by toggling it between active and inactive.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Test Facility Updated",
        "notes": "Updated by docs tests",
        "city": {
            "id": 23,
            "name": "loca-275"
        },
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "links": [
            {
                "id": 1,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": false,
        "created_at": "2026-05-04T12:59:12.000000Z",
        "updated_at": "2026-05-04T12:59:38.000000Z"
    }
}
DELETE /api/v1/locations/facilities/1

Delete Location Facilities

Delete a Location Facilities.

Deletes the specified Location Facilities from the system using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/locations/buildings

Create Location Buildings

Create a new Location Buildings.

Creates a new Location Buildings in the system using the provided data.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name array { "ar": "مبنى اختبار", "en": "Test Building" }
notes string Building created by docs tests
parent_id integer 1
type_id integer 24
capacity_falcons integer 100
capacity_eggs integer 200
supported_assets string falcons-eggs
is_active boolean 1
links array [ { "name": "Map", "url": "https:\/\/example.com\/map" } ]

Request Validations Or Notes

Field/Name Examples
name required, array
name.ar required, string, max 255
name.en required, string, max 255
notes optional, string
parent_id required, exists locations,id, LocationParentRule
type_id required, exists settings,id,type,locations-type
temperature optional, numeric
humidity optional, numeric
capacity_falcons optional, numeric, required if supported_assets = falcons
capacity_eggs optional, numeric, required if supported_assets = eggs
supported_assets required, allowed: falcons, eggs, falcons-eggs
is_active optional, true/false
links optional, array
links[].name required, string, max 255
links[].url required, url, max 2048
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 2,
        "name": "Test Building",
        "notes": "Building created by docs tests",
        "parent_id": 1,
        "parents": [
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 1
            }
        ],
        "unit_type": "building",
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "temperature": "0.00",
        "humidity": "0.00",
        "capacity_falcons": 100,
        "capacity_eggs": 200,
        "supported_assets": "falcons-eggs",
        "links": [
            {
                "id": 2,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:13.000000Z",
        "updated_at": "2026-05-04T12:59:13.000000Z"
    }
}
GET /api/v1/locations/buildings

Get Location Buildings List

Retrieve a list of Location Buildings.

Retrieves a list of Location Buildings records from the system.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 2,
            "name": "Test Building",
            "notes": "Building created by docs tests",
            "parent_id": 1,
            "parents": [
                {
                    "id": 1,
                    "name": "Test Facility",
                    "type": "facilities",
                    "level": 1
                }
            ],
            "unit_type": "building",
            "type": {
                "id": 24,
                "name": "loca-330"
            },
            "temperature": "0.00",
            "humidity": "0.00",
            "capacity_falcons": 100,
            "capacity_eggs": 200,
            "supported_assets": "falcons-eggs",
            "links": [
                {
                    "id": 2,
                    "name": "Map",
                    "url": "https:\/\/example.com\/map"
                }
            ],
            "is_active": true,
            "created_at": "2026-05-04T12:59:13.000000Z",
            "updated_at": "2026-05-04T12:59:13.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/locations/buildings/2

Get Location Buildings Details

Retrieve Location Buildings details.

Retrieves detailed information about a specific Location Buildings using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 2,
        "name": "Test Building",
        "notes": "Building created by docs tests",
        "parent_id": 1,
        "parents": [
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 1
            }
        ],
        "unit_type": "building",
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "temperature": "0.00",
        "humidity": "0.00",
        "capacity_falcons": 100,
        "capacity_eggs": 200,
        "supported_assets": "falcons-eggs",
        "links": [
            {
                "id": 2,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:13.000000Z",
        "updated_at": "2026-05-04T12:59:13.000000Z"
    }
}
PUT /api/v1/locations/buildings/2

Update Location Buildings

Update an existing Location Buildings.

Updates the specified Location Buildings with the provided data.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
id integer 2
name array { "ar": "مبنى اختبار محدث", "en": "Test Building Updated" }
notes string Updated by docs tests
parent_id integer 1
type_id integer 24
capacity_falcons integer 110
capacity_eggs integer 210
supported_assets string falcons-eggs
is_active boolean 1
links array [ { "name": "Map", "url": "https:\/\/example.com\/map" } ]

Request Validations Or Notes

Field/Name Examples
id required, integer, exists locations,id
name required, array
name.ar required, string, max 255
name.en required, string, max 255
notes optional, string
parent_id required, exists locations,id, LocationParentRule
type_id required, exists settings,id
temperature optional, numeric
humidity optional, numeric
capacity_falcons optional, numeric, required if supported_assets = falcons
capacity_eggs optional, numeric, required if supported_assets = eggs
supported_assets optional, allowed: falcons, eggs, falcons-eggs
is_active optional, true/false
links optional, array
links[].name required, string, max 255
links[].url required, url, max 2048
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 2,
        "name": "Test Building Updated",
        "notes": "Updated by docs tests",
        "parent_id": 1,
        "parents": [
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 1
            }
        ],
        "unit_type": "building",
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "temperature": "0.00",
        "humidity": "0.00",
        "capacity_falcons": 110,
        "capacity_eggs": 210,
        "supported_assets": "falcons-eggs",
        "links": [
            {
                "id": 2,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:13.000000Z",
        "updated_at": "2026-05-04T12:59:36.000000Z"
    }
}
PATCH /api/v1/locations/buildings/2

Toggle Location Buildings Status

Switch the Location Buildings status between active and inactive.

Updates the status of the specified Location Buildings by toggling it between active and inactive.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 2,
        "name": "Test Building Updated",
        "notes": "Updated by docs tests",
        "parent_id": 1,
        "parents": [
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 1
            }
        ],
        "unit_type": "building",
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "temperature": "0.00",
        "humidity": "0.00",
        "capacity_falcons": 110,
        "capacity_eggs": 210,
        "supported_assets": "falcons-eggs",
        "links": [
            {
                "id": 2,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": false,
        "created_at": "2026-05-04T12:59:13.000000Z",
        "updated_at": "2026-05-04T12:59:37.000000Z"
    }
}
DELETE /api/v1/locations/buildings/2

Delete Location Buildings

Delete a Location Buildings.

Deletes the specified Location Buildings from the system using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/locations/rooms

Create Location Rooms

Create a new Location Rooms.

Creates a new Location Rooms in the system using the provided data.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name array { "ar": "غرفة اختبار", "en": "Test Room" }
notes string Room created by docs tests
parent_id integer 2
type_id integer 24
temperature integer 22
humidity integer 50
capacity_falcons integer 30
capacity_eggs integer 60
supported_assets string falcons-eggs
is_active boolean 1
links array [ { "name": "Map", "url": "https:\/\/example.com\/map" } ]

Request Validations Or Notes

Field/Name Examples
name required, array
name.ar required, string, max 255
name.en required, string, max 255
notes optional, string
parent_id required, exists locations,id, LocationParentRule
type_id required, exists settings,id,type,locations-type
temperature optional, numeric
humidity optional, numeric
capacity_falcons optional, numeric, required if supported_assets = falcons
capacity_eggs optional, numeric, required if supported_assets = eggs
supported_assets required, allowed: falcons, eggs, falcons-eggs
is_active optional, true/false
links optional, array
links[].name required, string, max 255
links[].url required, url, max 2048
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 3,
        "name": "Test Room",
        "notes": "Room created by docs tests",
        "parent_id": 2,
        "parents": [
            {
                "id": 2,
                "name": "Test Building",
                "type": "buildings",
                "level": 1
            },
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 2
            }
        ],
        "unit_type": "room",
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "temperature": "22.00",
        "humidity": "50.00",
        "capacity_falcons": 30,
        "capacity_eggs": 60,
        "supported_assets": "falcons-eggs",
        "links": [
            {
                "id": 3,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:13.000000Z",
        "updated_at": "2026-05-04T12:59:13.000000Z"
    }
}
GET /api/v1/locations/rooms

Get Location Rooms List

Retrieve a list of Location Rooms.

Retrieves a list of Location Rooms records from the system.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 3,
            "name": "Test Room",
            "notes": "Room created by docs tests",
            "parent_id": 2,
            "parents": [
                {
                    "id": 2,
                    "name": "Test Building",
                    "type": "buildings",
                    "level": 1
                },
                {
                    "id": 1,
                    "name": "Test Facility",
                    "type": "facilities",
                    "level": 2
                }
            ],
            "unit_type": "room",
            "type": {
                "id": 24,
                "name": "loca-330"
            },
            "temperature": "22.00",
            "humidity": "50.00",
            "capacity_falcons": 30,
            "capacity_eggs": 60,
            "supported_assets": "falcons-eggs",
            "links": [
                {
                    "id": 3,
                    "name": "Map",
                    "url": "https:\/\/example.com\/map"
                }
            ],
            "is_active": true,
            "created_at": "2026-05-04T12:59:13.000000Z",
            "updated_at": "2026-05-04T12:59:13.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/locations/rooms/3

Get Location Rooms Details

Retrieve Location Rooms details.

Retrieves detailed information about a specific Location Rooms using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 3,
        "name": "Test Room",
        "notes": "Room created by docs tests",
        "parent_id": 2,
        "parents": [
            {
                "id": 2,
                "name": "Test Building",
                "type": "buildings",
                "level": 1
            },
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 2
            }
        ],
        "unit_type": "room",
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "temperature": "22.00",
        "humidity": "50.00",
        "capacity_falcons": 30,
        "capacity_eggs": 60,
        "supported_assets": "falcons-eggs",
        "links": [
            {
                "id": 3,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:13.000000Z",
        "updated_at": "2026-05-04T12:59:13.000000Z"
    }
}
PUT /api/v1/locations/rooms/3

Update Location Rooms

Update an existing Location Rooms.

Updates the specified Location Rooms with the provided data.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
id integer 3
name array { "ar": "غرفة اختبار محدثة", "en": "Test Room Updated" }
notes string Updated by docs tests
parent_id integer 2
type_id integer 24
temperature integer 23
humidity integer 51
capacity_falcons integer 35
capacity_eggs integer 65
supported_assets string falcons-eggs
is_active boolean 1
links array [ { "name": "Map", "url": "https:\/\/example.com\/map" } ]

Request Validations Or Notes

Field/Name Examples
id required, integer, exists locations,id
name required, array
name.ar required, string, max 255
name.en required, string, max 255
notes optional, string
parent_id required, exists locations,id, LocationParentRule
type_id required, exists settings,id
temperature optional, numeric
humidity optional, numeric
capacity_falcons optional, numeric, required if supported_assets = falcons
capacity_eggs optional, numeric, required if supported_assets = eggs
supported_assets optional, allowed: falcons, eggs, falcons-eggs
is_active optional, true/false
links optional, array
links[].name required, string, max 255
links[].url required, url, max 2048
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 3,
        "name": "Test Room Updated",
        "notes": "Updated by docs tests",
        "parent_id": 2,
        "parents": [
            {
                "id": 2,
                "name": "Test Building",
                "type": "buildings",
                "level": 1
            },
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 2
            }
        ],
        "unit_type": "room",
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "temperature": "23.00",
        "humidity": "51.00",
        "capacity_falcons": 35,
        "capacity_eggs": 65,
        "supported_assets": "falcons-eggs",
        "links": [
            {
                "id": 3,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:13.000000Z",
        "updated_at": "2026-05-04T12:59:36.000000Z"
    }
}
PATCH /api/v1/locations/rooms/3

Toggle Location Rooms Status

Switch the Location Rooms status between active and inactive.

Updates the status of the specified Location Rooms by toggling it between active and inactive.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 3,
        "name": "Test Room Updated",
        "notes": "Updated by docs tests",
        "parent_id": 2,
        "parents": [
            {
                "id": 2,
                "name": "Test Building",
                "type": "buildings",
                "level": 1
            },
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 2
            }
        ],
        "unit_type": "room",
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "temperature": "23.00",
        "humidity": "51.00",
        "capacity_falcons": 35,
        "capacity_eggs": 65,
        "supported_assets": "falcons-eggs",
        "links": [
            {
                "id": 3,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": false,
        "created_at": "2026-05-04T12:59:13.000000Z",
        "updated_at": "2026-05-04T12:59:36.000000Z"
    }
}
DELETE /api/v1/locations/rooms/3

Delete Location Rooms

Delete a Location Rooms.

Deletes the specified Location Rooms from the system using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/locations/subunits

Create Location Subunits

Create a new Location Subunits.

Creates a new Location Subunits in the system using the provided data.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name array { "ar": "وحدة فرعية اختبار", "en": "Test Subunit" }
notes string Subunit created by docs tests
parent_id integer 3
type_id integer 24
temperature integer 22
humidity integer 50
capacity_falcons integer 2
capacity_eggs integer 4
supported_assets string falcons-eggs
is_active boolean 1
links array [ { "name": "Map", "url": "https:\/\/example.com\/map" } ]

Request Validations Or Notes

Field/Name Examples
name required, array
name.ar required, string, max 255
name.en required, string, max 255
notes optional, string
parent_id required, exists locations,id, LocationParentRule
type_id required, exists settings,id,type,locations-type
temperature optional, numeric
humidity optional, numeric
capacity_falcons optional, numeric, required if supported_assets = falcons
capacity_eggs optional, numeric, required if supported_assets = eggs
supported_assets required, allowed: falcons, eggs, falcons-eggs
is_active optional, true/false
links optional, array
links[].name required, string, max 255
links[].url required, url, max 2048
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 4,
        "name": "Test Subunit",
        "notes": "Subunit created by docs tests",
        "parent_id": 3,
        "parents": [
            {
                "id": 3,
                "name": "Test Room",
                "type": "rooms",
                "level": 1
            },
            {
                "id": 2,
                "name": "Test Building",
                "type": "buildings",
                "level": 2
            },
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 3
            }
        ],
        "unit_type": "sub_unit",
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "temperature": "22.00",
        "humidity": "50.00",
        "capacity_falcons": 2,
        "capacity_eggs": 4,
        "supported_assets": "falcons-eggs",
        "links": [
            {
                "id": 4,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:13.000000Z",
        "updated_at": "2026-05-04T12:59:13.000000Z"
    }
}
GET /api/v1/locations/subunits

Get Location Subunits List

Retrieve a list of Location Subunits.

Retrieves a list of Location Subunits records from the system.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 4,
            "name": "Test Subunit",
            "notes": "Subunit created by docs tests",
            "parent_id": 3,
            "parents": [
                {
                    "id": 3,
                    "name": "Test Room",
                    "type": "rooms",
                    "level": 1
                },
                {
                    "id": 2,
                    "name": "Test Building",
                    "type": "buildings",
                    "level": 2
                },
                {
                    "id": 1,
                    "name": "Test Facility",
                    "type": "facilities",
                    "level": 3
                }
            ],
            "unit_type": "sub_unit",
            "type": {
                "id": 24,
                "name": "loca-330"
            },
            "temperature": "22.00",
            "humidity": "50.00",
            "capacity_falcons": 2,
            "capacity_eggs": 4,
            "supported_assets": "falcons-eggs",
            "links": [
                {
                    "id": 4,
                    "name": "Map",
                    "url": "https:\/\/example.com\/map"
                }
            ],
            "is_active": true,
            "created_at": "2026-05-04T12:59:13.000000Z",
            "updated_at": "2026-05-04T12:59:13.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/locations/subunits/4

Get Location Subunits Details

Retrieve Location Subunits details.

Retrieves detailed information about a specific Location Subunits using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 4,
        "name": "Test Subunit",
        "notes": "Subunit created by docs tests",
        "parent_id": 3,
        "parents": [
            {
                "id": 3,
                "name": "Test Room",
                "type": "rooms",
                "level": 1
            },
            {
                "id": 2,
                "name": "Test Building",
                "type": "buildings",
                "level": 2
            },
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 3
            }
        ],
        "unit_type": "sub_unit",
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "temperature": "22.00",
        "humidity": "50.00",
        "capacity_falcons": 2,
        "capacity_eggs": 4,
        "supported_assets": "falcons-eggs",
        "links": [
            {
                "id": 4,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:13.000000Z",
        "updated_at": "2026-05-04T12:59:13.000000Z"
    }
}
PUT /api/v1/locations/subunits/4

Update Location Subunits

Update an existing Location Subunits.

Updates the specified Location Subunits with the provided data.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
id integer 4
name array { "ar": "وحدة فرعية اختبار محدثة", "en": "Test Subunit Updated" }
notes string Updated by docs tests
parent_id integer 3
type_id integer 24
temperature integer 23
humidity integer 51
capacity_falcons integer 2
capacity_eggs integer 6
supported_assets string falcons-eggs
is_active boolean 1
links array [ { "name": "Map", "url": "https:\/\/example.com\/map" } ]

Request Validations Or Notes

Field/Name Examples
id required, integer, exists locations,id
name required, array
name.ar required, string, max 255
name.en required, string, max 255
notes optional, string
parent_id required, exists locations,id, LocationParentRule
type_id required, exists settings,id
temperature optional, numeric
humidity optional, numeric
capacity_falcons optional, numeric, required if supported_assets = falcons
capacity_eggs optional, numeric, required if supported_assets = eggs
supported_assets optional, allowed: falcons, eggs, falcons-eggs
is_active optional, true/false
links optional, array
links[].name required, string, max 255
links[].url required, url, max 2048
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 4,
        "name": "Test Subunit Updated",
        "notes": "Updated by docs tests",
        "parent_id": 3,
        "parents": [
            {
                "id": 3,
                "name": "Test Room",
                "type": "rooms",
                "level": 1
            },
            {
                "id": 2,
                "name": "Test Building",
                "type": "buildings",
                "level": 2
            },
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 3
            }
        ],
        "unit_type": "sub_unit",
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "temperature": "23.00",
        "humidity": "51.00",
        "capacity_falcons": 2,
        "capacity_eggs": 6,
        "supported_assets": "falcons-eggs",
        "links": [
            {
                "id": 4,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:13.000000Z",
        "updated_at": "2026-05-04T12:59:35.000000Z"
    }
}
PATCH /api/v1/locations/subunits/4

Toggle Location Subunits Status

Switch the Location Subunits status between active and inactive.

Updates the status of the specified Location Subunits by toggling it between active and inactive.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 4,
        "name": "Test Subunit Updated",
        "notes": "Updated by docs tests",
        "parent_id": 3,
        "parents": [
            {
                "id": 3,
                "name": "Test Room",
                "type": "rooms",
                "level": 1
            },
            {
                "id": 2,
                "name": "Test Building",
                "type": "buildings",
                "level": 2
            },
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 3
            }
        ],
        "unit_type": "sub_unit",
        "type": {
            "id": 24,
            "name": "loca-330"
        },
        "temperature": "23.00",
        "humidity": "51.00",
        "capacity_falcons": 2,
        "capacity_eggs": 6,
        "supported_assets": "falcons-eggs",
        "links": [
            {
                "id": 4,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": false,
        "created_at": "2026-05-04T12:59:13.000000Z",
        "updated_at": "2026-05-04T12:59:35.000000Z"
    }
}
DELETE /api/v1/locations/subunits/4

Delete Location Subunits

Delete a Location Subunits.

Deletes the specified Location Subunits from the system using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
POST /api/v1/locations/externals

Create Location Externals

Create a new Location Externals.

Creates a new Location Externals in the system using the provided data.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
name array { "ar": "خارجي اختبار", "en": "Test External" }
notes string External created by docs tests
city_id integer 23
is_active boolean 1
links array [ { "name": "Map", "url": "https:\/\/example.com\/map" } ]

Request Validations Or Notes

Field/Name Examples
name required, array
name.ar required, string, max 255
name.en required, string, max 255
notes optional, string
parent_id optional, exists locations,id
city_id required, exists settings,id
is_active optional, true/false
links optional, array
links[].name required, string, max 255
links[].url required, url, max 2048
Success (200 OK) 
{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 5,
        "name": "Test External",
        "notes": "External created by docs tests",
        "city": {
            "id": 23,
            "name": "loca-275"
        },
        "links": [
            {
                "id": 5,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:14.000000Z",
        "updated_at": "2026-05-04T12:59:14.000000Z"
    }
}
GET /api/v1/locations/externals

Get Location Externals List

Retrieve a list of Location Externals.

Retrieves a list of Location Externals records from the system.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 5,
            "name": "Test External",
            "notes": "External created by docs tests",
            "city": {
                "id": 23,
                "name": "loca-275"
            },
            "links": [
                {
                    "id": 5,
                    "name": "Map",
                    "url": "https:\/\/example.com\/map"
                }
            ],
            "is_active": true,
            "created_at": "2026-05-04T12:59:14.000000Z",
            "updated_at": "2026-05-04T12:59:14.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
GET /api/v1/locations/externals/5

Get Location Externals Details

Retrieve Location Externals details.

Retrieves detailed information about a specific Location Externals using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": {
        "id": 5,
        "name": "Test External",
        "notes": "External created by docs tests",
        "city": {
            "id": 23,
            "name": "loca-275"
        },
        "links": [
            {
                "id": 5,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:14.000000Z",
        "updated_at": "2026-05-04T12:59:14.000000Z"
    }
}
PUT /api/v1/locations/externals/5

Update Location Externals

Update an existing Location Externals.

Updates the specified Location Externals with the provided data.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key

Request Body

Field/Name Type Examples
id integer 5
name array { "ar": "خارجي اختبار محدث", "en": "Test External Updated" }
notes string Updated by docs tests
city_id integer 23
is_active boolean 1
links array [ { "name": "Map", "url": "https:\/\/example.com\/map" } ]

Request Validations Or Notes

Field/Name Examples
id required, integer, exists locations,id
name required, array
name.ar required, string, max 255
name.en required, string, max 255
notes optional, string
parent_id optional, exists locations,id
city_id required, exists settings,id
is_active optional, true/false
links optional, array
links[].name required, string, max 255
links[].url required, url, max 2048
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 5,
        "name": "Test External Updated",
        "notes": "Updated by docs tests",
        "city": {
            "id": 23,
            "name": "loca-275"
        },
        "links": [
            {
                "id": 5,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-04T12:59:14.000000Z",
        "updated_at": "2026-05-04T12:59:37.000000Z"
    }
}
PATCH /api/v1/locations/externals/5

Toggle Location Externals Status

Switch the Location Externals status between active and inactive.

Updates the status of the specified Location Externals by toggling it between active and inactive.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 5,
        "name": "Test External Updated",
        "notes": "Updated by docs tests",
        "city": {
            "id": 23,
            "name": "loca-275"
        },
        "links": [
            {
                "id": 5,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": false,
        "created_at": "2026-05-04T12:59:14.000000Z",
        "updated_at": "2026-05-04T12:59:37.000000Z"
    }
}
DELETE /api/v1/locations/externals/5

Delete Location Externals

Delete a Location Externals.

Deletes the specified Location Externals from the system using its unique identifier.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}
GET /api/v1/locations/externals/trash

Get Deleted Location

List deleted Location.

Retrieve a list of soft-deleted Location records from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data retrieved successfully.",
    "data": [
        {
            "id": 5,
            "name": "Test External Updated",
            "notes": "Updated by docs tests",
            "city": null,
            "links": [
                {
                    "id": 5,
                    "name": "Map",
                    "url": "https:\/\/example.com\/map"
                }
            ],
            "is_active": false,
            "created_at": "2026-05-04T12:59:14.000000Z",
            "updated_at": "2026-05-04T12:59:37.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}
PATCH /api/v1/locations/externals/5/restore

Restore Location

Restore deleted Location.

Restore a previously deleted Location record from the recycle bin.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 5,
        "name": "Test External Updated",
        "notes": "Updated by docs tests",
        "city": null,
        "links": [
            {
                "id": 5,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": false,
        "created_at": "2026-05-04T12:59:14.000000Z",
        "updated_at": "2026-05-04T13:00:15.000000Z"
    }
}
DELETE /api/v1/locations/externals/5/force-delete

Permanently Delete Location

Force delete Location.

Permanently remove the Location record from the system. This action cannot be undone.

Headers

Field/Name Type Examples
Content-Type string application/json
X-API-Token string X-API-Token Key
Accept string application/json
Authorization string Authorization Key
Success (200 OK) 
{
    "success": true,
    "message": "Data deleted successfully.",
    "data": []
}