GET api/AppointmentRequestLocations/search?accountNumber={accountNumber}&latitude={latitude}&longitude={longitude}&patientId={patientId}&distance={distance}&searchTerm={searchTerm}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of locations.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accountNumber

Account number

string

Required

latitude

Latitude of the location.

decimal number

Required

longitude

Longitude of the location.

decimal number

Required

patientId

Unique ID of patient.

globally unique identifier

None.

distance

Search radius.

decimal number

Default value is 15

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.

integer

Default value is 10

Body Parameters

None.

Response Information

Resource Description

ListModelOfLocationModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.

ItemsPerPage

integer

None.

CurrentPage

integer

None.

TotalPages

integer

None.

FirstRowOnPage

integer

None.

LastRowOnPage

integer

None.

Rows

Collection of LocationModel

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalItems": 1,
  "ItemsPerPage": 2,
  "CurrentPage": 3,
  "TotalPages": 4,
  "FirstRowOnPage": 5,
  "LastRowOnPage": 6,
  "Rows": [
    {
      "Id": "b9153620-d19d-4114-8393-57533c8f0460",
      "Name": "sample string 2",
      "Active": true,
      "Address1": "sample string 4",
      "Address2": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "Zip": "sample string 8",
      "CountryName": "sample string 9",
      "PhoneNumber": "sample string 10",
      "Notes": "sample string 11",
      "Latitude": 12.0,
      "Longitude": 13.0,
      "DistanceToAddress": 14.0,
      "EmailAddress": "sample string 15",
      "DoctorsQuantity": 16
    },
    {
      "Id": "b9153620-d19d-4114-8393-57533c8f0460",
      "Name": "sample string 2",
      "Active": true,
      "Address1": "sample string 4",
      "Address2": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "Zip": "sample string 8",
      "CountryName": "sample string 9",
      "PhoneNumber": "sample string 10",
      "Notes": "sample string 11",
      "Latitude": 12.0,
      "Longitude": 13.0,
      "DistanceToAddress": 14.0,
      "EmailAddress": "sample string 15",
      "DoctorsQuantity": 16
    }
  ]
}

application/xml, text/xml

Sample:
<ListModelOfLocationModelaKbTw8r2 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.AppointmentRequests">
    <d2p1:LocationModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Address1>sample string 4</d2p1:Address1>
      <d2p1:Address2>sample string 5</d2p1:Address2>
      <d2p1:City>sample string 6</d2p1:City>
      <d2p1:CountryName>sample string 9</d2p1:CountryName>
      <d2p1:DistanceToAddress>14</d2p1:DistanceToAddress>
      <d2p1:DoctorsQuantity>16</d2p1:DoctorsQuantity>
      <d2p1:EmailAddress>sample string 15</d2p1:EmailAddress>
      <d2p1:Id>b9153620-d19d-4114-8393-57533c8f0460</d2p1:Id>
      <d2p1:Latitude>12</d2p1:Latitude>
      <d2p1:Longitude>13</d2p1:Longitude>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Notes>sample string 11</d2p1:Notes>
      <d2p1:PhoneNumber>sample string 10</d2p1:PhoneNumber>
      <d2p1:State>sample string 7</d2p1:State>
      <d2p1:Zip>sample string 8</d2p1:Zip>
    </d2p1:LocationModel>
    <d2p1:LocationModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Address1>sample string 4</d2p1:Address1>
      <d2p1:Address2>sample string 5</d2p1:Address2>
      <d2p1:City>sample string 6</d2p1:City>
      <d2p1:CountryName>sample string 9</d2p1:CountryName>
      <d2p1:DistanceToAddress>14</d2p1:DistanceToAddress>
      <d2p1:DoctorsQuantity>16</d2p1:DoctorsQuantity>
      <d2p1:EmailAddress>sample string 15</d2p1:EmailAddress>
      <d2p1:Id>b9153620-d19d-4114-8393-57533c8f0460</d2p1:Id>
      <d2p1:Latitude>12</d2p1:Latitude>
      <d2p1:Longitude>13</d2p1:Longitude>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Notes>sample string 11</d2p1:Notes>
      <d2p1:PhoneNumber>sample string 10</d2p1:PhoneNumber>
      <d2p1:State>sample string 7</d2p1:State>
      <d2p1:Zip>sample string 8</d2p1:Zip>
    </d2p1:LocationModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfLocationModelaKbTw8r2>