gancio-upstream/docs/dev/api.md

1.9 KiB

layout title permalink parent nav_order
default API /dev/api Hacking 8
  1. TOC {:toc}

Get events

GET {: .label .label-green}

/api/events

Params

| start | integer | start timestamp (default: now) | | end | integer | end timestamp (optional) | | tags | array | List of tags | | places | array | List of places | | max | integer | Max events | | show_recurrent | boolean | Show also recurrent events (default: as choosen in admin settings) |

Example
https://demo.gancio.org/api/events
usage example


Add a new event

POST {: .label .label-orange}

/api/event

info "info" Content-Type has to be multipart/form-data to support image upload

Params

| title | string | event's title | | description | string | event's description (html accepted and sanitized) | | place_name | string | the name of the place | | place_address | string | the address of the place | | place_latitude | float | the latitude of the place | | place_longitude | float | the longitude of the place | | online_locations | array | List of online locations | | start_datetime | integer | start timestamp | | multidate | integer | is a multidate event? | | tags | array | List of tags | | recurrent | object | Recurrent event details | | recurrent.frequency | string | could be 1w or 2w | | recurrent.days | array | array of days | | image | image | Image |


Get current authenticated user

GET {: .label .label-green}

/api/user

Response

  {
    "description" : null,
    "recover_code" : "",
    "id" : 1,
    "createdAt" : "2020-01-29T18:10:16.630Z",
    "updatedAt" : "2020-01-30T22:42:14.789Z",
    "is_active" : true,
    "settings" : "{}",
    "email" : "eventi@cisti.org",
    "is_admin" : true
  }