GET api/Locations?mainOnly={mainOnly}&specialtyID={specialtyID}&city={city}

Get locations with filter/search parameters

Request Information

URI Parameters

Name	Description	Type	Additional information
mainOnly	True/False to only show Main Locations	boolean	Required
specialtyID	Use 0 for all specialties	integer	Default value is 0
city	City name. Leave blank for all cities	string	Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of Location

Name	Type	Additional information
ID	integer	None.
Name	string	None.
Address1	string	None.
Address2	string	None.
City	string	None.
State	string	None.
Zip	string	None.
Email	string	None.
URL	string	None.
SortOrder	integer	None.
Active	boolean	None.
Latitude	decimal number	None.
Longitude	decimal number	None.
Image	string	None.
AlternateText	string	None.
SEOTitle	string	None.
SEODescription	string	None.
Content	string	None.
URLToLocationDetail	string	None.
PhoneNumbers	Collection of LocationPhone	None.
LocationLongName	string	None.
HeaderImage	string	None.
ThumbImage	string	None.
OutreachLocation	boolean	None.
DisplayMain	boolean	None.
MapUrl	string	None.
DirectionsUrl	string	None.
MainLocationID	integer	None.
PrimaryPhone	string	None.
ShowDoctors	boolean	None.
HidePhoneNumbers	boolean	None.
CareOption	string	None.
Specialties	Collection of Specialty	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "Name": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "Zip": "sample string 7",
    "Email": "sample string 8",
    "URL": "sample string 9",
    "SortOrder": 10,
    "Active": true,
    "Latitude": 12.1,
    "Longitude": 13.1,
    "Image": "sample string 14",
    "AlternateText": "sample string 15",
    "SEOTitle": "sample string 16",
    "SEODescription": "sample string 17",
    "Content": "sample string 18",
    "URLToLocationDetail": "https://iowaclinic.spinudev.com/locations/sample string 9/",
    "PhoneNumbers": [
      {
        "PhoneNumber": "sample string 26",
        "PhoneType": "Primary"
      }
    ],
    "LocationLongName": "sample string 2 - sample string 3, sample string 5",
    "HeaderImage": "sample string 19",
    "ThumbImage": "sample string 20",
    "OutreachLocation": true,
    "DisplayMain": true,
    "MapUrl": "sample string 23",
    "DirectionsUrl": "sample string 24",
    "MainLocationID": 25,
    "PrimaryPhone": "sample string 26",
    "ShowDoctors": true,
    "HidePhoneNumbers": true,
    "CareOption": "sample string 29",
    "Specialties": []
  },
  {
    "ID": 1,
    "Name": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "Zip": "sample string 7",
    "Email": "sample string 8",
    "URL": "sample string 9",
    "SortOrder": 10,
    "Active": true,
    "Latitude": 12.1,
    "Longitude": 13.1,
    "Image": "sample string 14",
    "AlternateText": "sample string 15",
    "SEOTitle": "sample string 16",
    "SEODescription": "sample string 17",
    "Content": "sample string 18",
    "URLToLocationDetail": "https://iowaclinic.spinudev.com/locations/sample string 9/",
    "PhoneNumbers": [
      {
        "PhoneNumber": "sample string 26",
        "PhoneType": "Primary"
      }
    ],
    "LocationLongName": "sample string 2 - sample string 3, sample string 5",
    "HeaderImage": "sample string 19",
    "ThumbImage": "sample string 20",
    "OutreachLocation": true,
    "DisplayMain": true,
    "MapUrl": "sample string 23",
    "DirectionsUrl": "sample string 24",
    "MainLocationID": 25,
    "PrimaryPhone": "sample string 26",
    "ShowDoctors": true,
    "HidePhoneNumbers": true,
    "CareOption": "sample string 29",
    "Specialties": []
  }
]

application/xml, text/xml

Sample:

<ArrayOfLocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iowaclinic_api.API">
  <Location>
    <Active>true</Active>
    <Address1>sample string 3</Address1>
    <Address2>sample string 4</Address2>
    <AlternateText>sample string 15</AlternateText>
    <CareOption>sample string 29</CareOption>
    <City>sample string 5</City>
    <Content>sample string 18</Content>
    <DirectionsUrl>sample string 24</DirectionsUrl>
    <DisplayMain>true</DisplayMain>
    <Email>sample string 8</Email>
    <HeaderImage>sample string 19</HeaderImage>
    <HidePhoneNumbers>true</HidePhoneNumbers>
    <ID>1</ID>
    <Image>sample string 14</Image>
    <Latitude>12.1</Latitude>
    <Longitude>13.1</Longitude>
    <MainLocationID>25</MainLocationID>
    <MapUrl>sample string 23</MapUrl>
    <Name>sample string 2</Name>
    <OutreachLocation>true</OutreachLocation>
    <PhoneNumbers>
      <LocationPhone>
        <PhoneNumber>sample string 26</PhoneNumber>
        <PhoneType>Primary</PhoneType>
      </LocationPhone>
    </PhoneNumbers>
    <PrimaryPhone>sample string 26</PrimaryPhone>
    <SEODescription>sample string 17</SEODescription>
    <SEOTitle>sample string 16</SEOTitle>
    <ShowDoctors>true</ShowDoctors>
    <SortOrder>10</SortOrder>
    <Specialties />
    <State>sample string 6</State>
    <ThumbImage>sample string 20</ThumbImage>
    <URL>sample string 9</URL>
    <Zip>sample string 7</Zip>
  </Location>
  <Location>
    <Active>true</Active>
    <Address1>sample string 3</Address1>
    <Address2>sample string 4</Address2>
    <AlternateText>sample string 15</AlternateText>
    <CareOption>sample string 29</CareOption>
    <City>sample string 5</City>
    <Content>sample string 18</Content>
    <DirectionsUrl>sample string 24</DirectionsUrl>
    <DisplayMain>true</DisplayMain>
    <Email>sample string 8</Email>
    <HeaderImage>sample string 19</HeaderImage>
    <HidePhoneNumbers>true</HidePhoneNumbers>
    <ID>1</ID>
    <Image>sample string 14</Image>
    <Latitude>12.1</Latitude>
    <Longitude>13.1</Longitude>
    <MainLocationID>25</MainLocationID>
    <MapUrl>sample string 23</MapUrl>
    <Name>sample string 2</Name>
    <OutreachLocation>true</OutreachLocation>
    <PhoneNumbers>
      <LocationPhone>
        <PhoneNumber>sample string 26</PhoneNumber>
        <PhoneType>Primary</PhoneType>
      </LocationPhone>
    </PhoneNumbers>
    <PrimaryPhone>sample string 26</PrimaryPhone>
    <SEODescription>sample string 17</SEODescription>
    <SEOTitle>sample string 16</SEOTitle>
    <ShowDoctors>true</ShowDoctors>
    <SortOrder>10</SortOrder>
    <Specialties />
    <State>sample string 6</State>
    <ThumbImage>sample string 20</ThumbImage>
    <URL>sample string 9</URL>
    <Zip>sample string 7</Zip>
  </Location>
</ArrayOfLocation>