This wiki is no longer being updated as of December 10, 2025.
|
Business Coder UK:Response
| Business Coder UK Navigation | ||||
|---|---|---|---|---|
| ||||
| ||||
| ||||
| Business Coder UK Result Codes | ||||
| Sample Code |
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 Column input. Specifying a group name will return all columns in the group.
| Field Name | Group |
|---|---|
| TransmissionResults | [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 | 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 | GrpFirmographics |
| SICCode1 | |
| SICCode2 | |
| SICCode3 | |
| SICCode4 | |
| SICDescription1 | |
| SICDescription2 | |
| SICDescription3 | |
| SICDescription4 | |
| Latitude | GrpGeoCode |
| Longitude |
[DEFAULT]
TransmissionResults
- Returns the generic web service level result/error codes. For more information, see Business Coder UK Result Codes.
Protocol Syntax JSON "TransmissionResults":"string"
TransmissionReference
- A pass-through of the input Transmission Reference.
Protocol Syntax JSON "TransmissionReference":"string"
Version
- The current web service version.
Protocol Syntax JSON "Version":"string"
TotalRecords
- The total number of records returned in the records array.
Protocol Syntax JSON "TotalRecords":"string"
Records
- This is the returned array of records.
Protocol Syntax JSON "Records":"string"
AddressLine1
- Address Line 1 of the business.
Protocol Syntax JSON "AddressLine1":"string"
AddressLine2
- Address Line 2 of the business.
Protocol Syntax JSON "AddressLine2":"string"
AddressLine3
- Address Line 3 of the business.
Protocol Syntax JSON "AddressLine3":"string"
AddressLine4
- Address Line 4 of the business.
Protocol Syntax JSON "AddressLine4":"string"
AdministrativeArea
- The most common geographic data element.
Protocol Syntax JSON "AdministrativeArea":"string"
CompanyName
- Name of the business.
Protocol Syntax JSON "CompanyName":"string"
CountryName
- The country name, abbreviation, or code.
Protocol Syntax JSON "CountryName":"string"
CountryName
- The country name, abbreviation, or code.
Protocol Syntax JSON "CountryName":"string"
Locality
- The most common population center data element.
Protocol Syntax JSON "Locality":"string"
MelissaAddressKey
- (MAK) A unique key assigned to an address record.
Protocol Syntax JSON "MelissaAddressKey":"string"
MelissaAddressKeyBase
- A unique key assigned to the base address of a complex with apartments or suites.
Protocol Syntax JSON "MelissaAddressKeyBase":"string"
PostalCode
- Postal Code of the business.
Protocol Syntax JSON "PostalCode":"string"
RecordID
- Position of the record in the response array.
Protocol Syntax JSON "RecordID":"string"
Results
- Returns record specific result codes. For more information, see Business Coder UK Result Codes.
Protocol Syntax JSON "Results":"string"
GrpAddressDetails
The following elements set the basic options for each request. These apply to the entire request, not the individual records.
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
GrpAddressDetails
CountryCode
- The 2-Character Country Code.
Protocol Syntax JSON "CountryCode":"string"
CountryName
- The name of the Country based on address.
Protocol Syntax JSON "CountryName":"string"
DeliveryIndicator
- The RBDI Indicator based on the address.
Protocol Syntax JSON "DeliveryIndicator":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
Protocol Syntax JSON "":"string"
ThoroughfarePreDirection
- Thoroughfare directional information placed before the thoroughfare. This value is a part of the Thoroughfare field.
Protocol Syntax JSON "ThoroughfarePreDirection":"string"
ThoroughfareTrailingType
- A thoroughfare type that is placed after the thoroughfare. This value is a part of the Thoroughfare field.
Protocol Syntax JSON "ThoroughfareTrailingType":"string"
GrpFirmographics
IncorporationDate
- The year the business was incorporated (started).
Protocol Syntax JSON "IncorporationDate":"string"
SICCode1
- A 6-digit SIC code for the business's primary line of business.
Protocol Syntax JSON "SICCode1":"string"
SICCode2
- The second SIC code.
Protocol Syntax JSON "SICCode2":"string"
SICCode3
- The third SIC code.
Protocol Syntax JSON "SICCode3":"string"
SICCode4
- The fourth SIC code.
Protocol Syntax JSON "SICCode3":"string"
SICDescription1
- First SIC code description. Related to SICCode1.
Protocol Syntax JSON "SICDescription1":"string"
SICDescription2
- Second SIC code description. Related to SICCode2.
Protocol Syntax JSON "SICDescription2":"string"
SICDescription3
- Third SIC code description. Related to SICCode3.
Protocol Syntax JSON "SICDescription3":"string"
SICDescription4
- Fourth SIC code description. Related to SICCode4.
Protocol Syntax JSON "SICDescription4":"string"
GrpGeoCode
Latitude
- The latitude geo coordinate.
Protocol Syntax JSON "Latitude":"string"
Longitude
- The longitude geo coordinate.
Protocol Syntax JSON "Longitude":"string"