POST Api/Values/GetOutGoingMessage

Request Information

URI Parameters

None.

Body Parameters

PagingParameterModel
NameDescriptionTypeAdditional information
searchText

string

None.

pageNumber

integer

None.

_pageSize

integer

None.

pageSize

integer

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:
{
  "searchText": "sample string 1",
  "pageNumber": 2,
  "_pageSize": 4,
  "pageSize": 4,
  "CampusName": "sample string 5",
  "UserID": "sample string 6",
  "DeviceID": "sample string 7",
  "DeviceOS": "sample string 8",
  "Version": "sample string 9",
  "accessToken": "sample string 10"
}

text/html

Sample:
{"searchText":"sample string 1","pageNumber":2,"_pageSize":4,"pageSize":4,"CampusName":"sample string 5","UserID":"sample string 6","DeviceID":"sample string 7","DeviceOS":"sample string 8","Version":"sample string 9","accessToken":"sample string 10"}

application/xml, text/xml

Sample:
<PagingParameterModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">
  <CampusName>sample string 5</CampusName>
  <DeviceID>sample string 7</DeviceID>
  <DeviceOS>sample string 8</DeviceOS>
  <UserID>sample string 6</UserID>
  <Version>sample string 9</Version>
  <accessToken>sample string 10</accessToken>
  <_pageSize>4</_pageSize>
  <pageNumber>2</pageNumber>
  <pageSize>4</pageSize>
  <searchText>sample string 1</searchText>
</PagingParameterModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MessageReturnResult
NameDescriptionTypeAdditional information
status

boolean

None.

message

string

None.

messageList

Collection of ALL_INSTANTMESSAGES

None.

totalCount

integer

None.

pageSize

integer

None.

currentPage

integer

None.

totalPages

integer

None.

previousPage

boolean

None.

nextPage

boolean

None.

accessToken

string

None.

Response Formats

application/json, text/json

Sample:
{
  "status": true,
  "message": "sample string 2",
  "messageList": [
    {
      "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-05-31T22:09:34.9523757-04:00",
      "IM_ARCHIVED": 1,
      "IM_CREATEDATE": "2025-05-31T22:09:34.9523757-04:00",
      "IM_CREATEUSERID": "sample string 8",
      "IM_ALTNOTIFICATIONSENT": 1,
      "IM_ALTNOTIFICATIONADDRESS": "sample string 9",
      "IM_AUTO_ARCHIVE_DATE": "2025-05-31T22:09:34.9523757-04: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"
    },
    {
      "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-05-31T22:09:34.9523757-04:00",
      "IM_ARCHIVED": 1,
      "IM_CREATEDATE": "2025-05-31T22:09:34.9523757-04:00",
      "IM_CREATEUSERID": "sample string 8",
      "IM_ALTNOTIFICATIONSENT": 1,
      "IM_ALTNOTIFICATIONADDRESS": "sample string 9",
      "IM_AUTO_ARCHIVE_DATE": "2025-05-31T22:09:34.9523757-04: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"
    }
  ],
  "totalCount": 3,
  "pageSize": 4,
  "currentPage": 5,
  "totalPages": 6,
  "previousPage": true,
  "nextPage": true,
  "accessToken": "a4768b1a-b5c1-4561-86e7-324b8a368354"
}

text/html

Sample:
{"status":true,"message":"sample string 2","messageList":[{"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-05-31T22:09:34.9523757-04:00","IM_ARCHIVED":1,"IM_CREATEDATE":"2025-05-31T22:09:34.9523757-04:00","IM_CREATEUSERID":"sample string 8","IM_ALTNOTIFICATIONSENT":1,"IM_ALTNOTIFICATIONADDRESS":"sample string 9","IM_AUTO_ARCHIVE_DATE":"2025-05-31T22:09:34.9523757-04: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"},{"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-05-31T22:09:34.9523757-04:00","IM_ARCHIVED":1,"IM_CREATEDATE":"2025-05-31T22:09:34.9523757-04:00","IM_CREATEUSERID":"sample string 8","IM_ALTNOTIFICATIONSENT":1,"IM_ALTNOTIFICATIONADDRESS":"sample string 9","IM_AUTO_ARCHIVE_DATE":"2025-05-31T22:09:34.9523757-04: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"}],"totalCount":3,"pageSize":4,"currentPage":5,"totalPages":6,"previousPage":true,"nextPage":true,"accessToken":"a4768b1a-b5c1-4561-86e7-324b8a368354"}

application/xml, text/xml

Sample:
<MessageReturnResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">
  <currentPage>5</currentPage>
  <message>sample string 2</message>
  <messageList>
    <ALL_INSTANTMESSAGES>
      <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-05-31T22:09:34.9523757-04:00</IM_AUTO_ARCHIVE_DATE>
      <IM_CREATEDATE>2025-05-31T22:09:34.9523757-04: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-05-31T22:09:34.9523757-04: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>
    </ALL_INSTANTMESSAGES>
    <ALL_INSTANTMESSAGES>
      <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-05-31T22:09:34.9523757-04:00</IM_AUTO_ARCHIVE_DATE>
      <IM_CREATEDATE>2025-05-31T22:09:34.9523757-04: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-05-31T22:09:34.9523757-04: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>
    </ALL_INSTANTMESSAGES>
  </messageList>
  <nextPage>true</nextPage>
  <pageSize>4</pageSize>
  <previousPage>true</previousPage>
  <status>true</status>
  <totalCount>3</totalCount>
  <totalPages>6</totalPages>
</MessageReturnResult>