Ga naar hoofdinhoud

Routes

Verken alle beschikbare routes voor de REST API, die allemaal authenticatie via API-sleutel vereisen.
🔑 Activeer je sleutel volgens de richtlijnen op how-to-activate.md
❌ Voor standaard foutieve reacties, controleer failed-response.md
📝 Basis-URL: https://api.fivem-helper.eu

📦 Fractie

Fractie-informatie

GET /:fractionid/info

Krijg actuele informatie over een fractie.

🧾 Headers

NaamWaarde
Content-Typeapplication/json
Authorization<APIKey>

✅ Reactie 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 standaard),
"created_at": date (ISO 8601 standaard)
},
"links": [
{
"docs": string,
"support": string
}
]
}

Fractienaam bijwerken

PATCH /:fractionid/name

Werk de huidige fractienaam bij.

🧾 Headers

NaamWaarde
Content-Typeapplication/json
Authorization<APIKey>

📦 Body

NaamWaarde
Name<NewName>

✅ Reactie 200

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

❌ Reactie 400

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

Fractielogo bijwerken

PATCH /:fractionid/logo

Werk het huidige fractielogo bij.

🧾 Headers

NaamWaarde
Content-Typeapplication/json
Authorization<APIKey>

📦 Body

NaamWaarde
Logo<LinkToLogo>

✅ Reactie 200

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

❌ Reactie 400

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

🤖 Fractielid

Fractielid toevoegen

POST /:fractionid/:discordid/addMember

Voeg een nieuw fractielid toe.

🧾 Headers

NaamWaarde
Content-Typeapplication/json
Authorization<APIKey>

📦 Body

NaamWaarde
FirstNameString
LastNameString

✅ Reactie 200

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

❌ Reactie 400

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

Fractielid schoppen

PUT /:fractionid/:discordid/kickMember

Schop een fractielid.

🧾 Headers

NaamWaarde
Content-Typeapplication/json
Authorization<APIKey>

📦 Body

NaamWaarde
KickedByIdString

✅ Reactie 200

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

Fractielid informatie

GET /:fractionid/:discordid/info

Krijg actuele informatie over een fractielid.

🧾 Headers

NaamWaarde
Content-Typeapplication/json
Authorization<APIKey>

✅ Reactie 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 standaard),
"created_at": date (ISO 8601 standaard)
},
"links": [
{
"docs": string,
"support": string
}
]
}

❌ Reactie 401

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

❌ Reactie 404

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

⏱️ Stempelklok

Laatste stempel fractielid

GET /:fractionid/:discordid/lastStamp

Krijg de laatste stempel van een fractielid.

🧾 Headers

NaamWaarde
Content-Typeapplication/json
Authorization<APIKey>

✅ Reactie 200

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

❌ Reactie 404

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

Vorige stempels fractielid

GET /:fractionid/:discordid/previousStamps

Krijg de vorige stempels van een fractielid (max. 15 stempels)

🧾 Headers

NaamWaarde
Content-Typeapplication/json
Authorization<APIKey>

✅ Reactie 200

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

❌ Reactie 404

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

Fractielid stempelen

POST /:fractionid/:discordid/stamp

Stempel het huidige fractielid

🧾 Headers

NaamWaarde
Content-Typeapplication/json
Authorization<APIKey>

📦 Body

NaamWaarde
Type<IN of OUT>

✅ Reactie 200

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

❌ Reactie 400

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

🏖️ Vakantie

Laatste vakantie fractielid

GET /:fractionid/:discordid/lastHoliday

Krijg de laatste vakantie van een fractielid.

🧾 Headers

NaamWaarde
Content-Typeapplication/json
Authorization<APIKey>

✅ Reactie 200

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

❌ Reactie 404

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

Vorige vakanties fractielid

GET /:fractionid/:discordid/previousHolidays

Krijg de vorige vakanties van een fractielid (max. 15 stempels)

🧾 Headers

NaamWaarde
Content-Typeapplication/json
Authorization<APIKey>

✅ Reactie 200

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

❌ Reactie 404

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

Fractielid vakantie aanvragen

POST /:fractionid/:discordid/requestHoliday

Vraag een vakantie aan voor het huidige fractielid.

🧾 Headers

NaamWaarde
Content-Typeapplication/json
Authorization<APIKey>

📦 Body

NaamWaarde
StartDateDatum (ISO 8601 standaard)
EndDateDatum (ISO 8601 standaard)
ReasonString

✅ Reactie 200

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

❌ Reactie 400

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