GET api/SecureMessageRecipients/search?searchTerm={searchTerm}&page={page}&itemsPerPage={itemsPerPage}

Gets a list of secure recipients.

Request Information

URI Parameters

Name	Description	Type	Additional information
searchTerm	Search term.	string	Default value is
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

ListModelOfSecureRecipientModel

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 SecureRecipientModel	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalItems": 1,
  "ItemsPerPage": 2,
  "CurrentPage": 3,
  "TotalPages": 4,
  "FirstRowOnPage": 5,
  "LastRowOnPage": 6,
  "Rows": [
    {
      "Id": "900cf5a4-b336-4c10-9c04-58885c39497b",
      "Name": "sample string 2"
    },
    {
      "Id": "900cf5a4-b336-4c10-9c04-58885c39497b",
      "Name": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<ListModelOfSecureRecipientModelfe5TJzr4 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:SecureRecipientModel>
      <d2p1:Id>900cf5a4-b336-4c10-9c04-58885c39497b</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:SecureRecipientModel>
    <d2p1:SecureRecipientModel>
      <d2p1:Id>900cf5a4-b336-4c10-9c04-58885c39497b</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:SecureRecipientModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfSecureRecipientModelfe5TJzr4>