API Members Portal Email Support Request a Demo
Submit a request
  1. Nexudus
  2. API
  3. Sys

Reference

Chatusermessage

The chatusermessage object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this chatusermessage
ChatText: string optional
Delievered: bool optional
FromUserId: Id required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this chatusermessage
SystemId: string optional api-only
User defined data about this chatusermessage. This property can only be seen and updated using the API.

Json Structure Example 


{
  "Id": 1234567,
  "ChatText": "ChatText",
  "Delievered": false,
  "FromUserId": 12345678,
  "UniqueId": "72a3c4b8-0987-475a-879e-29ea2242a6e4",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Find a ChatUserMessage

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

GET https://spaces.nexudus.com/api/sys/chatusermessages?...

🔒 Requires role "ChatUserMessage-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 chatusermessage records based on their different properties.
Id number
?Id=12345678
ChatUserMessage_ChatText string
?ChatUserMessage_ChatText=...
ChatUserMessage_Delievered bool
?ChatUserMessage_Delievered=...
ChatUserMessage_FromUser User
?ChatUserMessage_FromUser=...
ChatUserMessage_ToUsers List of User
?ChatUserMessage_ToUsers=...

Range search querystring parameters
Lets you search chatusermessage records based on a range of date or numeric values.
To_ChatUserMessage_CreatedOn date
?To_ChatUserMessage_CreatedOn=2010-01-01T20:32
From_ChatUserMessage_CreatedOn date
?From_ChatUserMessage_CreatedOn=2010-01-01T20:32
To_ChatUserMessage_UpdatedOn date
?To_ChatUserMessage_UpdatedOn=2010-01-01T20:32
From_ChatUserMessage_UpdatedOn date
?From_ChatUserMessage_UpdatedOn=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/sys/chatusermessages?ChatUserMessage_ChatText=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "FromUser": ,
        "ChatText": "ChatText",
        "Delievered": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "bf2a6af2-2b87-443d-9c47-1bb9eac08343",
        "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 ChatUserMessages by IDs

Gets one or more chatusermessage records based on their Id. 
GET https://spaces.nexudus.com/api/sys/chatusermessages?ChatUserMessage_Id=[:id1,:id2,...]

🔒 Requires role "ChatUserMessage-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "FromUser": ,
        "ChatText": "ChatText",
        "Delievered": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "46d88fae-92c6-40ca-98cd-7a1a8537795c",
        "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 ChatUserMessage by Id

Gets one chatusermessage record by its Id. 
GET https://spaces.nexudus.com/api/sys/chatusermessages/:Id

🔒 Requires role "ChatUserMessage-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "ChatText": "ChatText",
  "Delievered": false,
  "FromUserId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "5f8953f1-25f0-4f65-bf80-983652b68ed9",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Create new ChatUserMessage

Creates a new chatusermessage. 
POST https://spaces.nexudus.com/api/sys/chatusermessages

🔒 Requires role "ChatUserMessage-Create"

Body parameters
FromUserId: number required
ChatText: string optional
Delievered: bool optional

Example request

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


{
    "FromUserId": 12345678,
    "ToUsers": [12345678, 87654321],
    "ChatText": "ChatText",
    "Delievered": 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 ChatUserMessage

Updates an existing chatusermessage. 
PUT https://spaces.nexudus.com/api/sys/chatusermessages

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

🔒 Requires role "ChatUserMessage-Edit"

Body parameters
Id: number required
The unique Id of the chatusermessage to update.
FromUserId: number cleared if missing
ChatText: string cleared if missing
Delievered: bool cleared if missing

Example request

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


{
    "Id": 12345678,
    "FromUserId": 12345678,
    "ToUsers": [12345678, 87654321],
    "ChatText": "ChatText",
    "Delievered": 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 ChatUserMessage

Deletes an existing chatusermessage by its Id. 
DELETE https://spaces.nexudus.com/api/sys/chatusermessages/:Id

🔒 Requires role "ChatUserMessage-Delete"

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

Example request

DELETE https://spaces.nexudus.com/api/sys/chatusermessages/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 chatusermessage 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 chatusermessage records. 
GET https://spaces.nexudus.com/api/sys/chatusermessages/commands

Example request

GET https://spaces.nexudus.com/api/sys/chatusermessages/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 chatusermessage record IDs. 
POST https://spaces.nexudus.com/api/sys/chatusermessages/runacommand
🔒 Requires role "ChatUserMessage-Edit"

Example request

POST https://spaces.nexudus.com/api/sys/chatusermessages/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.