GetFullAddress - Eircode � Data8 Web Services API Documentation

GetFullAddress

Gets a list of addresses on an Eircode.

Description

This is the main method to do Eircode lookup operations.

Supply the Eircode to get a list of all the addresses. This will normally be a single address, but can be multiple in some situations such as multiple businesses at the same location.

Each address will be returned as a FormattedAddress, which includes both a human-readable address, and a RawPAFAddress which contains a separate field for each part of the address, e.g. building number, street name etc. The details of how the formatted version of the address is generated from the raw address is controlled by the options described below. For more information and examples on the formatting options, please see the Address Formatting page.

As well as the address lines, the result will also include the coordinates of the address.

If the specified postcode does not exist, Status.Success will be false, and Status.ErrorMessage will indicate that an invalid postcode has been entered.

Endpoint URLs

To connect to this service you'll need to use one of these endpoints:

Protocol	URL
JSON	JSON https://webservices.data-8.co.uk/Eircode/GetFullAddress.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/Eircode/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/eircode.asmx

Parameters

The following parameters can be supplied to this method:

Name	Description
username	username See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix `apikey-`, e.g. `apikey-ABCD-1234-EFGH-5678`
password	password If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
licence	licence As the Eircode database can be licensed in multiple ways, this parameter indicates under which license you are accessing the data. This must match the variant you have a license or credits for - if you are unsure which option to choose, please contact your account manager
eircode	eircode The full Eircode to get addresses for. Formatting of the Eircode does not matter so `"a65f4e2"` and `"A65 F4E2"` are both accepted.
options	options An array of options that control further details of how this method operates. See the `Advanced Options` section below, for more information.

Advanced Options

The following options can be specified as part of the option parameter. Each option is specified as a key/value pair. The list of available names is shown below, along with a description of the allowable values for that name.

Name	Description
Common Options
ApplicationName	ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard.
Address Formatting Options
There are a large number of options to control how the raw address details are combined & formatted for presentation. They are described in more detail with live interactive examples on the address formatting reference. A summary of the available options is also listed below.
Formatter	Formatter Pick from one of the available formatters to control how the raw address is converted into a human-readable address: `DefaultFormatter` `PAFStandardFormatter` `NoOrganisationFormatter`
MaxLines	MaxLines The number of lines to format the address over. An additional line will be included at the end of the results for the postcode
MaxLineLength	MaxLineLength The maximum number of characters that can appear in each address line
FixTownCounty	FixTownCounty `true` to ensure that the town and county are returned in the last two address lines, or `false` if they should appear in the first available line
FixBuilding	FixBuilding Ensures the building name/number is always placed in the first line
NormalizeCase	NormalizeCase Converts all text in the address except the town name to proper case
NormalizeTownCase	NormalizeTownCase Converts the town name to proper case
UseAnyAvailableCounty	UseAnyAvailableCounty Uses any available county to populate the formatted address, not just the postal county
ExcludeCounty	ExcludeCounty Excludes the county, if any, from the formatted address
UnwantedPunctuation	UnwantedPunctuation A string containing any punctuation characters to be removed from the formatted address
Service Specific Options
ReturnResultCount	ReturnResultCount Indicates if the `ResultCount` field in the result should be populated with the total number of addresses returned.
PreferredLanguage	PreferredLanguage The ISO code of the language to retrieve the results in, where possible. Use "en" for English or "ga" for Irish. Any other language code will give the results in English.

Results

This method returns an object containing the following fields:

Name	Description
Status	Status Indicates whether the method call was successful, or if some error occurred. If the `Success` field is `true`, the other results described below can be used to get the results of the method. If `Success` is `false`, some error occurred in calling the method, such as the authentication failed or the account is out of credits. The details of the error can be obtained from the `ErrorMessage` field, and any other results should be ignored.
ResultCount	ResultCount Contains the number of addresses in the `Results` field. This field is only populated if the `ReturnResultCount` option is set to True
Results	Results Contains an array of addresses that match the query. A formatted version of each address in the array is available in the `Address` field, and a structured version of the address is available in the `RawAddress` field.

Credit Usage

Each request to this method consumes 1 Eircode credit.

Sample Code

Request Format

{
  "licence": "WebClick",
  "eircode": "P85 YH98",
  "options": {
    "ReturnResultCount": true,
    "PreferredLanguage": "en"
  }
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "ResultCount": 4,
  "Results": [
    {
      "Address": {
        "Lines": [
          "Private Residential Tenancies Board",
          "Unit B",
          "West Cork Business And Technology Park",
          "",
          "CLONAKILTY",
          "Co. Cork",
          "P85 YH98"
        ]
      },
      "RawAddress": {
        "Organisation": "PRIVATE RESIDENTIAL TENANCIES BOARD",
        "Department": "",
        "AddressKey": 1702095537,
        "OrganisationKey": 1900144266,
        "PostcodeType": "O",
        "BuildingNumber": 0,
        "SubBuildingName": "",
        "BuildingName": "UNIT B",
        "DependentThoroughfareName": "",
        "DependentThoroughfareDesc": "",
        "ThoroughfareName": "",
        "ThoroughfareDesc": "",
        "DoubleDependentLocality": "",
        "DependentLocality": "WEST CORK BUSINESS AND TECHNOLOGY PARK",
        "Locality": "CLONAKILTY",
        "Postcode": "P85YH98",
        "PoBox": "",
        "PostalCounty": "CORK",
        "TraditionalCounty": "",
        "AdministrativeCounty": "",
        "Location": {
          "Easting": 139753,
          "Northing": 43949,
          "Longitude": -8.871074198079823,
          "Latitude": 51.64537619796417
        }
      }
    },
    {
      "Address": {
        "Lines": [
          "Capita Customer Soloutions",
          "Unit B",
          "West Cork Business And Technology Park",
          "",
          "CLONAKILTY",
          "Co. Cork",
          "P85 YH98"
        ]
      },
      "RawAddress": {
        "Organisation": "CAPITA CUSTOMER SOLOUTIONS",
        "Department": "",
        "AddressKey": 1702095537,
        "OrganisationKey": 1900339770,
        "PostcodeType": "O",
        "BuildingNumber": 0,
        "SubBuildingName": "",
        "BuildingName": "UNIT B",
        "DependentThoroughfareName": "",
        "DependentThoroughfareDesc": "",
        "ThoroughfareName": "",
        "ThoroughfareDesc": "",
        "DoubleDependentLocality": "",
        "DependentLocality": "WEST CORK BUSINESS AND TECHNOLOGY PARK",
        "Locality": "CLONAKILTY",
        "Postcode": "P85YH98",
        "PoBox": "",
        "PostalCounty": "CORK",
        "TraditionalCounty": "",
        "AdministrativeCounty": "",
        "Location": {
          "Easting": 139753,
          "Northing": 43949,
          "Longitude": -8.871074198079823,
          "Latitude": 51.64537619796417
        }
      }
    },
    {
      "Address": {
        "Lines": [
          "Independent Newspapers",
          "Unit B",
          "West Cork Business And Technology Park",
          "",
          "CLONAKILTY",
          "Co. Cork",
          "P85 YH98"
        ]
      },
      "RawAddress": {
        "Organisation": "INDEPENDENT NEWSPAPERS",
        "Department": "",
        "AddressKey": 1702095537,
        "OrganisationKey": 1900144264,
        "PostcodeType": "O",
        "BuildingNumber": 0,
        "SubBuildingName": "",
        "BuildingName": "UNIT B",
        "DependentThoroughfareName": "",
        "DependentThoroughfareDesc": "",
        "ThoroughfareName": "",
        "ThoroughfareDesc": "",
        "DoubleDependentLocality": "",
        "DependentLocality": "WEST CORK BUSINESS AND TECHNOLOGY PARK",
        "Locality": "CLONAKILTY",
        "Postcode": "P85YH98",
        "PoBox": "",
        "PostalCounty": "CORK",
        "TraditionalCounty": "",
        "AdministrativeCounty": "",
        "Location": {
          "Easting": 139753,
          "Northing": 43949,
          "Longitude": -8.871074198079823,
          "Latitude": 51.64537619796417
        }
      }
    },
    {
      "Address": {
        "Lines": [
          "Personal Injuries Assessment Board",
          "Unit B",
          "West Cork Business And Technology Park",
          "",
          "CLONAKILTY",
          "Co. Cork",
          "P85 YH98"
        ]
      },
      "RawAddress": {
        "Organisation": "PERSONAL INJURIES ASSESSMENT BOARD",
        "Department": "",
        "AddressKey": 1702095537,
        "OrganisationKey": 1900144265,
        "PostcodeType": "O",
        "BuildingNumber": 0,
        "SubBuildingName": "",
        "BuildingName": "UNIT B",
        "DependentThoroughfareName": "",
        "DependentThoroughfareDesc": "",
        "ThoroughfareName": "",
        "ThoroughfareDesc": "",
        "DoubleDependentLocality": "",
        "DependentLocality": "WEST CORK BUSINESS AND TECHNOLOGY PARK",
        "Locality": "CLONAKILTY",
        "Postcode": "P85YH98",
        "PoBox": "",
        "PostalCounty": "CORK",
        "TraditionalCounty": "",
        "AdministrativeCounty": "",
        "Location": {
          "Easting": 139753,
          "Northing": 43949,
          "Longitude": -8.871074198079823,
          "Latitude": 51.64537619796417
        }
      }
    }
  ]
}

Depending on your chosen authentication method you will need to modify this request slightly:

API Key

Post the request to
https://webservices.data-8.co.uk/Eircode/GetFullAddress.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.

Parameter	Value
Parameters
licence	licence WebClickWebServerInternalUserGroup
eircode	eircode
Common Options
ApplicationName	ApplicationName
Address Formatting Options
Formatter	Formatter DefaultFormatter PAFStandardFormatter NoOrganisationFormatter
MaxLines	MaxLines
MaxLineLength	MaxLineLength
FixTownCounty	FixTownCounty falsetrue
FixBuilding	FixBuilding falsetrue
NormalizeCase	NormalizeCase falsetrue
NormalizeTownCase	NormalizeTownCase falsetrue
UseAnyAvailableCounty	UseAnyAvailableCounty falsetrue
UnwantedPunctuation	UnwantedPunctuation
Service-Specific Options
ReturnResultCount	ReturnResultCount
PreferredLanguage	PreferredLanguage
Credits Remaining Today: 5 Try It Now!