POST request/Info/Mprn

Display MPRN information of meter

Request Information

URI Parameters

None.

Body Parameters

The Mprn Info binding model.

MprnInfoBindingModel
NameDescriptionTypeAdditional information
Mprn

string

Required

Request Formats

application/json, text/json

Sample:
{
  "mprn": "sample string 1"
}

text/html

Sample:
{"mprn":"sample string 1"}

application/xml, text/xml

Sample:
<MprnInfoBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Domain.Default.BindingModel">
  <Mprn>sample string 1</Mprn>
</MprnInfoBindingModel>

Response Information

Resource Description

MprnInfoDtoResponse
NameDescriptionTypeAdditional information
ApiVersion

string

None.

MprnInfoDto

MprnInfoDto

None.

Uri

string

None.

Response Formats

application/json, text/json

Sample:
{
  "apiVersion": "sample string 1",
  "uri": "sample string 2",
  "mprnInfoDto": {
    "withinIndependentGasTransporterNetwork": true,
    "rateType": "Single",
    "requiredRateMeterTypes": [
      "Single",
      "Single"
    ]
  }
}

text/html

Sample:
{"apiVersion":"sample string 1","uri":"sample string 2","mprnInfoDto":{"withinIndependentGasTransporterNetwork":true,"rateType":"Single","requiredRateMeterTypes":["Single","Single"]}}

application/xml, text/xml

Sample:
<MprnInfoDtoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.DtoResponse">
  <ApiVersion>sample string 1</ApiVersion>
  <MprnInfoDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Dto">
    <d2p1:RateType>Single</d2p1:RateType>
    <d2p1:RequiredRateMeterTypes xmlns:d3p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Domain.Default.Switch">
      <d3p1:RateMeterType>Single</d3p1:RateMeterType>
      <d3p1:RateMeterType>Single</d3p1:RateMeterType>
    </d2p1:RequiredRateMeterTypes>
    <d2p1:WithinIndependentGasTransporterNetwork>true</d2p1:WithinIndependentGasTransporterNetwork>
  </MprnInfoDto>
  <Uri>sample string 2</Uri>
</MprnInfoDtoResponse>