Business Coder:Request: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
Newer edit →
Created page with "{{ BusinessCoderNav |RequestCollapse= }} {{CustomTOC}} A request consists of a protocol to make a call to the service, detailing desired elements. Your Customer ID is requi..."
 
No edit summary
Line 61: Line 61:
|-
|-
|REST||?t = {string}
|REST||?t = {string}
|}
<h3 style="background-color:rgb(240,240,240);">License</h3>
:''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.
:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||&lic = {string}
|}
<h3 style="background-color:rgb(240,240,240);">Column</h3>
:''Optional.''
:This string value specifies which column(s) to be output as a comma delimited string.
:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||&cols = {string}
|}
<h3 style="background-color:rgb(240,240,240);">Options</h3>
:''Optional.''
:This is a string value specifies options, if any.
:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||&opt = {string}
|}
|}


Line 74: Line 112:




<h3 style="background-color:rgb(240,240,240);">PhoneNumber</h3>
<h3 style="background-color:rgb(240,240,240);">Company Name</h3>
:''Required.''
:''Optional.''
 
:The name of the business.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||&comp = {string}
|}
 
|Phone Number|| ||phone
 
 
 
<h3 style="background-color:rgb(240,240,240);">Address1</h3>
:''Optional.''
 
:The first address line of the business.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||&a1 = {string}
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Address2</h3>
:''Optional.''
 
:The second address line (suite) of the business.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||&a2 = {string}
|}
 
 
<h3 style="background-color:rgb(240,240,240);">City</h3>
:''Optional.''
 
:The city (locality).
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||&city = {string}
|}
 
 
<h3 style="background-color:rgb(240,240,240);">State</h3>
:''Optional.''
 
:The state (Administrative Area).
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||&state = {string}
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Postal</h3>
:''Optional.''
 
:The postal code.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||&postal = {string}
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Country</h3>
:''Optional.''
 
:The country.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||&ctry = {string}
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Melissa Address Key (MAK)</h3>
:''Optional.''
 
:A propietary unique key identifier for an address. This is derived from Address Checking.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||&mkey = {string}
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Stock Ticker</h3>
:''Optional.''
 
:A unique abbreviation/symbol assigned by the stock exchange for listed companies.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||&stock = {string}
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Web Address</h3>
:''Optional.''


:The phone number to be verified
:The web address/domain for a company.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|REST||&phone = {string}
|REST||&web = {string}
|}
|}


Revision as of 22:36, 5 January 2016

← Business Coder

Business Coder Navigation
Introduction
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
Result Codes
Result Code Use
Business Coder Result Codes
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 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


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}
Retrieved from "http://wiki.melissadata.com/index.php?title=Business_Coder:Request&oldid=10406"