GET api/Search/{regionCode}?name={name}

Request Information

URI Parameters

Name	Description	Type	Additional information
name		string	Required
regionCode		string	None.

Body Parameters

None.

Response Information

Resource Description

SearchResult

Name	Type	Additional information
Addresses	Collection of OsmAddress	None.
Places	Collection of OsmPlace	None.
Streets	Collection of OsmStreet	None.

Response Formats

application/json, text/json

Sample:

{
  "Addresses": [
    {
      "OsmId": 1,
      "OsmStreet": "sample string 2",
      "OsmHouseNumber": "sample string 3",
      "OsmPostCode": "sample string 4",
      "OsmCity": "sample string 5",
      "Lat": 6.1,
      "Lng": 7.1,
      "Geom": {},
      "Score": 9.1
    },
    {
      "OsmId": 1,
      "OsmStreet": "sample string 2",
      "OsmHouseNumber": "sample string 3",
      "OsmPostCode": "sample string 4",
      "OsmCity": "sample string 5",
      "Lat": 6.1,
      "Lng": 7.1,
      "Geom": {},
      "Score": 9.1
    }
  ],
  "Places": [
    {
      "OsmId": 1,
      "OsmName": "sample string 2",
      "OsmType": "sample string 3",
      "Lat": 4.1,
      "Lng": 5.1,
      "Geom": {},
      "Score": 7.1
    },
    {
      "OsmId": 1,
      "OsmName": "sample string 2",
      "OsmType": "sample string 3",
      "Lat": 4.1,
      "Lng": 5.1,
      "Geom": {},
      "Score": 7.1
    }
  ],
  "Streets": [
    {
      "OsmId": 1,
      "OsmName": "sample string 2",
      "OsmType": "sample string 3",
      "Lat": 4.1,
      "Lng": 5.1,
      "Geom": {},
      "Score": 7.1
    },
    {
      "OsmId": 1,
      "OsmName": "sample string 2",
      "OsmType": "sample string 3",
      "Lat": 4.1,
      "Lng": 5.1,
      "Geom": {},
      "Score": 7.1
    }
  ]
}

text/html

Sample:

{"Addresses":[{"OsmId":1,"OsmStreet":"sample string 2","OsmHouseNumber":"sample string 3","OsmPostCode":"sample string 4","OsmCity":"sample string 5","Lat":6.1,"Lng":7.1,"Geom":{},"Score":9.1},{"OsmId":1,"OsmStreet":"sample string 2","OsmHouseNumber":"sample string 3","OsmPostCode":"sample string 4","OsmCity":"sample string 5","Lat":6.1,"Lng":7.1,"Geom":{},"Score":9.1}],"Places":[{"OsmId":1,"OsmName":"sample string 2","OsmType":"sample string 3","Lat":4.1,"Lng":5.1,"Geom":{},"Score":7.1},{"OsmId":1,"OsmName":"sample string 2","OsmType":"sample string 3","Lat":4.1,"Lng":5.1,"Geom":{},"Score":7.1}],"Streets":[{"OsmId":1,"OsmName":"sample string 2","OsmType":"sample string 3","Lat":4.1,"Lng":5.1,"Geom":{},"Score":7.1},{"OsmId":1,"OsmName":"sample string 2","OsmType":"sample string 3","Lat":4.1,"Lng":5.1,"Geom":{},"Score":7.1}]}

application/xml, text/xml

Sample:

<SearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BGW.Search.Core">
  <Addresses>
    <OsmAddress>
      <Geom />
      <Lat>6.1</Lat>
      <Lng>7.1</Lng>
      <OsmCity>sample string 5</OsmCity>
      <OsmHouseNumber>sample string 3</OsmHouseNumber>
      <OsmId>1</OsmId>
      <OsmPostCode>sample string 4</OsmPostCode>
      <OsmStreet>sample string 2</OsmStreet>
      <Score>9.1</Score>
    </OsmAddress>
    <OsmAddress>
      <Geom />
      <Lat>6.1</Lat>
      <Lng>7.1</Lng>
      <OsmCity>sample string 5</OsmCity>
      <OsmHouseNumber>sample string 3</OsmHouseNumber>
      <OsmId>1</OsmId>
      <OsmPostCode>sample string 4</OsmPostCode>
      <OsmStreet>sample string 2</OsmStreet>
      <Score>9.1</Score>
    </OsmAddress>
  </Addresses>
  <Places>
    <OsmPlace>
      <Geom />
      <Lat>4.1</Lat>
      <Lng>5.1</Lng>
      <OsmId>1</OsmId>
      <OsmName>sample string 2</OsmName>
      <OsmType>sample string 3</OsmType>
      <Score>7.1</Score>
    </OsmPlace>
    <OsmPlace>
      <Geom />
      <Lat>4.1</Lat>
      <Lng>5.1</Lng>
      <OsmId>1</OsmId>
      <OsmName>sample string 2</OsmName>
      <OsmType>sample string 3</OsmType>
      <Score>7.1</Score>
    </OsmPlace>
  </Places>
  <Streets>
    <OsmStreet>
      <Geom />
      <Lat>4.1</Lat>
      <Lng>5.1</Lng>
      <OsmId>1</OsmId>
      <OsmName>sample string 2</OsmName>
      <OsmType>sample string 3</OsmType>
      <Score>7.1</Score>
    </OsmStreet>
    <OsmStreet>
      <Geom />
      <Lat>4.1</Lat>
      <Lng>5.1</Lng>
      <OsmId>1</OsmId>
      <OsmName>sample string 2</OsmName>
      <OsmType>sample string 3</OsmType>
      <Score>7.1</Score>
    </OsmStreet>
  </Streets>
</SearchResult>