Perform action for a single business

Request

Uses HTTP GET to accept one input record and returns the response in XML format.

Path

actionstringrequired

There are two available actions:

get - Get count of addresses that fit in the given criteria.
buy - Buy a list of addresses' info that fit the given criteria.

Enum:"get""buy"

Example:get

geographicTypestringrequired

The included Geographic Types are zip, city, county, state, radius, circle, and polygon.

Enum:"zip""city""county""state""radius""circle""polygon"

Example:zip

Query

idstringrequired

Requester's customer ID or email address

Example:id={REPLACE-WITH-YOUR-LICENSE-KEY}

zipstring

Geographic Type

Required: zip
Optional: radius

Handling: Each five-digit ZIP is validated.

Example:zip=92688

zip+4string

Geographic Type

Required: zip
Optional: radius

Handling: Plus4 is a filter in data selection.

citystring

Geographic Type

Required: city
Optional: radius

Handling: Each city and state combination is valid

countystring

Geographic Type

Required: county

Handling: Each county and state combination is validated. FIPS is retrieved if valid.

statestring

Geographic Type

Required: state
Optional: radius

Handling: Two-digit state code is validated.

addrstring

Geographic Type

Required: radius

Handling: Exact street number and street name are used in data selection. No validation. Latitude and longitude are retrieved if the address exists.

milestring

Geographic Type

Required: circle
Optional: radius (Mile or record must be given.)

Handling: Mile is used to find out the latitude and longitude of a parameter for many miles away from the given address. For radius type, maximum is 50 miles. For circle type, the radius must be between .025 and 25 miles

recordsstring

Geographic Type

Optional: radius (Mile or record must be given.)

Handling: Number of records that are closest to the given address

strstring

Geographic Type

Optional: radius

Handling: A street name within the given zip. (The street name needs to be exact.)

strzipstring

Geographic Type

Optional: radius

Handling: Zip for a specific street that is within the given radius (combination with a given address.)

ptstring

Geographic Type

Required: circle

Handling: A longitude;latitude point

pointsstring

Geographic Type

Required: polygon

Handling: Each set of points for a polygon is validated and reoriented in the sequence of drawing.

sicstring

Meanings: Append 6- digit SIC code to file if exists

Default: sic=0

To Append: sic=1

sic-dstring

Meanings: Various SIC codes as selection/filter

Default: all inclusive

To Append: Otherwise specify the SIC's (2 to 6 digits), use '-'' dash to specify multiple SIC codes, i.e. sic-d=17-9999-729924

staffstring

Meanings: Append number of employees to file

Default: staff=0

To Append: staff=1

staff-dstring

Meanings: Various sizes of staff as selection/filter

1 - 4
5 - 9
10 - 19
20 - 49
50 - 99
100 - 249
250 - 499
500 - 999
1,000 - 4,999
5,000 - 9,999
10,000

Default: all inclusive

To Append: Otherwise specify the index; use '-' dash to specify multiple staff codes, i.e. staff-d=6-8-10

salestring

Meanings: Append annual sales volume to file

Default: sale=0 To Append: sale=1

sale-dstring

Meanings: Various ranges of annual sales volumes as selection/filter

$1,000-$499,999
$500,000-$999,999
$1,000,000-$2,499,999
$2,500,000-$4,999,999
$5,000,000-$9,999,999
$10,000,000-$19,999,999
$20,000,000-$49,999,999
$50,000,000-$99,999,999
$100,000,000-$499,999,999
$500,000,000-$999,999,999
Over $1 billion

Default: all inclusive

To Append: Otherwise specify the index; use '-' dash to specify multiple sales volume codes, i.e. sale-d=6-8-10

contacttitle-dstring

Meanings: Various ContactTitle as selection/filter

Default: all

To Append: use ‘,’ comma to specify multiple contacttitles

contacttitle-d=1,2,3

title-dstring

Meanings: Various Title as selection/filter

Default: all

To Append: use ‘,’ comma to specify multiple titles

title-d=DDS,DPT

onestring

One contact per business

Default Value: one=1

Optional Output Parameter: one=0 returns all contacts

dbugstring

Parameter check. If a parameter is spelt wrong or not suited for the given call, the request will be rejected.

Default Value: dbug=0

Optional Output Parameter: dbug=1 to check

namestring

Append contact name and gender to file if exists

Default Value: name=0

Optional Output Parameter: To append: name=1

postring

Customer's purchase order number

Default Value: none

Optional Output Parameter: To specify: po=xxxx

multistring

By default, purchased lists may be used once. With this parameter included in the Buy call, you can purchase the right to use a list for multiple mailings. Specify the number of uses like this: multi=4. The maximum number of uses allowed for any purchased list is 5.

Default Value: multi=1

Optional Output Parameter: multi=(1 through 5)

filestring

Defines the desired file format of a purchased list.

Default Value: file=8

Optional Output Parameter:

2 - File Format: Zipped .txt
3 - File Format: Zipped .csv
5 - File Format: Zipped .xls (Excel)
7 - File Format: .txt
8 - (Default) File Format: .csv
10 - File Format: .xls (Excel)

faxstring

Append fax number (if available)

Default Value: fax=0

Optional Output Parameter: fax=1

phonestring

Append phone number (if available)

Default Value: phone=0

Optional Output Parameter: phone=1

naicsstring

Append 8-digit NAICS code to file if exists

Default Value: naics=0

Optional Output Parameter: naics=1

numempstring

Appends the number of actual employees (as opposed to a range like staff)

Default Value: numemp=0

Optional Output Parameter: numemp=1

keyexecstring

Appends the Key Executive to file

Default Value: keyexec=0

Optional Output Parameter: keyexec=1

numsalesstring

Appends the estimated sales volume in thousands (as opposed to a range like sale)

Default Value: numsales=0

Optional Output Parameter: numsales=1

Acceptstringrequired

Format of the response.

Enum:"application/xml""*/*"

Example:application/xml

Content-Typestringrequired

Format of the request.

Enum:"application/xml""application/json"

curl -i -X GET \
  'https://list.melissadata.net/v1/Business/rest/Service.svc/get/zip?id=%7BREPLACE-WITH-YOUR-LICENSE-KEY%7D' \
  -H 'Accept: application/xml' \
  -H 'Content-Type: application/xml'

Responses

Successful response

Bodyapplication/xml

TransmissionReferencestring

Serves as a unique request identifier.

Versionstring

The current service version number.

TransmissionResultsstring

Lists error codes from any errors caused by the most recent request as a whole.

TotalRecordsstring

Total number of records.

Geographyobject

Geo request.

Optionsobject

Requests within Geo Selects. Tags returned depend on Geo type.

CountDetailsobject

TotalCountobject

Total number of records returned with the selected options.

Resultobject

Indicates the status of a request. Returns Declined, Approved, or Err.

Response

<Business>
  <Geography>
      <Zip>92688</Zip>
  </Geography>
  <Options>
      <ContactPersonInfo>
          <ContactPersonInfo>One per Business</ContactPersonInfo>
      </ContactPersonInfo>
      <NumberOfEmployees>
          <IncludeAll>True</IncludeAll>
          <AppendToFile>False</AppendToFile>
      </NumberOfEmployees>
      <AnnualSalesVolume>
          <Details>$500,000-$999,999</Details>
          <AppendToFile>False</AppendToFile>
      </AnnualSalesVolume>
      <SIC>
          <IncludeAll>True</IncludeAll>
          <AppendToFile>False</AppendToFile>
      </SIC>
      <Email>
          <Details>All Records</Details>
          <AppendToFile>False</AppendToFile>
      </Email>
  </Options>
  <CountDetails>
      <StreetRange>
          <Street>
              <StartNumber>0</StartNumber>
              <EndNumber>0</EndNumber>
          </Street>
      </StreetRange>
  </CountDetails>
  <TotalCount>
      <Count>0</Count>
  </TotalCount>
  <Result>
      <StatusCode>Appro…