ZootAPI

Basic API to manage database interactions. It manages the following datapoints:

• venue
• title
• music_starts
• doors_open
• performance_date
• price
• description
• url
• image_url

Deployment

The API is managed via the serverless framework, using an AWS backend. To deploy, install the dependencies then run deploy using your desired AWS profile.

npm install
sls deploy --aws-profile <profile-name>

Functionality

All methods are within gigmanagement.py

Get Gigs

GET: gigs

By default returns all shows; shows from the past and future. The API supports querystring filtering by any of the above listed data points, eg:

/gigs?venue=jazzlab
/gigs?venue=paris_cat&performance_date=YYYY-MM-DD

The response is a JSON array containing the shows requested, eg:

[
    {
        "title": "Rob Burke presents: Paul Williamson and the Young GUNS",
        "venue": "jazzlab",
        "description": "Paul has built his reputation on the Australian jazz and improvisation scene as an individual voice in trumpet and composition. Tonight he is joined by some of the rising stars of the Australian jazz scene.  ",
        "performance_date": "2019-05-15",
        "doors_open": "8:00 PM",
        "music_starts": "8:30 PM",
        "price": 20,
        "url": "https://jazzlab.club/1089-rob-burke-presents-paul-williamson-and-the-young-guns",
        "image_url": "https://jazzlab.club/media/com_eventbooking/images/PW-Image.jpg"
    },
    {
        "title": "Raymond MacDonald (Scotland) + Rob Burke Quartet",
        "venue": "jazzlab",
        "description": "As a saxophonist and composer Raymond MacDonald's work is informed by a view of improvisation as a social, collaborative and uniquely creative process that provides opportunities to develop new ways of working musically. Raymond will be joined by Rob Burke (saxophone), Paul Grabowsky (piano), Nick Haywood (bass), Tony Floyd (drums)",
        "performance_date": "2019-05-29",
        "doors_open": "8:00 PM",
        "music_starts": "8:30 PM",
        "price": 20,
        "url": "https://jazzlab.club/1091-raymond-macdonald-scotland-rob-burke-quartet",
        "image_url": "https://jazzlab.club/media/com_eventbooking/images/RaymondMacDonald.jpg"
    }
]

Add Gigs

POST: gigs

Insert process to add new shows. The API supports both single & batch requests. Both require a gig object to be provided which should resemble:

{
    "venue": "venue",
    "title": "title",
    "music_starts": "HH:MM",
    "doors_open": "HH:MM",
    "performance_date": "YYYY-MM-DD",
    "price": price,
    "description": "description",
    "url": "url",
    "image_url": "image url" 
}

For single items, submit just the above object. For batch requests submit an array of them. Eg:

[
    {
    "venue": "venue",
    "title": "title",
    "music_starts": "HH:MM",
    "doors_open": "HH:MM",
    "performance_date": "YYYY-MM-DD",
    "price": price,
    "description": "description",
    "url": "url",
    "image_url": "image url" 
    },
    ...
]

The response is a JSON containing the number of records attempted, updated and added, eg:

{
    "records_attempted": 3,
    "records_updated": 2,
    "records_added": 1
}

Get Venues

GET: venues

No search options currently supported, it simply returns all available venues.

/venues

The response is a JSON array containing the all venues, eg:

[
    {
        "name": "303",
        "address": "303 High St, Northcote VIC 3070",
        "url": "https://303.net.au",
        "image_url": "https://scontent.fmel12-1.fna.fbcdn.net/v/t1.6435-9/120326041_3258664840837348_1752761260857739659_n.jpg?_nc_cat=104&ccb=1-4&_nc_sid=09cbfe&_nc_ohc=-pnqfV96YtYAX-HPha3&tn=15IMkiJDR1oObYeR&_nc_ht=scontent.fmel12-1.fna&oh=14cd416181c563b9ea4600ec4f633492&oe=6131BE46"
    },
    {
        "name": "Bird's Basement",
        "address": "11 Singers Ln, Melbourne VIC 3000",
        "url": "https://birdsbasement.com/",
        "image_url": "https://scontent.fmel12-1.fna.fbcdn.net/v/t1.18169-9/12193600_1660474057526040_1865837591702638753_n.jpg?_nc_cat=107&ccb=1-4&_nc_sid=09cbfe&_nc_ohc=f6RlLxkgFN0AX9HCtLh&_nc_ht=scontent.fmel12-1.fna&oh=ca322328ec45a857498ea35fc619e944&oe=61327BBA"
    }
]

Add Venue

POST: venues

Inserts a single venue into the DB. The request must reflect:

{
    "name": "Venue name",
    "address": "Venue address in the format of: 123 abc st, suburb VIC 3XXX",
    "url": "url to homepage",
    "image_url": "url to venue icon" 
}

The response is a JSON indicating the number of records attempted, whether the venue already existed & if the venue was added, eg:

{
    "attempted": 1,
    "already_existed": false,
    "added": 1
}