From db7ea5aba7bd10666ceb00f0c8f8197380f90bbe Mon Sep 17 00:00:00 2001 From: LiNEX GIT Date: Tue, 11 Jun 2024 15:17:06 +0700 Subject: [PATCH] Update 'Return message details' --- Return-message-details.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 Return-message-details.md diff --git a/Return-message-details.md b/Return-message-details.md new file mode 100644 index 0000000..4acf2b9 --- /dev/null +++ b/Return-message-details.md @@ -0,0 +1,39 @@ +Return message details +====================== + +Returns all details about a message + +URL +--- + +`/api/v1/messages/message` + +Access +------ + +Must be authenticated as a server. If not authorised, a `AccessDenied` error will be returned. + +Parameters +---------- + +| Parameter | Type | Default | +| --- | --- | --- | +|`id` | Integer | null | + +|_The ID of the message_| | | + + +Errors +------ + +| Error | Attributes | +| --- | --- | +|`MessageNotFound`| `id` | | +|No message found matching provided ID | The ID of the message | + +Response Data +------------- + +This action will return a [message structure](message-structure.md). + +You will only receive basic data for this structure, no extended data is available. By default, you'll receive no expansions for the structure. You can add them by providing an array of new expansion names in the `_expansions` parameter on the request. You can send `true` rather than array to receive all expansions. \ No newline at end of file