API Documentation

Get event by id

GET 'eventposts/<eventid>'

• Author: İbrahim Kağan Bayat

• Definition: Allows a user to fetch an event from database

• Example Response Value:

  {
      "@context": "https://www.w3.org/ns/activitystreams",
      "summary": "Sally created an event",
      "type": "Create",
      "actor": {
          "type": "Person",
          "name": "Sally"
      },
      "object": {
          "type": "Event",
          "name": "A Simple Event",
          "postId": "",
          "ownerId": "",
          "content": "",
          "title": "Beginner friendly tennis game",
          "creationDate": "2014-11-31T23:00:00-08:00",
          "lastUpdateDate": "2014-11-31T23:00:00-08:00",
          "numberOfClicks": 0,
          "location": {
              "name": "Etiler Tennis Club",
              "type": "Place",
              "longitude": 12.34,
              "latitude": 56.78,
              "altitude": 90,
              "units": "m"
          },
          "eventDate": "2014-12-31T23 00 00-08 00",
          "eventSport": "Tennis",
          "eventMinAge": 16,
          "eventMaxAge": 18,
          "eventMinSkillLevel": 1,
          "eventMaxSkillLevel": 5,
          "eventPlayerCapacity": 12,
          "eventSpectatorCapacity": 12,
          "eventApplicants": [1,2,3],
          "eventPlayers": [1,2,3]
      }
  } 

• Parameters

  Parameter	Description	Parameter Type	Data Type
  eventid	ID of the searched event	Path	Int

• Response Messages

  • 200: Ok.
  • 404: Not Found.

Get all events

GET 'eventposts'

• Author: İbrahim Kağan Bayat

• Definition: Returns a list of post ids using filters.

• Example Response Value:

  {
      "pageNumber": 0,
      "totalPages": 3,
      "data":[
          1,2,3,4
      ]
  }

• Parameters

  Parameter	Description	Parameter Type	Data Type
  query	Query string	Query	String
  radius	Radius to find nearby events, unit is kilometers. Must be given.	Query	Integer
  latitude	Radius to find nearby events, unit is kilometers. Must be given.	Query	Integer
  longtitude	Radius to find nearby events, unit is kilometers. Must be given.	Query	Integer
  sport	Sport type of searched events. Only the events with the given sport type are displayed.	Query	String
  skillLevelMin	Minimum kill level of the searched events. It is an integer between 1-5. Other values are not accepted.	Query	Integer
  skillLevelMax	Maximum kill level of the searched events. It is an integer between 1-5. Other values are not accepted.	Query	Integer
  minAge	The lower bounds of the age group of events.	Query	Integer
  maxAge	The lower bounds of the age group of events.	Query	Integer
  dateBegin	A datetime object with format "%d/%m/%Y %H:%M:%S". Must be given together with dateEnd to filter the events that will take place between two dates. Events are filtered with respect to date and time separately. For example, when 06/06/2021 13:00:00 and 20/06/2021 15:00:00 are given as dateBegin and dateEnd, filtered events will take place in between 13:00:00 and 15:00:00, 07/06/2021 12:00:00 would not be returned for this query, even though its date is between the given dates.	Query	Datetime
  dateEnd	A datetime object with format "%d/%m/%Y %H:%M:%S". Must be given together with dateBegin.	Query	Datetime
  orderby	Column name to sort the events. title, content, eventSport, location, eventSkillLevel, eventDate can be used for sorting.	Query	String
  order	Direction of the sorting. Must be "asc" or "desc". "asc" results in ascending order and "desc" results in descending order.	Query	String
  page	Page number.	Query	Integer
  playerCapacityMin	Minimum player capacity of the searched event	Body	Integer
  playerCapacityMax	Maximum player capacity of the searched event	Body	Integer
  playerCapacityFull	Is the event player capacity full?	Body	Boolean

• Response Messages

  • 200: Ok.
  • 500: Internal server error.

Create an event

POST 'eventposts'

• Author: İbrahim Kağan Bayat

• Definition: Allows a user to create an event

• Example Response Value:

  {
      "@context": "https://www.w3.org/ns/activitystreams",
      "summary": "Sally created an event",
      "type": "Create",
      "actor": {
          "type": "Person",
          "name": "Sally"
      },
      "object": {
          "type": "Event",
          "name": "A Simple Event",
          "postId": "",
          "ownerId": "",
          "content": "",
          "title": "Beginner friendly tennis game",
          "creationDate": "2014-11-31T23:00:00-08:00",
          "lastUpdateDate": "2014-11-31T23:00:00-08:00",
          "numberOfClicks": 0,
          "location": {
              "name": "Etiler Tennis Club",
              "type": "Place",
              "longitude": 12.34,
              "latitude": 56.78,
              "altitude": 90,
              "units": "m"
          },
          "eventDate": "2014-12-31T23 00 00-08 00",
          "eventSport": "Tennis",
          "eventMinAge": 16,
          "eventMaxAge": 18,
          "eventMinSkillLevel": 1,
          "eventMaxSkillLevel": 5,
          "eventPlayerCapacity": 12,
          "eventSpectatorCapacity": 12,
          "eventApplicants": [1,2,3],
          "eventPlayers": [1,2,3]
      }
  } 

• Parameters

  Parameter	Description	Parameter Type	Data Type

• Response Messages

  • 201: Created.
  • 400: Bad request.