Omni CMS Calendar API Documentation

Base URLLink to this section

https://api.calendar.moderncampus.net/

GET - Get public calendarLink to this section

Path: /pubcalendar/{calendar-id}
Description: Return the requested calendar info.
Status: Active

Parameters

Name	Location	Required	Type
calendar-id	path	true	string

Responses

Status Response

200 - Calendar info.

Status	Response
200 - Calendar info.	application/json { "timezoneLabel": "string", "color": "string", "submit": false, "showPhone": false, "timezone": "string", "title": "string", "locale": "string", "rsvp": false, "showMailTo": false, "personalization": false, "captchaSiteKey": "string", "modified": "string", "modifiedFormatted": "string", "id": "string", "autoscroll": true, "image": "string", "imageAltText": "string", "submitShowLink": false, "created": "string", "eventType": "string", "createdFormatted": "string", "privatte": false, "layout": "string", "hasSubmitPasscode": false, "site": "string", "googleMapKey": "string", "approvalRequired": false, "subtitle": "string", "featuredSlider": false, "font": "string" }

application/json

{
    "timezoneLabel": "string",
    "color": "string",
    "submit": false,
    "showPhone": false,
    "timezone": "string",
    "title": "string",
    "locale": "string",
    "rsvp": false,
    "showMailTo": false,
    "personalization": false,
    "captchaSiteKey": "string",
    "modified": "string",
    "modifiedFormatted": "string",
    "id": "string",
    "autoscroll": true,
    "image": "string",
    "imageAltText": "string",
    "submitShowLink": false,
    "created": "string",
    "eventType": "string",
    "createdFormatted": "string",
    "privatte": false,
    "layout": "string",
    "hasSubmitPasscode": false,
    "site": "string",
    "googleMapKey": "string",
    "approvalRequired": false,
    "subtitle": "string",
    "featuredSlider": false,
    "font": "string"
}

GET - Get categories in this calendarLink to this section

Path: /pubcalendar/{calendar-id}/categories
Description: Return the internal categories in this calendar.
Status: Active

Parameters

Name	Location	Required	Type
calendar-id	path	true	string

Responses

Status	Response
200 - Category info.	application/json `[ { "color": "string", "name": "string", "id": "string" } ]`

GET - Get eventsLink to this section

Path: /pubcalendar/{calendar-id}/events
Description: Get a list of events.
Status: Active

Parameters

Name	Location	Required	Type
calendar-id	path	true	string
featured	query	false	boolean
category	query	false	array
tag	query	false	array
start	query	false	string
end	query	false	string
expandInstances	query	false	boolean
query	query	false	string
count	query	false	integer

Responses

Status Response

200 - Events list.

Status	Response
200 - Events list.	application/json [ { "startDatetime": "string", "ticketUrl": "string", "featured": false, "submissionName": "string", "endDate": "string", "timezone": "string", "subject": "string", "ticketOption": "string", "description": "string", "ticketPriceMinimum": "string", "descriptionText": "string", "title": "string", "type": "string", "categoryName": "string", "posted": "string", "submissionType": "string", "rrule": "string", "locationOther": "string", "locationDetail": "object", "ticketCurrency": "string", "modified": "string", "id": "string", "modifiedFormatted": "string", "ticketPriceMaximum": "string", "image": "string", "imageAltText": "string", "recurring": false, "postedFormatted": "string", "created": "string", "createdFormatted": "string", "tags": "array", "locationRoom": "string", "organizer": "string", "ticketButtonLabel": "string", "location": "string", "exdates": "array", "organizerDetail": "object", "category": "string", "startDate": "string", "endDatetime": "string", "status": "string" } ]

application/json

[
    {
        "startDatetime": "string",
        "ticketUrl": "string",
        "featured": false,
        "submissionName": "string",
        "endDate": "string",
        "timezone": "string",
        "subject": "string",
        "ticketOption": "string",
        "description": "string",
        "ticketPriceMinimum": "string",
        "descriptionText": "string",
        "title": "string",
        "type": "string",
        "categoryName": "string",
        "posted": "string",
        "submissionType": "string",
        "rrule": "string",
        "locationOther": "string",
        "locationDetail": "object",
        "ticketCurrency": "string",
        "modified": "string",
        "id": "string",
        "modifiedFormatted": "string",
        "ticketPriceMaximum": "string",
        "image": "string",
        "imageAltText": "string",
        "recurring": false,
        "postedFormatted": "string",
        "created": "string",
        "createdFormatted": "string",
        "tags": "array",
        "locationRoom": "string",
        "organizer": "string",
        "ticketButtonLabel": "string",
        "location": "string",
        "exdates": "array",
        "organizerDetail": "object",
        "category": "string",
        "startDate": "string",
        "endDatetime": "string",
        "status": "string"
    }
]

GET - Get an eventLink to this section

Path: /pubcalendar/{calendar-id}/events/{event-id}
Description: Return the requested event info.
Status: Active

Parameters

Name	Location	Required	Type
calendar-id	path	true	string
event-id	path	true	string

Responses

Status Response

200 - Event Info.

Status	Response
200 - Event Info.	application/json { "startDatetime": "string", "ticketUrl": "string", "featured": false, "submissionName": "string", "endDate": "string", "subject": "string", "ticketOption": "string", "ticketPriceMinimum": "string", "type": "string", "rsvp": false, "rrule": "string", "rsvpMaximum": "integer", "locationDetail": "object", "ticketCurrency": "string", "submissionEmail": "string", "modified": "string", "id": "string", "conferenceButtonLabel": "string", "image": "string", "imageAltText": "string", "created": "string", "rsvpAvailable": "integer", "createdFormatted": "string", "tags": "array", "customAttr": "string", "locationRoom": "string", "ticketButtonLabel": "string", "submissionPhone": "string", "startDate": "string", "endDatetime": "string", "status": "string", "rsvpStart": "string", "timezone": "string", "submissionAbout": "string", "description": "string", "title": "string", "categoryName": "string", "posted": "string", "submissionType": "string", "locationOther": "string", "conferenceLink": "string", "rsvpEnd": "string", "modifiedFormatted": "string", "ticketPriceMaximum": "string", "postedFormatted": "string", "organizer": "string", "location": "string", "exdates": "array", "organizerDetail": "object", "category": "string" }

application/json

{
    "startDatetime": "string",
    "ticketUrl": "string",
    "featured": false,
    "submissionName": "string",
    "endDate": "string",
    "subject": "string",
    "ticketOption": "string",
    "ticketPriceMinimum": "string",
    "type": "string",
    "rsvp": false,
    "rrule": "string",
    "rsvpMaximum": "integer",
    "locationDetail": "object",
    "ticketCurrency": "string",
    "submissionEmail": "string",
    "modified": "string",
    "id": "string",
    "conferenceButtonLabel": "string",
    "image": "string",
    "imageAltText": "string",
    "created": "string",
    "rsvpAvailable": "integer",
    "createdFormatted": "string",
    "tags": "array",
    "customAttr": "string",
    "locationRoom": "string",
    "ticketButtonLabel": "string",
    "submissionPhone": "string",
    "startDate": "string",
    "endDatetime": "string",
    "status": "string",
    "rsvpStart": "string",
    "timezone": "string",
    "submissionAbout": "string",
    "description": "string",
    "title": "string",
    "categoryName": "string",
    "posted": "string",
    "submissionType": "string",
    "locationOther": "string",
    "conferenceLink": "string",
    "rsvpEnd": "string",
    "modifiedFormatted": "string",
    "ticketPriceMaximum": "string",
    "postedFormatted": "string",
    "organizer": "string",
    "location": "string",
    "exdates": "array",
    "organizerDetail": "object",
    "category": "string"
}

GET - Get an event ics fileLink to this section

Path: /pubcalendar/{calendar-id}/events/{event-id}/ics
Description: Return the requested event ics file.
Status: Active

Parameters

Name	Location	Required	Type
calendar-id	path	true	string
event-id	path	true	string
url	query	false	string
text	query	false	boolean
hash	query	false	boolean

Responses

Status	Response
200 - Calendar ics file.	application/octet-stream

GET - Get an instance of recurring eventLink to this section

Path: /pubcalendar/{calendar-id}/events/{event-id}/instances/{date}
Description: Return the requested recurring event instance info.
Status: Active

Parameters

Name	Location	Required	Type
calendar-id	path	true	string
event-id	path	true	string
date	path	true	string

Responses

Status Response

200 - Event Instance Info.

Status	Response
200 - Event Instance Info.	application/json { "startDatetime": "string", "ticketUrl": "string", "featured": false, "submissionName": "string", "endDate": "string", "subject": "string", "ticketOption": "string", "ticketPriceMinimum": "string", "type": "string", "rsvp": false, "rrule": "string", "rsvpMaximum": "integer", "locationDetail": "object", "ticketCurrency": "string", "submissionEmail": "string", "modified": "string", "id": "string", "conferenceButtonLabel": "string", "image": "string", "imageAltText": "string", "created": "string", "rsvpAvailable": "integer", "createdFormatted": "string", "tags": "array", "customAttr": "string", "locationRoom": "string", "ticketButtonLabel": "string", "submissionPhone": "string", "startDate": "string", "endDatetime": "string", "status": "string", "rsvpStart": "string", "timezone": "string", "submissionAbout": "string", "description": "string", "title": "string", "categoryName": "string", "posted": "string", "submissionType": "string", "locationOther": "string", "conferenceLink": "string", "rsvpEnd": "string", "modifiedFormatted": "string", "ticketPriceMaximum": "string", "postedFormatted": "string", "organizer": "string", "location": "string", "exdates": "array", "organizerDetail": "object", "category": "string" }

application/json

{
    "startDatetime": "string",
    "ticketUrl": "string",
    "featured": false,
    "submissionName": "string",
    "endDate": "string",
    "subject": "string",
    "ticketOption": "string",
    "ticketPriceMinimum": "string",
    "type": "string",
    "rsvp": false,
    "rrule": "string",
    "rsvpMaximum": "integer",
    "locationDetail": "object",
    "ticketCurrency": "string",
    "submissionEmail": "string",
    "modified": "string",
    "id": "string",
    "conferenceButtonLabel": "string",
    "image": "string",
    "imageAltText": "string",
    "created": "string",
    "rsvpAvailable": "integer",
    "createdFormatted": "string",
    "tags": "array",
    "customAttr": "string",
    "locationRoom": "string",
    "ticketButtonLabel": "string",
    "submissionPhone": "string",
    "startDate": "string",
    "endDatetime": "string",
    "status": "string",
    "rsvpStart": "string",
    "timezone": "string",
    "submissionAbout": "string",
    "description": "string",
    "title": "string",
    "categoryName": "string",
    "posted": "string",
    "submissionType": "string",
    "locationOther": "string",
    "conferenceLink": "string",
    "rsvpEnd": "string",
    "modifiedFormatted": "string",
    "ticketPriceMaximum": "string",
    "postedFormatted": "string",
    "organizer": "string",
    "location": "string",
    "exdates": "array",
    "organizerDetail": "object",
    "category": "string"
}

POST - Register attendeeLink to this section

Path: /pubcalendar/{calendar-id}/events/{event-id}/register
Description: Add an attendee.
Status: Active

Parameters

Name	Location	Required	Type
calendar-id	path	true	string
event-id	path	true	string

Request Body

Content Type	Body
application/x-www-form-urlencoded	`{ "name": "string", "email": "string", "token": "string" }`

Responses

Status	Response
400 - Bad request.
204 - The new attendee has been added successfully.

GET - Get public calendar ics fileLink to this section

Path: /pubcalendar/{calendar-id}/ics
Description: Return the requested calendar ics file.
Status: Active

Parameters

Name	Location	Required	Type
calendar-id	path	true	string
url	query	false	string
text	query	false	boolean
category	query	false	array
view	query	false	boolean
hash	query	false	boolean

Responses

Status	Response
200 - Calendar ics feed.	application/octet-stream

GET - Get public calendar rss feedLink to this section

Path: /pubcalendar/{calendar-id}/rss
Description: Return the requested calendar rss feed.
Status: Active

Parameters

Name	Location	Required	Type
calendar-id	path	true	string
url	query	false	string
text	query	false	boolean
featured	query	false	boolean
category	query	false	array
tag	query	false	array
start	query	false	string
end	query	false	string
hash	query	false	boolean

Responses

Status	Response
200 - Calendar rss feed.	application/xml

POST - Submit eventLink to this section

Path: /pubcalendar/{calendar-id}/submit-event
Description: Submit event.
Status: Active

Parameters

Name	Location	Required	Type
calendar-id	path	true	string

Request Body

Content Type Body

application/json

Content Type	Body
application/json	{ "startDatetime": "string", "submissionName": "string", "locationName": "string", "endDate": "string", "submissionAbout": "string", "description": "string", "locationAddress": "string", "title": "string", "tags": "array", "submissionType": "string", "organizerPhone": "string", "conferenceLink": "string", "submissionEmail": "string", "organizerName": "string", "organizerEmail": "string", "category": "string", "submissionPhone": "string", "startDate": "string", "endDatetime": "string", "conferenceButtonLabel": "string" }

{
    "startDatetime": "string",
    "submissionName": "string",
    "locationName": "string",
    "endDate": "string",
    "submissionAbout": "string",
    "description": "string",
    "locationAddress": "string",
    "title": "string",
    "tags": "array",
    "submissionType": "string",
    "organizerPhone": "string",
    "conferenceLink": "string",
    "submissionEmail": "string",
    "organizerName": "string",
    "organizerEmail": "string",
    "category": "string",
    "submissionPhone": "string",
    "startDate": "string",
    "endDatetime": "string",
    "conferenceButtonLabel": "string"
}

Responses

Status	Response
400 - Bad request.
204 - The event has been submitted successfully.

POST - Verify passcodeLink to this section

Path: /pubcalendar/{calendar-id}/submit-verify
Description: Verify passcode.
Status: Active

Parameters

Name	Location	Required	Type
calendar-id	path	true	string

Request Body

Content Type	Body
application/x-www-form-urlencoded	`{ "passcode": "string", "token": "string" }`

Responses

Status	Response
400 - Bad request.
204 - The passcode has been verified successfully.
403 - Access is forbidden.

GET - Get tags used by this calendarLink to this section

Path: /pubcalendar/{calendar-id}/tags
Description: Return the tags used by this calendar.
Status: Active

Parameters

Name	Location	Required	Type
calendar-id	path	true	string
category	query	false	array

Responses

Status	Response
200 - Calendar tags.	application/json `['string', 'string', 'string']`

Was this page helpful?