POST request/Address/Postcode/Ready

Capturing the consumer’s postcode enables accurate pricing for quoting. Energy suppliers price energy differently throughout the UK and varies across core 14 regional areas. These areas are referred to as DNO’s

Request Information

URI Parameters

None.

Body Parameters

The postcode ready binding model.

PostcodeReadyBindingModel

Name	Description	Type	Additional information
Postcode		string	None.

Request Formats

application/json, text/json

Sample:

{
  "postcode": "sample string 1"
}

application/xml, text/xml

Sample:

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

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Postcode"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

PostcodeIsSwitchableResponse

Name	Type	Additional information
ApiVersion	string	None.
PostcodeReadyDto	PostcodeReadyDto	None.
Uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "postcodeReadyDto": {
    "postcodeIsSwitchable": true,
    "suggestedFormat": "sample string 2",
    "groupId": "sample string 3"
  },
  "apiVersion": "sample string 1",
  "uri": "sample string 2"
}

application/xml, text/xml

Sample:

<PostcodeIsSwitchableResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.DtoResponse">
  <ApiVersion>sample string 1</ApiVersion>
  <PostcodeReadyDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.Dto">
    <d2p1:GroupId>sample string 3</d2p1:GroupId>
    <d2p1:PostcodeIsSwitchable>true</d2p1:PostcodeIsSwitchable>
    <d2p1:SuggestedFormat>sample string 2</d2p1:SuggestedFormat>
  </PostcodeReadyDto>
  <Uri>sample string 2</Uri>
</PostcodeIsSwitchableResponse>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PostcodeReadyDto.PostcodeIsSwitchable"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PostcodeReadyDto.SuggestedFormat"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PostcodeReadyDto.GroupId"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ApiVersion"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Uri"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--