GET api/address?prefix={prefix}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
prefix

string

Required

Body Parameters

None.

Response Information

Resource Description

AddressSearch_Result
NameDescriptionTypeAdditional information
addresses

Collection of Addresses

None.

message

string

None.

code

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "addresses": [
    {
      "Fulladdress": "sample string 1",
      "Category": "sample string 2"
    },
    {
      "Fulladdress": "sample string 1",
      "Category": "sample string 2"
    }
  ],
  "message": "sample string 1",
  "code": 2
}

text/xml

Sample:
<AddressSearch_Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BNGWebAPI.Classes">
  <addresses>
    <Addresses>
      <Category>sample string 2</Category>
      <Fulladdress>sample string 1</Fulladdress>
    </Addresses>
    <Addresses>
      <Category>sample string 2</Category>
      <Fulladdress>sample string 1</Fulladdress>
    </Addresses>
  </addresses>
  <code>2</code>
  <message>sample string 1</message>
</AddressSearch_Result>