Skip to main content
#P1783

GET /b2c/v1/office/users


Get Office/Company Users

این اندپوینت جهت دریافت لیست تمامی کاربران (Users) تعریف شده در زیرمجموعه یک شرکت یا آژانس (Colleague) استفاده می‌شود.
نکته مهم: دسترسی به این متد محدود است و تنها کاربرانی که سطح دسترسی آن‌ها مدیریت (Management) باشد مجاز به فراخوانی آن هستند. در غیر این صورت خطای 406 بازگردانده می‌شود.



Fetch Sub-Users

URL: /b2c/v1/office/users
Method: GET
Controller: V1UserController@usersOffice
Auth: Required (Bearer Token - Management Only)

Headers (الزامی)

Header Name Description
Authorization توکن احراز هویت (Bearer Token) کاربر مدیر.

Response Structure (Success)

Key Type Description
items Array لیست کاربران زیرمجموعه.
↳ id Integer شناسه کاربر.
↳ username String نام کاربری جهت ورود.
↳ category String دسته‌بندی نقش کاربر (مثلاً management, sales).
↳ level Integer سطح دسترسی عددی.
↳ ceiling Object تنظیمات سقف اعتبار (amount: مبلغ, deadline: مهلت).
↳ status Integer وضعیت کاربر (1: فعال، 0: غیرفعال).
meta.timestamp Timestamp زمان تولید پاسخ.

Example Responses

۱. موفقیت آمیز (مدیر):

{
    "items": [
        {
            "id": 10,
            "colleague": 55, 
            "username": "admin_agency",
            "category": "management",
            "level": 1,
            "ceiling": {
                "amount": false,
                "deadline": false
            },
            "expired_at": false,
            "created_at": "2023-01-01 10:00:00",
            "updated_at": "2023-05-20 14:30:00",
            "status": 1
        },
        {
            "id": 12,
            "colleague": 55,
            "username": "sales_counter",
            "category": "sales",
            "level": 2,
            "ceiling": {
                "amount": 5000000,
                "deadline": 1
            },
            "expired_at": "2024-12-29",
            "created_at": "2023-02-15 09:00:00",
            "updated_at": "2023-02-15 09:00:00",
            "status": 1
        }
    ],
    "meta": {
        "timestamp": 1702150000
    }
}

۲. خطا - عدم دسترسی (کاربر عادی):

{
    "error": {
        "code": 1000,
        "message": "دسترسی فقط برای سطح مدیریت"
    },
    "meta": {
        "timestamp": 1702150005
    }
}

Technical Logic

Request Received
↓
User Category == 'management'?
↓ Yes
Fetch Users
Query `colleague_auth`
Where `colleague` == Operator's Colleague ID
↓ No
Error 406
"Access Denied"
↓
Map & Format Data
Format Dates, Check Ceilings, Enrich Colleague Info (if applicable)
↓
Return JSON
Back to top