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

The MPRN used in the property lookup

 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.

The

PropertyLookupResponse
Name Description Type Additional information
addressPropertyName

string

None.
addressStreet

string

None.
addressLocality

string

None.
addressTown

string

None.
addressRegion

string

None.
addressPostcode

string

None.
electricMeterType

integer

None.
electricMeterSerialNumber

string

None.
electricEnergised

boolean

None.
addressMatched

boolean

None.
terminated

boolean

None.

application/json, text/json
Sample: 
{
  "addressPropertyName": "sample string 1",
  "addressStreet": "sample string 2",
  "addressLocality": "sample string 3",
  "addressTown": "sample string 4",
  "addressRegion": "sample string 5",
  "addressPostcode": "sample string 6",
  "electricMeterType": 7,
  "electricMeterSerialNumber": "sample string 8",
  "electricEnergised": true,
  "addressMatched": true,
  "terminated": true
}

application/xml, text/xml
Sample: 
<PropertyLookupResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <addressPropertyName>sample string 1</addressPropertyName>
  <addressStreet>sample string 2</addressStreet>
  <addressLocality>sample string 3</addressLocality>
  <addressTown>sample string 4</addressTown>
  <addressRegion>sample string 5</addressRegion>
  <addressPostcode>sample string 6</addressPostcode>
  <electricMeterType>7</electricMeterType>
  <electricMeterSerialNumber>sample string 8</electricMeterSerialNumber>
  <electricEnergised>true</electricEnergised>
  <addressMatched>true</addressMatched>
  <terminated>true</terminated>
</PropertyLookupResponse>