POST Api/Values/GetMessageById
Request Information
URI Parameters
None.
Body Parameters
GetMessageModel| Name | Description | Type | Additional information |
|---|---|---|---|
| IM_ID | decimal number |
None. |
|
| CampusName | string |
None. |
|
| UserID | string |
None. |
|
| DeviceID | string |
None. |
|
| DeviceOS | string |
None. |
|
| Version | string |
None. |
|
| accessToken | string |
Required Matching regular expression pattern: ^a4768b1a-b5c1-4561-86e7-324b8a368354$ |
Request Formats
application/json, text/json
Sample:
{
"IM_ID": 1.0,
"CampusName": "sample string 2",
"UserID": "sample string 3",
"DeviceID": "sample string 4",
"DeviceOS": "sample string 5",
"Version": "sample string 6",
"accessToken": "sample string 7"
}
text/html
Sample:
{"IM_ID":1.0,"CampusName":"sample string 2","UserID":"sample string 3","DeviceID":"sample string 4","DeviceOS":"sample string 5","Version":"sample string 6","accessToken":"sample string 7"}
application/xml, text/xml
Sample:
<GetMessageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model"> <CampusName>sample string 2</CampusName> <DeviceID>sample string 4</DeviceID> <DeviceOS>sample string 5</DeviceOS> <UserID>sample string 3</UserID> <Version>sample string 6</Version> <accessToken>sample string 7</accessToken> <IM_ID>1</IM_ID> </GetMessageModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
MessageItemReturnResult| Name | Description | Type | Additional information |
|---|---|---|---|
| status | boolean |
None. |
|
| message | string |
None. |
|
| messageItem | ALL_INSTANTMESSAGES |
None. |
Response Formats
application/json, text/json
Sample:
{
"status": true,
"message": "sample string 2",
"messageItem": {
"IM_ID": 1.0,
"IM_FROM": "sample string 2",
"IM_TO": "sample string 3",
"IM_SSN": 1.0,
"Student_Login": "sample string 4",
"Student_FirstName": "sample string 5",
"Student_LastName": "sample string 6",
"IM_APPROVED": 1,
"IM_MESSAGE": "sample string 7",
"IM_READCONFIRMED": 1,
"IM_READ_DATE": "2025-12-13T01:11:14.2231372-05:00",
"IM_ARCHIVED": 1,
"IM_CREATEDATE": "2025-12-13T01:11:14.2231372-05:00",
"IM_CREATEUSERID": "sample string 8",
"IM_ALTNOTIFICATIONSENT": 1,
"IM_ALTNOTIFICATIONADDRESS": "sample string 9",
"IM_AUTO_ARCHIVE_DATE": "2025-12-13T01:11:14.2231372-05:00",
"IM_STAFFID": 1.0,
"IM_SUBJECT": "sample string 10",
"IM_VIDEO_FILE": "sample string 11",
"IM_PICTURE_FILE": "sample string 12",
"IM_READ_USERS_IDS": "sample string 13"
}
}
text/html
Sample:
{"status":true,"message":"sample string 2","messageItem":{"IM_ID":1.0,"IM_FROM":"sample string 2","IM_TO":"sample string 3","IM_SSN":1.0,"Student_Login":"sample string 4","Student_FirstName":"sample string 5","Student_LastName":"sample string 6","IM_APPROVED":1,"IM_MESSAGE":"sample string 7","IM_READCONFIRMED":1,"IM_READ_DATE":"2025-12-13T01:11:14.2231372-05:00","IM_ARCHIVED":1,"IM_CREATEDATE":"2025-12-13T01:11:14.2231372-05:00","IM_CREATEUSERID":"sample string 8","IM_ALTNOTIFICATIONSENT":1,"IM_ALTNOTIFICATIONADDRESS":"sample string 9","IM_AUTO_ARCHIVE_DATE":"2025-12-13T01:11:14.2231372-05:00","IM_STAFFID":1.0,"IM_SUBJECT":"sample string 10","IM_VIDEO_FILE":"sample string 11","IM_PICTURE_FILE":"sample string 12","IM_READ_USERS_IDS":"sample string 13"}}
application/xml, text/xml
Sample:
<MessageItemReturnResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">
<message>sample string 2</message>
<messageItem>
<IM_ALTNOTIFICATIONADDRESS>sample string 9</IM_ALTNOTIFICATIONADDRESS>
<IM_ALTNOTIFICATIONSENT>1</IM_ALTNOTIFICATIONSENT>
<IM_APPROVED>1</IM_APPROVED>
<IM_ARCHIVED>1</IM_ARCHIVED>
<IM_AUTO_ARCHIVE_DATE>2025-12-13T01:11:14.2231372-05:00</IM_AUTO_ARCHIVE_DATE>
<IM_CREATEDATE>2025-12-13T01:11:14.2231372-05:00</IM_CREATEDATE>
<IM_CREATEUSERID>sample string 8</IM_CREATEUSERID>
<IM_FROM>sample string 2</IM_FROM>
<IM_ID>1</IM_ID>
<IM_MESSAGE>sample string 7</IM_MESSAGE>
<IM_PICTURE_FILE>sample string 12</IM_PICTURE_FILE>
<IM_READCONFIRMED>1</IM_READCONFIRMED>
<IM_READ_DATE>2025-12-13T01:11:14.2231372-05:00</IM_READ_DATE>
<IM_READ_USERS_IDS>sample string 13</IM_READ_USERS_IDS>
<IM_SSN>1</IM_SSN>
<IM_STAFFID>1</IM_STAFFID>
<IM_SUBJECT>sample string 10</IM_SUBJECT>
<IM_TO>sample string 3</IM_TO>
<IM_VIDEO_FILE>sample string 11</IM_VIDEO_FILE>
<Student_FirstName>sample string 5</Student_FirstName>
<Student_LastName>sample string 6</Student_LastName>
<Student_Login>sample string 4</Student_Login>
</messageItem>
<status>true</status>
</MessageItemReturnResult>