POST 17.0/app/utilityswitching/mprnlookup/{mprn}

Description

Performs a property lookup based on the passed MPRN

URI Parameters
Name Description Type Additional information
mprn

string

Required

Address
Name Description Type Additional information
CountryCode

integer

None.
PostCode

string

None.
PropertyName

string

None.
Street

string

None.
Locality

string

None.
Town

string

None.
Region

string

None.
Country

string

None.

application/json, text/json
Sample: 
{
  "countryCode": 1,
  "postCode": "sample string 2",
  "propertyName": "sample string 3",
  "street": "sample string 4",
  "locality": "sample string 5",
  "town": "sample string 6",
  "region": "sample string 7",
  "country": "sample string 8"
}

application/xml, text/xml
Sample: 
<Address xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CountryCode>1</CountryCode>
  <PostCode>sample string 2</PostCode>
  <PropertyName>sample string 3</PropertyName>
  <Street>sample string 4</Street>
  <Locality>sample string 5</Locality>
  <Town>sample string 6</Town>
  <Region>sample string 7</Region>
  <Country>sample string 8</Country>
</Address>

application/x-www-form-urlencoded
Sample:

Sample not available.

200 with a PropertyLookupResponse on success; otherwise HomeMover's typed MprnLookupError body and HTTP status relayed through (e.g. 503 MprnLookupUnavailable, or 400 InvalidMprn) so the front end can show a different message per error type. See PBUS-4.

IHttpActionResult

None.

application/json, text/json
Sample:

Sample not available.