Calendar Linker API
Jan 1 2022 at 12:00 AM
The Calendar Linker service is used to synchronise a destination calendar with a source calendar. Any event changes on the source calendar is reflected on destination.
Prerequisites
To use this service you will first need to create a user in portal and link two calendars through the Calendar Linker Manager.
Getting Started
The service can be run directly in Visual Studio. The appsettings.json must be correctly configured to connect to the Dev stack in order for this service to process messages.
APIs within Calendar Linker API
CalendarLinker
API Calls
InsertLinkModel
Permission
calendar.linker:add
Accessible
Tenant only
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarLinker/InsertLinkModel
URL Params
NONE
Data Params
{
"calendarLink": {
"Id": "string",
"SourceCalendar": "string",
"DestinationCalendar": "string",
"Priority": "int",
"ExtendedProperties": {"string”: “string", "string”: “string"},
"Enabled": true
}
}
• calendarLink : CalendarLinkDto (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
InsertLinkParams
Permission
calendar.linker:add
Accessible
Tenant only
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarLinker/InsertLinkParams
URL Params
NONE
Data Params
{
"sourceCalendarId": "string",
"destinationCalendarId": "string",
"priority": 0,
"enabled": false
}
• sourceCalendarId: string (required)
• destinationCalendarId: string (required)
• priority: int
• enabled: bool
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
InsertLinks
Permission
calendar.linker:add
Accessible
Tenant only
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarLinker/InsertLinks
URL Params
NONE
Data Params
{
"calendarLinks": {
{
“Id”:”string”,
”SourceCalendar” : ”string”,
”DestinationCalendar” : ”string”,
”Priority” : 0,
”ExtendedProperties”:{”string”:”string”},
”Enabled” : true}
},
{
“Id”:”string”,
”SourceCalendar” : ”string”,
”DestinationCalendar” : ”string”,
”Priority” : 0,
”ExtendedProperties”:{”string”:”string”},
”Enabled” : true}
}
}
}
• calendarLinks: List
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
GetAll
Permission
calendar.linker:get
Accessible
Tenant only
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarLinker/GetAll
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
GetAllWithSource
Permission
calendar.linker:get
Accessible
Tenant only
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarLinker/GetAllWithSource
URL Params
NONE
Data Params
{
“sourceCalendarId”: “text”
}
• sourceCalendarId: 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
GetAllWithDestination
Permission
calendar.linker:get
Accessible
Tenant only
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarLinker/GetAllWithDestination
URL Params
NONE
Data Params
{
“destinationCalendarId”: “text”
}
• destinationCalendarId: 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
RemoveLinkParams
Permission
calendar.linker:delete
Accessible
Tenant only
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarLinker/RemoveLinkParams
URL Params
NONE
Data Params
{
“sourceCalendarId”: “text”,
“destinationCalendarId”: “text”
}
• sourceCalendarId: text (required) • destinationCalendarId: 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
ImportLinks
Permission
calendar.linker:import
Accessible
Tenant only
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarLinker/ImportLinks
URL Params
NONE
Data Params
{
“csv”:{JObject, JObject}
}
• csv: List
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
UpdateLink
Permission
calendar.linker:update
Accessible
Tenant only
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarLinker/UpdateLink
URL Params
NONE
Data Params
{
“calendarLink” : {
“Id”:”string”,
”SourceCalendar” : ”string”,
”DestinationCalendar” : ”string”,
”Priority” : 0,
”ExtendedProperties”:{”string”:”string”},
”Enabled” : true}
}
• calendarLink: CalendarLinkDto (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
GetLink
Permission
calendar.linker:get
Accessible
Tenant only
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarLinker/GetLink
URL Params
NONE
Data Params
{
“id” : "string"
}
• id: string (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
ExportAllLinks
Permission
calendar.linker:export
Accessible
Tenant only
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarLinker/ExportAllLinks
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