GET api/Hcps/GetHcps/{brand}/{zipCode}/{distance}

The GetHcps operation retrieves a list of HCP specialists associated with a specified brand and located within a specified distance of a specified zip code. Additional parameters can be specified via the querystring. These additional parameters control how the results are returns. See full documentation for details.

Request Information

URI Parameters

Name	Description	Type	Additional information
brand	The name of the brand for which to search for associated HCP specialists	string	Required
zipCode	The origin zip code around which to search	string	Required
distance	The distance (radius) within which to locate HCP specialists from the origin zip code	integer	Required

Body Parameters

None.

Response Information

Resource Description

JSON representing an HcpResults object. See detailed documentation for JSON format.

HcpResults

Name	Description	Type	Additional information
Status	Property that contains a Status object, indicating the status of the request	Status	None.
Hcps	Property containing the list of returned Hcp objects matching the search criteria	Collection of Hcp	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": {
    "StatusCode": 1,
    "StatusMessage": "sample string 2"
  },
  "Hcps": [
    {
      "HcpID": 1,
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4",
      "Suffix": "sample string 5",
      "Specialty": "sample string 6",
      "IsPriority": true,
      "Practice": {
        "PracticeID": 1,
        "Name": "sample string 2",
        "WebsiteURL": "sample string 3",
        "Locations": [
          {
            "LocationID": 1,
            "StreetAddress1": "sample string 2",
            "StreetAddress2": "sample string 3",
            "City": "sample string 4",
            "State": "sample string 5",
            "ZipCode": "sample string 6",
            "Phone": "sample string 7",
            "Fax": "sample string 8",
            "EmailAddress": "sample string 9",
            "Latitude": 10.0,
            "Longitude": 11.0,
            "Distance": 1.1
          },
          {
            "LocationID": 1,
            "StreetAddress1": "sample string 2",
            "StreetAddress2": "sample string 3",
            "City": "sample string 4",
            "State": "sample string 5",
            "ZipCode": "sample string 6",
            "Phone": "sample string 7",
            "Fax": "sample string 8",
            "EmailAddress": "sample string 9",
            "Latitude": 10.0,
            "Longitude": 11.0,
            "Distance": 1.1
          }
        ]
      }
    },
    {
      "HcpID": 1,
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4",
      "Suffix": "sample string 5",
      "Specialty": "sample string 6",
      "IsPriority": true,
      "Practice": {
        "PracticeID": 1,
        "Name": "sample string 2",
        "WebsiteURL": "sample string 3",
        "Locations": [
          {
            "LocationID": 1,
            "StreetAddress1": "sample string 2",
            "StreetAddress2": "sample string 3",
            "City": "sample string 4",
            "State": "sample string 5",
            "ZipCode": "sample string 6",
            "Phone": "sample string 7",
            "Fax": "sample string 8",
            "EmailAddress": "sample string 9",
            "Latitude": 10.0,
            "Longitude": 11.0,
            "Distance": 1.1
          },
          {
            "LocationID": 1,
            "StreetAddress1": "sample string 2",
            "StreetAddress2": "sample string 3",
            "City": "sample string 4",
            "State": "sample string 5",
            "ZipCode": "sample string 6",
            "Phone": "sample string 7",
            "Fax": "sample string 8",
            "EmailAddress": "sample string 9",
            "Latitude": 10.0,
            "Longitude": 11.0,
            "Distance": 1.1
          }
        ]
      }
    }
  ]
}

application/xml, text/xml

Sample:

<HcpResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MDLocatorService.Models">
  <Hcps>
    <Hcp>
      <FirstName>sample string 2</FirstName>
      <HcpID>1</HcpID>
      <IsPriority>true</IsPriority>
      <LastName>sample string 4</LastName>
      <MiddleName>sample string 3</MiddleName>
      <Practice>
        <Locations>
          <Location>
            <City>sample string 4</City>
            <Distance>1.1</Distance>
            <EmailAddress>sample string 9</EmailAddress>
            <Fax>sample string 8</Fax>
            <Latitude>10</Latitude>
            <LocationID>1</LocationID>
            <Longitude>11</Longitude>
            <Phone>sample string 7</Phone>
            <State>sample string 5</State>
            <StreetAddress1>sample string 2</StreetAddress1>
            <StreetAddress2>sample string 3</StreetAddress2>
            <ZipCode>sample string 6</ZipCode>
          </Location>
          <Location>
            <City>sample string 4</City>
            <Distance>1.1</Distance>
            <EmailAddress>sample string 9</EmailAddress>
            <Fax>sample string 8</Fax>
            <Latitude>10</Latitude>
            <LocationID>1</LocationID>
            <Longitude>11</Longitude>
            <Phone>sample string 7</Phone>
            <State>sample string 5</State>
            <StreetAddress1>sample string 2</StreetAddress1>
            <StreetAddress2>sample string 3</StreetAddress2>
            <ZipCode>sample string 6</ZipCode>
          </Location>
        </Locations>
        <Name>sample string 2</Name>
        <PracticeID>1</PracticeID>
        <WebsiteURL>sample string 3</WebsiteURL>
      </Practice>
      <Specialty>sample string 6</Specialty>
      <Suffix>sample string 5</Suffix>
    </Hcp>
    <Hcp>
      <FirstName>sample string 2</FirstName>
      <HcpID>1</HcpID>
      <IsPriority>true</IsPriority>
      <LastName>sample string 4</LastName>
      <MiddleName>sample string 3</MiddleName>
      <Practice>
        <Locations>
          <Location>
            <City>sample string 4</City>
            <Distance>1.1</Distance>
            <EmailAddress>sample string 9</EmailAddress>
            <Fax>sample string 8</Fax>
            <Latitude>10</Latitude>
            <LocationID>1</LocationID>
            <Longitude>11</Longitude>
            <Phone>sample string 7</Phone>
            <State>sample string 5</State>
            <StreetAddress1>sample string 2</StreetAddress1>
            <StreetAddress2>sample string 3</StreetAddress2>
            <ZipCode>sample string 6</ZipCode>
          </Location>
          <Location>
            <City>sample string 4</City>
            <Distance>1.1</Distance>
            <EmailAddress>sample string 9</EmailAddress>
            <Fax>sample string 8</Fax>
            <Latitude>10</Latitude>
            <LocationID>1</LocationID>
            <Longitude>11</Longitude>
            <Phone>sample string 7</Phone>
            <State>sample string 5</State>
            <StreetAddress1>sample string 2</StreetAddress1>
            <StreetAddress2>sample string 3</StreetAddress2>
            <ZipCode>sample string 6</ZipCode>
          </Location>
        </Locations>
        <Name>sample string 2</Name>
        <PracticeID>1</PracticeID>
        <WebsiteURL>sample string 3</WebsiteURL>
      </Practice>
      <Specialty>sample string 6</Specialty>
      <Suffix>sample string 5</Suffix>
    </Hcp>
  </Hcps>
  <Status>
    <StatusCode>1</StatusCode>
    <StatusMessage>sample string 2</StatusMessage>
  </Status>
</HcpResults>