[HTTP GET] ~/events/{eventId}
Description: Get the details of a specific Event
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
eventId |
The specific Event's Id |
integer |
Required |
Body Parameters
None
Response Information
Description
Successful Response - OK (200):
An Event
Response Content : Event
Name | Description | Type | Additional information |
---|---|---|---|
Id |
The Id of the Event |
integer |
None. |
Name |
The Name of the Event |
string |
None. |
Location |
The Location of the Event |
string |
None. |
Category |
The Event's category |
string |
None. |
Description |
A description of the Event |
string |
None. |
StartDate |
When the Event Starts |
date |
None. |
EndDate |
When the Event Ends |
date |
None. |
Organiser |
The Organiser's Name |
string |
None. |
OrganiserEmail |
The Organiser's Email Address |
string |
None. |
OrganiserMobile |
The Organiser's Mobile Number |
string |
None. |
RegistrationLimit |
The maximum amount of Attendees who can register to attend |
integer |
None. |
Response Codes:
-
200 - OK
- The specified Event was retrieved and returned successfully.
-
401 - Unauthorized
- Request has been denied as it lacks valid Authentication credentials.
-
403 - Forbidden
- The user does not have the relevant permissions to perform this action.
-
404 - NotFound
- The specified Event was not found.
-
500 - InternalServerError
- An error occurred while processing this request.
Formats
application/json, text/json
Sample:
{ "Id": 1, "Name": "sample string 2", "Location": "sample string 3", "Category": "sample string 4", "Description": "sample string 5", "StartDate": "2024-05-06T05:24:14.0722984+01:00", "EndDate": "2024-05-06T05:24:14.0722984+01:00", "Organiser": "sample string 7", "OrganiserEmail": "sample string 8", "OrganiserMobile": "sample string 9", "RegistrationLimit": 10 }
application/csp-report
Sample:
{"Id":1,"Name":"sample string 2","Location":"sample string 3","Category":"sample string 4","Description":"sample string 5","StartDate":"2024-05-06T05:24:14.0722984+01:00","EndDate":"2024-05-06T05:24:14.0722984+01:00","Organiser":"sample string 7","OrganiserEmail":"sample string 8","OrganiserMobile":"sample string 9","RegistrationLimit":10}
application/xml, text/xml
Sample:
<Event xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO"> <Category>sample string 4</Category> <Description>sample string 5</Description> <EndDate>2024-05-06T05:24:14.0722984+01:00</EndDate> <Id>1</Id> <Location>sample string 3</Location> <Name>sample string 2</Name> <Organiser>sample string 7</Organiser> <OrganiserEmail>sample string 8</OrganiserEmail> <OrganiserMobile>sample string 9</OrganiserMobile> <RegistrationLimit>10</RegistrationLimit> <StartDate>2024-05-06T05:24:14.0722984+01:00</StartDate> </Event>