ICalIntegration API

Jan 1 2022 at 12:00 AM

Prerequisites
APIs within ICalIntegration API
1. iCalIntegration
  1. API Calls

The iCalendar Integration Service is used to integrate a 3rd party calendar app supporting ical with entity calendars. It connects to a congifured mail account using imap to keep track of received emails containing ical info and also sends out emails using smtp with ical info.

The mail account optionally includes one or more approver emails. Additionaly the service orchestrates calendar event scheduling between an organiser and/or approver(s) for a room.

Prerequisites

To use this service you will need access to Portal UI in order to configure an iCal Integration in Calendar Linker Manager.

APIs within ICalIntegration API

iCalIntegration

API Calls

SetCalendarIntegration

Permission

calendar.ical:set

Accessible

All. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/iCalIntegration/SetCalendarIntegration

URL Params

None

Data Params

{
    "calendarIntegration":{
            "CalendarId": "string",
            "ImapHost": "string",
            "ImapPort": "int",
            "ImapUseSsl": "bool",
            "SmtpHost": "string",
            "SmtpPort": "int",
            "SmtpUseSsl": "bool",
            "Username": "string",
            "Password": "string",
            "Approvers": "string",
            "Enabled": "bool",
            "Status": "string",
            "LastMessage": "string",
            "LastDateTime": "DateTime"
    }
}

calendarIntegration: calendarIntergrationDto (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

GetCalendarIntegrations

Permission

calendar.ical:get

Accessible

All. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/iCalIntegration/GetCalendarIntegrations

URL Params

None

Data Params

None

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

GetCalendarIntegration

Permission

calendar.ical:get

Accessible

All. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/iCalIntegration/GetCalendarIntegration

URL Params

None

Data Params

{
    "calendarId":"text"
}

calendarId: text (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

RemoveCalendarIntegration

Permission

calendar.ical:delete

Accessible

All. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/iCalIntegration/RemoveCalendarIntegration

URL Params

None

Data Params

{
    "calendarId":"text"
}

calendarId: text (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

ImportCalendarIntegrations

Permission

calendar.ical:import

Accessible

All. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/iCalIntegration/ImportCalendarIntegrations

URL Params

None

Data Params

{
    "csv":{"Jobject", "Jobject"}
}

csv: List (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

ExportCalendarIntegrations

Permission

calendar.ical:export

Accessible

All. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/iCalIntegration/ExportCalendarIntegrations

URL Params

None

Data Params

None

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

SubscribeToUpdates

Permission

calendar.ical:get

Accessible

All. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/iCalIntegration/SubscribeToUpdates

URL Params

None

Data Params

None

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

UnsubscribeToUpdates

Permission

calendar.ical:get

Accessible

All. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/iCalIntegration/UnsubscribeToUpdates

URL Params

None

Data Params

None

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

TestSmtp

Permission

calendar.ical:test

Accessible

All. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/iCalIntegration/TestSmtp

URL Params

          {
"calendarId": "string",
"emailAddress": "string"
}

calendarId: string (Required)
emailAddress: string (Required)

Data Params

None

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

TestImap

Permission

calendar.ical:test

Accessible

All. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/iCalIntegration/TestImap

URL Params

          {
"calendarId": "string"
}

calendarId: string (Required)

Data Params

None

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

ICalIntegration API

Prerequisites

APIs within ICalIntegration API

iCalIntegration

API Calls

Continue reading

Community

Questions

Website