Reference

Eventcomment

The eventcomment object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this eventcomment
BusinessId: Id required
CalendarEventId: Id required
PostedById: Id optional
Published: bool optional
Text: string required
Title: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this eventcomment
SystemId: string optional api-only
User defined data about this eventcomment. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "CalendarEventId": 12345678,
  "PostedById": 12345678,
  "Published": false,
  "Text": "Text",
  "Title": "Title",
  "UniqueId": "c86a096d-eb7c-4c43-8fc3-73b980263e59",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a EventComment

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

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

πŸ”’ Requires role "EventComment-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=Id
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 eventcomment records based on their different properties.
Id number
?Id=12345678
EventComment_Business Business
?EventComment_Business=...
EventComment_CalendarEvent CalendarEvent
?EventComment_CalendarEvent=...
EventComment_PostedBy User
?EventComment_PostedBy=...
EventComment_Published bool
?EventComment_Published=...
EventComment_Text string
?EventComment_Text=...
EventComment_Title string
?EventComment_Title=...
EventComment_PostedByFullName string
?EventComment_PostedByFullName=...

Range search querystring parameters
Lets you search eventcomment records based on a range of date or numeric values.
To_EventComment_CreatedOn date
?To_EventComment_CreatedOn=2010-01-01T20:32
From_EventComment_CreatedOn date
?From_EventComment_CreatedOn=2010-01-01T20:32
To_EventComment_UpdatedOn date
?To_EventComment_UpdatedOn=2010-01-01T20:32
From_EventComment_UpdatedOn date
?From_EventComment_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "CalendarEvent": ,
        "PostedBy": ,
        "Title": "Title",
        "Text": "Text",
        "Published": false,
        "EventCommentPostedByFullName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "ca548673-0e3a-4277-b760-a02961abbe5a",
        "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 EventComments by IDs

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

πŸ”’ Requires role "EventComment-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "CalendarEvent": ,
        "PostedBy": ,
        "Title": "Title",
        "Text": "Text",
        "Published": false,
        "EventCommentPostedByFullName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "635b5566-9b8d-4a43-ad72-9d3b4fa6326b",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single EventComment by Id

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

πŸ”’ Requires role "EventComment-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "CalendarEventId": 12345678,
  "PostedById": 12345678,
  "Published": false,
  "Text": "Text",
  "Title": "Title",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "0d417af0-3300-413d-9f9c-f6f40bf6cab9",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new EventComment

Creates a new eventcomment.
POST https://spaces.nexudus.com/api/content/eventcomments

πŸ”’ Requires role "EventComment-Create"

Body parameters
BusinessId: number required
CalendarEventId: number required
PostedById: number optional
Title: string required
Text: string required
Published: bool optional

Example request

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

{
    "BusinessId": 12345678,
    "CalendarEventId": 12345678,
    "PostedById": 12345678,
    "Title": "Title",
    "Text": "Text",
    "Published": 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 EventComment

Updates an existing eventcomment.
PUT https://spaces.nexudus.com/api/content/eventcomments

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

πŸ”’ Requires role "EventComment-Edit"

Body parameters
Id: number required
The unique Id of the eventcomment to update.
BusinessId: number cleared if missing
CalendarEventId: number cleared if missing
PostedById: number cleared if missing
Title: string cleared if missing
Text: string cleared if missing
Published: bool cleared if missing

Example request

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

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "CalendarEventId": 12345678,
    "PostedById": 12345678,
    "Title": "Title",
    "Text": "Text",
    "Published": 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 EventComment

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

πŸ”’ Requires role "EventComment-Delete"

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

Example request

DELETE https://spaces.nexudus.com/api/content/eventcomments/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 eventcomment 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 eventcomment records.
GET https://spaces.nexudus.com/api/content/eventcomments/commands

Example request

GET https://spaces.nexudus.com/api/content/eventcomments/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 eventcomment record IDs.
POST https://spaces.nexudus.com/api/content/eventcomments/runacommand
πŸ”’ Requires role "EventComment-Edit"

Example request

POST https://spaces.nexudus.com/api/content/eventcomments/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
}


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.