Reference

Helpdeskmessage

The helpdeskmessage object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this helpdeskmessage
BusinessId: Id required
Closed: bool optional
ClosedOn: DateTime? optional
CoworkerId: Id required
HelpDeskDepartmentId: Id optional
MessageText: string required
OwnerId: Id optional
Priority: Nexudus.Coworking.Core.Enums.eHelpDeskMessagePriority optional
Subject: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this helpdeskmessage
SystemId: string optional api-only
User defined data about this helpdeskmessage. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Closed": false,
  "ClosedOn": ,
  "CoworkerId": 12345678,
  "HelpDeskDepartmentId": 12345678,
  "MessageText": "MessageText",
  "OwnerId": 12345678,
  "Priority": 1,
  "Subject": "Name",
  "UniqueId": "837f51f1-1aa4-4761-8fff-c7ee56c5ddb2",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a HelpDeskMessage

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

GET https://spaces.nexudus.com/api/support/helpdeskmessages?...

πŸ”’ Requires role "HelpDeskMessage-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=Subject
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 helpdeskmessage records based on their different properties.
Id number
?Id=12345678
HelpDeskMessage_Business Business
?HelpDeskMessage_Business=...
HelpDeskMessage_Closed bool
?HelpDeskMessage_Closed=...
HelpDeskMessage_ClosedOn DateTime?
?HelpDeskMessage_ClosedOn=...
HelpDeskMessage_Coworker Coworker
?HelpDeskMessage_Coworker=...
HelpDeskMessage_HelpDeskDepartment HelpDeskDepartment
?HelpDeskMessage_HelpDeskDepartment=...
HelpDeskMessage_MessageText string
?HelpDeskMessage_MessageText=...
HelpDeskMessage_Owner User
?HelpDeskMessage_Owner=...
HelpDeskMessage_Priority Nexudus.Coworking.Core.Enums.eHelpDeskMessagePriority
?HelpDeskMessage_Priority=...
HelpDeskMessage_Subject string
?HelpDeskMessage_Subject=...
HelpDeskMessage_CoworkerFullName string
?HelpDeskMessage_CoworkerFullName=...
HelpDeskMessage_HelpDeskDepartmentName string
?HelpDeskMessage_HelpDeskDepartmentName=...
HelpDeskMessage_OwnerFullName string
?HelpDeskMessage_OwnerFullName=...

Range search querystring parameters
Lets you search helpdeskmessage records based on a range of date or numeric values.
To_HelpDeskMessage_CreatedOn date
?To_HelpDeskMessage_CreatedOn=2010-01-01T20:32
From_HelpDeskMessage_CreatedOn date
?From_HelpDeskMessage_CreatedOn=2010-01-01T20:32
To_HelpDeskMessage_UpdatedOn date
?To_HelpDeskMessage_UpdatedOn=2010-01-01T20:32
From_HelpDeskMessage_UpdatedOn date
?From_HelpDeskMessage_UpdatedOn=2010-01-01T20:32
To_HelpDeskMessage_ClosedOn date
?To_HelpDeskMessage_ClosedOn=2010-01-01T20:32
From_HelpDeskMessage_ClosedOn date
?From_HelpDeskMessage_ClosedOn=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/support/helpdeskmessages?HelpDeskMessage_Subject=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Coworker": ,
        "HelpDeskDepartment": ,
        "Subject": "Name",
        "MessageText": "MessageText",
        "Priority": 1,
        "Closed": false,
        "ClosedOn": ,
        "Owner": ,
        "HelpDeskMessageCoworkerFullName": "...",
        "HelpDeskMessageHelpDeskDepartmentName": "...",
        "HelpDeskMessageOwnerFullName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "a13d0390-3b72-4f95-9861-4043d20adc70",
        "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 HelpDeskMessages by IDs

Gets one or more helpdeskmessage records based on their Id.
GET https://spaces.nexudus.com/api/support/helpdeskmessages?HelpDeskMessage_Id=[:id1,:id2,...]

πŸ”’ Requires role "HelpDeskMessage-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Coworker": ,
        "HelpDeskDepartment": ,
        "Subject": "Name",
        "MessageText": "MessageText",
        "Priority": 1,
        "Closed": false,
        "ClosedOn": ,
        "Owner": ,
        "HelpDeskMessageCoworkerFullName": "...",
        "HelpDeskMessageHelpDeskDepartmentName": "...",
        "HelpDeskMessageOwnerFullName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "fd5c7fe9-1025-4e5a-bf43-82aa99ae94c5",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Subject",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single HelpDeskMessage by Id

Gets one helpdeskmessage record by its Id.
GET https://spaces.nexudus.com/api/support/helpdeskmessages/:Id

πŸ”’ Requires role "HelpDeskMessage-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Closed": false,
  "ClosedOn": ,
  "CoworkerId": 12345678,
  "HelpDeskDepartmentId": 12345678,
  "MessageText": "MessageText",
  "OwnerId": 12345678,
  "Priority": 1,
  "Subject": "Name",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "18e6aa6d-2755-4d94-bc22-07067897d774",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new HelpDeskMessage

Creates a new helpdeskmessage.
POST https://spaces.nexudus.com/api/support/helpdeskmessages

πŸ”’ Requires role "HelpDeskMessage-Create"

Body parameters
BusinessId: number required
CoworkerId: number required
HelpDeskDepartmentId: number optional
Subject: string required
MessageText: string required
Priority: Nexudus.Coworking.Core.Enums.eHelpDeskMessagePriority optional
Closed: bool optional
ClosedOn: DateTime? optional
OwnerId: number optional

Example request

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

{
    "BusinessId": 12345678,
    "CoworkerId": 12345678,
    "HelpDeskDepartmentId": 12345678,
    "Subject": "Name",
    "MessageText": "MessageText",
    "Priority": 1, //(check Enumerated values section below)
    "Closed": false,
    "ClosedOn": ,
    "OwnerId": 12345678,
}


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 HelpDeskMessage

Updates an existing helpdeskmessage.
PUT https://spaces.nexudus.com/api/support/helpdeskmessages

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

πŸ”’ Requires role "HelpDeskMessage-Edit"

Body parameters
Id: number required
The unique Id of the helpdeskmessage to update.
BusinessId: number cleared if missing
CoworkerId: number cleared if missing
HelpDeskDepartmentId: number cleared if missing
Subject: string cleared if missing
MessageText: string cleared if missing
Priority: Nexudus.Coworking.Core.Enums.eHelpDeskMessagePriority cleared if missing
Closed: bool cleared if missing
ClosedOn: DateTime? cleared if missing
OwnerId: number cleared if missing

Example request

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

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "CoworkerId": 12345678,
    "HelpDeskDepartmentId": 12345678,
    "Subject": "Name",
    "MessageText": "MessageText",
    "Priority": 1, //(check Enumerated values section below)
    "Closed": false,
    "ClosedOn": ,
    "OwnerId": 12345678,
}


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 HelpDeskMessage

Deletes an existing helpdeskmessage by its Id.
DELETE https://spaces.nexudus.com/api/support/helpdeskmessages/:Id

πŸ”’ Requires role "HelpDeskMessage-Delete"

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

Example request

DELETE https://spaces.nexudus.com/api/support/helpdeskmessages/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 helpdeskmessage 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 helpdeskmessage records.
GET https://spaces.nexudus.com/api/support/helpdeskmessages/commands

Example request

GET https://spaces.nexudus.com/api/support/helpdeskmessages/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 helpdeskmessage record IDs.
POST https://spaces.nexudus.com/api/support/helpdeskmessages/runacommand
πŸ”’ Requires role "HelpDeskMessage-Edit"

Example request

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

Priority

GET /api/utils/enums?name=eHelpDeskMessagePriority

Binary files

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

Image

GET https://spaces.nexudus.com/api/support/helpdeskmessages/getimage/:id
URL parameters
Id: number required
The id of the HelpDeskMessage to get the image 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.