Routes

⚙️ All Routes for the Rest-API

Explore all available routes for the REST API, each requiring authentication via API Key. 🔑 Activate your key following the guidelines at How to activate ❌ For default failed responses, check Failed Response 📝 Base-URL: https://api.fivem-helper.eu

📦Fraction

Fraction Info

GET /:fractionid/info

Get current Information about a Fraction

Headers

Name	Value
Content-Type	application/json
Authorization	<APIKey>

Response

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
        }
    ]
}

Update Fraction Name

PATCH /:fractionid/name

Update the current fraction name

Headers

Name	Value
Content-Type	application/json
Authorization	<APIKey>

Body

Name	Value
Name	<NewName>

Response

200

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

400

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

Update Fraction Logo

PATCH /:fractionid/logo

Update the current fraction logo

Headers

Name	Value
Content-Type	application/json
Authorization	<APIKey>

Body

Name	Value
Logo	<LinkToLogo>

Response

200

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

400

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

🤖 Fraction Member

Fraction Member Add

POST /:fractionid/:discordid/addMember

Add a Fraction Member

Headers

Name	Value
Content-Type	application/json
Authorization	<APIKey>

Body

Name	Value
FirstName	String
LastName	String

Response

200

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

400

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

Fraction Member Kick

PUT /:fractionid/:discordid/kickMember

Kick a Fraction Member

Headers

Name	Value
Content-Type	application/json
Authorization	<APIKey>

Body

Name	Value
KickedById	String

200

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

Fraction Member Info

GET /:fractionid/:discordid/info

Get current Information about a Fraction Member

Headers

Name	Value
Content-Type	application/json
Authorization	<APIKey>

Response

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
        }
    ]
}

⏱️ Stamp Clock

Fraction Member Last Stamp

GET /:fractionid/:discordid/lastStamp

Get the last fraction member stamp

Headers

Name	Value
Content-Type	application/json
Authorization	<APIKey>

Response

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
        }
    ]
}

Fraction Member Previous Stamps

GET /:fractionid/:discordid/previousStamps

Get the previous fraction member stamps (Max. 15 Stamps)

Headers

Name	Value
Content-Type	application/json
Authorization	<APIKey>

Response

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
        }
    ]
}

Fraction Member Stamp

POST /:fractionid/:discordid/stamp

Stamp the current fraction member

Headers

Name	Value
Content-Type	application/json
Authorization	<APIKey>

Body

Name	Value
Type	<IN or OUT>

Response

200

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

400

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

🏖️ Holiday

Fraction Member Last Holiday

GET /:fractionid/:discordid/lastHoliday

Get the last fraction member holiday

Headers

Name	Value
Content-Type	application/json
Authorization	<APIKey>

Response

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
        }
    ]
}

Fraction Member Previous Holidays

GET /:fractionid/:discordid/previousHolidays

Get the previous fraction member holiday (Max. 15 Stamps)

Headers

Name	Value
Content-Type	application/json
Authorization	<APIKey>

Response

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
        }
    ]
}

Fraction Member Request Holiday

POST /:fractionid/:discordid/requestHoliday

Request a holiday for the current fraction member

Headers

Name	Value
Content-Type	application/json
Authorization	<APIKey>

Body

Name	Value
StartDate	Date (ISO 8601 Standard)
EndDate	Date (ISO 8601 Standard)
Reason	String

Response

200

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

400

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