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

The GetAccountsEa operation retrieves a list of accounts/practices associated with Endo Aesthetics 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

NameDescriptionTypeAdditional information
brand

The name of the brand for which to search for associated accounts/practices

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 AccountResultsEa object. See detailed documentation for JSON format.

AccountResults
NameDescriptionTypeAdditional information
Status

Property that contains a Status object, indicating the status of the request

Status

None.

Accounts

Property containing the list of returned Hcp objects matching the search criteria

Collection of Account

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": {
    "StatusCode": 1,
    "StatusMessage": "sample string 2"
  },
  "Accounts": [
    {
      "AccountID": 1,
      "Name": "sample string 2",
      "StreetAddress1": "sample string 3",
      "StreetAddress2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "ZipCode": "sample string 7",
      "Phone": "sample string 8",
      "Fax": "sample string 9",
      "EmailAddress": "sample string 10",
      "WebsiteURL": "sample string 11",
      "ImageURL": "sample string 12",
      "IsPriority": true,
      "Latitude": 14.0,
      "Longitude": 15.0,
      "AdwID": "sample string 16",
      "EndoMdmID": "sample string 17",
      "Distance": 1.1
    },
    {
      "AccountID": 1,
      "Name": "sample string 2",
      "StreetAddress1": "sample string 3",
      "StreetAddress2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "ZipCode": "sample string 7",
      "Phone": "sample string 8",
      "Fax": "sample string 9",
      "EmailAddress": "sample string 10",
      "WebsiteURL": "sample string 11",
      "ImageURL": "sample string 12",
      "IsPriority": true,
      "Latitude": 14.0,
      "Longitude": 15.0,
      "AdwID": "sample string 16",
      "EndoMdmID": "sample string 17",
      "Distance": 1.1
    }
  ]
}

application/xml, text/xml

Sample:
<AccountResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MDLocatorService.Models">
  <Accounts>
    <Account>
      <AccountID>1</AccountID>
      <AdwID>sample string 16</AdwID>
      <City>sample string 5</City>
      <Distance>1.1</Distance>
      <EmailAddress>sample string 10</EmailAddress>
      <EndoMdmID>sample string 17</EndoMdmID>
      <Fax>sample string 9</Fax>
      <ImageURL>sample string 12</ImageURL>
      <IsPriority>true</IsPriority>
      <Latitude>14</Latitude>
      <Longitude>15</Longitude>
      <Name>sample string 2</Name>
      <Phone>sample string 8</Phone>
      <State>sample string 6</State>
      <StreetAddress1>sample string 3</StreetAddress1>
      <StreetAddress2>sample string 4</StreetAddress2>
      <WebsiteURL>sample string 11</WebsiteURL>
      <ZipCode>sample string 7</ZipCode>
    </Account>
    <Account>
      <AccountID>1</AccountID>
      <AdwID>sample string 16</AdwID>
      <City>sample string 5</City>
      <Distance>1.1</Distance>
      <EmailAddress>sample string 10</EmailAddress>
      <EndoMdmID>sample string 17</EndoMdmID>
      <Fax>sample string 9</Fax>
      <ImageURL>sample string 12</ImageURL>
      <IsPriority>true</IsPriority>
      <Latitude>14</Latitude>
      <Longitude>15</Longitude>
      <Name>sample string 2</Name>
      <Phone>sample string 8</Phone>
      <State>sample string 6</State>
      <StreetAddress1>sample string 3</StreetAddress1>
      <StreetAddress2>sample string 4</StreetAddress2>
      <WebsiteURL>sample string 11</WebsiteURL>
      <ZipCode>sample string 7</ZipCode>
    </Account>
  </Accounts>
  <Status>
    <StatusCode>1</StatusCode>
    <StatusMessage>sample string 2</StatusMessage>
  </Status>
</AccountResults>