GET api/SecureMessagesToPractice/search?messageStatus={messageStatus}&searchTerm={searchTerm}&secureRecipientName={secureRecipientName}&getFullBody={getFullBody}&page={page}&itemsPerPage={itemsPerPage}

Gets a list of sent secure messages

Request Information

URI Parameters

Name	Description	Type	Additional information
messageStatus	Message status. Possible values Sent and Draft.	string	Default value is Sent
searchTerm	Search term.	string	Default value is
secureRecipientName	Name of the recipient	string	Default value is
getFullBody	Indicates if full body of message should be returned.	boolean	Default value is False
page	Page number requested (search results are paginated).	integer	Default value is 1
itemsPerPage	Items to return on each page. See page parameter above. Pass 0 to get all records.	integer	Default value is 10

Body Parameters

None.

Response Information

Resource Description

ListModelOfMessageToPracticeModel

Name	Type	Additional information
TotalItems	integer	None.
ItemsPerPage	integer	None.
CurrentPage	integer	None.
TotalPages	integer	None.
FirstRowOnPage	integer	None.
LastRowOnPage	integer	None.
Rows	Collection of MessageToPracticeModel	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalItems": 1,
  "ItemsPerPage": 2,
  "CurrentPage": 3,
  "TotalPages": 4,
  "FirstRowOnPage": 5,
  "LastRowOnPage": 6,
  "Rows": [
    {
      "Id": "765ae762-7b6f-4c60-ace6-b7f4f0099e5f",
      "CreationDate": "sample string 2",
      "Priority": "sample string 3",
      "Status": "sample string 4",
      "Read": true,
      "SecureRecipientId": "1b7edc04-1f5f-4ad3-b7c4-86a7680f9cde",
      "SecureRecipientName": "sample string 7",
      "Subject": "sample string 8",
      "Body": "sample string 9",
      "SentDate": "sample string 10"
    },
    {
      "Id": "765ae762-7b6f-4c60-ace6-b7f4f0099e5f",
      "CreationDate": "sample string 2",
      "Priority": "sample string 3",
      "Status": "sample string 4",
      "Read": true,
      "SecureRecipientId": "1b7edc04-1f5f-4ad3-b7c4-86a7680f9cde",
      "SecureRecipientName": "sample string 7",
      "Subject": "sample string 8",
      "Body": "sample string 9",
      "SentDate": "sample string 10"
    }
  ]
}

application/xml, text/xml

Sample:

<ListModelOfMessageToPracticeModelfe5TJzr4 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models">
  <CurrentPage>3</CurrentPage>
  <FirstRowOnPage>5</FirstRowOnPage>
  <ItemsPerPage>2</ItemsPerPage>
  <LastRowOnPage>6</LastRowOnPage>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.SecureMessages">
    <d2p1:MessageToPracticeModel>
      <d2p1:Body>sample string 9</d2p1:Body>
      <d2p1:CreationDate>sample string 2</d2p1:CreationDate>
      <d2p1:Id>765ae762-7b6f-4c60-ace6-b7f4f0099e5f</d2p1:Id>
      <d2p1:Priority>sample string 3</d2p1:Priority>
      <d2p1:Read>true</d2p1:Read>
      <d2p1:SecureRecipientId>1b7edc04-1f5f-4ad3-b7c4-86a7680f9cde</d2p1:SecureRecipientId>
      <d2p1:SecureRecipientName>sample string 7</d2p1:SecureRecipientName>
      <d2p1:SentDate>sample string 10</d2p1:SentDate>
      <d2p1:Status>sample string 4</d2p1:Status>
      <d2p1:Subject>sample string 8</d2p1:Subject>
    </d2p1:MessageToPracticeModel>
    <d2p1:MessageToPracticeModel>
      <d2p1:Body>sample string 9</d2p1:Body>
      <d2p1:CreationDate>sample string 2</d2p1:CreationDate>
      <d2p1:Id>765ae762-7b6f-4c60-ace6-b7f4f0099e5f</d2p1:Id>
      <d2p1:Priority>sample string 3</d2p1:Priority>
      <d2p1:Read>true</d2p1:Read>
      <d2p1:SecureRecipientId>1b7edc04-1f5f-4ad3-b7c4-86a7680f9cde</d2p1:SecureRecipientId>
      <d2p1:SecureRecipientName>sample string 7</d2p1:SecureRecipientName>
      <d2p1:SentDate>sample string 10</d2p1:SentDate>
      <d2p1:Status>sample string 4</d2p1:Status>
      <d2p1:Subject>sample string 8</d2p1:Subject>
    </d2p1:MessageToPracticeModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfMessageToPracticeModelfe5TJzr4>