API Documentation

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-dev.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",
        "created_at": "2026-05-21",
        "is_active": true,
        "avatar": null,
        "roles": [
            {
                "id": 1,
                "name": "Default Role"
            },
            {
                "id": 2,
                "name": "Super Admin Role "
            }
        ],
        "permissions": [
            "dashboard-fetch",
            "roles-fetch",
            "roles-create",
            "roles-read",
            "roles-update",
            "roles-delete",
            "admins-fetch",
            "admins-create",
            "admins-read",
            "admins-update",
            "admins-delete"
        ],
        "token": "2|HkXSoJll8MdBbEp9rJKatwyIg1ThjDECotsg1AiS67c52aa0",
        "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",
        "created_at": "2026-05-21",
        "is_active": false
    }
}

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": 2,
            "name": "Admin 2",
            "email": "admin2@gmail.com",
            "phone": "01112226666",
            "created_at": "2026-05-21",
            "is_active": true,
            "avatar": null,
            "roles": [
                {
                    "id": 1,
                    "name": "Default Role"
                },
                {
                    "id": 2,
                    "name": "Super Admin Role "
                }
            ],
            "permissions": [
                "dashboard-fetch",
                "roles-fetch",
                "roles-create",
                "roles-read",
                "roles-update",
                "roles-delete",
                "admins-fetch",
                "admins-create",
                "admins-read",
                "admins-update",
                "admins-delete"
            ]
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "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",
        "created_at": "2026-05-21",
        "is_active": true,
        "avatar": null,
        "roles": [
            {
                "id": 1,
                "name": "Default Role"
            },
            {
                "id": 2,
                "name": "Super Admin Role "
            }
        ],
        "permissions": [
            "dashboard-fetch",
            "roles-fetch",
            "roles-create",
            "roles-read",
            "roles-update",
            "roles-delete",
            "admins-fetch",
            "admins-create",
            "admins-read",
            "admins-update",
            "admins-delete"
        ]
    }
}

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, string, max 255, valid email, Unique
phone	required, string, min 7, max 15, regex, Unique
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",
        "created_at": "2026-05-21",
        "is_active": true
    }
}

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",
        "created_at": "2026-05-21",
        "is_active": false
    }
}

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": null
}

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",
            "created_at": "2026-05-21",
            "is_active": false,
            "avatar": null,
            "roles": [
                {
                    "id": 1,
                    "name": "Default Role"
                },
                {
                    "id": 2,
                    "name": "Super Admin Role "
                }
            ],
            "permissions": [
                "dashboard-fetch",
                "roles-fetch",
                "roles-create",
                "roles-read",
                "roles-update",
                "roles-delete",
                "admins-fetch",
                "admins-create",
                "admins-read",
                "admins-update",
                "admins-delete"
            ]
        }
    ],
    "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",
        "created_at": "2026-05-21",
        "is_active": false
    }
}

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, DoesNotContainAllPermissions
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-21T10:48:11.000000Z",
        "created_at": "2026-05-21T10:48:11.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": 2,
            "name": "Super Admin Role ",
            "admins": [
                {
                    "id": 1,
                    "name": "Admin",
                    "email": "admin@base.com",
                    "phone": "000000000000",
                    "created_at": "2026-05-21",
                    "is_active": true
                },
                {
                    "id": 2,
                    "name": "Admin 2",
                    "email": "admin2@gmail.com",
                    "phone": "01112226666",
                    "created_at": "2026-05-21",
                    "is_active": true
                }
            ],
            "admins_count": 2,
            "is_active": true,
            "created_at": "2026-05-21T10:48:08.000000Z"
        },
        {
            "id": 3,
            "name": "Test Role",
            "admins": [],
            "admins_count": 0,
            "is_active": true,
            "created_at": "2026-05-21T10:48:11.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 2,
        "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,
        "name": "Test Role",
        "permissions": [
            {
                "id": 23,
                "name": "dashboard-fetch"
            }
        ],
        "name_translate": {
            "ar": "أختبار",
            "en": "Test Role"
        },
        "admins": [],
        "admins_count": 0,
        "is_active": true,
        "created_at": "2026-05-21T10:48:11.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, DoesNotContainAllPermissions
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-21T10:48:11.000000Z",
        "updated_at": "2026-05-21T10:48:11.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-21T10:48:11.000000Z",
        "updated_at": "2026-05-21T10:48:33.000000Z",
        "admins": []
    }
}

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",
            "is_active": false,
            "created_at": "2026-05-21T10:48:11.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-21T10:48:08.000000Z",
        "updated_at": "2026-05-21T10:48:08.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": "dashboard-fetch"
                }
            ]
        },
        {
            "id": 2,
            "title": "Roles",
            "permissions": [
                {
                    "id": 1,
                    "title": "Fetch Data",
                    "name": "roles-fetch"
                },
                {
                    "id": 2,
                    "title": "Create Data",
                    "name": "roles-create"
                },
                {
                    "id": 3,
                    "title": "Read Data",
                    "name": "roles-read"
                },
                {
                    "id": 4,
                    "title": "Update Data",
                    "name": "roles-update"
                },
                {
                    "id": 5,
                    "title": "Delete Data",
                    "name": "roles-delete"
                }
            ]
        },
        {
            "id": 3,
            "title": "Admins",
            "permissions": [
                {
                    "id": 1,
                    "title": "Fetch Data",
                    "name": "admins-fetch"
                },
                {
                    "id": 2,
                    "title": "Create Data",
                    "name": "admins-create"
                },
                {
                    "id": 3,
                    "title": "Read Data",
                    "name": "admins-read"
                },
                {
                    "id": 4,
                    "title": "Update Data",
                    "name": "admins-update"
                },
                {
                    "id": 5,
                    "title": "Delete Data",
                    "name": "admins-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/animals-seller-type

Create animals seller type

Store a new animals seller 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	anim-966
name_ar	string	أختبار للاعدادات490

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": "anim-966"
    }
}

GET /api/v1/settings/animals-seller-type

Get animals seller type List

This API retrieves a paginated list of animals seller 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": 3,
            "name": "anim-966",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/animals-seller-type/3

Show Single animals seller type

Get Single animals seller 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": 3,
        "name": "anim-966",
        "is_active": 1
    }
}

PUT /api/v1/settings/animals-seller-type/3

Update animals seller type

Update animals seller 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	anim-625
name_ar	string	أختبار للاعدادات186
id	integer	3

Request Validations Or Notes

Field/Name	Examples
id	required, integer, exists settings,id,type,animals-seller-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": 3,
        "name": "anim-625"
    }
}

PATCH /api/v1/settings/animals-seller-type/3

Active Or InActive animals seller type

Update animals seller type

Update animals seller 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": 3,
        "name": "anim-625"
    }
}

DELETE /api/v1/settings/animals-seller-type/3

Delete animals seller type

Delete animals seller 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/animals-gift-type

Create animals gift type

Store a new animals gift 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	anim-831
name_ar	string	أختبار للاعدادات214

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": "anim-831"
    }
}

GET /api/v1/settings/animals-gift-type

Get animals gift type List

This API retrieves a paginated list of animals gift 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": 4,
            "name": "anim-831",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/animals-gift-type/4

Show Single animals gift type

Get Single animals gift 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": 4,
        "name": "anim-831",
        "is_active": 1
    }
}

PUT /api/v1/settings/animals-gift-type/4

Update animals gift type

Update animals gift 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	anim-907
name_ar	string	أختبار للاعدادات988
id	integer	4

Request Validations Or Notes

Field/Name	Examples
id	required, integer, exists settings,id,type,animals-gift-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": 4,
        "name": "anim-907"
    }
}

PATCH /api/v1/settings/animals-gift-type/4

Active Or InActive animals gift type

Update animals gift type

Update animals gift 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": 4,
        "name": "anim-907"
    }
}

DELETE /api/v1/settings/animals-gift-type/4

Delete animals gift type

Delete animals gift 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/animals-species

Create animals species

Store a new animals 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	anim-355
name_ar	string	أختبار للاعدادات210

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": 6,
        "name": "anim-355"
    }
}

GET /api/v1/settings/animals-species

Get animals species List

This API retrieves a paginated list of animals 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": 6,
            "name": "anim-355",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/animals-species/6

Show Single animals species

Get Single animals 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": 6,
        "name": "anim-355",
        "is_active": 1
    }
}

PUT /api/v1/settings/animals-species/6

Update animals species

Update animals 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	anim-398
name_ar	string	أختبار للاعدادات243
id	integer	6

Request Validations Or Notes

Field/Name	Examples
id	required, integer, exists settings,id,type,animals-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": 6,
        "name": "anim-398"
    }
}

PATCH /api/v1/settings/animals-species/6

Active Or InActive animals species

Update animals species

Update animals 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": 6,
        "name": "anim-398"
    }
}

DELETE /api/v1/settings/animals-species/6

Delete animals species

Delete animals 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/animals-color

Create animals color

Store a new animals 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	anim-816
name_ar	string	أختبار للاعدادات531

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": "anim-816"
    }
}

GET /api/v1/settings/animals-color

Get animals color List

This API retrieves a paginated list of animals 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": 5,
            "name": "anim-816",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/animals-color/5

Show Single animals color

Get Single animals 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": 5,
        "name": "anim-816",
        "is_active": 1
    }
}

PUT /api/v1/settings/animals-color/5

Update animals color

Update animals 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	anim-810
name_ar	string	أختبار للاعدادات583
id	integer	5

Request Validations Or Notes

Field/Name	Examples
id	required, integer, exists settings,id,type,animals-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": 5,
        "name": "anim-810"
    }
}

PATCH /api/v1/settings/animals-color/5

Active Or InActive animals color

Update animals color

Update animals 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": 5,
        "name": "anim-810"
    }
}

DELETE /api/v1/settings/animals-color/5

Delete animals color

Delete animals 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/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-477
name_ar	string	أختبار للاعدادات829

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-477"
    }
}

GET /api/v1/settings/eggs-health-status

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-477",
            "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

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-477",
        "is_active": 1
    }
}

PUT /api/v1/settings/eggs-health-status/1

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-343
name_ar	string	أختبار للاعدادات525
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-343"
    }
}

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-343"
    }
}

DELETE /api/v1/settings/eggs-health-status/1

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

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-569
name_ar	string	أختبار للاعدادات651

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-569"
    }
}

GET /api/v1/settings/eggs-reason

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-569",
            "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

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-569",
        "is_active": 1
    }
}

PUT /api/v1/settings/eggs-reason/2

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-669
name_ar	string	أختبار للاعدادات459
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-669"
    }
}

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-669"
    }
}

DELETE /api/v1/settings/eggs-reason/2

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-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-919
name_ar	string	أختبار للاعدادات326

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-919"
    }
}

GET /api/v1/settings/falcon-gender

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": 7,
            "name": "falc-919",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/falcon-gender/7

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": 7,
        "name": "falc-919",
        "is_active": 1
    }
}

PUT /api/v1/settings/falcon-gender/7

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-198
name_ar	string	أختبار للاعدادات681
id	integer	7

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": 7,
        "name": "falc-198"
    }
}

PATCH /api/v1/settings/falcon-gender/7

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": 7,
        "name": "falc-198"
    }
}

DELETE /api/v1/settings/falcon-gender/7

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

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-203
name_ar	string	أختبار للاعدادات816

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-203"
    }
}

GET /api/v1/settings/falcon-age

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": 8,
            "name": "falc-203",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/falcon-age/8

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": 8,
        "name": "falc-203",
        "is_active": 1
    }
}

PUT /api/v1/settings/falcon-age/8

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-881
name_ar	string	أختبار للاعدادات341
id	integer	8

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": 8,
        "name": "falc-881"
    }
}

PATCH /api/v1/settings/falcon-age/8

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": 8,
        "name": "falc-881"
    }
}

DELETE /api/v1/settings/falcon-age/8

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

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-360
name_ar	string	أختبار للاعدادات204

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": 10,
        "name": "falc-360"
    }
}

GET /api/v1/settings/falcon-id

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": 10,
            "name": "falc-360",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/falcon-id/10

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": 10,
        "name": "falc-360",
        "is_active": 1
    }
}

PUT /api/v1/settings/falcon-id/10

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-783
name_ar	string	أختبار للاعدادات355
id	integer	10

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": 10,
        "name": "falc-783"
    }
}

PATCH /api/v1/settings/falcon-id/10

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": 10,
        "name": "falc-783"
    }
}

DELETE /api/v1/settings/falcon-id/10

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-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-254
name_ar	string	أختبار للاعدادات130

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-254"
    }
}

GET /api/v1/settings/falcon-behavior

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": 11,
            "name": "falc-254",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/falcon-behavior/11

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": 11,
        "name": "falc-254",
        "is_active": 1
    }
}

PUT /api/v1/settings/falcon-behavior/11

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-722
name_ar	string	أختبار للاعدادات302
id	integer	11

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": 11,
        "name": "falc-722"
    }
}

PATCH /api/v1/settings/falcon-behavior/11

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": 11,
        "name": "falc-722"
    }
}

DELETE /api/v1/settings/falcon-behavior/11

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

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-331
name_ar	string	أختبار للاعدادات881

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": "falc-331"
    }
}

GET /api/v1/settings/falcon-reason

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": 13,
            "name": "falc-331",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/falcon-reason/13

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": 13,
        "name": "falc-331",
        "is_active": 1
    }
}

PUT /api/v1/settings/falcon-reason/13

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-917
name_ar	string	أختبار للاعدادات907
id	integer	13

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": 13,
        "name": "falc-917"
    }
}

PATCH /api/v1/settings/falcon-reason/13

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": 13,
        "name": "falc-917"
    }
}

DELETE /api/v1/settings/falcon-reason/13

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": []
}

PUT /api/v1/feedings/items/1/complete

Complete Item

Complete an existing Item.

Completes the specified Item by filling the remaining required data. The system validates the request and updates the existing incomplete 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	1
calories	integer	100
note	string	test-note
is_active	boolean	1
supports	array	[ { "support_id": 6 } ]
ages	array	[ { "age_id": 8 } ]

Request Validations Or Notes

Field/Name	Examples
id	required, integer, exists feeding_items,id
calories	required, numeric, min 0
note	optional, string
supports	required, array, min 1
supports[].support_id	required, integer, exists settings,id,type,animals-species
ages	required, array, min 1
ages[].age_id	required, integer, exists settings,id,type,falcon-age
is_active	optional, true/false

Success (200 OK)

{
    "success": true,
    "message": "Item completed successfully.",
    "data": {
        "id": 1,
        "name": "QA Test Feed Item",
        "calories": 100,
        "unit": {
            "id": 15,
            "name": "feed-924"
        },
        "category": {
            "id": 14,
            "name": "feed-498"
        },
        "is_active": true,
        "note": "test-note",
        "is_completed": true,
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ]
    }
}

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": "QA Test Feed Item",
            "calories": "100.00",
            "unit": {
                "id": 15,
                "name": "feed-924"
            },
            "category": {
                "id": 14,
                "name": "feed-498"
            },
            "is_active": true,
            "note": "test-note",
            "is_completed": true,
            "supports": [
                {
                    "id": 6,
                    "name": "anim-355"
                }
            ],
            "ages": [
                {
                    "id": 8,
                    "name": "falc-203"
                }
            ]
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/feedings/items/1

Get Item Details

Retrieve Item details.

Retrieves detailed information about a specific Item 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": "QA Test Feed Item",
        "calories": "100.00",
        "unit": {
            "id": 15,
            "name": "feed-924"
        },
        "category": {
            "id": 14,
            "name": "feed-498"
        },
        "is_active": true,
        "note": "test-note",
        "is_completed": true,
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ]
    }
}

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	array	{ "en": "QA Test Falcon Feed Mix", "ar": "علف صقور اختبار الجودة" }
categories	array	[ { "category_id": 14 } ]
unit_id	integer	15
calories	integer	100
note	string	test-note
is_active	boolean	1
supports	array	[ { "support_id": 6 } ]
ages	array	[ { "age_id": 8 } ]
id	integer	1

Request Validations Or Notes

Field/Name	Examples
id	required, integer, exists feeding_items,id
name	required, array
name.ar	required, string, max 255
name.en	required, string, max 255
categories	required, array, min 1
categories[].category_id	required, integer, exists settings,id,type,feeding-category
unit_id	required, integer, exists settings,id,type,feeding-unit
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,animals-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": "QA Test Falcon Feed Mix",
        "calories": 100,
        "unit": {
            "id": 15,
            "name": "feed-924"
        },
        "category": {
            "id": 14,
            "name": "feed-498"
        },
        "is_active": true,
        "note": "test-note",
        "is_completed": true,
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ]
    }
}

PATCH /api/v1/feedings/items/1/toggle-active

Toggle Item Status

Switch the Item status between active and inactive.

Updates the status of the specified Item 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": "QA Test Falcon Feed Mix",
        "calories": "100.00",
        "unit": {
            "id": 15,
            "name": "feed-924"
        },
        "category": {
            "id": 14,
            "name": "feed-498"
        },
        "is_active": false,
        "note": "test-note",
        "is_completed": true,
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ]
    }
}

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": "QA Test Falcon Feed Mix",
            "calories": "100.00",
            "unit": {
                "id": 15,
                "name": "feed-655"
            },
            "category": {
                "id": 14,
                "name": "feed-354"
            },
            "is_active": false,
            "note": "test-note",
            "is_completed": true,
            "supports": [
                {
                    "id": 6,
                    "name": "anim-398"
                }
            ],
            "ages": [
                {
                    "id": 8,
                    "name": "falc-881"
                }
            ]
        }
    ],
    "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": "QA Test Falcon Feed Mix",
        "calories": "100.00",
        "unit": {
            "id": 15,
            "name": "feed-655"
        },
        "category": {
            "id": 14,
            "name": "feed-354"
        },
        "is_active": false,
        "note": "test-note",
        "is_completed": true,
        "supports": [
            {
                "id": 6,
                "name": "anim-398"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-881"
            }
        ]
    }
}

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	14
cost_per_unit	integer	100
calories	integer	100
note	string	test-note
is_active	boolean	1
supports	array	[ { "support_id": 6 } ]
ages	array	[ { "age_id": 8 } ]
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,animals-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, CompletedFeedingItemRule
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-21T10:48:23.000000Z",
        "category": {
            "id": 14,
            "name": "feed-498"
        },
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "items": [
            {
                "id": 1,
                "name": "QA Test Feed Item",
                "calories": "100.00",
                "unit": {
                    "id": 15,
                    "name": "feed-924"
                },
                "category": {
                    "id": 14,
                    "name": "feed-498"
                },
                "is_active": true
            }
        ]
    }
}

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-21T10:48:23.000000Z",
            "category": {
                "id": 14,
                "name": "feed-498"
            },
            "supports": [
                {
                    "id": 6,
                    "name": "anim-355"
                }
            ],
            "ages": [
                {
                    "id": 8,
                    "name": "falc-203"
                }
            ],
            "items": [
                {
                    "id": 1,
                    "name": "QA Test Feed Item",
                    "calories": "100.00",
                    "unit": {
                        "id": 15,
                        "name": "feed-924"
                    },
                    "category": {
                        "id": 14,
                        "name": "feed-498"
                    },
                    "is_active": true
                }
            ]
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/feedings/meals/1

Get Meal Details

Retrieve Meal details.

Retrieves detailed information about a specific Meal 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-item",
        "is_active": 1,
        "note": "test-note",
        "created_at": "2026-05-21T10:48:23.000000Z",
        "category": {
            "id": 14,
            "name": "feed-498"
        },
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "items": [
            {
                "id": 1,
                "name": "QA Test Falcon Feed Mix",
                "calories": "100.00",
                "unit": {
                    "id": 15,
                    "name": "feed-924"
                },
                "category": {
                    "id": 14,
                    "name": "feed-498"
                },
                "is_active": false
            }
        ]
    }
}

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	14
note	string	test-note
is_active	boolean	1
supports	array	[ { "support_id": 6 } ]
ages	array	[ { "age_id": 8 } ]
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,animals-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, CompletedFeedingItemRule
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-21T10:48:23.000000Z",
        "category": {
            "id": 14,
            "name": "feed-498"
        },
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "items": [
            {
                "id": 1,
                "name": "QA Test Falcon Feed Mix",
                "calories": "100.00",
                "unit": {
                    "id": 15,
                    "name": "feed-924"
                },
                "category": {
                    "id": 14,
                    "name": "feed-498"
                },
                "is_active": false
            }
        ]
    }
}

PATCH /api/v1/feedings/meals/1/toggle-active

Toggle Meal Status

Switch the Meal status between active and inactive.

Updates the status of the specified Meal 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": "test-item",
        "is_active": false,
        "note": "test-note",
        "created_at": "2026-05-21T10:48:23.000000Z",
        "category": {
            "id": 14,
            "name": "feed-498"
        },
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "items": [
            {
                "id": 1,
                "name": "QA Test Falcon Feed Mix",
                "calories": "100.00",
                "unit": {
                    "id": 15,
                    "name": "feed-924"
                },
                "category": {
                    "id": 14,
                    "name": "feed-498"
                },
                "is_active": false
            }
        ]
    }
}

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-21T10:48:23.000000Z",
            "category": {
                "id": 14,
                "name": "feed-354"
            },
            "supports": [
                {
                    "id": 6,
                    "name": "anim-398"
                }
            ],
            "ages": [
                {
                    "id": 8,
                    "name": "falc-881"
                }
            ],
            "items": [
                {
                    "id": 1,
                    "name": "QA Test Falcon Feed Mix",
                    "calories": "100.00",
                    "unit": {
                        "id": 15,
                        "name": "feed-655"
                    },
                    "category": {
                        "id": 14,
                        "name": "feed-354"
                    },
                    "is_active": false
                }
            ]
        }
    ],
    "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-21T10:48:23.000000Z",
        "category": {
            "id": 14,
            "name": "feed-354"
        },
        "supports": [
            {
                "id": 6,
                "name": "anim-398"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-881"
            }
        ],
        "items": [
            {
                "id": 1,
                "name": "QA Test Falcon Feed Mix",
                "calories": "100.00",
                "unit": {
                    "id": 15,
                    "name": "feed-655"
                },
                "category": {
                    "id": 14,
                    "name": "feed-354"
                },
                "is_active": false
            }
        ]
    }
}

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": 6 } ]
ages	array	[ { "age_id": 8 } ]
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,animals-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-21T10:48:24.000000Z",
        "supports": [
            {
                "id": 1,
                "plan_id": 1,
                "support_type": "settings",
                "support_id": 6,
                "created_at": "2026-05-21T10:48:24.000000Z",
                "updated_at": "2026-05-21T10:48:24.000000Z"
            }
        ],
        "ages": [
            {
                "id": 1,
                "plan_id": 1,
                "age_type": "settings",
                "age_id": 8,
                "created_at": "2026-05-21T10:48:24.000000Z",
                "updated_at": "2026-05-21T10:48:24.000000Z"
            }
        ],
        "meals": [
            {
                "id": 1,
                "plan_id": 1,
                "meal_id": 1,
                "quantity": "2.00",
                "timing": "08:30:00",
                "created_at": "2026-05-21T10:48:24.000000Z",
                "updated_at": "2026-05-21T10:48:24.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-21T10:48:24.000000Z",
            "supports": [
                {
                    "id": 6,
                    "name": "anim-355"
                }
            ],
            "ages": [
                {
                    "id": 8,
                    "name": "falc-203"
                }
            ],
            "meals": [
                {
                    "id": 1,
                    "name": "test-item"
                }
            ]
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/feedings/plans/1

Get Plan Details

Retrieve Plan details.

Retrieves detailed information about a specific 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": "Falcon Monthly Plan 1",
        "type": "monthly",
        "note": "Monthly feeding plan",
        "is_active": 1,
        "created_at": "2026-05-21T10:48:24.000000Z",
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "meals": [
            {
                "id": 1,
                "name": "test-item"
            }
        ]
    }
}

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": 6 } ]
ages	array	[ { "age_id": 8 } ]
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,animals-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-21T10:48:24.000000Z",
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "meals": [
            {
                "id": 1,
                "name": "test-item"
            }
        ]
    }
}

PATCH /api/v1/feedings/plans/1/toggle-active

Toggle Plan Status

Switch the Plan status between active and inactive.

Updates the status of the specified 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": "Falcon Monthly Plan 1",
        "type": "monthly",
        "note": "Monthly feeding plan",
        "is_active": false,
        "created_at": "2026-05-21T10:48:24.000000Z",
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "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-21T10:48:24.000000Z",
            "supports": [
                {
                    "id": 6,
                    "name": "anim-398"
                }
            ],
            "ages": [
                {
                    "id": 8,
                    "name": "falc-881"
                }
            ],
            "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-21T10:48:24.000000Z",
        "supports": [
            {
                "id": 6,
                "name": "anim-398"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-881"
            }
        ],
        "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

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-498
name_ar	string	أختبار للاعدادات836

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-498"
    }
}

GET /api/v1/settings/feeding-category

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": 14,
            "name": "feed-498",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/feeding-category/14

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": 14,
        "name": "feed-498",
        "is_active": 1
    }
}

PUT /api/v1/settings/feeding-category/14

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-354
name_ar	string	أختبار للاعدادات982
id	integer	14

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": 14,
        "name": "feed-354"
    }
}

PATCH /api/v1/settings/feeding-category/14

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": 14,
        "name": "feed-354"
    }
}

DELETE /api/v1/settings/feeding-category/14

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

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-381
name_ar	string	أختبار للاعدادات463

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": "feed-381"
    }
}

GET /api/v1/settings/feeding-meals-type

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": 16,
            "name": "feed-381",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/feeding-meals-type/16

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": 16,
        "name": "feed-381",
        "is_active": 1
    }
}

PUT /api/v1/settings/feeding-meals-type/16

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-103
name_ar	string	أختبار للاعدادات636
id	integer	16

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": 16,
        "name": "feed-103"
    }
}

PATCH /api/v1/settings/feeding-meals-type/16

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": 16,
        "name": "feed-103"
    }
}

DELETE /api/v1/settings/feeding-meals-type/16

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

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-924
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": "feed-924"
    }
}

GET /api/v1/settings/feeding-unit

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": 15,
            "name": "feed-924",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/feeding-unit/15

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": 15,
        "name": "feed-924",
        "is_active": 1
    }
}

PUT /api/v1/settings/feeding-unit/15

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-655
name_ar	string	أختبار للاعدادات996
id	integer	15

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": 15,
        "name": "feed-655"
    }
}

PATCH /api/v1/settings/feeding-unit/15

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": 15,
        "name": "feed-655"
    }
}

DELETE /api/v1/settings/feeding-unit/15

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

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-970
name_ar	string	أختبار للاعدادات764

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-970"
    }
}

GET /api/v1/settings/medical-category

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": 17,
            "name": "medi-970",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/medical-category/17

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": 17,
        "name": "medi-970",
        "is_active": 1
    }
}

PUT /api/v1/settings/medical-category/17

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-739
name_ar	string	أختبار للاعدادات497
id	integer	17

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": 17,
        "name": "medi-739"
    }
}

PATCH /api/v1/settings/medical-category/17

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": 17,
        "name": "medi-739"
    }
}

DELETE /api/v1/settings/medical-category/17

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

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-522
name_ar	string	أختبار للاعدادات540

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-522"
    }
}

GET /api/v1/settings/medical-unit

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": 18,
            "name": "medi-522",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/medical-unit/18

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": 18,
        "name": "medi-522",
        "is_active": 1
    }
}

PUT /api/v1/settings/medical-unit/18

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-849
name_ar	string	أختبار للاعدادات810
id	integer	18

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": 18,
        "name": "medi-849"
    }
}

PATCH /api/v1/settings/medical-unit/18

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": 18,
        "name": "medi-849"
    }
}

DELETE /api/v1/settings/medical-unit/18

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

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-280
name_ar	string	أختبار للاعدادات449

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-280"
    }
}

GET /api/v1/settings/medical-medicine-category

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": 19,
            "name": "medi-280",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/medical-medicine-category/19

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": 19,
        "name": "medi-280",
        "is_active": 1
    }
}

PUT /api/v1/settings/medical-medicine-category/19

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-307
name_ar	string	أختبار للاعدادات716
id	integer	19

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": 19,
        "name": "medi-307"
    }
}

PATCH /api/v1/settings/medical-medicine-category/19

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": 19,
        "name": "medi-307"
    }
}

DELETE /api/v1/settings/medical-medicine-category/19

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

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-409
name_ar	string	أختبار للاعدادات401

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": "medi-409"
    }
}

GET /api/v1/settings/medical-medicine-form

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": 20,
            "name": "medi-409",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/medical-medicine-form/20

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": 20,
        "name": "medi-409",
        "is_active": 1
    }
}

PUT /api/v1/settings/medical-medicine-form/20

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-545
name_ar	string	أختبار للاعدادات156
id	integer	20

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": 20,
        "name": "medi-545"
    }
}

PATCH /api/v1/settings/medical-medicine-form/20

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": 20,
        "name": "medi-545"
    }
}

DELETE /api/v1/settings/medical-medicine-form/20

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

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-995
name_ar	string	أختبار للاعدادات178

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": "medi-995"
    }
}

GET /api/v1/settings/medical-severity

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": 21,
            "name": "medi-995",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/medical-severity/21

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": 21,
        "name": "medi-995",
        "is_active": 1
    }
}

PUT /api/v1/settings/medical-severity/21

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-852
name_ar	string	أختبار للاعدادات294
id	integer	21

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": 21,
        "name": "medi-852"
    }
}

PATCH /api/v1/settings/medical-severity/21

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": 21,
        "name": "medi-852"
    }
}

DELETE /api/v1/settings/medical-severity/21

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": []
}

PUT /api/v1/medications/1/complete

Complete Medication

Complete an existing Medication.

Completes the specified Medication by filling the remaining required data. The system validates the request and updates the existing incomplete 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
form_id	integer	20
supports	array	[ { "support_id": 6 } ]
ages	array	[ { "age_id": 8 } ]

Request Validations Or Notes

Field/Name	Examples
form_id	required, integer, exists settings,id,type,medical-medicine-form
supports	required, array, min 1
supports[].support_id	required, integer, exists settings,id,type,animals-species
ages	required, array, min 1
ages[].age_id	required, integer, exists settings,id,type,falcon-age

Success (200 OK)

{
    "success": true,
    "message": "Medication completed successfully.",
    "data": {
        "id": 1,
        "name": "QA Test Medication Item",
        "unit": {
            "id": 18,
            "name": "medi-522"
        },
        "categories": [
            {
                "id": 19,
                "name": "medi-280"
            }
        ],
        "note": "QA test medication inventory item",
        "form": {
            "id": 20,
            "name": "medi-409"
        },
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "is_active": true,
        "is_completed": true,
        "created_at": "2026-05-21T10:48:21.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": "QA Test Medication Item",
            "unit": {
                "id": 18,
                "name": "medi-522"
            },
            "categories": [
                {
                    "id": 19,
                    "name": "medi-280"
                }
            ],
            "note": "QA test medication inventory item",
            "form": {
                "id": 20,
                "name": "medi-409"
            },
            "supports": [
                {
                    "id": 6,
                    "name": "anim-355"
                }
            ],
            "ages": [
                {
                    "id": 8,
                    "name": "falc-203"
                }
            ],
            "is_active": true,
            "is_completed": true,
            "created_at": "2026-05-21T10:48:21.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": "QA Test Medication Item",
        "unit": {
            "id": 18,
            "name": "medi-522"
        },
        "categories": [
            {
                "id": 19,
                "name": "medi-280"
            }
        ],
        "note": "QA test medication inventory item",
        "form": {
            "id": 20,
            "name": "medi-409"
        },
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "is_active": true,
        "is_completed": true,
        "created_at": "2026-05-21T10:48:21.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 ملغ (محدث)" }
notes	string	Updated notes: Keep refrigerated after opening
categories	array	[ { "category_id": 19 } ]
form_id	integer	20
unit_id	integer	18
is_active	boolean	1
supports	array	[ { "support_id": 6 } ]
ages	array	[ { "age_id": 8 } ]
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 categories,id
unit_id	optional, exists settings,id,type,medical-unit
form_id	optional, exists settings,id,type,medical-medicine-form
supports	optional, array, min 1
supports[].support_id	required, integer, exists settings,id,type,animals-species
ages	optional, array, min 1
ages[].age_id	required, integer, exists settings,id,type,falcon-age
categories	optional, array, min 1
categories[].category_id	required, integer, exists settings,id,type,medical-medicine-category
note	optional, string, max 255
is_active	optional, true/false

Success (200 OK)

{
    "success": true,
    "message": "Data updated successfully.",
    "data": {
        "id": 1,
        "name": "Amoxicillin Antibiotic 500mg (Updated)",
        "unit": {
            "id": 18,
            "name": "medi-522"
        },
        "categories": [
            {
                "id": 19,
                "name": "medi-280"
            }
        ],
        "note": "QA test medication inventory item",
        "form": {
            "id": 20,
            "name": "medi-409"
        },
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "is_active": true,
        "is_completed": true,
        "created_at": "2026-05-21T10:48:21.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)",
        "unit": {
            "id": 18,
            "name": "medi-522"
        },
        "categories": [
            {
                "id": 19,
                "name": "medi-280"
            }
        ],
        "note": "QA test medication inventory item",
        "form": {
            "id": 20,
            "name": "medi-409"
        },
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "is_active": false,
        "is_completed": true,
        "created_at": "2026-05-21T10:48:21.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)",
            "unit": null,
            "categories": [
                {
                    "id": 1,
                    "name": null
                }
            ],
            "note": "QA test medication inventory item",
            "form": null,
            "supports": [
                {
                    "id": 1,
                    "name": null
                }
            ],
            "ages": [
                {
                    "id": 1,
                    "name": null
                }
            ],
            "is_active": false,
            "is_completed": true,
            "created_at": "2026-05-21T10:48:21.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)",
        "unit": null,
        "categories": [
            {
                "id": 1,
                "name": null
            }
        ],
        "note": "QA test medication inventory item",
        "form": null,
        "supports": [
            {
                "id": 1,
                "name": null
            }
        ],
        "ages": [
            {
                "id": 1,
                "name": null
            }
        ],
        "is_active": false,
        "is_completed": true,
        "created_at": "2026-05-21T10:48:21.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	17
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
note	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-21T10:48:28.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": 17,
                "name": "medi-970"
            },
            "is_active": true,
            "created_at": "2026-05-21T10:48:28.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-21T10:48:28.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	17
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
note	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-21T10:48:28.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-21T10:48:28.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-21T10:48:28.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-21T10:48:28.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": 17 } ]
diagnosis	array	{ "diagnosis": "Test Diagnosis", "category_id": 17, "severity_id": 21, "note": "Test Diagnosis Note" }
procedures	array	{ "items": [ { "procedure_id": 1, "date": "2026-04-01", "time": "10:00" } ] }
medication_plan	array	{ "start_date": "2026-05-21", "end_date": "2026-05-24", "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-20260521-104829-RVZC28",
            "note": "Test Diagnosis Note",
            "action_by": 1,
            "is_active": true,
            "created_at": "2026-05-21T10:48:29.000000Z",
            "diagnoses": [
                {
                    "id": 1,
                    "diagnosis": "Test Diagnosis",
                    "category": {
                        "id": 17,
                        "name": "medi-970"
                    },
                    "severity": {
                        "id": 21,
                        "name": "medi-995"
                    }
                }
            ],
            "targets": [
                {
                    "id": 1,
                    "target_id": 17
                }
            ]
        },
        {
            "id": 2,
            "request_id": null,
            "action_type": "procedure",
            "action_code": "MED-20260521-104829-RVZC28",
            "note": null,
            "action_by": 1,
            "is_active": true,
            "created_at": "2026-05-21T10:48:29.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": 17
                }
            ]
        },
        {
            "id": 3,
            "request_id": null,
            "action_type": "medication",
            "action_code": "MED-20260521-104829-RVZC28",
            "note": "Test Medication Plan",
            "action_by": 1,
            "is_active": true,
            "created_at": "2026-05-21T10:48:29.000000Z",
            "medication_plans": [
                {
                    "id": 1,
                    "status": "active",
                    "start_date": "2026-05-21",
                    "end_date": "2026-05-24",
                    "items": [
                        {
                            "id": 1,
                            "medication": {
                                "id": 1,
                                "name": "QA Test Medication Item",
                                "unit": {
                                    "id": 18,
                                    "name": "medi-522"
                                },
                                "categories": [
                                    {
                                        "id": 19,
                                        "name": "medi-280"
                                    }
                                ]
                            },
                            "dose": "1 pill",
                            "doses_per_day": 2,
                            "repeat_every_days": 1,
                            "times": [
                                "08:00",
                                "20:00"
                            ]
                        }
                    ]
                }
            ],
            "targets": [
                {
                    "id": 3,
                    "target_id": 17
                }
            ]
        }
    ]
}

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-20260521-104829-RVZC28",
            "note": "Test Diagnosis Note",
            "action_by": 1,
            "is_active": true,
            "created_at": "2026-05-21T10:48:29.000000Z",
            "diagnoses": [
                {
                    "id": 1,
                    "diagnosis": "Test Diagnosis",
                    "category": {
                        "id": 17,
                        "name": "medi-970"
                    },
                    "severity": {
                        "id": 21,
                        "name": "medi-995"
                    }
                }
            ],
            "targets": [
                {
                    "id": 1,
                    "target_id": 17
                }
            ]
        },
        {
            "id": 2,
            "request_id": null,
            "action_type": "procedure",
            "action_code": "MED-20260521-104829-RVZC28",
            "note": null,
            "action_by": 1,
            "is_active": true,
            "created_at": "2026-05-21T10:48:29.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": 17
                }
            ]
        },
        {
            "id": 3,
            "request_id": null,
            "action_type": "medication",
            "action_code": "MED-20260521-104829-RVZC28",
            "note": "Test Medication Plan",
            "action_by": 1,
            "is_active": true,
            "created_at": "2026-05-21T10:48:29.000000Z",
            "medication_plans": [
                {
                    "id": 1,
                    "status": "active",
                    "start_date": "2026-05-21",
                    "end_date": "2026-05-24",
                    "items": [
                        {
                            "id": 1,
                            "medication": {
                                "id": 1,
                                "name": "QA Test Medication Item",
                                "unit": {
                                    "id": 18,
                                    "name": "medi-522"
                                },
                                "categories": [
                                    {
                                        "id": 19,
                                        "name": "medi-280"
                                    }
                                ]
                            },
                            "dose": "1 pill",
                            "doses_per_day": 2,
                            "repeat_every_days": 1,
                            "times": [
                                "08:00",
                                "20:00"
                            ]
                        }
                    ]
                }
            ],
            "targets": [
                {
                    "id": 3,
                    "target_id": 17
                }
            ]
        }
    ],
    "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-20260521-104829-RVZC28",
        "note": "Test Diagnosis Note",
        "action_by": 1,
        "is_active": true,
        "created_at": "2026-05-21T10:48:29.000000Z",
        "diagnoses": [
            {
                "id": 1,
                "diagnosis": "Test Diagnosis",
                "category": {
                    "id": 17,
                    "name": "medi-970"
                },
                "severity": {
                    "id": 21,
                    "name": "medi-995"
                }
            }
        ],
        "targets": [
            {
                "id": 1,
                "target_id": 17
            }
        ]
    }
}

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-20260521-104829-RVZC28",
        "note": "Test Diagnosis Note",
        "action_by": 1,
        "is_active": false,
        "created_at": "2026-05-21T10:48:29.000000Z",
        "diagnoses": [
            {
                "id": 1,
                "diagnosis": "Test Diagnosis",
                "category": {
                    "id": 17,
                    "name": "medi-970"
                },
                "severity": {
                    "id": 21,
                    "name": "medi-995"
                }
            }
        ],
        "targets": [
            {
                "id": 1,
                "target_id": 17
            }
        ]
    }
}

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-20260521-104829-RVZC28",
            "note": "Test Diagnosis Note",
            "action_by": 1,
            "is_active": false,
            "created_at": "2026-05-21T10:48:29.000000Z",
            "diagnoses": [
                {
                    "id": 1,
                    "diagnosis": "Test Diagnosis",
                    "category": null,
                    "severity": null
                }
            ],
            "targets": [
                {
                    "id": 1,
                    "target_id": 17
                }
            ]
        }
    ],
    "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-20260521-104829-RVZC28",
        "note": "Test Diagnosis Note",
        "action_by": 1,
        "is_active": false,
        "created_at": "2026-05-21T10:48:29.000000Z",
        "diagnoses": [
            {
                "id": 1,
                "diagnosis": "Test Diagnosis",
                "category": null,
                "severity": null
            }
        ],
        "targets": [
            {
                "id": 1,
                "target_id": 17
            }
        ]
    }
}

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

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-557
name_ar	string	أختبار للاعدادات754

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": "trai-557"
    }
}

GET /api/v1/settings/training-category

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": 22,
            "name": "trai-557",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/training-category/22

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": 22,
        "name": "trai-557",
        "is_active": 1
    }
}

PUT /api/v1/settings/training-category/22

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-435
name_ar	string	أختبار للاعدادات667
id	integer	22

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": 22,
        "name": "trai-435"
    }
}

PATCH /api/v1/settings/training-category/22

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": 22,
        "name": "trai-435"
    }
}

DELETE /api/v1/settings/training-category/22

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

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-620
name_ar	string	أختبار للاعدادات890

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": 23,
        "name": "trai-620"
    }
}

GET /api/v1/settings/training-rate

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": 23,
            "name": "trai-620",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/training-rate/23

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": 23,
        "name": "trai-620",
        "is_active": 1
    }
}

PUT /api/v1/settings/training-rate/23

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-102
name_ar	string	أختبار للاعدادات145
id	integer	23

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": 23,
        "name": "trai-102"
    }
}

PATCH /api/v1/settings/training-rate/23

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": 23,
        "name": "trai-102"
    }
}

DELETE /api/v1/settings/training-rate/23

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": 6 } ]
categories	array	[ { "category_id": 22 } ]
ages	array	[ { "age_id": 8 } ]
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,animals-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": 8,
                "name": "falc-203"
            }
        ],
        "categories": [
            {
                "id": 22,
                "name": "trai-557"
            }
        ],
        "trainers": [
            {
                "id": 2,
                "name": "Admin 2"
            }
        ],
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "note": null,
        "is_active": true,
        "created_at": "2026-05-21T10:48:30.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": 8,
                    "name": "falc-203"
                }
            ],
            "categories": [
                {
                    "id": 22,
                    "name": "trai-557"
                }
            ],
            "trainers": [
                {
                    "id": 2,
                    "name": "Admin 2"
                }
            ],
            "supports": [
                {
                    "id": 6,
                    "name": "anim-355"
                }
            ],
            "note": null,
            "is_active": true,
            "created_at": "2026-05-21T10:48:30.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": 8,
                "name": "falc-203"
            }
        ],
        "categories": [
            {
                "id": 22,
                "name": "trai-557"
            }
        ],
        "trainers": [
            {
                "id": 2,
                "name": null
            }
        ],
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "note": null,
        "is_active": true,
        "created_at": "2026-05-21T10:48:30.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": 6 } ]
categories	array	[ { "category_id": 22 } ]
ages	array	[ { "age_id": 8 } ]
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,animals-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": 8,
                "name": "falc-203"
            }
        ],
        "categories": [
            {
                "id": 22,
                "name": "trai-557"
            }
        ],
        "trainers": [
            {
                "id": 2,
                "name": null
            }
        ],
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "note": null,
        "is_active": true,
        "created_at": "2026-05-21T10:48:30.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": 8,
                "name": "falc-203"
            }
        ],
        "categories": [
            {
                "id": 22,
                "name": "trai-557"
            }
        ],
        "trainers": [
            {
                "id": 2,
                "name": null
            }
        ],
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "note": null,
        "is_active": false,
        "created_at": "2026-05-21T10:48:30.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": 6 } ]
ages	array	[ { "age_id": 8 } ]
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,animals-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",
                    "created_at": "2026-05-21",
                    "is_active": true
                },
                "is_active": true,
                "created_at": "2026-05-21T10:48:30.000000Z"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "note": null,
        "is_active": true,
        "created_at": "2026-05-21T10:48:30.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",
                        "created_at": "2026-05-21",
                        "is_active": true
                    },
                    "is_active": true,
                    "created_at": "2026-05-21T10:48:30.000000Z"
                }
            ],
            "ages": [
                {
                    "id": 8,
                    "name": "falc-203"
                }
            ],
            "supports": [
                {
                    "id": 6,
                    "name": "anim-355"
                }
            ],
            "note": null,
            "is_active": true,
            "created_at": "2026-05-21T10:48:30.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-21T10:48:30.000000Z"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "note": null,
        "is_active": true,
        "created_at": "2026-05-21T10:48:30.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": 6 } ]
ages	array	[ { "age_id": 8 } ]
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,animals-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-21T10:48:30.000000Z"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "note": null,
        "is_active": true,
        "created_at": "2026-05-21T10:48:30.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-21T10:48:30.000000Z"
            }
        ],
        "ages": [
            {
                "id": 8,
                "name": "falc-203"
            }
        ],
        "supports": [
            {
                "id": 6,
                "name": "anim-355"
            }
        ],
        "note": null,
        "is_active": false,
        "created_at": "2026-05-21T10:48:30.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

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-942
name_ar	string	أختبار للاعدادات524

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-942"
    }
}

GET /api/v1/settings/locations-country

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": 24,
            "name": "loca-942",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/locations-country/24

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": 24,
        "name": "loca-942",
        "is_active": 1
    }
}

PUT /api/v1/settings/locations-country/24

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-633
name_ar	string	أختبار للاعدادات632
id	integer	24

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": 24,
        "name": "loca-633"
    }
}

PATCH /api/v1/settings/locations-country/24

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": 24,
        "name": "loca-633"
    }
}

DELETE /api/v1/settings/locations-country/24

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

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-131
name_ar	string	أختبار للاعدادات106
parent_id	integer	24

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": 26,
        "name": "loca-131"
    }
}

GET /api/v1/settings/locations-city

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": 26,
            "name": "loca-131",
            "is_active": 1,
            "parent": {
                "id": 24,
                "name": "loca-942"
            }
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/locations-city/26

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": 26,
        "name": "loca-131",
        "is_active": 1,
        "parent": {
            "id": 24,
            "name": "loca-633"
        }
    }
}

PUT /api/v1/settings/locations-city/26

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-181
name_ar	string	أختبار للاعدادات184
id	integer	26

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": 26,
        "name": "loca-181"
    }
}

PATCH /api/v1/settings/locations-city/26

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": 26,
        "name": "loca-181"
    }
}

DELETE /api/v1/settings/locations-city/26

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

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-662
name_ar	string	أختبار للاعدادات236

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-662"
    }
}

GET /api/v1/settings/locations-type

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": 25,
            "name": "loca-662",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/locations-type/25

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": 25,
        "name": "loca-662",
        "is_active": 1
    }
}

PUT /api/v1/settings/locations-type/25

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-325
name_ar	string	أختبار للاعدادات217
id	integer	25

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": 25,
        "name": "loca-325"
    }
}

PATCH /api/v1/settings/locations-type/25

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": 25,
        "name": "loca-325"
    }
}

DELETE /api/v1/settings/locations-type/25

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

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-665
name_ar	string	أختبار للاعدادات851

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": 27,
        "name": "loca-665"
    }
}

GET /api/v1/settings/locations-subunit-type

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": 27,
            "name": "loca-665",
            "is_active": 1
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/locations-subunit-type/27

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": 27,
        "name": "loca-665",
        "is_active": 1
    }
}

PUT /api/v1/settings/locations-subunit-type/27

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-978
name_ar	string	أختبار للاعدادات923
id	integer	27

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": 27,
        "name": "loca-978"
    }
}

PATCH /api/v1/settings/locations-subunit-type/27

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": 27,
        "name": "loca-978"
    }
}

DELETE /api/v1/settings/locations-subunit-type/27

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

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-451
name_ar	string	أختبار للاعدادات160
parent_id	integer	27

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": 28,
        "name": "loca-451"
    }
}

GET /api/v1/settings/locations-subunit-sub-type

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": 28,
            "name": "loca-451",
            "is_active": 1,
            "parent": {
                "id": 27,
                "name": "loca-665"
            }
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

GET /api/v1/settings/locations-subunit-sub-type/28

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": 28,
        "name": "loca-451",
        "is_active": 1,
        "parent": {
            "id": 27,
            "name": "loca-978"
        }
    }
}

PUT /api/v1/settings/locations-subunit-sub-type/28

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-538
name_ar	string	أختبار للاعدادات805
id	integer	28

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": 28,
        "name": "loca-538"
    }
}

PATCH /api/v1/settings/locations-subunit-sub-type/28

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": 28,
        "name": "loca-538"
    }
}

DELETE /api/v1/settings/locations-subunit-sub-type/28

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	25
city_id	integer	26
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
note	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",
        "note": null,
        "city": {
            "id": 26,
            "name": "loca-131"
        },
        "type": {
            "id": 25,
            "name": "loca-662"
        },
        "links": [
            {
                "id": 1,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-21T10:48:25.000000Z",
        "updated_at": "2026-05-21T10:48:25.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",
            "note": null,
            "city": {
                "id": 26,
                "name": "loca-131"
            },
            "type": {
                "id": 25,
                "name": "loca-662"
            },
            "links": [
                {
                    "id": 1,
                    "name": "Map",
                    "url": "https:\/\/example.com\/map"
                }
            ],
            "is_active": true,
            "created_at": "2026-05-21T10:48:25.000000Z",
            "updated_at": "2026-05-21T10:48:25.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",
        "note": null,
        "city": {
            "id": 26,
            "name": "loca-131"
        },
        "type": {
            "id": 25,
            "name": "loca-662"
        },
        "links": [
            {
                "id": 1,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-21T10:48:25.000000Z",
        "updated_at": "2026-05-21T10:48:25.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	25
city_id	integer	26
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
note	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",
        "note": null,
        "city": {
            "id": 26,
            "name": "loca-131"
        },
        "type": {
            "id": 25,
            "name": "loca-662"
        },
        "links": [
            {
                "id": 1,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-21T10:48:25.000000Z",
        "updated_at": "2026-05-21T10:48:41.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",
        "note": null,
        "city": {
            "id": 26,
            "name": "loca-131"
        },
        "type": {
            "id": 25,
            "name": "loca-662"
        },
        "links": [
            {
                "id": 1,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": false,
        "created_at": "2026-05-21T10:48:25.000000Z",
        "updated_at": "2026-05-21T10:48:41.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	25
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
note	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",
        "note": null,
        "parent_id": 1,
        "parents": [
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 1
            }
        ],
        "unit_type": "building",
        "type": {
            "id": 25,
            "name": "loca-662"
        },
        "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-21T10:48:25.000000Z",
        "updated_at": "2026-05-21T10:48:25.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",
            "note": null,
            "parent_id": 1,
            "parents": [
                {
                    "id": 1,
                    "name": "Test Facility",
                    "type": "facilities",
                    "level": 1
                }
            ],
            "unit_type": "building",
            "type": {
                "id": 25,
                "name": "loca-662"
            },
            "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-21T10:48:25.000000Z",
            "updated_at": "2026-05-21T10:48:25.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",
        "note": null,
        "parent_id": 1,
        "parents": [
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 1
            }
        ],
        "unit_type": "building",
        "type": {
            "id": 25,
            "name": "loca-662"
        },
        "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-21T10:48:25.000000Z",
        "updated_at": "2026-05-21T10:48:25.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	25
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
note	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",
        "note": null,
        "parent_id": 1,
        "parents": [
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 1
            }
        ],
        "unit_type": "building",
        "type": {
            "id": 25,
            "name": "loca-662"
        },
        "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-21T10:48:25.000000Z",
        "updated_at": "2026-05-21T10:48:40.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",
        "note": null,
        "parent_id": 1,
        "parents": [
            {
                "id": 1,
                "name": "Test Facility",
                "type": "facilities",
                "level": 1
            }
        ],
        "unit_type": "building",
        "type": {
            "id": 25,
            "name": "loca-662"
        },
        "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-21T10:48:25.000000Z",
        "updated_at": "2026-05-21T10:48:40.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	25
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
note	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",
        "note": null,
        "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": 25,
            "name": "loca-662"
        },
        "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-21T10:48:26.000000Z",
        "updated_at": "2026-05-21T10:48:26.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",
            "note": null,
            "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": 25,
                "name": "loca-662"
            },
            "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-21T10:48:26.000000Z",
            "updated_at": "2026-05-21T10:48:26.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",
        "note": null,
        "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": 25,
            "name": "loca-662"
        },
        "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-21T10:48:26.000000Z",
        "updated_at": "2026-05-21T10:48:26.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	25
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
note	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",
        "note": null,
        "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": 25,
            "name": "loca-662"
        },
        "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-21T10:48:26.000000Z",
        "updated_at": "2026-05-21T10:48:39.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",
        "note": null,
        "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": 25,
            "name": "loca-662"
        },
        "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-21T10:48:26.000000Z",
        "updated_at": "2026-05-21T10:48:39.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	25
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
note	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",
        "note": null,
        "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": 25,
            "name": "loca-662"
        },
        "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-21T10:48:26.000000Z",
        "updated_at": "2026-05-21T10:48:26.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",
            "note": null,
            "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": 25,
                "name": "loca-662"
            },
            "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-21T10:48:26.000000Z",
            "updated_at": "2026-05-21T10:48:26.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",
        "note": null,
        "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": 25,
            "name": "loca-662"
        },
        "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-21T10:48:26.000000Z",
        "updated_at": "2026-05-21T10:48:26.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	25
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
note	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",
        "note": null,
        "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": 25,
            "name": "loca-662"
        },
        "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-21T10:48:26.000000Z",
        "updated_at": "2026-05-21T10:48:38.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",
        "note": null,
        "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": 25,
            "name": "loca-662"
        },
        "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-21T10:48:26.000000Z",
        "updated_at": "2026-05-21T10:48:38.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	26
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
note	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",
        "note": null,
        "city": {
            "id": 26,
            "name": "loca-131"
        },
        "links": [
            {
                "id": 5,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-21T10:48:27.000000Z",
        "updated_at": "2026-05-21T10:48:27.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",
            "note": null,
            "city": {
                "id": 26,
                "name": "loca-131"
            },
            "links": [
                {
                    "id": 5,
                    "name": "Map",
                    "url": "https:\/\/example.com\/map"
                }
            ],
            "is_active": true,
            "created_at": "2026-05-21T10:48:27.000000Z",
            "updated_at": "2026-05-21T10:48:27.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",
        "note": null,
        "city": {
            "id": 26,
            "name": "loca-131"
        },
        "links": [
            {
                "id": 5,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-21T10:48:27.000000Z",
        "updated_at": "2026-05-21T10:48:27.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	26
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
note	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",
        "note": null,
        "city": {
            "id": 26,
            "name": "loca-131"
        },
        "links": [
            {
                "id": 5,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": true,
        "created_at": "2026-05-21T10:48:27.000000Z",
        "updated_at": "2026-05-21T10:48:40.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",
        "note": null,
        "city": {
            "id": 26,
            "name": "loca-131"
        },
        "links": [
            {
                "id": 5,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": false,
        "created_at": "2026-05-21T10:48:27.000000Z",
        "updated_at": "2026-05-21T10:48:40.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",
            "note": null,
            "city": null,
            "links": [
                {
                    "id": 5,
                    "name": "Map",
                    "url": "https:\/\/example.com\/map"
                }
            ],
            "is_active": false,
            "created_at": "2026-05-21T10:48:27.000000Z",
            "updated_at": "2026-05-21T10:48:40.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",
        "note": null,
        "city": null,
        "links": [
            {
                "id": 5,
                "name": "Map",
                "url": "https:\/\/example.com\/map"
            }
        ],
        "is_active": false,
        "created_at": "2026-05-21T10:48:27.000000Z",
        "updated_at": "2026-05-21T10:49:04.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": []
}

POST /api/v1/inventory/suppliers

Create Supplier

Create a new Supplier.

Creates a new Supplier 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	QA Test Supplier
phone	string	0501234567
email	string	qa-supplier@test.com
address	string	123 Test Street, Riyadh
is_active	boolean	1
categories	array	[ { "category_id": 29 } ]

Request Validations Or Notes

Field/Name	Examples
name	required, string, max 255
phone	required, string, max 255
email	optional, valid email, max 255
address	required, string, max 255
categories	required, array, min 1
categories[].category_id	required, integer, exists settings,id,type,inventory-category
is_active	required, true/false

Success (200 OK)

{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 1,
        "name": "QA Test Supplier",
        "phone": "0501234567",
        "email": "qa-supplier@test.com",
        "address": "123 Test Street, Riyadh",
        "is_active": true,
        "categories": [],
        "created_at": "2026-05-21T10:48:21.000000Z"
    }
}

GET /api/v1/inventory/suppliers

Get Supplier List

Retrieve a list of Supplier.

Retrieves a list of Supplier 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": "QA Test Supplier",
            "phone": "0501234567",
            "email": "qa-supplier@test.com",
            "address": "123 Test Street, Riyadh",
            "is_active": true,
            "categories": [],
            "created_at": "2026-05-21T10:48:21.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 1,
        "last_page": 1
    }
}

POST /api/v1/inventory/items

Create Feeding Item

Create a new Feeding inventory 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
type	string	feeding
name	array	{ "en": "QA Test Feed Item", "ar": "مادة علف اختبار الجودة" }
categories	array	[ { "category_id": 14 } ]
unit_id	integer	15
note	string	QA test feeding inventory item
reorder_level	integer	5
initial_quantity	integer	5
unit_cost	double	25.5
supplier_id	integer	1

Request Validations Or Notes

Field/Name	Examples
type	required, In
name	required, array
name.ar	required, ArabicRoleName, UniqueInventoryItemName
name.en	required, EnglishRoleName, UniqueInventoryItemName
unit_id	optional, integer, exists settings,id, SourceUnitSettingTypeRule
reorder_level	optional, numeric, min 0
categories	required, array, min 1
categories[].category_id	required_with, integer, SourceCategorySettingTypeRule
note	optional, string
calories	optional, numeric, min 0
initial_quantity	required, numeric, min 0
unit_cost	required, numeric, min 0
supplier_id	optional, integer, exists inventory_suppliers,id
expiry_date	optional, date, after_or_equal
batch_no	optional, string, max 255
equipment_type	RequiredIf, optional, In

Success (200 OK)

{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 1,
        "item": {
            "id": 1,
            "name": "QA Test Feed Item",
            "calories": "0.00",
            "unit": {
                "id": 15,
                "name": "feed-924"
            },
            "category": {
                "id": 14,
                "name": "feed-498"
            },
            "is_active": true
        },
        "item_type": "feeding_item",
        "reorder_level": "5.000",
        "total_quantity": "5.000",
        "is_active": true,
        "batches": [
            {
                "id": 1,
                "quantity": "5.000",
                "unit_cost": "25.500",
                "expiry_date": null,
                "supplier": {
                    "id": 1,
                    "name": "QA Test Supplier"
                }
            }
        ],
        "created_at": "2026-05-21T10:48:21.000000Z"
    }
}

POST /api/v1/inventory/items

Create Medication Item

Create a new Medication inventory item.

Headers

Field/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
type	string	medication
name	array	{ "en": "QA Test Medication Item", "ar": "دواء اختبار الجودة" }
categories	array	[ { "category_id": 19 } ]
unit_id	integer	18
note	string	QA test medication inventory item
reorder_level	integer	5
initial_quantity	integer	5
unit_cost	double	15.25
supplier_id	integer	1

Request Validations Or Notes

Field/Name	Examples
type	required, In
name	required, array
name.ar	required, ArabicRoleName, UniqueInventoryItemName
name.en	required, EnglishRoleName, UniqueInventoryItemName
unit_id	optional, integer, exists settings,id, SourceUnitSettingTypeRule
reorder_level	optional, numeric, min 0
categories	required, array, min 1
categories[].category_id	required_with, integer, SourceCategorySettingTypeRule
note	optional, string
calories	optional, numeric, min 0
initial_quantity	required, numeric, min 0
unit_cost	required, numeric, min 0
supplier_id	optional, integer, exists inventory_suppliers,id
expiry_date	optional, date, after_or_equal
batch_no	optional, string, max 255
equipment_type	RequiredIf, optional, In

Success (200 OK)

{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 2,
        "item": {
            "id": 1,
            "name": "QA Test Medication Item",
            "unit": {
                "id": 18,
                "name": "medi-522"
            },
            "categories": [
                {
                    "id": 19,
                    "name": "medi-280"
                }
            ]
        },
        "item_type": "medication",
        "reorder_level": "5.000",
        "total_quantity": "5.000",
        "is_active": true,
        "batches": [
            {
                "id": 2,
                "quantity": "5.000",
                "unit_cost": "15.250",
                "expiry_date": null,
                "supplier": {
                    "id": 1,
                    "name": "QA Test Supplier"
                }
            }
        ],
        "created_at": "2026-05-21T10:48:21.000000Z"
    }
}

POST /api/v1/inventory/items

Create Equipment Item

Create a new Equipment inventory item.

Headers

Field/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
type	string	equipment
name	array	{ "en": "QA Test Equipment Item", "ar": "معدة اختبار الجودة" }
categories	array	[ { "category_id": 29 } ]
equipment_type	string	permanent
note	string	QA test equipment inventory item
reorder_level	integer	5
initial_quantity	integer	5
unit_cost	double	15.25
supplier_id	integer	1

Request Validations Or Notes

Field/Name	Examples
type	required, In
name	required, array
name.ar	required, ArabicRoleName, UniqueInventoryItemName
name.en	required, EnglishRoleName, UniqueInventoryItemName
unit_id	optional, integer, exists settings,id, SourceUnitSettingTypeRule
reorder_level	optional, numeric, min 0
categories	required, array, min 1
categories[].category_id	required_with, integer, SourceCategorySettingTypeRule
note	optional, string
calories	optional, numeric, min 0
initial_quantity	required, numeric, min 0
unit_cost	required, numeric, min 0
supplier_id	optional, integer, exists inventory_suppliers,id
expiry_date	optional, date, after_or_equal
batch_no	optional, string, max 255
equipment_type	RequiredIf, optional, In

Success (200 OK)

{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 3,
        "item": {
            "id": 1,
            "name": "QA Test Equipment Item"
        },
        "item_type": "equipment",
        "reorder_level": "5.000",
        "total_quantity": "5.000",
        "is_active": true,
        "batches": [
            {
                "id": 3,
                "quantity": "5.000",
                "unit_cost": "15.250",
                "expiry_date": null,
                "supplier": {
                    "id": 1,
                    "name": "QA Test Supplier"
                }
            }
        ],
        "created_at": "2026-05-21T10:48:21.000000Z"
    }
}

GET /api/v1/inventory/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,
            "item": {
                "id": 1,
                "name": "QA Test Feed Item",
                "calories": "0.00",
                "unit": {
                    "id": 15,
                    "name": "feed-924"
                },
                "category": {
                    "id": 14,
                    "name": "feed-498"
                },
                "is_active": true
            },
            "item_type": "feeding_item",
            "reorder_level": "5.000",
            "total_quantity": "5.000",
            "is_active": true,
            "batches": [
                {
                    "id": 1,
                    "quantity": "5.000",
                    "unit_cost": "25.500",
                    "expiry_date": null,
                    "supplier": {
                        "id": 1,
                        "name": "QA Test Supplier"
                    }
                }
            ],
            "created_at": "2026-05-21T10:48:21.000000Z"
        },
        {
            "id": 2,
            "item": {
                "id": 1,
                "name": "QA Test Medication Item",
                "unit": {
                    "id": 18,
                    "name": "medi-522"
                },
                "categories": [
                    {
                        "id": 19,
                        "name": "medi-280"
                    }
                ]
            },
            "item_type": "medication",
            "reorder_level": "5.000",
            "total_quantity": "5.000",
            "is_active": true,
            "batches": [
                {
                    "id": 2,
                    "quantity": "5.000",
                    "unit_cost": "15.250",
                    "expiry_date": null,
                    "supplier": {
                        "id": 1,
                        "name": "QA Test Supplier"
                    }
                }
            ],
            "created_at": "2026-05-21T10:48:21.000000Z"
        },
        {
            "id": 3,
            "item": {
                "id": 1,
                "name": "QA Test Equipment Item"
            },
            "item_type": "equipment",
            "reorder_level": "5.000",
            "total_quantity": "5.000",
            "is_active": true,
            "batches": [
                {
                    "id": 3,
                    "quantity": "5.000",
                    "unit_cost": "15.250",
                    "expiry_date": null,
                    "supplier": {
                        "id": 1,
                        "name": "QA Test Supplier"
                    }
                }
            ],
            "created_at": "2026-05-21T10:48:21.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 3,
        "last_page": 1
    }
}

POST /api/v1/inventory/purchases

Create Purchase

Create a new Purchase.

Creates a new Purchase 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
supplier_id	integer	1
purchase_date	string	2026-05-21
note	string	QA test purchase
categories	array	[ { "category_id": 29 } ]
items	array	[ { "inventory_item_id": 1, "quantity": 10, "unit_cost": 25.5, "expiry_date": "2027-05-21" } ]

Request Validations Or Notes

Field/Name	Examples
supplier_id	required, exists inventory_suppliers,id, SupplierSupportsCategories
categories	required, array, min 1
categories[].category_id	required, integer, exists settings,id,type,inventory-category
purchase_date	optional, date
note	optional, string
items	required, array, min 1
items[].inventory_item_id	required, exists inventory_items,id, ItemSupportsCategories
items[].quantity	required, numeric, min 0.01
items[].unit_cost	required, numeric, min 0
items[].expiry_date	optional, date, after_or_equal

Success (200 OK)

{
    "success": true,
    "message": "Data inserted successfully.",
    "data": {
        "id": 4,
        "purchase_no": "PO-202605-0004"
    }
}

GET /api/v1/inventory/purchases

Get Purchase List

Retrieve a list of Purchase.

Retrieves a list of Purchase 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,
            "purchase_no": "PO-202605-0001",
            "categories": [],
            "items": [
                {
                    "id": 1,
                    "inventory_item": {
                        "id": 1,
                        "item": {
                            "id": 1,
                            "name": "QA Test Feed Item",
                            "calories": "0.00",
                            "unit": {
                                "id": 15,
                                "name": "feed-924"
                            },
                            "category": {
                                "id": 14,
                                "name": "feed-498"
                            },
                            "is_active": true
                        },
                        "item_type": "feeding_item"
                    },
                    "quantity": "5.000",
                    "unit_cost": "25.500",
                    "total_cost": "127.500",
                    "expiry_date": null
                }
            ],
            "total_amount": "127.500",
            "supplier": {
                "id": 1,
                "name": "QA Test Supplier"
            },
            "note": null,
            "created_at": "2026-05-21T10:48:21.000000Z"
        },
        {
            "id": 2,
            "purchase_no": "PO-202605-0002",
            "categories": [],
            "items": [
                {
                    "id": 2,
                    "inventory_item": {
                        "id": 2,
                        "item": {
                            "id": 1,
                            "name": "QA Test Medication Item",
                            "unit": {
                                "id": 18,
                                "name": "medi-522"
                            },
                            "categories": [
                                {
                                    "id": 19,
                                    "name": "medi-280"
                                }
                            ]
                        },
                        "item_type": "medication"
                    },
                    "quantity": "5.000",
                    "unit_cost": "15.250",
                    "total_cost": "76.250",
                    "expiry_date": null
                }
            ],
            "total_amount": "76.250",
            "supplier": {
                "id": 1,
                "name": "QA Test Supplier"
            },
            "note": null,
            "created_at": "2026-05-21T10:48:21.000000Z"
        },
        {
            "id": 3,
            "purchase_no": "PO-202605-0003",
            "categories": [],
            "items": [
                {
                    "id": 3,
                    "inventory_item": {
                        "id": 3,
                        "item": {
                            "id": 1,
                            "name": "QA Test Equipment Item"
                        },
                        "item_type": "equipment"
                    },
                    "quantity": "5.000",
                    "unit_cost": "15.250",
                    "total_cost": "76.250",
                    "expiry_date": null
                }
            ],
            "total_amount": "76.250",
            "supplier": {
                "id": 1,
                "name": "QA Test Supplier"
            },
            "note": null,
            "created_at": "2026-05-21T10:48:21.000000Z"
        },
        {
            "id": 4,
            "purchase_no": "PO-202605-0004",
            "categories": [],
            "items": [
                {
                    "id": 4,
                    "inventory_item": {
                        "id": 1,
                        "item": {
                            "id": 1,
                            "name": "QA Test Feed Item",
                            "calories": "0.00",
                            "unit": {
                                "id": 15,
                                "name": "feed-924"
                            },
                            "category": {
                                "id": 14,
                                "name": "feed-498"
                            },
                            "is_active": true
                        },
                        "item_type": "feeding_item"
                    },
                    "quantity": "10.000",
                    "unit_cost": "25.500",
                    "total_cost": "255.000",
                    "expiry_date": "2027-05-21"
                }
            ],
            "total_amount": "255.000",
            "supplier": {
                "id": 1,
                "name": "QA Test Supplier"
            },
            "note": "QA test purchase",
            "created_at": "2026-05-21T10:48:22.000000Z"
        }
    ],
    "pagination": {
        "per_page": 10,
        "current_page": 1,
        "total": 4,
        "last_page": 1
    }
}