Usermessage

The usermessage object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this usermessage
Body: string optional
BusinessId: Id required
FromName: string optional read-only
FromUserId: Id optional read-only
Header: string optional
IsRead: bool optional read-only
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this usermessage
SystemId: string optional api-only
User defined data about this usermessage. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Body": "Body",
  "BusinessId": 12345678,
  "FromName": "FromName",
  "FromUserId": 12345678,
  "Header": "Header",
  "IsRead": false,
  "UniqueId": "aac5561f-ff95-4da4-9ec5-f9cd23d55040",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a UserMessage

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

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

๐Ÿ”’ Requires role "UserMessage-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 usermessage records based on their different properties.
Id number
?Id=12345678
UserMessage_Body string
?UserMessage_Body=...
UserMessage_Business Business
?UserMessage_Business=...
UserMessage_FromName string
?UserMessage_FromName=...
UserMessage_FromUser User
?UserMessage_FromUser=...
UserMessage_Header string
?UserMessage_Header=...
UserMessage_IsRead bool
?UserMessage_IsRead=...
UserMessage_ToUsers ICollection
?UserMessage_ToUsers=...

Range search querystring parameters
Lets you search usermessage records based on a range of date or numeric values.
To_UserMessage_CreatedOn date
?To_UserMessage_CreatedOn=2010-01-01T20:32
From_UserMessage_CreatedOn date
?From_UserMessage_CreatedOn=2010-01-01T20:32
To_UserMessage_UpdatedOn date
?To_UserMessage_UpdatedOn=2010-01-01T20:32
From_UserMessage_UpdatedOn date
?From_UserMessage_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "FromName": "FromName",
        "FromUser": ,
        "Header": "Header",
        "Body": "Body",
        "IsRead": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "fbbfc043-fe75-42a6-9782-f1a936ac4a4b",
        "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 UserMessages by IDs

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

๐Ÿ”’ Requires role "UserMessage-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "FromName": "FromName",
        "FromUser": ,
        "Header": "Header",
        "Body": "Body",
        "IsRead": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "c9823027-246c-4e53-8c94-16b909785b17",
        "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 UserMessage by Id

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

๐Ÿ”’ Requires role "UserMessage-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "Body": "Body",
  "BusinessId": 12345678,
  "FromName": "FromName",
  "FromUserId": 12345678,
  "Header": "Header",
  "IsRead": false,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "68088f9e-3a66-497c-b8cb-32fcf6ee0eb3",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new UserMessage

Creates a new usermessage.
POST https://spaces.nexudus.com/api/sys/usermessages

๐Ÿ”’ Requires role "UserMessage-Create"

Body parameters
BusinessId: number required
Header: string optional
Body: string optional

Example request

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

{
    "BusinessId": 12345678,
    "ToUsers": [12345678, 87654321],
    "Header": "Header",
    "Body": "Body",
}


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"
        },
    ]
}


Commands

Commands allow to perform actions against one or more usermessage 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 usermessage records.
GET https://spaces.nexudus.com/api/sys/usermessages/commands

Example request

GET https://spaces.nexudus.com/api/sys/usermessages/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 usermessage record IDs.
POST https://spaces.nexudus.com/api/sys/usermessages/runacommand
๐Ÿ”’ Requires role "UserMessage-Edit"

Example request

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