Calendar Events API (Reference) v1.0.0

Calendar events API reference.

info

You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which itself is generated from annotations in the source code of the project. It is possible that this documentation includes bugs and that code samples are incomplete or wrong.

Authentication

• JWT Bearer token
  • Header: Authorization: Bearer <JWT>. Authentication and authorization using a valid JWT token

Calendar Events

Get Google Calendar Event URL

GET /cal/events/google/{id}/event HTTP/1.1

Base paths: /cal

Get the Google Calendar event URL for an appointment.

Required authorization: none

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	ID specifies the unique identifier of the appointment for Google Calendar event retrieval.

Responses

Overview

Status	Meaning	Description	Schema
302	Found	The Google Calendar event URL was found and a redirection is made.	None
400	Bad Request	Bad request. The request was malformed or missing required fields.	None
404	Not Found	StatusNotFound. - No appointment found matching the specified id.	None
500	Internal Server Error	Internal Server Error. An unexpected error occurred, preventing the successful processing of the request.	None

caution

To perform this operation, you must be authenticated by means of one of the following methods: jwtBearerToken

Code samples

Shell

curl -X GET /cal/events/google/{id}/event \
  -H 'Authorization: Bearer <JWT>'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Authorization": []string{"Bearer <JWT>"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/cal/events/google/{id}/event", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Authorization': "Bearer <JWT>"
}

fetch('/cal/events/google/{id}/event', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/cal/events/google/{id}/event");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Authorization': "Bearer <JWT>"
}

r = requests.get(
  '/cal/events/google/{id}/event',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Authorization' => "Bearer <JWT>"
}

result = RestClient.get '/cal/events/google/{id}/event',
  params: {}, headers: headers

p JSON.parse(result)

Get iCalendar Event

GET /cal/events/ical/{id}/event HTTP/1.1

Base paths: /cal

Get appointment event calendar in iCalendar format.

Required authorization: none

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	Id specifies the unique identifier of the appointment used for either iCalendar or Google Calendar event retrieval.

Responses

Overview

Status	Meaning	Description	Schema
200	OK	iCalendar object - see rfc5546	None
400	Bad Request	Bad request. The request was malformed or missing required fields.	None
404	Not Found	StatusNotFound. - No appointment found matching the specified id.	None
500	Internal Server Error	Internal Server Error. An unexpected error occurred, preventing the successful processing of the request.	None

caution

To perform this operation, you must be authenticated by means of one of the following methods: jwtBearerToken

Code samples

Shell

curl -X GET /cal/events/ical/{id}/event \
  -H 'Authorization: Bearer <JWT>'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Authorization": []string{"Bearer <JWT>"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "/cal/events/ical/{id}/event", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Authorization': "Bearer <JWT>"
}

fetch('/cal/events/ical/{id}/event', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("/cal/events/ical/{id}/event");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Authorization': "Bearer <JWT>"
}

r = requests.get(
  '/cal/events/ical/{id}/event',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Authorization' => "Bearer <JWT>"
}

result = RestClient.get '/cal/events/ical/{id}/event',
  params: {}, headers: headers

p JSON.parse(result)