Routes

استكشف جميع المسارات المتاحة لـ REST API، كل منها يتطلب مصادقة عبر مفتاح API.
🔑 قم بتفعيل مفتاحك وفقًا للإرشادات في how-to-activate.md
❌ للتحقق من الاستجابات الفاشلة الافتراضية، تحقق من failed-response.md
📝 Base-URL: https://api.fivem-helper.eu

📦 Fraction

معلومات الفصيل

GET /:fractionid/info

احصل على معلومات حالية حول فصيل.

🧾 الرؤوس

الاسم	القيمة
Content-Type	`application/json`
Authorization	`<APIKey>`

✅ الاستجابة 200

{
    "status": 200,
    "data": {
            "id": int,
            "isActive": int,
            "name": string,
            "img": string,
            "guildId": string,
            "categoryId": string,
            "roleId": string,
            "leaderInboxChannelId": string,
            "stampClockChannelId": string,
            "stampClockMessageId": string,
            "managementChannelId": string,
            "managementMessageId": string,
            "dutyListChannelId": string,
            "dutyListMessageId": string,
            "holidayListChannelId": string,
            "holidayListMessageId": string,
            "internalLogChannelId": string,
            "memberCount": int,
            "complaintCount": int,
            "derankCount": int,
            "gradesCount": int,
            "holidayCount": int,
            "kickCount": int,
            "meetingCount": int,
            "meetingCancellationCount": int,
            "panicCount": int,
            "promotionCount": int,
            "stampCount": int,
            "terminationCount": int,
            "uprankCount": int,
            "warnCount": int,
            "last_update": date (ISO 8601 standard),
            "created_at": date (ISO 8601 standard)
    },
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

تحديث اسم الفصيل

PATCH /:fractionid/name

قم بتحديث اسم الفصيل الحالي.

🧾 الرؤوس

الاسم	القيمة
Content-Type	`application/json`
Authorization	`<APIKey>`

📦 الجسم

الاسم	القيمة
Name	`<NewName>`

✅ الاستجابة 200

{
    "status": 200,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

❌ الاستجابة 400

{
    "status": 400,
    "message": string,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

تحديث شعار الفصيل

PATCH /:fractionid/logo

قم بتحديث شعار الفصيل الحالي.

🧾 الرؤوس

الاسم	القيمة
Content-Type	`application/json`
Authorization	`<APIKey>`

📦 الجسم

الاسم	القيمة
Logo	`<LinkToLogo>`

✅ الاستجابة 200

{
    "status": 200,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

❌ الاستجابة 400

{
    "status": 400,
    "message": string,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

🤖 عضو الفصيل

إضافة عضو فصيل

POST /:fractionid/:discordid/addMember

أضف عضوًا جديدًا إلى الفصيل.

🧾 الرؤوس

الاسم	القيمة
Content-Type	`application/json`
Authorization	`<APIKey>`

📦 الجسم

الاسم	القيمة
FirstName	`String`
LastName	`String`

✅ الاستجابة 200

{
    "status": 200,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

❌ الاستجابة 400

{
    "status": 400,
    "message": string,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

طرد عضو الفصيل

PUT /:fractionid/:discordid/kickMember

قم بطرد عضو الفصيل.

🧾 الرؤوس

الاسم	القيمة
Content-Type	`application/json`
Authorization	`<APIKey>`

📦 الجسم

الاسم	القيمة
KickedById	`String`

✅ الاستجابة 200

{
    "status": 200,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

معلومات عضو الفصيل

GET /:fractionid/:discordid/info

احصل على معلومات حالية حول عضو الفصيل.

🧾 الرؤوس

الاسم	القيمة
Content-Type	`application/json`
Authorization	`<APIKey>`

✅ الاستجابة 200

{
    "status": 200,
    "data": {
          "id": int,
          "userId": string,
          "firstName": string,
          "lastName": string,
          "isLeader": int,
          "gradeId": int,
          "grade": int,
          "gradeLabel": string,
          "dutyTime": int,
          "stampCount": int,
          "holidayCount": int,
          "promotionCount": int,
          "complaintCount": int,
          "meetingCancellationCount": int,
          "panicCount": int,
          "uprankCount": int,
          "derankCount": int,
          "warnCount": int,
          "last_update": date (ISO 8601 standard),
          "created_at": date (ISO 8601 standard)
    },
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

❌ الاستجابة 401

{
    "status": 401,
    "message": string,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

❌ الاستجابة 404

{
    "status": 404,
    "message": string,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

⏱️ ساعة الطوابع

آخر طابع لعضو الفصيل

GET /:fractionid/:discordid/lastStamp

احصل على آخر طابع لعضو الفصيل.

🧾 الرؤوس

الاسم	القيمة
Content-Type	`application/json`
Authorization	`<APIKey>`

✅ الاستجابة 200

{
    "status": 200,
    "data": {
        "id": int,
        "stampType": string,
        "stampTime": date (ISO 8601 standard)
    },
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

❌ الاستجابة 404

{
    "status": 404,
    "message": string,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

الطوابع السابقة لعضو الفصيل

GET /:fractionid/:discordid/previousStamps

احصل على الطوابع السابقة لعضو الفصيل (حد أقصى 15 طابع)

🧾 الرؤوس

الاسم	القيمة
Content-Type	`application/json`
Authorization	`<APIKey>`

✅ الاستجابة 200

{
    "status": 200,
    "data": [
        {
            "id": int,
            "stampType": string,
            "stampTime": date (ISO 8601 standard)
        }
        ... max 14 other stamps
    ],
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

❌ الاستجابة 404

{
    "status": 404,
    "message": string,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

طابع عضو الفصيل

POST /:fractionid/:discordid/stamp

قم بطابع عضو الفصيل الحالي

🧾 الرؤوس

الاسم	القيمة
Content-Type	`application/json`
Authorization	`<APIKey>`

📦 الجسم

الاسم	القيمة
Type	`<IN or OUT>`

✅ الاستجابة 200

{
    "status": 200,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

❌ الاستجابة 400

{
    "status": 400,
    "message": string,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

🏖️ عطلة

آخر عطلة لعضو الفصيل

GET /:fractionid/:discordid/lastHoliday

احصل على آخر عطلة لعضو الفصيل.

🧾 الرؤوس

الاسم	القيمة
Content-Type	`application/json`
Authorization	`<APIKey>`

✅ الاستجابة 200

{
    "status": 200,
    "data": {
        "isActive": boolean,
        "holidayStartDate": date (ISO 8601 standard),
        "holidayEndDate": date (ISO 8601 standard),
        "holidayReason": string
    },
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

❌ الاستجابة 404

{
    "status": 404,
    "message": string,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

العطلات السابقة لعضو الفصيل

GET /:fractionid/:discordid/previousHolidays

احصل على العطلات السابقة لعضو الفصيل (حد أقصى 15 طابع)

🧾 الرؤوس

الاسم	القيمة
Content-Type	`application/json`
Authorization	`<APIKey>`

✅ الاستجابة 200

{
    "status": 200,
    "data": [
        {
            "isActive": boolean,
            "holidayStartDate": date (ISO 8601 standard),
            "holidayEndDate": date (ISO 8601 standard),
            "holidayReason": string
        }
        ... max 14 other holidays
    ],
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

❌ الاستجابة 404

{
    "status": 404,
    "message": string,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

طلب عطلة لعضو الفصيل

POST /:fractionid/:discordid/requestHoliday

اطلب عطلة لعضو الفصيل الحالي.

🧾 الرؤوس

الاسم	القيمة
Content-Type	`application/json`
Authorization	`<APIKey>`

📦 الجسم

الاسم	القيمة
StartDate	`Date (ISO 8601 Standard)`
EndDate	`Date (ISO 8601 Standard)`
Reason	`String`

✅ الاستجابة 200

{
    "status": 200,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

❌ الاستجابة 400

{
    "status": 400,
    "message": string,
    "links": [
        {
            "docs": string,
            "support": string
        }
    ]
}

📦 Fraction​

معلومات الفصيل​

تحديث اسم الفصيل​

تحديث شعار الفصيل​

🤖 عضو الفصيل​

إضافة عضو فصيل​

طرد عضو الفصيل​

معلومات عضو الفصيل​

⏱️ ساعة الطوابع​

آخر طابع لعضو الفصيل​

الطوابع السابقة لعضو الفصيل​

طابع عضو الفصيل​

🏖️ عطلة​

آخر عطلة لعضو الفصيل​

العطلات السابقة لعضو الفصيل​

طلب عطلة لعضو الفصيل​

📦 Fraction

معلومات الفصيل

تحديث اسم الفصيل

تحديث شعار الفصيل

🤖 عضو الفصيل

إضافة عضو فصيل

طرد عضو الفصيل

معلومات عضو الفصيل

⏱️ ساعة الطوابع

آخر طابع لعضو الفصيل

الطوابع السابقة لعضو الفصيل

طابع عضو الفصيل

🏖️ عطلة

آخر عطلة لعضو الفصيل

العطلات السابقة لعضو الفصيل

طلب عطلة لعضو الفصيل