GET api/MedicationRefillRequestsOnly/search?createdOperator={createdOperator}&created1={created1}&created2={created2}&medicationName={medicationName}&pharmacyName={pharmacyName}&pharmacyPhone={pharmacyPhone}&secureRecipientId[0]={secureRecipientId[0]}&secureRecipientId[1]={secureRecipientId[1]}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of refill request only of a medication.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
createdOperator

Operator used to filter the list based on the created date of the refill request only. Possible values: NotCompare (equals to empty string ""), Equals, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, Between, DifferentThan, Contains, StartsWith

string

Default value is

created1

Used to filter the list based on the created date of the refill request only.

date

None.

created2

Used to filter the list based on the created date of the refill request only (only when comparison operator is Between).

date

None.

medicationName

Name of the medication for filtering refill request only.

string

Default value is

pharmacyName

Name of the pharmacy for filtering refill request only.

string

Default value is

pharmacyPhone

Phone of the pharmacy for filtering refill request only.

string

Default value is

secureRecipientId

Unique ID of secure recipients for filtering refill request only.

Collection of globally unique identifier

None.

page

Page number requested (search results are paginated).

integer

Default value is 1

itemsPerPage

Items to return on each page. See page parameter above.

integer

Default value is 10

Body Parameters

None.

Response Information

Resource Description

Returns a list of refill request only of a medication.

ListModelOfMedicationRefillRequestOnlyModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.

ItemsPerPage

integer

None.

CurrentPage

integer

None.

TotalPages

integer

None.

FirstRowOnPage

integer

None.

LastRowOnPage

integer

None.

Rows

Collection of MedicationRefillRequestOnlyModel

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalItems": 1,
  "ItemsPerPage": 2,
  "CurrentPage": 3,
  "TotalPages": 4,
  "FirstRowOnPage": 5,
  "LastRowOnPage": 6,
  "Rows": [
    {
      "Id": 1,
      "Created": "sample string 2",
      "PatientFullName": "sample string 3",
      "MedicationName": "sample string 4",
      "PatientComments": "sample string 5",
      "PharmacyName": "sample string 6",
      "PharmacyPhone": "sample string 7",
      "PharmacyAddress1": "sample string 8",
      "PharmacyAddress2": "sample string 9",
      "PharmacyCity": "sample string 10",
      "PharmacyState": "sample string 11",
      "PharmacyZip": "sample string 12",
      "SecureRecipientId": "e0afb382-0f0f-49e2-b199-0b30054383fd",
      "PreferredPharmacyName": "sample string 14",
      "PreferredPharmacyPhone": "sample string 15",
      "PreferredPharmacyAddress1": "sample string 16",
      "PreferredPharmacyAddress2": "sample string 17",
      "PreferredPharmacyCity": "sample string 18",
      "PreferredPharmacyState": "sample string 19",
      "PreferredPharmacyZip": "sample string 20"
    },
    {
      "Id": 1,
      "Created": "sample string 2",
      "PatientFullName": "sample string 3",
      "MedicationName": "sample string 4",
      "PatientComments": "sample string 5",
      "PharmacyName": "sample string 6",
      "PharmacyPhone": "sample string 7",
      "PharmacyAddress1": "sample string 8",
      "PharmacyAddress2": "sample string 9",
      "PharmacyCity": "sample string 10",
      "PharmacyState": "sample string 11",
      "PharmacyZip": "sample string 12",
      "SecureRecipientId": "e0afb382-0f0f-49e2-b199-0b30054383fd",
      "PreferredPharmacyName": "sample string 14",
      "PreferredPharmacyPhone": "sample string 15",
      "PreferredPharmacyAddress1": "sample string 16",
      "PreferredPharmacyAddress2": "sample string 17",
      "PreferredPharmacyCity": "sample string 18",
      "PreferredPharmacyState": "sample string 19",
      "PreferredPharmacyZip": "sample string 20"
    }
  ]
}

application/xml, text/xml

Sample:
<ListModelOfMedicationRefillRequestOnlyModely579f2rt 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.PatientMedications">
    <d2p1:MedicationRefillRequestOnlyModel>
      <d2p1:Created>sample string 2</d2p1:Created>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:MedicationName>sample string 4</d2p1:MedicationName>
      <d2p1:PatientComments>sample string 5</d2p1:PatientComments>
      <d2p1:PatientFullName>sample string 3</d2p1:PatientFullName>
      <d2p1:PharmacyAddress1>sample string 8</d2p1:PharmacyAddress1>
      <d2p1:PharmacyAddress2>sample string 9</d2p1:PharmacyAddress2>
      <d2p1:PharmacyCity>sample string 10</d2p1:PharmacyCity>
      <d2p1:PharmacyName>sample string 6</d2p1:PharmacyName>
      <d2p1:PharmacyPhone>sample string 7</d2p1:PharmacyPhone>
      <d2p1:PharmacyState>sample string 11</d2p1:PharmacyState>
      <d2p1:PharmacyZip>sample string 12</d2p1:PharmacyZip>
      <d2p1:PreferredPharmacyAddress1>sample string 16</d2p1:PreferredPharmacyAddress1>
      <d2p1:PreferredPharmacyAddress2>sample string 17</d2p1:PreferredPharmacyAddress2>
      <d2p1:PreferredPharmacyCity>sample string 18</d2p1:PreferredPharmacyCity>
      <d2p1:PreferredPharmacyName>sample string 14</d2p1:PreferredPharmacyName>
      <d2p1:PreferredPharmacyPhone>sample string 15</d2p1:PreferredPharmacyPhone>
      <d2p1:PreferredPharmacyState>sample string 19</d2p1:PreferredPharmacyState>
      <d2p1:PreferredPharmacyZip>sample string 20</d2p1:PreferredPharmacyZip>
      <d2p1:SecureRecipientId>e0afb382-0f0f-49e2-b199-0b30054383fd</d2p1:SecureRecipientId>
    </d2p1:MedicationRefillRequestOnlyModel>
    <d2p1:MedicationRefillRequestOnlyModel>
      <d2p1:Created>sample string 2</d2p1:Created>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:MedicationName>sample string 4</d2p1:MedicationName>
      <d2p1:PatientComments>sample string 5</d2p1:PatientComments>
      <d2p1:PatientFullName>sample string 3</d2p1:PatientFullName>
      <d2p1:PharmacyAddress1>sample string 8</d2p1:PharmacyAddress1>
      <d2p1:PharmacyAddress2>sample string 9</d2p1:PharmacyAddress2>
      <d2p1:PharmacyCity>sample string 10</d2p1:PharmacyCity>
      <d2p1:PharmacyName>sample string 6</d2p1:PharmacyName>
      <d2p1:PharmacyPhone>sample string 7</d2p1:PharmacyPhone>
      <d2p1:PharmacyState>sample string 11</d2p1:PharmacyState>
      <d2p1:PharmacyZip>sample string 12</d2p1:PharmacyZip>
      <d2p1:PreferredPharmacyAddress1>sample string 16</d2p1:PreferredPharmacyAddress1>
      <d2p1:PreferredPharmacyAddress2>sample string 17</d2p1:PreferredPharmacyAddress2>
      <d2p1:PreferredPharmacyCity>sample string 18</d2p1:PreferredPharmacyCity>
      <d2p1:PreferredPharmacyName>sample string 14</d2p1:PreferredPharmacyName>
      <d2p1:PreferredPharmacyPhone>sample string 15</d2p1:PreferredPharmacyPhone>
      <d2p1:PreferredPharmacyState>sample string 19</d2p1:PreferredPharmacyState>
      <d2p1:PreferredPharmacyZip>sample string 20</d2p1:PreferredPharmacyZip>
      <d2p1:SecureRecipientId>e0afb382-0f0f-49e2-b199-0b30054383fd</d2p1:SecureRecipientId>
    </d2p1:MedicationRefillRequestOnlyModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfMedicationRefillRequestOnlyModely579f2rt>