OpenAPI definition (v0)

Download OpenAPI specification:Download

YUP - User Controller

This page document the RestAPI of User Controller. All the end-point of the application are specified.

Returns if exist the user by username

This end-point is useful to test if a username is available

Request Body schema: application/json
required

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

Update user details

Updates the user's details based on the provided UserUpdateRequest object.

Request Body schema: application/json

username	string
firstname	string
lastname	string
email	string
internal	boolean

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"internal": true
}

Register a new user

Register a new user in the system, after passing the anti-robot check

query Parameters

g-recaptcha-response

required

string

Request Body schema: application/json

username	string
firstname	string
lastname	string
email	string
password	string
confirmPassword	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"password": "string",
"confirmPassword": "string"
}

Delete a user

Deletes a user based on the user ID retrieved from an authentication cookie.

Responses

Change user password

Changes the password for a user identified by a cookie in the request.

query Parameters

required

object (ChangePasswordRequest)

Responses

Registration view

View the details of the logged user

Responses

Registration view

Show the registration page

Responses

YUP - Authentication Controller

This page document the RestAPI of Authentication Controller. All the end-point of the application are specified.

Authenticate a user

Authenticates the user with username and password, after passing the anti-robot check, sets a JWT token in a cookie, and redirects to the homepage.

query Parameters

g-recaptcha-response

required

string

Request Body schema: application/json

username	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Show login page

Returns the view for the login page, with an AuthenticationRequest object for binding the data.

Responses

Log out the current user

Logs out the current user by deleting the JWT cookie and redirects to the homepage.

Responses

YUP - EventController

This page document the RestAPI of Event Controller. All the end-point of the application are specified.

Create a new event

Creates a new event with the provided details.

Request Body schema: application/json

	object (EventRequest)
eventImageFile required	string <binary>

Responses

Request samples

Payload

Content type

application/json

{"event": {"name": "string",
"description": "string",
"location": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"endDateTime": "2019-08-24T14:15:22Z",
"eventImage": ["string"
],
"tag": "PARTY",
"latitude": "string",
"longitude": "string",
"participantsMaxNumber": 0
},
"eventImageFile": "string"
}

Delete an event

Deletes an event using the event ID if the user is authenticated and is the owner of the event.

query Parameters

eventId

required

string <uuid>

Responses

Get a specific Event

Retrieve the specified event using the ID of the event

path Parameters

eventId

required

string <uuid>

Responses

Get participants details of specified event

Retrieves the participants list of an event using the event ID if the user is authenticated and is the owner of the event.

path Parameters

eventId

required

string <uuid>

Responses

Retrieve the image for a specific event

Returns the image associated with the given event ID. The image is returned as a JPEG file.

path Parameters

eventId

required

string <uuid>

Responses

Show Event Form

Display the form for creating a new event.

Responses

Get events by owner

Retrieves a list of events owned by the authenticated user.

Responses

Get a specific event with owner view

Retrieve the specified event using the ID of the event

path Parameters

eventId

required

string <uuid>

Responses

Get All Events in format GEO Json

Retrieve all events in GeoJSON format

Responses

Get All Events

Retrieve a list of all events.

Responses

YUP - Reservation Controller

This page document the RestAPI of Reservation Controller. All the end-point of the application are specified.

Add a new reservation

Add a new reservation in the system for the couple User-Event

Request Body schema: application/json

eventId	string <uuid>
userId	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Check the reservation

This method allows to check the reservation of a participant

Request Body schema: application/json
required

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

Delete a reservation

Deletes a reservation for a given event ID and authenticated user.

query Parameters

eventId required	string <uuid>
userId required	string <uuid>

Responses

Get all the reservations

Get all the events reserved from the system inside the 'My Reservations' page

Responses

YUP - Error Controller

This page document the RestAPI of Error Controller. All the end-point of the application are specified.

Sending error email

This method allows reporting an exception to the team

Request Body schema: application/json
required

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

Error

Handle errors in the application

Responses

Error

Handle errors in the application

Responses

Error

Handle errors in the application

Responses

Error

Handle errors in the application

Responses

Error

Handle errors in the application

Responses

Error

Handle errors in the application

Responses

Error

Handle errors in the application

Responses

YUP - Generic Controller

This page document the RestAPI of Generic Controller. All the end-point of the application are specified.

Return the homepage

This end-point is used to return the homepage of the application

Responses

User

Returns if exist the user by username

This end-point is useful to test if a username is available

Request Body schema: application/json
required

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

Update user details

Updates the user's details based on the provided UserUpdateRequest object.

Request Body schema: application/json

username	string
firstname	string
lastname	string
email	string
internal	boolean

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"internal": true
}

Register a new user

Register a new user in the system, after passing the anti-robot check

query Parameters

g-recaptcha-response

required

string

Request Body schema: application/json

username	string
firstname	string
lastname	string
email	string
password	string
confirmPassword	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"password": "string",
"confirmPassword": "string"
}

Delete a user

Deletes a user based on the user ID retrieved from an authentication cookie.

Responses

Change user password

Changes the password for a user identified by a cookie in the request.

query Parameters

required

object (ChangePasswordRequest)

Responses

Registration view

View the details of the logged user

Responses

Registration view

Show the registration page

Responses

Post

Returns if exist the user by username

This end-point is useful to test if a username is available

Request Body schema: application/json
required

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

POST

Update user details

Updates the user's details based on the provided UserUpdateRequest object.

Request Body schema: application/json

username	string
firstname	string
lastname	string
email	string
internal	boolean

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"internal": true
}

Register a new user

Register a new user in the system, after passing the anti-robot check

query Parameters

g-recaptcha-response

required

string

Request Body schema: application/json

username	string
firstname	string
lastname	string
email	string
password	string
confirmPassword	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"password": "string",
"confirmPassword": "string"
}

Delete a user

Deletes a user based on the user ID retrieved from an authentication cookie.

Responses

Change user password

Changes the password for a user identified by a cookie in the request.

query Parameters

required

object (ChangePasswordRequest)

Responses

Sending error email

This method allows reporting an exception to the team

Request Body schema: application/json
required

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

Add a new reservation

Add a new reservation in the system for the couple User-Event

Request Body schema: application/json

eventId	string <uuid>
userId	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Check the reservation

This method allows to check the reservation of a participant

Request Body schema: application/json
required

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

Create a new event

Creates a new event with the provided details.

Request Body schema: application/json

	object (EventRequest)
eventImageFile required	string <binary>

Responses

Request samples

Payload

Content type

application/json

{"event": {"name": "string",
"description": "string",
"location": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"endDateTime": "2019-08-24T14:15:22Z",
"eventImage": ["string"
],
"tag": "PARTY",
"latitude": "string",
"longitude": "string",
"participantsMaxNumber": 0
},
"eventImageFile": "string"
}

Delete an event

Deletes an event using the event ID if the user is authenticated and is the owner of the event.

query Parameters

eventId

required

string <uuid>

Responses

Authenticate a user

Authenticates the user with username and password, after passing the anti-robot check, sets a JWT token in a cookie, and redirects to the homepage.

query Parameters

g-recaptcha-response

required

string

Request Body schema: application/json

username	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Error

Sending error email

This method allows reporting an exception to the team

Request Body schema: application/json
required

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

Error

Handle errors in the application

Responses

Error

Handle errors in the application

Responses

Error

Handle errors in the application

Responses

Error

Handle errors in the application

Responses

Error

Handle errors in the application

Responses

Error

Handle errors in the application

Responses

Error

Handle errors in the application

Responses

Reservation

Add a new reservation

Add a new reservation in the system for the couple User-Event

Request Body schema: application/json

eventId	string <uuid>
userId	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Check the reservation

This method allows to check the reservation of a participant

Request Body schema: application/json
required

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

Get all the reservations

Get all the events reserved from the system inside the 'My Reservations' page

Responses

Event

Create a new event

Creates a new event with the provided details.

Request Body schema: application/json

	object (EventRequest)
eventImageFile required	string <binary>

Responses

Request samples

Payload

Content type

application/json

{"event": {"name": "string",
"description": "string",
"location": "string",
"startDateTime": "2019-08-24T14:15:22Z",
"endDateTime": "2019-08-24T14:15:22Z",
"eventImage": ["string"
],
"tag": "PARTY",
"latitude": "string",
"longitude": "string",
"participantsMaxNumber": 0
},
"eventImageFile": "string"
}

Delete an event

Deletes an event using the event ID if the user is authenticated and is the owner of the event.

query Parameters

eventId

required

string <uuid>

Responses

Get a specific Event

Retrieve the specified event using the ID of the event

path Parameters

eventId

required

string <uuid>

Responses

Get participants details of specified event

Retrieves the participants list of an event using the event ID if the user is authenticated and is the owner of the event.

path Parameters

eventId

required

string <uuid>

Responses

Show Event Form

Display the form for creating a new event.

Responses

Get a specific event with owner view

Retrieve the specified event using the ID of the event

path Parameters

eventId

required

string <uuid>

Responses

Get All Events in format GEO Json

Retrieve all events in GeoJSON format

Responses

Get All Events

Retrieve a list of all events.

Responses

Auth

Authenticate a user

Authenticates the user with username and password, after passing the anti-robot check, sets a JWT token in a cookie, and redirects to the homepage.

query Parameters

g-recaptcha-response

required

string

Request Body schema: application/json

username	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Show login page

Returns the view for the login page, with an AuthenticationRequest object for binding the data.

Responses

Log out the current user

Logs out the current user by deleting the JWT cookie and redirects to the homepage.

Responses

GET

Registration view

View the details of the logged user

Responses

Registration view

Show the registration page

Responses

Get all the reservations

Get all the events reserved from the system inside the 'My Reservations' page

Responses

Return the homepage

This end-point is used to return the homepage of the application

Responses

Get a specific Event

Retrieve the specified event using the ID of the event

path Parameters

eventId

required

string <uuid>

Responses

Get participants details of specified event

Retrieves the participants list of an event using the event ID if the user is authenticated and is the owner of the event.

path Parameters

eventId

required

string <uuid>

Responses

Show Event Form

Display the form for creating a new event.

Responses

Get events by owner

Retrieves a list of events owned by the authenticated user.

Responses

Get a specific event with owner view

Retrieve the specified event using the ID of the event

path Parameters

eventId

required

string <uuid>

Responses

Get All Events in format GEO Json

Retrieve all events in GeoJSON format

Responses

Get All Events

Retrieve a list of all events.

Responses

Show login page

Returns the view for the login page, with an AuthenticationRequest object for binding the data.

Responses

Log out the current user

Logs out the current user by deleting the JWT cookie and redirects to the homepage.

OpenAPI definition (v0)

YUP - User Controller

Returns if exist the user by username

Request Body schema: application/jsonrequired

Responses

Request samples

Update user details

Request Body schema: application/json

Responses

Request samples

Register a new user

query Parameters

Request Body schema: application/json

Responses

Request samples

Delete a user

Responses

Change user password

query Parameters

Responses

Registration view

Responses

Registration view

Responses

YUP - Authentication Controller

Authenticate a user

query Parameters

Request Body schema: application/json

Responses

Request samples

Show login page

Responses

Log out the current user

Responses

YUP - EventController

Create a new event

Request Body schema: application/json

Responses

Request samples

Delete an event

query Parameters

Responses

Get a specific Event

path Parameters

Responses

Get participants details of specified event

path Parameters

Responses

Retrieve the image for a specific event

path Parameters

Responses

Show Event Form

Responses

Get events by owner

Responses

Get a specific event with owner view

path Parameters

Responses

Get All Events in format GEO Json

Responses

Get All Events

Responses

YUP - Reservation Controller

Add a new reservation

Request Body schema: application/json

Responses

Request samples

Check the reservation

Request Body schema: application/jsonrequired

Responses

Request samples

Delete a reservation

query Parameters

Responses

Get all the reservations

Responses

YUP - Error Controller

Sending error email

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required