GET api/ContactLensOrders/search?createdUtcOperator={createdUtcOperator}&createdUtc1={createdUtc1}&createdUtc2={createdUtc2}&page={page}&itemsPerPage={itemsPerPage}

Gets a list of contact lens orders.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
createdUtcOperator

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

string

Default value is

createdUtc1

Used to filter the list based on the created date of the contact lens order.

date

None.

createdUtc2

Used to filter the list based on the created date of the contact lens order (only when comparison operator is Between).

date

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 contact lens orders

ListModelOfContactLensOrderModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.

ItemsPerPage

integer

None.

CurrentPage

integer

None.

TotalPages

integer

None.

FirstRowOnPage

integer

None.

LastRowOnPage

integer

None.

Rows

Collection of ContactLensOrderModel

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalItems": 1,
  "ItemsPerPage": 2,
  "CurrentPage": 3,
  "TotalPages": 4,
  "FirstRowOnPage": 5,
  "LastRowOnPage": 6,
  "Rows": [
    {
      "Id": 1,
      "CreatedUtc": "sample string 2",
      "LensNameLeftEye": "sample string 3",
      "LensDetailLeftEye": "sample string 4",
      "OrderAmountLeftEye": "sample string 5",
      "LensNameRightEye": "sample string 6",
      "LensDetailRightEye": "sample string 7",
      "OrderAmountRightEye": "sample string 8",
      "Comments": "sample string 9",
      "MessageToPracticeId": "5e307d59-89bb-46cf-aa81-65879bbdca2e"
    },
    {
      "Id": 1,
      "CreatedUtc": "sample string 2",
      "LensNameLeftEye": "sample string 3",
      "LensDetailLeftEye": "sample string 4",
      "OrderAmountLeftEye": "sample string 5",
      "LensNameRightEye": "sample string 6",
      "LensDetailRightEye": "sample string 7",
      "OrderAmountRightEye": "sample string 8",
      "Comments": "sample string 9",
      "MessageToPracticeId": "5e307d59-89bb-46cf-aa81-65879bbdca2e"
    }
  ]
}

application/xml, text/xml

Sample:
<ListModelOfContactLensOrderModelOdWhz8ip 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.ContactLensOrders">
    <d2p1:ContactLensOrderModel>
      <d2p1:Comments>sample string 9</d2p1:Comments>
      <d2p1:CreatedUtc>sample string 2</d2p1:CreatedUtc>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LensDetailLeftEye>sample string 4</d2p1:LensDetailLeftEye>
      <d2p1:LensDetailRightEye>sample string 7</d2p1:LensDetailRightEye>
      <d2p1:LensNameLeftEye>sample string 3</d2p1:LensNameLeftEye>
      <d2p1:LensNameRightEye>sample string 6</d2p1:LensNameRightEye>
      <d2p1:MessageToPracticeId>5e307d59-89bb-46cf-aa81-65879bbdca2e</d2p1:MessageToPracticeId>
      <d2p1:OrderAmountLeftEye>sample string 5</d2p1:OrderAmountLeftEye>
      <d2p1:OrderAmountRightEye>sample string 8</d2p1:OrderAmountRightEye>
    </d2p1:ContactLensOrderModel>
    <d2p1:ContactLensOrderModel>
      <d2p1:Comments>sample string 9</d2p1:Comments>
      <d2p1:CreatedUtc>sample string 2</d2p1:CreatedUtc>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LensDetailLeftEye>sample string 4</d2p1:LensDetailLeftEye>
      <d2p1:LensDetailRightEye>sample string 7</d2p1:LensDetailRightEye>
      <d2p1:LensNameLeftEye>sample string 3</d2p1:LensNameLeftEye>
      <d2p1:LensNameRightEye>sample string 6</d2p1:LensNameRightEye>
      <d2p1:MessageToPracticeId>5e307d59-89bb-46cf-aa81-65879bbdca2e</d2p1:MessageToPracticeId>
      <d2p1:OrderAmountLeftEye>sample string 5</d2p1:OrderAmountLeftEye>
      <d2p1:OrderAmountRightEye>sample string 8</d2p1:OrderAmountRightEye>
    </d2p1:ContactLensOrderModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfContactLensOrderModelOdWhz8ip>