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	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": "84de7afa-553a-44e9-a07c-915352a23ed7",
      "TownShipCode": "sample string 2",
      "Zone": "sample string 3",
      "PostalCode": "sample string 4",
      "OfficeCode": "sample string 5",
      "CreatedOn": "2025-12-05T23:42:03.7329833-04:00",
      "IdAsentaCPcons": "sample string 7",
      "Name": "sample string 8",
      "TownId": "75ad04b8-b9f0-45b9-96c4-e897364948c3",
      "Town": {
        "Id": "b901b425-c742-4fc6-a085-4cb32abf64a0",
        "Name": "sample string 2",
        "Code": "sample string 3",
        "CityName": "sample string 4",
        "CityCode": "sample string 5",
        "CreatedOn": "2025-12-05T23:42:03.7339816-04:00",
        "StateId": "573d6543-a885-4e06-a42a-58fb268dd46a",
        "State": {
          "Id": "fdc4be77-fa56-4320-8085-e2746da8540c",
          "Name": "sample string 2",
          "Code": "sample string 3",
          "CreatedOn": "2025-12-05T23:42:03.7339816-04:00"
        }
      },
      "TownShipTypeId": "0f33dc2c-175f-4bc2-98ca-6474a8225552",
      "TownShipType": {
        "Id": "4682fd89-baa5-4d18-b8fc-0d84891cbd29",
        "Name": "sample string 2",
        "Code": "sample string 3",
        "CreatedOn": "2025-12-05T23:42:03.7349801-04:00"
      }
    },
    {
      "Id": "84de7afa-553a-44e9-a07c-915352a23ed7",
      "TownShipCode": "sample string 2",
      "Zone": "sample string 3",
      "PostalCode": "sample string 4",
      "OfficeCode": "sample string 5",
      "CreatedOn": "2025-12-05T23:42:03.7329833-04:00",
      "IdAsentaCPcons": "sample string 7",
      "Name": "sample string 8",
      "TownId": "75ad04b8-b9f0-45b9-96c4-e897364948c3",
      "Town": {
        "Id": "b901b425-c742-4fc6-a085-4cb32abf64a0",
        "Name": "sample string 2",
        "Code": "sample string 3",
        "CityName": "sample string 4",
        "CityCode": "sample string 5",
        "CreatedOn": "2025-12-05T23:42:03.7339816-04:00",
        "StateId": "573d6543-a885-4e06-a42a-58fb268dd46a",
        "State": {
          "Id": "fdc4be77-fa56-4320-8085-e2746da8540c",
          "Name": "sample string 2",
          "Code": "sample string 3",
          "CreatedOn": "2025-12-05T23:42:03.7339816-04:00"
        }
      },
      "TownShipTypeId": "0f33dc2c-175f-4bc2-98ca-6474a8225552",
      "TownShipType": {
        "Id": "4682fd89-baa5-4d18-b8fc-0d84891cbd29",
        "Name": "sample string 2",
        "Code": "sample string 3",
        "CreatedOn": "2025-12-05T23:42:03.7349801-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>2025-12-05T23:42:03.7329833-04:00</CreatedOn>
      <Id>84de7afa-553a-44e9-a07c-915352a23ed7</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>2025-12-05T23:42:03.7339816-04:00</CreatedOn>
        <Id>b901b425-c742-4fc6-a085-4cb32abf64a0</Id>
        <Name>sample string 2</Name>
        <State>
          <Code>sample string 3</Code>
          <CreatedOn>2025-12-05T23:42:03.7339816-04:00</CreatedOn>
          <Id>fdc4be77-fa56-4320-8085-e2746da8540c</Id>
          <Name>sample string 2</Name>
        </State>
        <StateId>573d6543-a885-4e06-a42a-58fb268dd46a</StateId>
      </Town>
      <TownId>75ad04b8-b9f0-45b9-96c4-e897364948c3</TownId>
      <TownShipCode>sample string 2</TownShipCode>
      <TownShipType>
        <Code>sample string 3</Code>
        <CreatedOn>2025-12-05T23:42:03.7349801-04:00</CreatedOn>
        <Id>4682fd89-baa5-4d18-b8fc-0d84891cbd29</Id>
        <Name>sample string 2</Name>
      </TownShipType>
      <TownShipTypeId>0f33dc2c-175f-4bc2-98ca-6474a8225552</TownShipTypeId>
      <Zone>sample string 3</Zone>
    </TownShipModel>
    <TownShipModel>
      <CreatedOn>2025-12-05T23:42:03.7329833-04:00</CreatedOn>
      <Id>84de7afa-553a-44e9-a07c-915352a23ed7</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>2025-12-05T23:42:03.7339816-04:00</CreatedOn>
        <Id>b901b425-c742-4fc6-a085-4cb32abf64a0</Id>
        <Name>sample string 2</Name>
        <State>
          <Code>sample string 3</Code>
          <CreatedOn>2025-12-05T23:42:03.7339816-04:00</CreatedOn>
          <Id>fdc4be77-fa56-4320-8085-e2746da8540c</Id>
          <Name>sample string 2</Name>
        </State>
        <StateId>573d6543-a885-4e06-a42a-58fb268dd46a</StateId>
      </Town>
      <TownId>75ad04b8-b9f0-45b9-96c4-e897364948c3</TownId>
      <TownShipCode>sample string 2</TownShipCode>
      <TownShipType>
        <Code>sample string 3</Code>
        <CreatedOn>2025-12-05T23:42:03.7349801-04:00</CreatedOn>
        <Id>4682fd89-baa5-4d18-b8fc-0d84891cbd29</Id>
        <Name>sample string 2</Name>
      </TownShipType>
      <TownShipTypeId>0f33dc2c-175f-4bc2-98ca-6474a8225552</TownShipTypeId>
      <Zone>sample string 3</Zone>
    </TownShipModel>
  </data>
</ResponseGetAllTownShipModel>