Skip to content

Venue API

Goran Nikic edited this page Feb 12, 2018 · 1 revision

The Venue API will allow you to fetch venues in the OC system.

List All Venues

GET /venues Returns a Paged Result containing the list of Venues.

Filters

  • "country" - String - "United Kingdom" - LIKE OPERATION
  • "city" - String - "London" - LIKE OPERATION
  • "name" - String - "HUB75" - LIKE OPERATION
  • "commercial" - Numeric - If the venue is commercial(1) or non-profit(2)
  • "status" - Numeric - "mike@test.com" - LIKE OPERATION

Get a Venue By ID

GET /venues/get/:id

Response

{
    "status": "OK",
    "code": 200,
    "messages": "common.SUCCESSFUL_REQUEST",
    "data": {
        "rows_per_page": 1,
        "total_rows": 44,
        "rows": [
            {
                "id": 65,
                "user_id": 159,
                "country": "United Kingdom",
                "address": "RG4 5NA",
                "lat": 51.4662,
                "lng": -0.954293,
                "city": "Reading",
                "images": "",
                "featured_image": "",
                "background_image": null,
                "name": "Amersham Road Youth and Community Centre",
                "screening": null,
                "commercial": null,
                "indoor": null,
                "outdoor_location": null,
                "seats": 20,
                "phone": 0,
                "description": "The Amersham Road Community Centre plans to renovate in 2017 and reopen as the hub of the local community. Indoor and outdoor activities which bring together neighbours and support well being will be paramount at this venue.",
                "hours": "Upon appointment",
                "created_at": "2016-12-07",
                "updated_at": "2016-12-07",
                "specifications": "[]",
                "features": "[{\"name\":\"Parking\",\"type\":2},{\"name\":\"Good for Children\",\"type\":2},{\"name\":\"Good for Groups\",\"type\":2},{\"name\":\"Outdoor Seating\",\"type\":2}]",
                "views": 0,
                "status": 1
            }
        ]
    }
}

Clone this wiki locally