GET v1/message/{messageId}
Gets a specific message
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| messageId |
id of message |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
LUVIT.Main.BLL.LACAPI.Communication.LacapiMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| MessageId | integer |
None. |
|
| From | string |
None. |
|
| To | string |
None. |
|
| FromPersonalId | string |
None. |
|
| ToPersonalId | string |
None. |
|
| Subject | string |
None. |
|
| Sent | string |
None. |
|
| Message | string |
None. |
|
| CourseId | string |
None. |
|
| CourseTitle | string |
None. |
|
| HasAttachment | boolean |
None. |
|
| NoReply | boolean |
None. |
|
| DefaultGetEmailPortal | boolean |
None. |
|
| DefaultGetEmailCourse | boolean |
None. |
|
| string |
None. |
||
| Unread | boolean |
None. |
|
| ShowAllReceivers | boolean |
None. |
|
| Receivers | Collection of LUVIT.Main.BLL.LACAPI.Communication.LacapiMessageReceiver |
None. |
|
| Attachments | Collection of LUVIT.Main.BLL.LACAPI.Communication.LacapiMessageAttachment |
None. |
|
| Image | string |
None. |
|
| FolderId | integer |
None. |
Response Formats
application/json, text/json, application/scim+json
Sample:
{
"messageId": 1,
"from": "sample string 2",
"to": "sample string 3",
"fromPersonalId": "sample string 4",
"toPersonalId": "sample string 5",
"subject": "sample string 6",
"sent": "sample string 7",
"message": "sample string 8",
"courseId": "sample string 9",
"courseTitle": "sample string 10",
"hasAttachment": true,
"noReply": true,
"defaultGetEmailPortal": true,
"defaultGetEmailCourse": true,
"email": "sample string 15",
"unread": true,
"showAllReceivers": true,
"receivers": [
{
"receiver": "sample string 1",
"receiverId": "sample string 2",
"recieverType": "sample string 3",
"defaultGetEmailPortal": true,
"defaultGetEmailCourse": true,
"email": "sample string 6"
},
{
"receiver": "sample string 1",
"receiverId": "sample string 2",
"recieverType": "sample string 3",
"defaultGetEmailPortal": true,
"defaultGetEmailCourse": true,
"email": "sample string 6"
}
],
"attachments": [
{
"fileName": "sample string 1",
"url": "sample string 2"
},
{
"fileName": "sample string 1",
"url": "sample string 2"
}
],
"image": "sample string 18",
"folderId": 19
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MessageId" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="From" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="To" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="FromPersonalId" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ToPersonalId" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Subject" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Sent" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Message" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CourseId" sample string 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CourseTitle" sample string 10 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="HasAttachment" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="NoReply" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="DefaultGetEmailPortal" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="DefaultGetEmailCourse" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Email" sample string 15 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Unread" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ShowAllReceivers" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Receivers[0].Receiver" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Receivers[0].ReceiverId" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Receivers[0].RecieverType" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Receivers[0].DefaultGetEmailPortal" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Receivers[0].DefaultGetEmailCourse" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Receivers[0].Email" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Receivers[1].Receiver" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Receivers[1].ReceiverId" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Receivers[1].RecieverType" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Receivers[1].DefaultGetEmailPortal" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Receivers[1].DefaultGetEmailCourse" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Receivers[1].Email" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Attachments[0].FileName" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Attachments[0].Url" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Attachments[1].FileName" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Attachments[1].Url" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Image" sample string 18 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="FolderId" 19 --MultipartDataMediaFormatterBoundary1q2w3e--