Menu

#8753 Webservices plugin

Parent Category:
DPCalendar
Category:
Joomla plugins
Last Updated:
Allon Moritz, Tuesday, 23 November 2021 10:02 (Tuesday, 23 November 2021)
Created:
Friday, 03 September 2021 16:24 (Friday, 03 September 2021)
Hits:
296

Introduction

The webservices plugin from DPCalendar extends the official Joomla API endpoint of your web site with calendar data. This functionality is offered for developers who want to integrate event data in other websites or mobile applications.

The integrator has the possibility to read/write/update/delete events, calendars and locations. All returned data can be parsed as JSON, which is nowadays pretty much a standard for REST API's.

Make sure the Webservices - DPCalendar plugin is enabled. More information about the core API endpoints and how to access them can be found here. How to enable authentication can be found here.

Endpoints

DPCalendar offers the following endpoints as HTTP requests. The first word is the HTTP method to use. Parameters are starting with a double point. All endpoints are available under the following path "/api/index.php/v1". To get all events, use then "/api/index.php/v1/dpcalendar/events".

Events

  • GET /dpcalendar/events
    Get a list of events.
  • GET /dpcalendar/events/:id
    Get a single event by id.
  • POST /dpcalendar/events
    Create a new event, the body is the data of the new event.
  • PATCH /dpcalendar/events/:id
    Update an existing event by id, the body is the data of the updated event.
  • DELETE /dpcalendar/events/:id
    Deletes an event by id.

Calendars

  • GET /dpcalendar/calendars
    Get a list of calendars.
  • GET /dpcalendar/calendars/:id
    Get a single calendar by id.
  • POST /dpcalendar/calendars
    Create a new calendar, the body is the data of the new calendar.
  • PATCH /dpcalendar/calendars/:id
    Update an existing calendar by id, the body is the data of the updated calendar.
  • DELETE /dpcalendar/calendars/:id
    Deletes an calendar by id.

Locations

  • GET /dpcalendar/locations
    Get a list of locations.
  • GET /dpcalendar/locations/:id
    Get a single location by id.
  • POST /dpcalendar/locations
    Create a new location, the body is the data of the new location.
  • PATCH /dpcalendar/locations/:id
    Update an existing location by id, the body is the data of the updated location.
  • DELETE /dpcalendar/locations/:id
    Deletes an location by id.

Comments (0)

We use cookies on our website. Some of them are essential for the operation of the site, while others help us to improve this site and the user experience (tracking cookies). You can decide for yourself whether you want to allow cookies or not. Please note that if you reject them, you may not be able to use all the functionalities of the site.