Difference between revisions of "Business Coder UK:JSON"

From Melissa Data Wiki
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 6: Line 6:
{{CustomTOC}}
{{CustomTOC}}


==JSON Batch Request==
==JSON Request==
A maximum of up to 100 records per request can be sent.
<pre>
<pre>
{
{
   "t":"string",
   "TransmissionReference":"string",
   "id":"string",
   "CustomerID":"string",
   "cols":"string",
   "Columns":"string",
   "opt":"string",
   "Options":"string",
  "Format":"string",
   "Records":[{
   "Records":[{
     "rec":"string",
     "RecordID":"string",
     "comp":"string",
     "Company":"string",
     "a1":"string",
     "AddressLine1":"string",
     "a2":"string",
     "AddressLine2":"string",
     "loc":"string",
     "AddressLine3":"string",
     "area":"string",
     "AddressLine4":"string",
     "postal":"string",
     "Locality":"string",
     "ctry":"string"
     "DependentLocality":"string",
  },
     "DoubleDependentLocality":"string",
  {
     "SubAdministrativeArea":"string",
    "rec":"string",
     "AdministrativeArea":"string",
     "comp":"string",
     "SubNationalArea":"string",
     "a1":"string",
     "PostalCode":"string",
     "a2":"string",
     "Country":"string",
     "loc":"string",
     "MelissaAddressKey":"string"
     "area":"string",
     "postal":"string",
     "ctry":"string"
  },
  {
    ...
   }]
   }]
}
}
Line 41: Line 35:




==JSON Batch Response==
==JSON Response==
<pre>
<pre>
{
{
"TransmissionResults":"string",
    "TransmissionResults": "string",
  "TransmissionReference":"string",
    "TransmissionReference": "string",
  "Version":"string",
    "Version": "string",
  "TotalRecords":"string",
    "TotalRecords": "string",
  "Records": [{
    "Records": [
    "AddressLine1": "string",
        {
    "AddressLine2": "string",
            "AddressLine1": "string",
    "AddressLine3": "string",
            "AddressLine2": "string",
    "AddressLine4": "string",
            "AddressLine3": "string",
    "AdministrativeArea": "string",
            "AddressLine4": "string",
    "Building": "string",
            "AdministrativeArea": "string",
    "CompanyName": "string",
            "Building": "string",
    "CountryCode": "string",
            "CompanyName": "string",
    "CountryName": "string",
            "CountryCode": "string",
    "CountyName": "string",
            "CountryName": "string",
    "DeliveryIndicator": "string",
            "CountyName": "string",
    "DependentLocality": "string",
            "DeliveryIndicator": "string",
    "DependentThoroughfare": "string",
            "DependentLocality": "string",
    "DependentThoroughfareLeadingType": "string",
            "DependentThoroughfare": "string",
    "DependentThoroughfareName": "string",
            "DependentThoroughfareLeadingType": "string",
    "DependentThoroughfarePostDirection": "string",
            "DependentThoroughfareName": "string",
    "DependentThoroughfarePreDirection": "string",
            "DependentThoroughfarePostDirection": "string",
    "DependentThoroughfareTrailingType": "string",
            "DependentThoroughfarePreDirection": "string",
    "DoubleDependentLocality": "string",
            "DependentThoroughfareTrailingType": "string",
    "FormattedAddress": "string",
            "DoubleDependentLocality": "string",
    "IncorporationDate": "string",
            "FormattedAddress": "string",
    "Latitude": "string",
            "IncorporationDate": "string",
    "Locality": "string",
            "Latitude": "string",
    "Longitude": "string",
            "Locality": "string",
    "MelissaAddressKey": "string",
            "Longitude": "string",
    "MelissaAddressKeyBase": "string",
            "MelissaAddressKey": "string",
    "PostBox": "string",
            "MelissaAddressKeyBase": "string",
    "PostalCode": "string",
            "PostBox": "string",
    "PremisesNumber": "string",
            "PostalCode": "string",
    "PremisesType": "string",
            "PremisesNumber": "string",
    "RecordID": "string",
            "PremisesType": "string",
    "Results": "string",
            "RecordID": "string",
    "SICCode1": "string",
            "Results": "string",
    "SICCode2": "string",
            "SICCode1": "string",
    "SICCode3": "string",
            "SICCode2": "string",
    "SICCode4": "string",
            "SICCode3": "string",
    "SICDescription1": "string",
            "SICCode4": "string",
    "SICDescription2": "string",
            "SICDescription1": "string",
    "SICDescription3": "string",
            "SICDescription2": "string",
    "SICDescription4": "string",
            "SICDescription3": "string",
    "SubAdministrativeArea": "string",
            "SICDescription4": "string",
    "SubNationalArea": "string",
            "SubAdministrativeArea": "string",
    "SubPremises": "string",
            "SubNationalArea": "string",
    "SubPremisesNumber": "string",
            "SubPremises": "string",
    "SubPremisesType": "string",
            "SubPremisesNumber": "string",
    "Thoroughfare": "string",
            "SubPremisesType": "string",
    "ThoroughfareLeadingType": "string",
            "Thoroughfare": "string",
    "ThoroughfareName": "string",
            "ThoroughfareLeadingType": "string",
    "ThoroughfarePostDirection": "string",
            "ThoroughfareName": "string",
    "ThoroughfarePreDirection": "string",
            "ThoroughfarePostDirection": "string",
    "ThoroughfareTrailingType": "string"
            "ThoroughfarePreDirection": "string",
  },
            "ThoroughfareTrailingType": "string"
    "AddressLine1": "string",
        }
     "AddressLine2": "string",
     ]
    "AddressLine3": "string",
    "AddressLine4": "string",
    "AdministrativeArea": "string",
    "Building": "string",
    "CompanyName": "string",
    "CountryCode": "string",
    "CountryName": "string",
    "CountyName": "string",
    "DeliveryIndicator": "string",
    "DependentLocality": "string",
    "DependentThoroughfare": "string",
    "DependentThoroughfareLeadingType": "string",
    "DependentThoroughfareName": "string",
    "DependentThoroughfarePostDirection": "string",
    "DependentThoroughfarePreDirection": "string",
    "DependentThoroughfareTrailingType": "string",
    "DoubleDependentLocality": "string",
    "FormattedAddress": "string",
    "IncorporationDate": "string",
    "Latitude": "string",
    "Locality": "string",
    "Longitude": "string",
    "MelissaAddressKey": "string",
    "MelissaAddressKeyBase": "string",
    "PostBox": "string",
    "PostalCode": "string",
    "PremisesNumber": "string",
    "PremisesType": "string",
    "RecordID": "string",
    "Results": "string",
    "SICCode1": "string",
    "SICCode2": "string",
    "SICCode3": "string",
    "SICCode4": "string",
    "SICDescription1": "string",
    "SICDescription2": "string",
    "SICDescription3": "string",
    "SICDescription4": "string",
    "SubAdministrativeArea": "string",
    "SubNationalArea": "string",
    "SubPremises": "string",
    "SubPremisesNumber": "string",
    "SubPremisesType": "string",
    "Thoroughfare": "string",
    "ThoroughfareLeadingType": "string",
    "ThoroughfareName": "string",
    "ThoroughfarePostDirection": "string",
    "ThoroughfarePreDirection": "string",
    "ThoroughfareTrailingType": "string"
  },
  ]
}
}
</pre>
</pre>

Latest revision as of 19:09, 31 October 2017

← Business Coder UK

Business Coder UK Navigation
Introduction
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
JSON
Business Coder UK Result Codes
Sample Code



JSON Request

{
  "TransmissionReference":"string",
  "CustomerID":"string",
  "Columns":"string",
  "Options":"string",
  "Format":"string",
  "Records":[{
    "RecordID":"string",
    "Company":"string",
    "AddressLine1":"string",
    "AddressLine2":"string",
    "AddressLine3":"string",
    "AddressLine4":"string",
    "Locality":"string",
    "DependentLocality":"string",
    "DoubleDependentLocality":"string",
    "SubAdministrativeArea":"string",
    "AdministrativeArea":"string",
    "SubNationalArea":"string",
    "PostalCode":"string",
    "Country":"string",
    "MelissaAddressKey":"string"
  }]
}


JSON Response

{
    "TransmissionResults": "string",
    "TransmissionReference": "string",
    "Version": "string",
    "TotalRecords": "string",
    "Records": [
        {
            "AddressLine1": "string",
            "AddressLine2": "string",
            "AddressLine3": "string",
            "AddressLine4": "string",
            "AdministrativeArea": "string",
            "Building": "string",
            "CompanyName": "string",
            "CountryCode": "string",
            "CountryName": "string",
            "CountyName": "string",
            "DeliveryIndicator": "string",
            "DependentLocality": "string",
            "DependentThoroughfare": "string",
            "DependentThoroughfareLeadingType": "string",
            "DependentThoroughfareName": "string",
            "DependentThoroughfarePostDirection": "string",
            "DependentThoroughfarePreDirection": "string",
            "DependentThoroughfareTrailingType": "string",
            "DoubleDependentLocality": "string",
            "FormattedAddress": "string",
            "IncorporationDate": "string",
            "Latitude": "string",
            "Locality": "string",
            "Longitude": "string",
            "MelissaAddressKey": "string",
            "MelissaAddressKeyBase": "string",
            "PostBox": "string",
            "PostalCode": "string",
            "PremisesNumber": "string",
            "PremisesType": "string",
            "RecordID": "string",
            "Results": "string",
            "SICCode1": "string",
            "SICCode2": "string",
            "SICCode3": "string",
            "SICCode4": "string",
            "SICDescription1": "string",
            "SICDescription2": "string",
            "SICDescription3": "string",
            "SICDescription4": "string",
            "SubAdministrativeArea": "string",
            "SubNationalArea": "string",
            "SubPremises": "string",
            "SubPremisesNumber": "string",
            "SubPremisesType": "string",
            "Thoroughfare": "string",
            "ThoroughfareLeadingType": "string",
            "ThoroughfareName": "string",
            "ThoroughfarePostDirection": "string",
            "ThoroughfarePreDirection": "string",
            "ThoroughfareTrailingType": "string"
        }
    ]
}
Retrieved from "http://wiki.melissadata.com/index.php?title=Business_Coder_UK:JSON&oldid=13487"