GET api/Town/GetTownByCity/{cityCode}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| cityCode | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ResponseGetTownsModel| Name | Description | Type | Additional information |
|---|---|---|---|
| data | Collection of TownModel |
None. |
|
| message | string |
None. |
|
| success | boolean |
None. |
|
| total | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"data": [
{
"Id": "62ed46a9-1525-44a1-9b38-6af5614490b6",
"Name": "sample string 2",
"Code": "sample string 3",
"CityName": "sample string 4",
"CityCode": "sample string 5",
"CreatedOn": "2026-01-22T17:23:50.4565097-04:00",
"StateId": "79361592-c2f5-4441-abf3-37c558567b25",
"State": {
"Id": "7fce2141-85b2-4719-aba8-560286ba81cd",
"Name": "sample string 2",
"Code": "sample string 3",
"CreatedOn": "2026-01-22T17:23:50.4565097-04:00"
}
},
{
"Id": "62ed46a9-1525-44a1-9b38-6af5614490b6",
"Name": "sample string 2",
"Code": "sample string 3",
"CityName": "sample string 4",
"CityCode": "sample string 5",
"CreatedOn": "2026-01-22T17:23:50.4565097-04:00",
"StateId": "79361592-c2f5-4441-abf3-37c558567b25",
"State": {
"Id": "7fce2141-85b2-4719-aba8-560286ba81cd",
"Name": "sample string 2",
"Code": "sample string 3",
"CreatedOn": "2026-01-22T17:23:50.4565097-04:00"
}
}
],
"message": "sample string 1",
"success": true,
"total": 3
}
application/xml, text/xml
Sample:
<ResponseGetTownsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UnderArmorAPI.Models">
<message>sample string 1</message>
<success>true</success>
<total>3</total>
<data>
<TownModel>
<CityCode>sample string 5</CityCode>
<CityName>sample string 4</CityName>
<Code>sample string 3</Code>
<CreatedOn>2026-01-22T17:23:50.4565097-04:00</CreatedOn>
<Id>62ed46a9-1525-44a1-9b38-6af5614490b6</Id>
<Name>sample string 2</Name>
<State>
<Code>sample string 3</Code>
<CreatedOn>2026-01-22T17:23:50.4565097-04:00</CreatedOn>
<Id>7fce2141-85b2-4719-aba8-560286ba81cd</Id>
<Name>sample string 2</Name>
</State>
<StateId>79361592-c2f5-4441-abf3-37c558567b25</StateId>
</TownModel>
<TownModel>
<CityCode>sample string 5</CityCode>
<CityName>sample string 4</CityName>
<Code>sample string 3</Code>
<CreatedOn>2026-01-22T17:23:50.4565097-04:00</CreatedOn>
<Id>62ed46a9-1525-44a1-9b38-6af5614490b6</Id>
<Name>sample string 2</Name>
<State>
<Code>sample string 3</Code>
<CreatedOn>2026-01-22T17:23:50.4565097-04:00</CreatedOn>
<Id>7fce2141-85b2-4719-aba8-560286ba81cd</Id>
<Name>sample string 2</Name>
</State>
<StateId>79361592-c2f5-4441-abf3-37c558567b25</StateId>
</TownModel>
</data>
</ResponseGetTownsModel>