Support & Documentation

Coding Help

POST
Register /register
POST
Login /api/login_check
GET
Get all users /api/users
GET
Get own profile /api/profile
PUT
Edit own profile /api/profile
DELETE
Delete profile /api/profile
POST
Upload profile image /api/profile/upload/image
GET
Get events wich we are in /api/profile/events
GET
Get our contributions /api/profile/contributions
GET
Get events wich we are in /api/profile/events
GET
Create Event /api/create/event
PUT
Edit Event /api/edit/event/{id}
GET
Get Events /api/events
GET
Get Events Private /api/event/private
GET
Get Events Public /api/event/public
GET
Get one event /api/event/{id}
GET
Search event /api/search/Event/{searchterm}
PATCH
Add administrator /api/event/{event id}/add/profile/{profile id}/as/administrator
DELETE
Add administrator /api/event/{event id}/remove/profile/{profile id }/from/administrators
PATCH
Join public event /api/join/event/{id event }
PATCH
Left public event /api/left/event/{id event }
PATCH
Close/canceled public event /api/event/{id event }
POST
Invite to private event /api/invite
PATCH
Accept invite /api/invite/{id invitation}/accept
PATCH
Refuse invite /api/invite/{id invitation}/refuse
POST
Create suggestion to event /api/event/{id event}/create/suggestion
PUT
Edit suggestion to event /api/edit/suggestion/{id suggestion}
DELETE
Delete suggestion to event /api/delete/suggestion/{id suggestion}
PATCH
Handle suggestion /api/suggestion/{id suggestion}
DELETE
Miss handle suggestion /api/suggestion/{id suggestion}
post
Create rebelle contribution /api/event/{event id}/suggestion/rebelle
PUT
Edit own contribution /api/edit/contribution/{id contribution}
DELETE
Delete own contribution /api/delete/contribution/{id contribution}

Register

POST
/register

This route doesn't need authentication

Body: 
JSON[
    {
        "displayName": "string (NOT NUL)",
        "email": "string (NOT NUL)",
        "password": "string (NOT NUL)"
    }
]
Response: 
JSON{
    "message": "ok"
}

Login

POST
/api/login_check

This route doesn't need authentication

Body: 
JSON[
    {
        "username": "string (NOT NUL)",
        "password": "string (NOT NUL)"
    }
]
Response: 
JSON{
    "token": "string"
}

Get all users

GET
/api/users

This route needs authentication

Body: 
JSON[]
Response: 
JSON{
    "id": "int (AI) ",
    "email": "string",
    "createdAt": "string (d.m.Y h:i)",
    "profile": {
        "id": "int (AI) ",
        "displayName": "string",
        "imageUrl": "string"
    },
    "0": [
        "..."
    ]
}

Get own profile

GET
/api/profile

This route needs authentication

Body: 
JSON[]
Response: 
JSON[
    {
        "id": "int (AI)",
        "displayName": "string",
        "imageUrl": "string",
        "userAssociated": {
            "id": "int (AI) ",
            "email": "string",
            "createdAt": "string (d.m.Y h:i)"
        },
        "0": [
            "..."
        ]
    }
]

Edit own profile

PUT
/api/profile

This route needs authentication

Body: 
JSON{
    "displayName": "string (NOT NULL)"
}
Response: 
JSON{
    "message": "ok"
}

Delete profile

DELETE
/api/profile

This route needs authentication

Body: 
JSON[]
Response: 
JSON{
    "message": "ok"
}

Upload profile image

POST
/api/profile/upload/image

This route needs authentication

Body: 
JSON{
    "formdata": "form data with key 'image'"
}
Response: 
JSON{
    "url": "string"
}

Get events wich we are in

GET
/api/profile/events

This route needs authentication

Body: 
JSON[]
Response: 
JSON[
    {
        "id": "int (AI) (NOT NULL)",
        "name": "string",
        "description": "string",
        "isPublic": "boolean",
        "startDate": "string (d.m.Y h:i)",
        "endDate": "string (d.m.Y h:i)",
        "isPublicPlace": "boolean",
        "state": "onSchedule\/canceled",
        "createdAt": "string (d.m.Y h:i)"
    },
    [
        "..."
    ]
]

Get our contributions

GET
/api/profile/contributions

This route needs authentication

Body: 
JSON[]
Response: 
JSON[
    {
        "id": "int (AI) (NOT NULL)",
        "description": "null because contirbution is attached to sughgestion",
        "suggestion": {
            "id": "int (AI) (NOT NULL)",
            "description": "string",
            "isTaken": "boolean"
        },
        "event": {
            "id": "int (AI) (NOT NULL)",
            "name": "string",
            "isPublic": "boolean",
            "startDate": "string (d.m.Y h:i)",
            "endDate": "string (d.m.Y h:i)",
            "description": "string",
            "isPublicPlace": "boolean",
            "state": "onSchedule\/canceled",
            "createdAt": "string (d.m.Y h:i)"
        }
    },
    {
        "id": "int (AI) (NOT NULL)",
        "description": "string (NOT NULL)",
        "suggestion": "NULL",
        "event": {
            "id": "int (AI) (NOT NULL)",
            "name": "string",
            "isPublic": "boolean",
            "startDate": "string (d.m.Y h:i)",
            "endDate": "string (d.m.Y h:i)",
            "description": "string",
            "isPublicPlace": "boolean",
            "state": "onSchedule\/canceled",
            "createdAt": "string (d.m.Y h:i)"
        }
    },
    [
        "..."
    ]
]

Get events wich we are in

GET
/api/profile/events

This route needs authentication

Body: 
JSON[]
Response: 
JSON[
    {
        "id": "int (AI) (NOT NULL)",
        "name": "string",
        "description": "string",
        "isPublic": "boolean",
        "startDate": "string (d.m.Y h:i)",
        "endDate": "string (d.m.Y h:i)",
        "isPublicPlace": "boolean",
        "state": "onSchedule\/canceled",
        "createdAt": "string (d.m.Y h:i)"
    },
    [
        "..."
    ]
]

Create Event

GET
/api/create/event

This route needs authentication

Body: 
JSON{
    "name": "create by max",
    "description": "string",
    "startDate": "17.12.2024 9=>50",
    "endDate": "18.12.2024 10=>43",
    "publicPlace": true,
    "public": false
}
Response: 
JSON[]

Edit Event

PUT
/api/edit/event/{id}

This route needs authentication

Body: 
JSON{
    "name": "create by max",
    "description": "string",
    "startDate": "17.12.2024 9=>50",
    "endDate": "18.12.2024 10=>43",
    "publicPlace": true,
    "public": false
}
Response: 
JSON[]

Get Events

GET
/api/events

This route needs authentication

Body: 
JSON[]
Response: 
JSON[
    {
        "id": "int (AI) (NOT NULL)",
        "name": "string",
        "isPublic": "boolean",
        "startDate": "string (d.m.Y h:i)",
        "endDate": "string (d.m.Y h:i)",
        "description": "string",
        "isPublicPlace": "boolean",
        "state": "onSchedule\/canceled",
        "createdAt": "string (d.m.Y h:i)"
    },
    [
        "..."
    ]
]

Get Events Private

GET
/api/event/private

This route needs authentication

Body: 
JSON[]
Response: 
JSON[
    {
        "id": "int (AI) (NOT NULL)",
        "name": "string",
        "isPublic": "boolean",
        "startDate": "string (d.m.Y h:i)",
        "endDate": "string (d.m.Y h:i)",
        "description": "string",
        "isPublicPlace": "boolean",
        "state": "onSchedule\/canceled",
        "createdAt": "string (d.m.Y h:i)"
    },
    [
        "..."
    ]
]

Get Events Public

GET
/api/event/public

This route needs authentication

Body: 
JSON[]
Response: 
JSON[
    {
        "id": "int (AI) (NOT NULL)",
        "name": "string",
        "isPublic": "boolean",
        "startDate": "string (d.m.Y h:i)",
        "endDate": "string (d.m.Y h:i)",
        "description": "string",
        "isPublicPlace": "boolean",
        "state": "onSchedule\/canceled",
        "createdAt": "string (d.m.Y h:i)"
    },
    [
        "..."
    ]
]

Get one event

GET
/api/event/{id}

This route needs authentication

Body: 
JSON[]
Response: 
JSON{
    "id": "int (AI) (NOT NULL)",
    "name": "string",
    "isPublic": "boolean",
    "startDate": "string (d.m.Y h:i)",
    "endDate": "string (d.m.Y h:i)",
    "description": "string",
    "isPublicPlace": "boolean",
    "state": "onSchedule\/canceled",
    "createdAt": "string (d.m.Y h:i)",
    "participants": [
        {
            "id": "int (AI) (NOT NULL)",
            "displayName": "string"
        }
    ],
    "invitations": [],
    "suggestions": [
        {
            "id": "int (AI) (NOT NULL)",
            "description": "string",
            "isTaken": true
        }
    ],
    "contributions": [
        {
            "id": "int (AI) (NOT NULL)",
            "description": null,
            "author": {
                "id": 5,
                "displayName": "Me\u00efMe\u00ef"
            },
            "suggestionId": 2
        },
        {
            "id": "int (AI) (NOT NULL)",
            "description": "string",
            "author": {
                "id": "int (AI) (NOT NULL)",
                "displayName": "Me\u00efMe\u00ef"
            },
            "suggestionId": null
        }
    ],
    "administrators": []
}

Search event

GET
/api/search/Event/{searchterm}

This route needs authentication

Body: 
JSON[]
Response: 
JSON[
    {
        "id": "int (AI) (NOT NULL)",
        "name": "string",
        "isPublic": "boolean",
        "startDate": "string (d.m.Y h:i)",
        "endDate": "string (d.m.Y h:i)",
        "description": "string",
        "isPublicPlace": "boolean",
        "state": "onSchedule\/canceled",
        "createdAt": "string (d.m.Y h:i)"
    },
    [
        "..."
    ]
]

Add administrator

PATCH
/api/event/{event id}/add/profile/{profile id}/as/administrator

This route needs authentication

Body: 
JSON[]
Response: 
JSON[]

Add administrator

DELETE
/api/event/{event id}/remove/profile/{profile id }/from/administrators

This route needs authentication

Body: 
JSON[]
Response: 
JSON[]

Join public event

PATCH
/api/join/event/{id event }

This route needs authentication

Body: 
JSON[]
Response: 
JSON[]

Left public event

PATCH
/api/left/event/{id event }

This route needs authentication

Body: 
JSON[]
Response: 
JSON[]

Close/canceled public event

PATCH
/api/event/{id event }

This route needs authentication

Body: 
JSON[]
Response: 
JSON[]

Invite to private event

POST
/api/invite

This route needs authentication

Body: 
JSON{
    "eventId": 20,
    "profileId": 16
}
Response: 
JSON[]

Accept invite

PATCH
/api/invite/{id invitation}/accept

This route needs authentication

Body: 
JSON[]
Response: 
JSON[]

Refuse invite

PATCH
/api/invite/{id invitation}/refuse

This route needs authentication

Body: 
JSON[]
Response: 
JSON[]

Create suggestion to event

POST
/api/event/{id event}/create/suggestion

This route needs authentication

Body: 
JSON{
    "description": "string (NOT NULL)"
}
Response: 
JSON[]

Edit suggestion to event

PUT
/api/edit/suggestion/{id suggestion}

This route needs authentication

Body: 
JSON{
    "description": "string (NOT NULL)"
}
Response: 
JSON[]

Delete suggestion to event

DELETE
/api/delete/suggestion/{id suggestion}

This route needs authentication

Body: 
JSON[]
Response: 
JSON[]

Handle suggestion

PATCH
/api/suggestion/{id suggestion}

This route needs authentication

Body: 
JSON[]
Response: 
JSON[]

Miss handle suggestion

DELETE
/api/suggestion/{id suggestion}

This route needs authentication

Body: 
JSON[]
Response: 
JSON[]

Create rebelle contribution

post
/api/event/{event id}/suggestion/rebelle

This route needs authentication

Body: 
JSON{
    "description": "string (NOT NULL)"
}
Response: 
JSON[]

Edit own contribution

PUT
/api/edit/contribution/{id contribution}

This route needs authentication

Body: 
JSON{
    "description": "string (NOT NULL)"
}
Response: 
JSON[]

Delete own contribution

DELETE
/api/delete/contribution/{id contribution}

This route needs authentication

Body: 
JSON[]
Response: 
JSON[]