Message Route¶

Routes¶

FindAll¶

GET <base_url>/messages

Authentication: Required

Returns all messages from the system that the user has access to Parameters ^^^^^^^^^^

Query¶

Name	Description	Type	Default Value
limit	The maximimum number of results to return. Cannot exceed `1000`.	number	`100`
skip	The number of items to skip in the results (pagination).	number	`0`
sort	An object containing the name of the member to sort by and the order in which to sort.	object	`{ member: "<ASC\|DESC>" }`

Create¶

POST <base_url>/messages

Authentication: Required

Create a new message. Parameters ^^^^^^^^^^

Count¶

GET <base_url>/messages/count

Authentication: Required

Returns the count of messages Parameters ^^^^^^^^^^

FindById¶

GET <base_url>/messages/:id

Authentication: Required

Returns a single message from the system that the user has access to Parameters ^^^^^^^^^^ * Name id

Delete¶

DELETE <base_url>/messages/:id

Authentication: Required

Deletes the message Parameters ^^^^^^^^^^ * Name id

MarkRead¶

GET <base_url>/messages/:id/read

Authentication: Required

Marks the message with the given id as having been read by the user. Parameters ^^^^^^^^^^ * Name id

FindInboxByUserUid¶

GET <base_url>/messages/:userUid/inbox

Authentication: Required

Returns all of the messages from the system that have been sent to the given user. Parameters ^^^^^^^^^^ * Name userUid

DeleteInboxByUserUid¶

DELETE <base_url>/messages/:userUid/inbox

Authentication: Required

Deletes all messages sent to the given user. Parameters ^^^^^^^^^^ * Name userUid

FindSentByUserUid¶

GET <base_url>/messages/:userUid/sent

Authentication: Required

Returns all of the messages from the system that have been sent by the given user. Parameters ^^^^^^^^^^ * Name userUid

DeleteSentByUserUid¶

DELETE <base_url>/messages/:userUid/sent

Authentication: Required

Deletes all messages sent by the given user. Parameters ^^^^^^^^^^ * Name userUid

FindByIdAndUserUid¶

GET <base_url>/messages/:userUid/{id}

Authentication: Required

Returns the messages from the system with the given id that was sent to the given user. Parameters ^^^^^^^^^^ * Name userUid * Name id

DeleteByIdAndUserUid¶

DELETE <base_url>/messages/:userUid/{id}

Authentication: Required

Deletes the message with the given id that sent to the given user. Parameters ^^^^^^^^^^ * Name userUid * Name id

MarkReadByIdAndUserId¶

GET <base_url>/messages/:userUid/{id}/read

Authentication: Required

Marks the message with the given id as having been read by the user. Parameters ^^^^^^^^^^ * Name userUid * Name id