GET api/TownShip/GetAll/{postalCode}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| postalCode | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ResponseGetAllTownShipModel| Name | Description | Type | Additional information |
|---|---|---|---|
| data | Collection of TownShipModel |
None. |
|
| message | string |
None. |
|
| success | boolean |
None. |
|
| total | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"data": [
{
"Id": "70f37dda-61d4-4bb2-a1dd-bce95d9ef537",
"TownShipCode": "sample string 2",
"Zone": "sample string 3",
"PostalCode": "sample string 4",
"OfficeCode": "sample string 5",
"CreatedOn": "2026-06-24T15:44:05.0401316-04:00",
"IdAsentaCPcons": "sample string 7",
"Name": "sample string 8",
"TownId": "fc5306fd-8e77-412f-bd3e-3eaa10805a0b",
"Town": {
"Id": "5a036ebc-c385-45d5-b8f5-9d4b7f44091e",
"Name": "sample string 2",
"Code": "sample string 3",
"CityName": "sample string 4",
"CityCode": "sample string 5",
"CreatedOn": "2026-06-24T15:44:05.0411292-04:00",
"StateId": "2a50e6dd-b961-4054-8608-ece7a5f4baa3",
"State": {
"Id": "03a98b5f-a83f-4d3e-a0e9-405c1b47da33",
"Name": "sample string 2",
"Code": "sample string 3",
"CreatedOn": "2026-06-24T15:44:05.0411292-04:00"
}
},
"TownShipTypeId": "0db42ee5-2cd0-42aa-8c54-fa29de2e5e26",
"TownShipType": {
"Id": "b6b7b4de-2cae-40b8-b1d2-b115767edcb8",
"Name": "sample string 2",
"Code": "sample string 3",
"CreatedOn": "2026-06-24T15:44:05.0421323-04:00"
}
},
{
"Id": "70f37dda-61d4-4bb2-a1dd-bce95d9ef537",
"TownShipCode": "sample string 2",
"Zone": "sample string 3",
"PostalCode": "sample string 4",
"OfficeCode": "sample string 5",
"CreatedOn": "2026-06-24T15:44:05.0401316-04:00",
"IdAsentaCPcons": "sample string 7",
"Name": "sample string 8",
"TownId": "fc5306fd-8e77-412f-bd3e-3eaa10805a0b",
"Town": {
"Id": "5a036ebc-c385-45d5-b8f5-9d4b7f44091e",
"Name": "sample string 2",
"Code": "sample string 3",
"CityName": "sample string 4",
"CityCode": "sample string 5",
"CreatedOn": "2026-06-24T15:44:05.0411292-04:00",
"StateId": "2a50e6dd-b961-4054-8608-ece7a5f4baa3",
"State": {
"Id": "03a98b5f-a83f-4d3e-a0e9-405c1b47da33",
"Name": "sample string 2",
"Code": "sample string 3",
"CreatedOn": "2026-06-24T15:44:05.0411292-04:00"
}
},
"TownShipTypeId": "0db42ee5-2cd0-42aa-8c54-fa29de2e5e26",
"TownShipType": {
"Id": "b6b7b4de-2cae-40b8-b1d2-b115767edcb8",
"Name": "sample string 2",
"Code": "sample string 3",
"CreatedOn": "2026-06-24T15:44:05.0421323-04:00"
}
}
],
"message": "sample string 1",
"success": true,
"total": 3
}
application/xml, text/xml
Sample:
<ResponseGetAllTownShipModel 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>
<TownShipModel>
<CreatedOn>2026-06-24T15:44:05.0401316-04:00</CreatedOn>
<Id>70f37dda-61d4-4bb2-a1dd-bce95d9ef537</Id>
<IdAsentaCPcons>sample string 7</IdAsentaCPcons>
<Name>sample string 8</Name>
<OfficeCode>sample string 5</OfficeCode>
<PostalCode>sample string 4</PostalCode>
<Town>
<CityCode>sample string 5</CityCode>
<CityName>sample string 4</CityName>
<Code>sample string 3</Code>
<CreatedOn>2026-06-24T15:44:05.0411292-04:00</CreatedOn>
<Id>5a036ebc-c385-45d5-b8f5-9d4b7f44091e</Id>
<Name>sample string 2</Name>
<State>
<Code>sample string 3</Code>
<CreatedOn>2026-06-24T15:44:05.0411292-04:00</CreatedOn>
<Id>03a98b5f-a83f-4d3e-a0e9-405c1b47da33</Id>
<Name>sample string 2</Name>
</State>
<StateId>2a50e6dd-b961-4054-8608-ece7a5f4baa3</StateId>
</Town>
<TownId>fc5306fd-8e77-412f-bd3e-3eaa10805a0b</TownId>
<TownShipCode>sample string 2</TownShipCode>
<TownShipType>
<Code>sample string 3</Code>
<CreatedOn>2026-06-24T15:44:05.0421323-04:00</CreatedOn>
<Id>b6b7b4de-2cae-40b8-b1d2-b115767edcb8</Id>
<Name>sample string 2</Name>
</TownShipType>
<TownShipTypeId>0db42ee5-2cd0-42aa-8c54-fa29de2e5e26</TownShipTypeId>
<Zone>sample string 3</Zone>
</TownShipModel>
<TownShipModel>
<CreatedOn>2026-06-24T15:44:05.0401316-04:00</CreatedOn>
<Id>70f37dda-61d4-4bb2-a1dd-bce95d9ef537</Id>
<IdAsentaCPcons>sample string 7</IdAsentaCPcons>
<Name>sample string 8</Name>
<OfficeCode>sample string 5</OfficeCode>
<PostalCode>sample string 4</PostalCode>
<Town>
<CityCode>sample string 5</CityCode>
<CityName>sample string 4</CityName>
<Code>sample string 3</Code>
<CreatedOn>2026-06-24T15:44:05.0411292-04:00</CreatedOn>
<Id>5a036ebc-c385-45d5-b8f5-9d4b7f44091e</Id>
<Name>sample string 2</Name>
<State>
<Code>sample string 3</Code>
<CreatedOn>2026-06-24T15:44:05.0411292-04:00</CreatedOn>
<Id>03a98b5f-a83f-4d3e-a0e9-405c1b47da33</Id>
<Name>sample string 2</Name>
</State>
<StateId>2a50e6dd-b961-4054-8608-ece7a5f4baa3</StateId>
</Town>
<TownId>fc5306fd-8e77-412f-bd3e-3eaa10805a0b</TownId>
<TownShipCode>sample string 2</TownShipCode>
<TownShipType>
<Code>sample string 3</Code>
<CreatedOn>2026-06-24T15:44:05.0421323-04:00</CreatedOn>
<Id>b6b7b4de-2cae-40b8-b1d2-b115767edcb8</Id>
<Name>sample string 2</Name>
</TownShipType>
<TownShipTypeId>0db42ee5-2cd0-42aa-8c54-fa29de2e5e26</TownShipTypeId>
<Zone>sample string 3</Zone>
</TownShipModel>
</data>
</ResponseGetAllTownShipModel>