Admin at 18:50, 13 October 2017

2017-10-13T18:50:32Z

@@ Line 252: / Line 252: @@
 |-
 |JSON||<code>"CountryName":"'''''string'''''"</code>
 |}

Admin at 23:58, 11 October 2017

2017-10-11T23:58:36Z

← Older revision		Revision as of 23:58, 11 October 2017
Line 58:		Line 58:
	\|Results		\|Results
	\|-		\|-
	\|~~AddressType~~\|\|rowspan="27"\|'''GrpAddressDetails'''		\|Building\|\|rowspan="26"\|'''GrpAddressDetails'''
	\|-
	~~\|Building~~
	\|-		\|-
	\|CountryCode		\|CountryCode
Line 318:		Line 316:

	==GrpAddressDetails==		==GrpAddressDetails==
	~~<h3 style="background-color:rgb(240,240,240);">AddressType</h3>~~
	~~:One-character code for the type of address coded.~~

	~~:{\| class="alternate01"~~
	~~!Protocol !! Syntax~~
	\|-
	~~\|JSON\|\|<code>"AddressType":"'''''string'''''"</code>~~
	\|}


	<h3 style="background-color:rgb(240,240,240);">Building</h3>		<h3 style="background-color:rgb(240,240,240);">Building</h3>
	:Descriptive name identifying an individual location.		:Descriptive name identifying an individual location.

Admin at 23:23, 11 October 2017

2017-10-11T23:23:32Z

← Older revision		Revision as of 23:23, 11 October 2017
Line 318:		Line 318:

	==GrpAddressDetails==		==GrpAddressDetails==
	~~The following elements set the basic options for each request. These apply to the entire request, not the individual records.~~

	<h3 style="background-color:rgb(240,240,240);">AddressType</h3>		<h3 style="background-color:rgb(240,240,240);">AddressType</h3>
	:One-character code for the type of address coded.		:One-character code for the type of address coded.
Line 340:		Line 338:


	~~==GrpAddressDetails==~~
	<h3 style="background-color:rgb(240,240,240);">CountryCode</h3>		<h3 style="background-color:rgb(240,240,240);">CountryCode</h3>
	:The 2-Character Country Code.		:The 2-Character Country Code.

Admin at 21:23, 11 October 2017

2017-10-11T21:23:44Z

@@ Line 244: / Line 244: @@
 |-
 |JSON||<code>"CompanyName":"'''''string'''''"</code>
 |}

Admin at 21:23, 11 October 2017

2017-10-11T21:23:05Z

Show changes

Admin: Created page with "{{BusinessCoderUKNav |InputOutputCollapse= }} {{CustomTOC}} A response is the result of a request. This consists of returned results codes and Business details. Business C..."

2017-10-10T23:50:59Z

Created page with "{{BusinessCoderUKNav |InputOutputCollapse= }} {{CustomTOC}} A response is the result of a request. This consists of returned results codes and Business details. Business C..."

New page

{{BusinessCoderUKNav
|InputOutputCollapse=
}}

{{CustomTOC}}

A response is the result of a request. This consists of returned results codes and Business details.

Business Coder UK supports the JSON response protocol.

==Field Names==
This is a list of the response field names and their grouping.

You can choose what output columns to return by entering the column name in the [[Business Coder UK:Request#Column|Column]] input. Specifying a group name will return all columns in the group.

{| class="alternate01 sortable"
!Field Name !! Group
|-
|TransmissionResults||rowspan="19"|'''[DEFAULT]'''
Always return in the output structure.
|-
|TranmissionReference
|-
|Version
|-
|TotalRecords
|-
|Records
|-
|AddressLine1
|-
|AddressLine2
|-
|AddressLine3
|-
|AddressLine4
|-
|AdministrativeArea
|-
|CompanyName
|-
|CountryName
|-
|FormattedAddress
|-
|Locality
|-
|MelissaAddressKey
|-
|MelissaAddressKeyBase
|-
|PostalCode
|-
|RecordID
|-
|Results
|-
|AddressType||rowspan="27"|'''GrpAddressDetails'''
|-
|Building
|-
|CountryCode
|-
|CountyName
|-
|DeliveryIndicator
|-
|DependentLocality
|-
|DependentThoroughfare
|-
|DependentThoroughfareLeadinType
|-
|DependentThoroughfareName
|-
|DependentThoroughfarePostDirection
|-
|DependentThoroughfarePreDirection
|-
|DependentThoroughfareTrailingType
|-
|DoubleDependentLocality
|-
|PostBox
|-
|PremisesNumber
|-
|PremisesType
|-
|SubAdministrativeArea
|-
|SubNationalArea
|-
|SubPremises
|-
|SubPremisesNumber
|-
|SubPremisesType
|-
|Thoroughfare
|-
|ThoroughfareLeadinType
|-
|ThoroughfareName
|-
|ThoroughfarePostDirection
|-
|ThoroughfarePreDirection
|-
|ThoroughfareTrailingType
|-
|IncorporationDate||rowspan="9"|'''GrpFirmographics'''
|-
|SICCode1
|-
|SICCode2
|-
|SICCode3
|-
|SICCode4
|-
|SICDescription1
|-
|SICDescription2
|-
|SICDescription3
|-
|SICDescription4
|-
|Latitude||rowspan="2"|'''GrpGeoCode'''
|-
|Longitude
|}

==[DEFAULT]==
<h3 style="background-color:rgb(240,240,240);">TransmissionResults</h3>
:Returns the generic web service level result/error codes. For more information, see [[Business Coder UK:Result Codes|Business Coder UK Result Codes]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionResults":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">TransmissionReference</h3>
:A pass-through of the input Transmission Reference.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">Version</h3>
:The current web service version.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Version":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">TotalRecords</h3>
:The total number of records returned in the records array.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TotalRecords":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">Records</h3>
:This is the returned array of records.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Records":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AddressLine1</h3>
:Address Line 1 of the business.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine1":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AddressLine2</h3>
:Address Line 2 of the business.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine2":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AddressLine3</h3>
:Address Line 3 of the business.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine3":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AddressLine4</h3>
:Address Line 4 of the business.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine4":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AdministrativeArea</h3>
:The most common geographic data element.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AdministrativeArea":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">CompanyName</h3>
:Name of the business.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CompanyName":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">CountryName</h3>
:The country name, abbreviation, or code.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CountryName":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">CountryName</h3>
:The country name, abbreviation, or code.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CountryName":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">Locality</h3>
:The most common population center data element.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Locality":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">MelissaAddressKey</h3>
:(MAK) A unique key assigned to an address record.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MelissaAddressKey":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">MelissaAddressKeyBase</h3>
:A unique key assigned to the base address of a complex with apartments or suites.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MelissaAddressKeyBase":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">PostalCode</h3>
:Postal Code of the business.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PostalCode":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">RecordID</h3>
:Position of the record in the response array.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"RecordID":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">Results</h3>
:Returns record specific result codes. For more information, see [[Business Coder UK:Result Codes|Business Coder UK Result Codes]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Results":"'''''string'''''"</code>
|}

==GrpAddressDetails==
The following elements set the basic options for each request. These apply to the entire request, not the individual records.

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

==GrpAddressDetails==
<h3 style="background-color:rgb(240,240,240);">CountryCode</h3>
:The 2-Character Country Code.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CountryCode":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">CountryName</h3>
:The name of the Country based on address.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CountryName":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">DeliveryIndicator</h3>
:The RBDI Indicator based on the address.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"DeliveryIndicator":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);"></h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">ThoroughfarePreDirection</h3>
:Thoroughfare directional information placed before the thoroughfare. This value is a part of the Thoroughfare field.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"ThoroughfarePreDirection":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">ThoroughfareTrailingType</h3>
:A thoroughfare type that is placed after the thoroughfare. This value is a part of the Thoroughfare field.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"ThoroughfareTrailingType":"'''''string'''''"</code>
|}

==GrpFirmographics==
<h3 style="background-color:rgb(240,240,240);">IncorporationDate</h3>
:The year the business was incorporated (started).

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"IncorporationDate":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">SICCode1</h3>
:A 6-digit SIC code for the business's primary line of business.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SICCode1":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">SICCode2</h3>
:The second SIC code.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SICCode2":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">SICCode3</h3>
:The third SIC code.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SICCode3":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">SICCode4</h3>
:The fourth SIC code.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SICCode3":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">SICDescription1</h3>
:First SIC code description. Related to [[#SICCode1|SICCode1]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SICDescription1":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">SICDescription2</h3>
:Second SIC code description. Related to [[#SICCode2|SICCode2]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SICDescription2":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">SICDescription3</h3>
:Third SIC code description. Related to [[#SICCode3|SICCode3]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SICDescription3":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">SICDescription4</h3>
:Fourth SIC code description. Related to [[#SICCode4|SICCode4]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SICDescription4":"'''''string'''''"</code>
|}

==GrpGeoCode==
<h3 style="background-color:rgb(240,240,240);">Latitude</h3>
:The latitude geo coordinate.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Latitude":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">Longitude</h3>
:The longitude geo coordinate.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Longitude":"'''''string'''''"</code>
|}

[[Category:Business Coder UK]]
[[Category:Reference]]

Business Coder UK:Response - Revision history

Admin at 18:50, 13 October 2017

Admin at 23:58, 11 October 2017

Admin at 23:23, 11 October 2017

Admin at 21:23, 11 October 2017

Admin at 21:23, 11 October 2017

Admin: Created page with "{{BusinessCoderUKNav |InputOutputCollapse= }} {{CustomTOC}} A response is the result of a request. This consists of returned results codes and Business details. Business C..."