POST request/Address/postcode/io

?Postcode={Postcode}

Request Information

URI Parameters

Name	Description	Type	Additional information
Postcode		string	Required

Body Parameters

None.

Response Information

Resource Description

PostCodeIoResult

Name	Type	Additional information
ErrorMessage	string	None.
IsSuccess	boolean	None.
result	Result	None.
status	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "status": 1,
  "isSuccess": true,
  "result": {
    "postcode": "sample string 1",
    "quality": 2,
    "eastings": 3,
    "northings": 4,
    "country": "sample string 5",
    "nhs_ha": "sample string 6",
    "longitude": 7.1,
    "latitude": 8.1,
    "european_electoral_region": "sample string 9",
    "primary_care_trust": "sample string 10",
    "region": "sample string 11",
    "lsoa": "sample string 12",
    "msoa": "sample string 13",
    "incode": "sample string 14",
    "outcode": "sample string 15",
    "parliamentary_constituency": "sample string 16",
    "parliamentary_constituency_2024": "sample string 17",
    "admin_district": "sample string 18",
    "parish": "sample string 19",
    "admin_county": {},
    "date_of_introduction": "sample string 21",
    "admin_ward": "sample string 22",
    "ced": {},
    "ccg": "sample string 24",
    "nuts": "sample string 25",
    "pfa": "sample string 26",
    "nhs_region": "sample string 27",
    "ttwa": "sample string 28",
    "national_park": "sample string 29",
    "bua": "sample string 30",
    "icb": "sample string 31",
    "cancer_alliance": "sample string 32",
    "lsoa11": "sample string 33",
    "msoa11": "sample string 34",
    "lsoa21": "sample string 35",
    "msoa21": "sample string 36",
    "oa21": "sample string 37",
    "ruc11": "sample string 38",
    "ruc21": "sample string 39",
    "lep1": "sample string 40",
    "lep2": {},
    "codes": {
      "admin_district": "sample string 1",
      "admin_county": "sample string 2",
      "admin_ward": "sample string 3",
      "parish": "sample string 4",
      "parliamentary_constituency": "sample string 5",
      "parliamentary_constituency_2024": "sample string 6",
      "ccg": "sample string 7",
      "ccg_id": "sample string 8",
      "ced": "sample string 9",
      "nuts": "sample string 10",
      "lsoa": "sample string 11",
      "msoa": "sample string 12",
      "lau2": "sample string 13",
      "pfa": "sample string 14",
      "nhs_region": "sample string 15",
      "ttwa": "sample string 16",
      "national_park": "sample string 17",
      "bua": "sample string 18",
      "icb": "sample string 19",
      "cancer_alliance": "sample string 20",
      "lsoa11": "sample string 21",
      "msoa11": "sample string 22",
      "lsoa21": "sample string 23",
      "msoa21": "sample string 24",
      "oa21": "sample string 25",
      "ruc11": "sample string 26",
      "ruc21": "sample string 27",
      "lep1": "sample string 28",
      "lep2": {}
    }
  },
  "errorMessage": "sample string 3"
}

application/xml, text/xml

Sample:

<PostCodeIoResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.PostcodeIo">
  <ErrorMessage>sample string 3</ErrorMessage>
  <IsSuccess>true</IsSuccess>
  <result>
    <admin_county />
    <admin_district>sample string 18</admin_district>
    <admin_ward>sample string 22</admin_ward>
    <bua>sample string 30</bua>
    <cancer_alliance>sample string 32</cancer_alliance>
    <ccg>sample string 24</ccg>
    <ced />
    <codes>
      <admin_county>sample string 2</admin_county>
      <admin_district>sample string 1</admin_district>
      <admin_ward>sample string 3</admin_ward>
      <bua>sample string 18</bua>
      <cancer_alliance>sample string 20</cancer_alliance>
      <ccg>sample string 7</ccg>
      <ccg_id>sample string 8</ccg_id>
      <ced>sample string 9</ced>
      <icb>sample string 19</icb>
      <lau2>sample string 13</lau2>
      <lep1>sample string 28</lep1>
      <lep2 />
      <lsoa>sample string 11</lsoa>
      <lsoa11>sample string 21</lsoa11>
      <lsoa21>sample string 23</lsoa21>
      <msoa>sample string 12</msoa>
      <msoa11>sample string 22</msoa11>
      <msoa21>sample string 24</msoa21>
      <national_park>sample string 17</national_park>
      <nhs_region>sample string 15</nhs_region>
      <nuts>sample string 10</nuts>
      <oa21>sample string 25</oa21>
      <parish>sample string 4</parish>
      <parliamentary_constituency>sample string 5</parliamentary_constituency>
      <parliamentary_constituency_2024>sample string 6</parliamentary_constituency_2024>
      <pfa>sample string 14</pfa>
      <ruc11>sample string 26</ruc11>
      <ruc21>sample string 27</ruc21>
      <ttwa>sample string 16</ttwa>
    </codes>
    <country>sample string 5</country>
    <date_of_introduction>sample string 21</date_of_introduction>
    <eastings>3</eastings>
    <european_electoral_region>sample string 9</european_electoral_region>
    <icb>sample string 31</icb>
    <incode>sample string 14</incode>
    <latitude>8.1</latitude>
    <lep1>sample string 40</lep1>
    <lep2 />
    <longitude>7.1</longitude>
    <lsoa>sample string 12</lsoa>
    <lsoa11>sample string 33</lsoa11>
    <lsoa21>sample string 35</lsoa21>
    <msoa>sample string 13</msoa>
    <msoa11>sample string 34</msoa11>
    <msoa21>sample string 36</msoa21>
    <national_park>sample string 29</national_park>
    <nhs_ha>sample string 6</nhs_ha>
    <nhs_region>sample string 27</nhs_region>
    <northings>4</northings>
    <nuts>sample string 25</nuts>
    <oa21>sample string 37</oa21>
    <outcode>sample string 15</outcode>
    <parish>sample string 19</parish>
    <parliamentary_constituency>sample string 16</parliamentary_constituency>
    <parliamentary_constituency_2024>sample string 17</parliamentary_constituency_2024>
    <pfa>sample string 26</pfa>
    <postcode>sample string 1</postcode>
    <primary_care_trust>sample string 10</primary_care_trust>
    <quality>2</quality>
    <region>sample string 11</region>
    <ruc11>sample string 38</ruc11>
    <ruc21>sample string 39</ruc21>
    <ttwa>sample string 28</ttwa>
  </result>
  <status>1</status>
</PostCodeIoResult>

multipart/form-data

Sample:

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

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsSuccess"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.postcode"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.quality"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.eastings"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.northings"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.country"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.nhs_ha"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.longitude"

7.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.latitude"

8.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.european_electoral_region"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.primary_care_trust"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.region"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.lsoa"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.msoa"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.incode"

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.outcode"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.parliamentary_constituency"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.parliamentary_constituency_2024"

sample string 17
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.admin_district"

sample string 18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.parish"

sample string 19
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.admin_county"

System.Object
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.date_of_introduction"

sample string 21
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.admin_ward"

sample string 22
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.ced"

System.Object
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.ccg"

sample string 24
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.nuts"

sample string 25
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.pfa"

sample string 26
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.nhs_region"

sample string 27
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.ttwa"

sample string 28
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.national_park"

sample string 29
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.bua"

sample string 30
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.icb"

sample string 31
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.cancer_alliance"

sample string 32
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.lsoa11"

sample string 33
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.msoa11"

sample string 34
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.lsoa21"

sample string 35
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.msoa21"

sample string 36
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.oa21"

sample string 37
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.ruc11"

sample string 38
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.ruc21"

sample string 39
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.lep1"

sample string 40
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.lep2"

System.Object
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.admin_district"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.admin_county"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.admin_ward"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.parish"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.parliamentary_constituency"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.parliamentary_constituency_2024"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.ccg"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.ccg_id"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.ced"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.nuts"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.lsoa"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.msoa"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.lau2"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.pfa"

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.nhs_region"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.ttwa"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.national_park"

sample string 17
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.bua"

sample string 18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.icb"

sample string 19
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.cancer_alliance"

sample string 20
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.lsoa11"

sample string 21
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.msoa11"

sample string 22
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.lsoa21"

sample string 23
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.msoa21"

sample string 24
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.oa21"

sample string 25
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.ruc11"

sample string 26
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.ruc21"

sample string 27
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.lep1"

sample string 28
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.codes.lep2"

System.Object
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ErrorMessage"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e--