Reference

Calendarevent

The calendarevent object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this calendarevent
Allocation: int? optional
AllowComments: bool optional
AskBuyerAddress: bool optional
BusinessId: Id required
CreateZoomWebinarInvite: bool optional
EndDate: DateTime required
FacebookPage: string optional
IncludeZoomInvite: bool optional
Location: string optional
LongDescription: string optional
Name: string required
OnlyForContacts: bool optional
OnlyForMembers: bool optional
PublishDate: DateTime? optional
RepeatEvent: bool optional
RepeatEvery: int? optional
RepeatOnFridays: bool optional
RepeatOnMondays: bool optional
RepeatOnSaturdays: bool optional
RepeatOnSundays: bool optional
RepeatOnThursdays: bool optional
RepeatOnTuesdays: bool optional
RepeatOnWednesdays: bool optional
Repeats: Nexudus.Coworking.Core.Enums.eCalendarEventRepeatCycle optional
RepeatSeriesUniqueId: Guid? optional
RepeatUntil: DateTime? optional
ResourceId: Id optional
ShortDescription: string optional
ShowEventAttendees: bool optional
ShowInHomeBanner: bool optional
ShowInHomePage: bool optional
StartDate: DateTime required
TicketNotes: string optional
TicketsPage: string optional
VenueAddress: string optional
WebAddress: string optional
WhichEventsToUpdate: Nexudus.Coworking.Core.Enums.eRepeatedCalendarEventUpdateAction optional
ZoomWebinarAlternativeHosts: string optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this calendarevent
SystemId: string optional api-only
User defined data about this calendarevent. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Allocation": ,
  "AllowComments": false,
  "AskBuyerAddress": false,
  "BusinessId": 12345678,
  "CreateZoomWebinarInvite": false,
  "EndDate": 2020-01-01T21:03:54Z,
  "FacebookPage": "TicketsPage",
  "IncludeZoomInvite": false,
  "Location": "Location",
  "LongDescription": "Description",
  "Name": "Name",
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "PublishDate": ,
  "RepeatEvent": false,
  "RepeatEvery": ,
  "RepeatOnFridays": false,
  "RepeatOnMondays": false,
  "RepeatOnSaturdays": false,
  "RepeatOnSundays": false,
  "RepeatOnThursdays": false,
  "RepeatOnTuesdays": false,
  "RepeatOnWednesdays": false,
  "Repeats": 1,
  "RepeatSeriesUniqueId": ,
  "RepeatUntil": ,
  "ResourceId": 12345678,
  "ShortDescription": "Description",
  "ShowEventAttendees": false,
  "ShowInHomeBanner": false,
  "ShowInHomePage": false,
  "StartDate": 2020-01-01T21:03:54Z,
  "TicketNotes": "TicketNotes",
  "TicketsPage": "TicketsPage",
  "VenueAddress": "Location",
  "WebAddress": "WebAddress",
  "WhichEventsToUpdate": 1,
  "ZoomWebinarAlternativeHosts": "ZoomWebinarAlternativeHosts",
  "UniqueId": "c399cb1e-9544-440c-91e9-15507b9cf4f5",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CalendarEvent

This endpoint allows you to GET a list of calendarevents based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/content/calendarevents?...

πŸ”’ Requires role "CalendarEvent-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=StartDate
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search calendarevent records based on their different properties.
Id number
?Id=12345678
CalendarEvent_Allocation int?
?CalendarEvent_Allocation=...
CalendarEvent_AllowComments bool
?CalendarEvent_AllowComments=...
CalendarEvent_AskBuyerAddress bool
?CalendarEvent_AskBuyerAddress=...
CalendarEvent_Business Business
?CalendarEvent_Business=...
CalendarEvent_CreateZoomWebinarInvite bool
?CalendarEvent_CreateZoomWebinarInvite=...
CalendarEvent_EndDate DateTime
?CalendarEvent_EndDate=...
CalendarEvent_FacebookPage string
?CalendarEvent_FacebookPage=...
CalendarEvent_IncludeZoomInvite bool
?CalendarEvent_IncludeZoomInvite=...
CalendarEvent_Location string
?CalendarEvent_Location=...
CalendarEvent_LongDescription string
?CalendarEvent_LongDescription=...
CalendarEvent_Name string
?CalendarEvent_Name=...
CalendarEvent_OnlyForContacts bool
?CalendarEvent_OnlyForContacts=...
CalendarEvent_OnlyForMembers bool
?CalendarEvent_OnlyForMembers=...
CalendarEvent_PublishDate DateTime?
?CalendarEvent_PublishDate=...
CalendarEvent_RepeatEvent bool
?CalendarEvent_RepeatEvent=...
CalendarEvent_RepeatEvery int?
?CalendarEvent_RepeatEvery=...
CalendarEvent_RepeatOnFridays bool
?CalendarEvent_RepeatOnFridays=...
CalendarEvent_RepeatOnMondays bool
?CalendarEvent_RepeatOnMondays=...
CalendarEvent_RepeatOnSaturdays bool
?CalendarEvent_RepeatOnSaturdays=...
CalendarEvent_RepeatOnSundays bool
?CalendarEvent_RepeatOnSundays=...
CalendarEvent_RepeatOnThursdays bool
?CalendarEvent_RepeatOnThursdays=...
CalendarEvent_RepeatOnTuesdays bool
?CalendarEvent_RepeatOnTuesdays=...
CalendarEvent_RepeatOnWednesdays bool
?CalendarEvent_RepeatOnWednesdays=...
CalendarEvent_Repeats Nexudus.Coworking.Core.Enums.eCalendarEventRepeatCycle
?CalendarEvent_Repeats=...
CalendarEvent_RepeatSeriesUniqueId Guid?
?CalendarEvent_RepeatSeriesUniqueId=...
CalendarEvent_RepeatUntil DateTime?
?CalendarEvent_RepeatUntil=...
CalendarEvent_Resource Resource
?CalendarEvent_Resource=...
CalendarEvent_ShortDescription string
?CalendarEvent_ShortDescription=...
CalendarEvent_ShowEventAttendees bool
?CalendarEvent_ShowEventAttendees=...
CalendarEvent_ShowInHomeBanner bool
?CalendarEvent_ShowInHomeBanner=...
CalendarEvent_ShowInHomePage bool
?CalendarEvent_ShowInHomePage=...
CalendarEvent_StartDate DateTime
?CalendarEvent_StartDate=...
CalendarEvent_TicketNotes string
?CalendarEvent_TicketNotes=...
CalendarEvent_TicketsPage string
?CalendarEvent_TicketsPage=...
CalendarEvent_VenueAddress string
?CalendarEvent_VenueAddress=...
CalendarEvent_WebAddress string
?CalendarEvent_WebAddress=...
CalendarEvent_WhichEventsToUpdate Nexudus.Coworking.Core.Enums.eRepeatedCalendarEventUpdateAction
?CalendarEvent_WhichEventsToUpdate=...
CalendarEvent_ZoomWebinarAlternativeHosts string
?CalendarEvent_ZoomWebinarAlternativeHosts=...
CalendarEvent_EventCategories List of CalendarEventCategory
?CalendarEvent_EventCategories=...

Range search querystring parameters
Lets you search calendarevent records based on a range of date or numeric values.
To_CalendarEvent_CreatedOn date
?To_CalendarEvent_CreatedOn=2010-01-01T20:32
From_CalendarEvent_CreatedOn date
?From_CalendarEvent_CreatedOn=2010-01-01T20:32
To_CalendarEvent_UpdatedOn date
?To_CalendarEvent_UpdatedOn=2010-01-01T20:32
From_CalendarEvent_UpdatedOn date
?From_CalendarEvent_UpdatedOn=2010-01-01T20:32
To_CalendarEvent_StartDate date
?To_CalendarEvent_StartDate=2010-01-01T20:32
From_CalendarEvent_StartDate date
?From_CalendarEvent_StartDate=2010-01-01T20:32
To_CalendarEvent_EndDate date
?To_CalendarEvent_EndDate=2010-01-01T20:32
From_CalendarEvent_EndDate date
?From_CalendarEvent_EndDate=2010-01-01T20:32
To_CalendarEvent_Allocation number
?To_CalendarEvent_Allocation=0
From_CalendarEvent_Allocation number
?From_CalendarEvent_Allocation=10
To_CalendarEvent_PublishDate date
?To_CalendarEvent_PublishDate=2010-01-01T20:32
From_CalendarEvent_PublishDate date
?From_CalendarEvent_PublishDate=2010-01-01T20:32
To_CalendarEvent_RepeatEvery number
?To_CalendarEvent_RepeatEvery=0
From_CalendarEvent_RepeatEvery number
?From_CalendarEvent_RepeatEvery=10
To_CalendarEvent_RepeatUntil date
?To_CalendarEvent_RepeatUntil=2010-01-01T20:32
From_CalendarEvent_RepeatUntil date
?From_CalendarEvent_RepeatUntil=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/content/calendarevents?CalendarEvent_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "ShortDescription": "Description",
        "LongDescription": "Description",
        "TicketNotes": "TicketNotes",
        "AskBuyerAddress": false,
        "ShowEventAttendees": false,
        "Location": "Location",
        "VenueAddress": "Location",
        "Resource": ,
        "StartDate": 2020-01-01T21:03:54Z,
        "EndDate": 2020-01-01T21:03:54Z,
        "Allocation": ,
        "PublishDate": ,
        "ShowInHomeBanner": false,
        "ShowInHomePage": false,
        "AllowComments": false,
        "IncludeZoomInvite": false,
        "CreateZoomWebinarInvite": false,
        "ZoomWebinarAlternativeHosts": "ZoomWebinarAlternativeHosts",
        "OnlyForContacts": false,
        "OnlyForMembers": false,
        "WebAddress": "WebAddress",
        "FacebookPage": "TicketsPage",
        "TicketsPage": "TicketsPage",
        "RepeatSeriesUniqueId": ,
        "RepeatEvent": false,
        "Repeats": 1,
        "WhichEventsToUpdate": 1,
        "RepeatEvery": ,
        "RepeatUntil": ,
        "RepeatOnMondays": false,
        "RepeatOnTuesdays": false,
        "RepeatOnWednesdays": false,
        "RepeatOnThursdays": false,
        "RepeatOnFridays": false,
        "RepeatOnSaturdays": false,
        "RepeatOnSundays": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "02da1910-8c00-497c-9df3-a1c68cfd4361",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}


Find CalendarEvents by IDs

Gets one or more calendarevent records based on their Id.
GET https://spaces.nexudus.com/api/content/calendarevents?CalendarEvent_Id=[:id1,:id2,...]

πŸ”’ Requires role "CalendarEvent-List"

Querystring parameters
CalendarEvent_Id: array requried
?CalendarEvent_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/content/calendarevents?CalendarEvent_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "ShortDescription": "Description",
        "LongDescription": "Description",
        "TicketNotes": "TicketNotes",
        "AskBuyerAddress": false,
        "ShowEventAttendees": false,
        "Location": "Location",
        "VenueAddress": "Location",
        "Resource": ,
        "StartDate": 2020-01-01T21:03:54Z,
        "EndDate": 2020-01-01T21:03:54Z,
        "Allocation": ,
        "PublishDate": ,
        "ShowInHomeBanner": false,
        "ShowInHomePage": false,
        "AllowComments": false,
        "IncludeZoomInvite": false,
        "CreateZoomWebinarInvite": false,
        "ZoomWebinarAlternativeHosts": "ZoomWebinarAlternativeHosts",
        "OnlyForContacts": false,
        "OnlyForMembers": false,
        "WebAddress": "WebAddress",
        "FacebookPage": "TicketsPage",
        "TicketsPage": "TicketsPage",
        "RepeatSeriesUniqueId": ,
        "RepeatEvent": false,
        "Repeats": 1,
        "WhichEventsToUpdate": 1,
        "RepeatEvery": ,
        "RepeatUntil": ,
        "RepeatOnMondays": false,
        "RepeatOnTuesdays": false,
        "RepeatOnWednesdays": false,
        "RepeatOnThursdays": false,
        "RepeatOnFridays": false,
        "RepeatOnSaturdays": false,
        "RepeatOnSundays": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "38b9d199-0ea0-4f67-ad33-875b8c52961c",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "StartDate",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single CalendarEvent by Id

Gets one calendarevent record by its Id.
GET https://spaces.nexudus.com/api/content/calendarevents/:Id

πŸ”’ Requires role "CalendarEvent-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/content/calendarevents/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "Allocation": ,
  "AllowComments": false,
  "AskBuyerAddress": false,
  "BusinessId": 12345678,
  "CreateZoomWebinarInvite": false,
  "EndDate": 2020-01-01T21:03:54Z,
  "FacebookPage": "TicketsPage",
  "IncludeZoomInvite": false,
  "Location": "Location",
  "LongDescription": "Description",
  "Name": "Name",
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "PublishDate": ,
  "RepeatEvent": false,
  "RepeatEvery": ,
  "RepeatOnFridays": false,
  "RepeatOnMondays": false,
  "RepeatOnSaturdays": false,
  "RepeatOnSundays": false,
  "RepeatOnThursdays": false,
  "RepeatOnTuesdays": false,
  "RepeatOnWednesdays": false,
  "Repeats": 1,
  "RepeatSeriesUniqueId": ,
  "RepeatUntil": ,
  "ResourceId": 12345678,
  "ShortDescription": "Description",
  "ShowEventAttendees": false,
  "ShowInHomeBanner": false,
  "ShowInHomePage": false,
  "StartDate": 2020-01-01T21:03:54Z,
  "TicketNotes": "TicketNotes",
  "TicketsPage": "TicketsPage",
  "VenueAddress": "Location",
  "WebAddress": "WebAddress",
  "WhichEventsToUpdate": 1,
  "ZoomWebinarAlternativeHosts": "ZoomWebinarAlternativeHosts",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "3a4f5f79-4c6c-4d1a-ab04-d682fc87c194",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CalendarEvent

Creates a new calendarevent.
POST https://spaces.nexudus.com/api/content/calendarevents

πŸ”’ Requires role "CalendarEvent-Create"

Body parameters
BusinessId: number required
Name: string required
ShortDescription: string optional
LongDescription: string optional
TicketNotes: string optional
AskBuyerAddress: bool optional
ShowEventAttendees: bool optional
Location: string optional
VenueAddress: string optional
ResourceId: number optional
StartDate: DateTime required
EndDate: DateTime required
Allocation: int? optional
PublishDate: DateTime? optional
ShowInHomeBanner: bool optional
ShowInHomePage: bool optional
AllowComments: bool optional
IncludeZoomInvite: bool optional
CreateZoomWebinarInvite: bool optional
ZoomWebinarAlternativeHosts: string optional
OnlyForContacts: bool optional
OnlyForMembers: bool optional
WebAddress: string optional
FacebookPage: string optional
TicketsPage: string optional
RepeatSeriesUniqueId: Guid? optional
RepeatEvent: bool optional
Repeats: Nexudus.Coworking.Core.Enums.eCalendarEventRepeatCycle optional
RepeatEvery: int? optional
RepeatUntil: DateTime? optional
RepeatOnMondays: bool optional
RepeatOnTuesdays: bool optional
RepeatOnWednesdays: bool optional
RepeatOnThursdays: bool optional
RepeatOnFridays: bool optional
RepeatOnSaturdays: bool optional
RepeatOnSundays: bool optional

Example request

POST https://spaces.nexudus.com/api/content/calendarevents
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "BusinessId": 12345678,
    "Name": "Name",
    "ShortDescription": "Description",
    "LongDescription": "Description",
    "TicketNotes": "TicketNotes",
    "AskBuyerAddress": false,
    "ShowEventAttendees": false,
    "Location": "Location",
    "VenueAddress": "Location",
    "ResourceId": 12345678,
    "StartDate": 2020-01-01T21:03:54Z,
    "EndDate": 2020-01-01T21:03:54Z,
    "Allocation": ,
    "EventCategories": [12345678, 87654321],
    "PublishDate": ,
    "ShowInHomeBanner": false,
    "ShowInHomePage": false,
    "AllowComments": false,
    "IncludeZoomInvite": false,
    "CreateZoomWebinarInvite": false,
    "ZoomWebinarAlternativeHosts": "ZoomWebinarAlternativeHosts",
    "OnlyForContacts": false,
    "OnlyForMembers": false,
    "WebAddress": "WebAddress",
    "FacebookPage": "TicketsPage",
    "TicketsPage": "TicketsPage",
    "RepeatSeriesUniqueId": ,
    "RepeatEvent": false,
    "Repeats": 1, //(check Enumerated values section below)
    "RepeatEvery": ,
    "RepeatUntil": ,
    "RepeatOnMondays": false,
    "RepeatOnTuesdays": false,
    "RepeatOnWednesdays": false,
    "RepeatOnThursdays": false,
    "RepeatOnFridays": false,
    "RepeatOnSaturdays": false,
    "RepeatOnSundays": false,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Update CalendarEvent

Updates an existing calendarevent.
PUT https://spaces.nexudus.com/api/content/calendarevents

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "CalendarEvent-Edit"

Body parameters
Id: number required
The unique Id of the calendarevent to update.
BusinessId: number cleared if missing
Name: string cleared if missing
ShortDescription: string cleared if missing
LongDescription: string cleared if missing
TicketNotes: string cleared if missing
AskBuyerAddress: bool cleared if missing
ShowEventAttendees: bool cleared if missing
Location: string cleared if missing
VenueAddress: string cleared if missing
ResourceId: number cleared if missing
StartDate: DateTime cleared if missing
EndDate: DateTime cleared if missing
Allocation: int? cleared if missing
PublishDate: DateTime? cleared if missing
ShowInHomeBanner: bool cleared if missing
ShowInHomePage: bool cleared if missing
AllowComments: bool cleared if missing
IncludeZoomInvite: bool cleared if missing
CreateZoomWebinarInvite: bool cleared if missing
ZoomWebinarAlternativeHosts: string cleared if missing
OnlyForContacts: bool cleared if missing
OnlyForMembers: bool cleared if missing
WebAddress: string cleared if missing
FacebookPage: string cleared if missing
TicketsPage: string cleared if missing
RepeatSeriesUniqueId: Guid? cleared if missing
Repeats: Nexudus.Coworking.Core.Enums.eCalendarEventRepeatCycle cleared if missing
WhichEventsToUpdate: Nexudus.Coworking.Core.Enums.eRepeatedCalendarEventUpdateAction cleared if missing
RepeatOnMondays: bool cleared if missing
RepeatOnTuesdays: bool cleared if missing
RepeatOnWednesdays: bool cleared if missing
RepeatOnThursdays: bool cleared if missing
RepeatOnFridays: bool cleared if missing
RepeatOnSaturdays: bool cleared if missing
RepeatOnSundays: bool cleared if missing

Example request

PUT https://spaces.nexudus.com/api/content/calendarevents
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "Name",
    "ShortDescription": "Description",
    "LongDescription": "Description",
    "TicketNotes": "TicketNotes",
    "AskBuyerAddress": false,
    "ShowEventAttendees": false,
    "Location": "Location",
    "VenueAddress": "Location",
    "ResourceId": 12345678,
    "StartDate": 2020-01-01T21:03:54Z,
    "EndDate": 2020-01-01T21:03:54Z,
    "Allocation": ,
    "EventCategories": [12345678, 87654321],
    "PublishDate": ,
    "ShowInHomeBanner": false,
    "ShowInHomePage": false,
    "AllowComments": false,
    "IncludeZoomInvite": false,
    "CreateZoomWebinarInvite": false,
    "ZoomWebinarAlternativeHosts": "ZoomWebinarAlternativeHosts",
    "OnlyForContacts": false,
    "OnlyForMembers": false,
    "WebAddress": "WebAddress",
    "FacebookPage": "TicketsPage",
    "TicketsPage": "TicketsPage",
    "RepeatSeriesUniqueId": ,
    "RepeatEvent": false,
    "Repeats": 1, //(check Enumerated values section below)
    "RepeatEvery": ,
    "RepeatUntil": ,
    "RepeatOnMondays": false,
    "RepeatOnTuesdays": false,
    "RepeatOnWednesdays": false,
    "RepeatOnThursdays": false,
    "RepeatOnFridays": false,
    "RepeatOnSaturdays": false,
    "RepeatOnSundays": false,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Delete CalendarEvent

Deletes an existing calendarevent by its Id.
DELETE https://spaces.nexudus.com/api/content/calendarevents/:Id

πŸ”’ Requires role "CalendarEvent-Delete"

URL parameters
Id: number required
The unique Id of the calendarevent to update.

Example request

DELETE https://spaces.nexudus.com/api/content/calendarevents/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}


Commands

Commands allow to perform actions against one or more calendarevent records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for calendarevent records.
GET https://spaces.nexudus.com/api/content/calendarevents/commands

Example request

GET https://spaces.nexudus.com/api/content/calendarevents/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]


Run Command

Runs a command based on its Key and one or more calendarevent record IDs.
POST https://spaces.nexudus.com/api/content/calendarevents/runacommand
πŸ”’ Requires role "CalendarEvent-Edit"

Example request

POST https://spaces.nexudus.com/api/content/calendarevents/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}


Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}


Enumerated values

Repeats

GET /api/utils/enums?name=eCalendarEventRepeatCycle

WhichEventsToUpdate

GET /api/utils/enums?name=eRepeatedCalendarEventUpdateAction

Binary files

The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.

SmallLogo

GET https://spaces.nexudus.com/api/content/calendarevents/getsmalllogo/:id
URL parameters
Id: number required
The id of the CalendarEvent to get the smalllogo for.

LargeLogo

GET https://spaces.nexudus.com/api/content/calendarevents/getlargelogo/:id
URL parameters
Id: number required
The id of the CalendarEvent to get the largelogo for.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.