POST api/Address

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
search_string	string	None.
retcode	string	None.
postcode_valid	string	None.
pcupdate	UpdatedPostCodeResult	None.
number_results	string	None.
error_code	string	None.
error_message	string	None.
time_taken	string	None.
addresses	Collection of PremiseListAddress	None.

Request Formats

application/json, text/json

Sample:

{
  "search_stringField": "sample string 1",
  "retcodeField": "sample string 2",
  "postcode_validField": "sample string 3",
  "pcupdateField": {
    "postcode_updatedField": "sample string 1",
    "oldpostcodeField": "sample string 2",
    "postcodeupdatesField": [
      {
        "newpostcodeField": "sample string 1",
        "recodeddateField": "sample string 2"
      },
      {
        "newpostcodeField": "sample string 1",
        "recodeddateField": "sample string 2"
      }
    ]
  },
  "number_resultsField": "sample string 4",
  "error_codeField": "sample string 5",
  "error_messageField": "sample string 6",
  "time_takenField": "sample string 7",
  "addressesField": [
    {
      "premiseField": [
        {
          "organisationField": "sample string 1",
          "premiseField": "sample string 2"
        },
        {
          "organisationField": "sample string 1",
          "premiseField": "sample string 2"
        }
      ],
      "dependent_streetField": "sample string 1",
      "streetField": "sample string 2",
      "double_dependent_localityField": "sample string 3",
      "dependent_localityField": "sample string 4",
      "post_townField": "sample string 5",
      "countyField": "sample string 6",
      "postcodeField": "sample string 7"
    },
    {
      "premiseField": [
        {
          "organisationField": "sample string 1",
          "premiseField": "sample string 2"
        },
        {
          "organisationField": "sample string 1",
          "premiseField": "sample string 2"
        }
      ],
      "dependent_streetField": "sample string 1",
      "streetField": "sample string 2",
      "double_dependent_localityField": "sample string 3",
      "dependent_localityField": "sample string 4",
      "post_townField": "sample string 5",
      "countyField": "sample string 6",
      "postcodeField": "sample string 7"
    }
  ]
}

application/octet-stream, text/html

Sample:

{"search_stringField":"sample string 1","retcodeField":"sample string 2","postcode_validField":"sample string 3","pcupdateField":{"postcode_updatedField":"sample string 1","oldpostcodeField":"sample string 2","postcodeupdatesField":[{"newpostcodeField":"sample string 1","recodeddateField":"sample string 2"},{"newpostcodeField":"sample string 1","recodeddateField":"sample string 2"}]},"number_resultsField":"sample string 4","error_codeField":"sample string 5","error_messageField":"sample string 6","time_takenField":"sample string 7","addressesField":[{"premiseField":[{"organisationField":"sample string 1","premiseField":"sample string 2"},{"organisationField":"sample string 1","premiseField":"sample string 2"}],"dependent_streetField":"sample string 1","streetField":"sample string 2","double_dependent_localityField":"sample string 3","dependent_localityField":"sample string 4","post_townField":"sample string 5","countyField":"sample string 6","postcodeField":"sample string 7"},{"premiseField":[{"organisationField":"sample string 1","premiseField":"sample string 2"},{"organisationField":"sample string 1","premiseField":"sample string 2"}],"dependent_streetField":"sample string 1","streetField":"sample string 2","double_dependent_localityField":"sample string 3","dependent_localityField":"sample string 4","post_townField":"sample string 5","countyField":"sample string 6","postcodeField":"sample string 7"}]}

application/xml, text/xml

Sample:

<PremiseListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OAuthTest.uk.co.postcoderwebsoap.www">
  <addressesField>
    <PremiseListAddress>
      <countyField>sample string 6</countyField>
      <dependent_localityField>sample string 4</dependent_localityField>
      <dependent_streetField>sample string 1</dependent_streetField>
      <double_dependent_localityField>sample string 3</double_dependent_localityField>
      <post_townField>sample string 5</post_townField>
      <postcodeField>sample string 7</postcodeField>
      <premiseField>
        <PremiseList>
          <organisationField>sample string 1</organisationField>
          <premiseField>sample string 2</premiseField>
        </PremiseList>
        <PremiseList>
          <organisationField>sample string 1</organisationField>
          <premiseField>sample string 2</premiseField>
        </PremiseList>
      </premiseField>
      <streetField>sample string 2</streetField>
    </PremiseListAddress>
    <PremiseListAddress>
      <countyField>sample string 6</countyField>
      <dependent_localityField>sample string 4</dependent_localityField>
      <dependent_streetField>sample string 1</dependent_streetField>
      <double_dependent_localityField>sample string 3</double_dependent_localityField>
      <post_townField>sample string 5</post_townField>
      <postcodeField>sample string 7</postcodeField>
      <premiseField>
        <PremiseList>
          <organisationField>sample string 1</organisationField>
          <premiseField>sample string 2</premiseField>
        </PremiseList>
        <PremiseList>
          <organisationField>sample string 1</organisationField>
          <premiseField>sample string 2</premiseField>
        </PremiseList>
      </premiseField>
      <streetField>sample string 2</streetField>
    </PremiseListAddress>
  </addressesField>
  <error_codeField>sample string 5</error_codeField>
  <error_messageField>sample string 6</error_messageField>
  <number_resultsField>sample string 4</number_resultsField>
  <pcupdateField>
    <oldpostcodeField>sample string 2</oldpostcodeField>
    <postcode_updatedField>sample string 1</postcode_updatedField>
    <postcodeupdatesField>
      <UpdatedPostCode>
        <newpostcodeField>sample string 1</newpostcodeField>
        <recodeddateField>sample string 2</recodeddateField>
      </UpdatedPostCode>
      <UpdatedPostCode>
        <newpostcodeField>sample string 1</newpostcodeField>
        <recodeddateField>sample string 2</recodeddateField>
      </UpdatedPostCode>
    </postcodeupdatesField>
  </pcupdateField>
  <postcode_validField>sample string 3</postcode_validField>
  <retcodeField>sample string 2</retcodeField>
  <search_stringField>sample string 1</search_stringField>
  <time_takenField>sample string 7</time_takenField>
</PremiseListResult>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json, application/octet-stream, text/html

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>