Neighborhood List

This API returns neighborhood list in Turkey. List is filtered according to entered district.

API Information

URL

 /neighborhoodList

Method

 POST

Version

 1.0

Scope

 public

Authorization Flow

 Client Credentials


Input Information

Name Format Description Required/Optional

DistrictCode

 String District code Required


Output Information

Name Format Description

Neighborhood

 List< Neighborhood > Neighborhood information


Neighborhood

Name Format Description

NeighborhoodName

 String Neighborhood name

NeighborhoodCode

 String Neighborhood code


Message Codes

Message Code Description

ACBH000053

Bank district code should consist of only numerical data.

ACBH000069

Bank district code cannot be empty.

ACBH000128

Neighborhood is not found.

Example

Request:

{
	"DistrictCode":"34"
}

Response:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Completed",
        "ObjectID": "541c7a37-a3b0-48c0-9107-e7d2e408470b"
    },
    "Data": {
        "Neighborhood": [
            {
                "NeighborhoodName": "Yenişehir",
                "NeighborhoodCode": "68000703158"
            },
            {
                "NeighborhoodName": "Küçük Piyale",
                "NeighborhoodCode": "68000703158"
            },
            {
                "NeighborhoodName": "Sururi Mehmet Efendi",
                "NeighborhoodCode": "68000703158"
            },
			...
            {
                "NeighborhoodName": "Bostan",
                "NeighborhoodCode": "68000703158"
            }
        ]
    }
}