Skip to content

API Docs

eddrichjanzzenang edited this page Oct 10, 2018 · 3 revisions

Get Events

Endpoint: <api_url>/event

Event Object

Attribute Type Required Description
name String yes The name of the event
description String yes The description for the event
created_at DateTime no/autogenerated When the event was created
updated_at DateTime no/autogenerated When the event was updated
is_approved Boolean yes Indicates if the event has been approved by the admin
poster_url String yes The cloudinary hosted url of the event poster
event_url Boolean no A link to an existing event page
tags List yes A list of tags that belong the event
sanggu_hosts List no A list of sanggu_hosts for the event
office_hosts List no A list of office_hosts for the event
org_hosts List no A list of org_hosts for the event
event_logistics Object yes A list of event logistic objects

Sample Response:

{
    "id": 2,
    "name": "PULP",
    "sanggu_hosts": [],
    "office_hosts": [],
    "org_hosts": [
        2,
        28,
        32
    ],
    "description": "PULP is a conference by...",
    "poster_url": "https://res.cloudinary.com/dj3kdihst/image/upload/v1/media/images/logo-big.3d72fc4b_hv3won",
    "event_url": "http://bluehacks.compsat.org/",
    "tags": [
        4,
        3
    ],
    "event_logistics": [
        {
            "date": "2018-11-05",
            "start_time": "08:30:00",
            "end_time": "17:30:00",
            "venue": 5,
            "outside_venue_name": ""
        }
    ]
}


Pagination

Endpoint: <api_url>/event?page=<page_number>

MVP

  • Home page
  • Browse page
    • Reading events with filtering by entity, date–time, and tag
  • Entity accounts
    • Creating events
    • Updating events
    • Deleting events
    • Approval of org event submissions by an admin
  • Events
  • Event Logistics

Clone this wiki locally