PostcodeIT_UK web-service provides functions to obtain address(es) from postcodes. To keep the method calls tidy, the service makes use of SoapHeaders. Set up your SoapHeader with your CustomerId, LicenceKey and MachineId. (Customers with individual licences will require to provide the MachineId. Per Click licences and Unlimited use licences can leave the MachineId as an empty string).

In the response to a method call you will generally obtain a ResultCode (int) and a ResultDescription (string). A ResultCode of 0 is a success, any other code indicates a failure and the description of the failure will be placed in ResultDescription. Any unhandled exceptions will cause a SoapException to be thown.

The service makes use of the PAF™ (Postal Address File). The PAF is © of the Royal Mail and use of this service is governed by their end user licence agreement. All users of the service must obtain the approptiate licences. Please contact sales@mosaicsoftware.co.uk for further information on licencing

The following operations are supported. For a formal definition, please review the Service Description.

• GetByAddressKey
  Retrieves an address from the database using the AddressKey.
• GetByPostcode
  Retrieves a collection of addresses from the database by postcode. Postcode is not case sensitive and so can be upper or lower case.
• GetByPostcodeFiltered
  Retrieves a collection of addresses from the database by postcode and a house number/building name. Postcode is not case sensitive and so can be upper or lower case.
• GetByPostcodeSimple
  Retrieves a collection of addresses from the database by postcode. Postcode is not case sensitive and so can be upper or lower case.
• GetByPostcodeSimpleFiltered
  Retrieves a collection of addresses from the database by postcode and a house number/building name. Postcode is not case sensitive and so can be upper or lower case.
• GetByPostcodeSimpleIP
  Same as GetByPostcodeSimple - Accepts an IP for restricting the website demo clicks
• GetByPostcode_Dataset
  Retrieves an address from the database by postcode. Postcode is not case sensitive and so can be upper or lower case. The results are returned in a DataSet.
• HelloWorld
  Simple method available for testing your connection to the service. The string 'Hello World' is returned.
• SetAddressStyle
  Allows you to set the styling of the address returned by other Get methods. This only needs to be called once in your session as the setting is remembered for the duration of the Session.