Business Coder:Request: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 16: | Line 16: | ||
{| class="alternate01 sortable" | {| class="alternate01 sortable" | ||
!Field Name !! Level !! REST Abbreviation | !Field Name !! Level !! REST Abbreviation | ||
|- | |- | ||
|Transmission Reference||rowspan="4" valign="center"|Request||t | |||
|- | |||
|License||lic | |||
|- | |||
|Column||cols | |||
|- | |||
|Options||opt | |||
|- | |||
|Company Name||rowspan="11"|Request Record||comp | |||
|- | |||
|Phone Number||phone | |||
|- | |||
|Address1||a1 | |||
|- | |||
|Address2||a2 | |||
|- | |||
|City||city | |||
|- | |||
|State||state | |||
|- | |||
|Postal||postal | |||
|- | |||
|Country||ctry | |||
|- | |||
|Melissa Address Key (MAK)||mkey | |||
|- | |||
|Stock Ticker||stock | |||
|- | |||
|Web Address||web | |||
|} | |||
{| class="alternate01 sortable" | |||
!Field Name !! Level !! REST Abbreviation | |||
|- | |||
|Transmission Reference||Request||t | |Transmission Reference||Request||t | ||
|- | |- | ||
|License||Request||lic | |License||Request||lic | ||
|- | |- | ||
|Column|| | |Column||Request||cols | ||
|- | |- | ||
|Options||Request||opt | |Options||Request||opt |
Revision as of 22:35, 7 January 2016
Business Coder Navigation | ||||
---|---|---|---|---|
| ||||
| ||||
| ||||
| ||||
Sample Code |
A request consists of a protocol to make a call to the service, detailing desired elements. Your Customer ID is required.
Business Coder supports the REST protocol to access the service.
Field Names
This is a list of the request field names and their protocol naming conventions.
Field Name | Level | REST Abbreviation |
---|---|---|
Transmission Reference | Request | t |
License | lic | |
Column | cols | |
Options | opt | |
Company Name | Request Record | comp |
Phone Number | phone | |
Address1 | a1 | |
Address2 | a2 | |
City | city | |
State | state | |
Postal | postal | |
Country | ctry | |
Melissa Address Key (MAK) | mkey | |
Stock Ticker | stock | |
Web Address | web |
Field Name | Level | REST Abbreviation |
---|---|---|
Transmission Reference | Request | t |
License | Request | lic |
Column | Request | cols |
Options | Request | opt |
Company Name | Request Record | comp |
Phone Number | Request Record | phone |
Address1 | Request Record | a1 |
Address2 | Request Record | a2 |
City | Request Record | city |
State | Request Record | state |
Postal | Request Record | postal |
Country | Request Record | ctry |
Melissa Address Key (MAK) | Request Record | mkey |
Stock Ticker | Request Record | stock |
Web Address | Request Record | web |
Minimum Inputs
The following are the possible minimum input requirements.
- Address and Company
- MAK and Company
- Address Only
- MAK Only
- Phone Number
- Stock Ticker
- Web Address
Request Elements
The following elements set the basic options for each request. These apply to the entire request, not the individual records.
Transmission Reference
- Optional.
- This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Protocol Syntax REST ?t = {string}
License
- Required.
- This is a string value containing the license string issued to the customer by Melissa Data for the Business Coder.
- If this element is absent, the Web Service will return an error. To receive a license, please contact your Melissa Data sales representative at 1-800-MELISSA.
Protocol Syntax REST &lic = {string}
Column
- Optional.
- This string value specifies which column(s) to be output as a comma delimited string.
Protocol Syntax REST &cols = {string}
Options
- Optional.
- This is a string value specifies options, if any.
Protocol Syntax REST &opt = {string}
Request Record Elements
REST will only contain the Records element.
Protocol | Definition |
---|---|
REST | The REST interface only allows a single record per request. |
Company Name
- Optional.
- The name of the business.
Protocol Syntax REST &comp = {string}
|Phone Number|| ||phone
Address1
- Optional.
- The first address line of the business.
Protocol Syntax REST &a1 = {string}
Address2
- Optional.
- The second address line (suite) of the business.
Protocol Syntax REST &a2 = {string}
City
- Optional.
- The city (locality).
Protocol Syntax REST &city = {string}
State
- Optional.
- The state (Administrative Area).
Protocol Syntax REST &state = {string}
Postal
- Optional.
- The postal code.
Protocol Syntax REST &postal = {string}
Country
- Optional.
- The country.
Protocol Syntax REST &ctry = {string}
Melissa Address Key (MAK)
- Optional.
- A propietary unique key identifier for an address. This is derived from Address Checking.
Protocol Syntax REST &mkey = {string}
Stock Ticker
- Optional.
- A unique abbreviation/symbol assigned by the stock exchange for listed companies.
Protocol Syntax REST &stock = {string}
Web Address
- Optional.
- The web address/domain for a company.
Protocol Syntax REST &web = {string}