Skip to content

Events

Event List

GET /api/v2/event_list : List of events under a manager.

  • date_from and date_to are the date-range of the events to retrieve. The expected format is Y-m-d.

Only events that are flagged for API or website display (the "display event via API" / "website event" options in event planning) and whose event dates fall inside the requested range are returned.

Note: dates in the response are returned in dd.mm.yyyy format.

Example request

GET /api/v2/event_list?date_from=2021-05-10&date_to=2021-05-20&api_secret_key=<api_secret_key>

Example response

json
{
  "data":[
     {
        "id":1,
        "event_title":"Event 1",
        "marketing_data_title":"Test marketing title",
        "marketing_data_description":"Description",
        "date_from":"13.05.2021",
        "date_to":"14.05.2021",
        "time_from":"03:00",
        "time_to":"05:00",
        "entrance_time":"05:00",
        "beginning_time":"08:00",
        "marketing_data_ticket_link":"https:\/\/app.locaboo.com\/",
        "marketing_data_price":"12",
        "marketing_data_notice_text":"Test",
        "image":"https:\/\/app.locaboo.com\/files\/eplanning\/marketingdata\/262\/test_file1.jpg"
    },
    {
        "id":2,
        "event_title":"Event 2",
        "marketing_data_title":"Test marketing title",
        "marketing_data_description":"Description",
        "date_from":"15.05.2021",
        "date_to":"16.05.2021",
        "time_from":"03:00",
        "time_to":"05:00",
        "entrance_time":"05:00",
        "beginning_time":"08:00",
        "marketing_data_ticket_link":"https:\/\/app.locaboo.com\/",
        "marketing_data_price":"12",
        "marketing_data_notice_text":"Test",
        "image":"https:\/\/app.locaboo.com\/files\/eplanning\/marketingdata\/262\/test_file2.jpg"
    }
  ],
  "total":2,
  "success":true
}

Event Details

GET /api/v2/event_details/<event-id> : Details of event based on ID.

Example request

GET /api/v2/event_details/<event-id>?api_secret_key=<api_secret_key>

Example response

json
{
  "data":[
     {
      "id":"1",
      "event_title":"Event 1",
      "marketing_data_title":"Test Title",
      "marketing_data_description":"Test",
      "date_from":"13.05.2021",
      "date_to":"14.05.2021",
      "time_from":"06:28",
      "time_to":"12:00",
      "entrance_time":"04:00",
      "beginning_time":"09:00",
      "marketing_data_ticket_link":"",
      "marketing_data_price":"",
      "marketing_data_notice_text":"",
      "image":"https:\/\/app.locaboo.com\/files\/eplanning\/marketingdata\/262\/test_file1.jpg",
      "documents":[
        {
          "document_type":"Offer",
          "document_number":"OFFER 1",
          "price":11.5,
          "document_date":"13.05.2021",
          "processed_status":1,
          "processed_date":"14.05.2021",
          "bookings":[
            {
                "id":149293,
                "title":"Document test booking",
                "resources":[{
                  "resource_id":47,
                  "resource":"Sandkasten",
                  "instances":[
                     {
                        "id":6201748,
                        "resource_id":47,
                        "resource":"Sandkasten",
                        "from":"16.05.2021 09:00",
                        "to":"16.05.2021 17:00"
                     },
                     {
                        "id":6201749,
                        "resource_id":47,
                        "resource":"Sandkasten",
                        "from":"16.05.2021 09:00",
                        "to":"16.05.2021 17:00"
                     }
                  ]
                }]
             },
             {
                "id":193527,
                "title":"Test",
                "resources":[{
                  "resource_id":48,
                  "resource":"Stefan Test",
                  "instances":[
                     {
                        "id":5693679,
                        "resource_id":49,
                        "resource":"Stefan Test > Kleine Halle",
                        "from":"16.05.2021 12:00",
                        "to":"16.05.2021 12:15"
                     }
                  ]
                }]
             }
          ]
        },
        {
          "document_type":"Order confirmation",
          "document_number":"CONF 1",
          "price":12.65,
          "document_date":"14.05.2021",
          "processed_status":1,
          "processed_date":"15.05.2021",
          "bookings":[]
        },
        {
          "document_type":"Invoice",
          "document_number":"INVOICE 1",
          "price":12.65,
          "document_date":"15.05.2021",
          "processed_status":0,
          "processed_date":null,
          "bookings":[]
        }
      ]
    }
  ],
  "total":2,
  "success":true
}