GET api/polygontypes?includePolygonIds={includePolygonIds}

Fetches Polygon Types from Database

Request Information

URI Parameters

NameDescriptionTypeAdditional information
includePolygonIds

Include or Exclude polygonId list from PolygonType object

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Returns

Collection of PolygonType
NameDescriptionTypeAdditional information
PolyTypeId

Gets or Sets Polygon Type Id

integer

None.

TypeName

Gets or Sets Polygon Type Name

string

None.

Description

Gets or Sets Polygon Description

string

None.

PolygonIds

Gets or Sets list of Polygon Ids associated to Polygon Type

Collection of integer

None.

FeatureClassCode

Gets or Sets Feature Class Code

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "polyTypeId": 1,
    "typeName": "sample string 2",
    "description": "sample string 3",
    "polygonIds": [
      1,
      2
    ],
    "featureClassCode": "sample string 4"
  },
  {
    "polyTypeId": 1,
    "typeName": "sample string 2",
    "description": "sample string 3",
    "polygonIds": [
      1,
      2
    ],
    "featureClassCode": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfPolygonType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <PolygonType>
    <Description>sample string 3</Description>
    <FeatureClassCode>sample string 4</FeatureClassCode>
    <PolyTypeId>1</PolyTypeId>
    <PolygonIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </PolygonIds>
    <TypeName>sample string 2</TypeName>
  </PolygonType>
  <PolygonType>
    <Description>sample string 3</Description>
    <FeatureClassCode>sample string 4</FeatureClassCode>
    <PolyTypeId>1</PolyTypeId>
    <PolygonIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </PolygonIds>
    <TypeName>sample string 2</TypeName>
  </PolygonType>
</ArrayOfPolygonType>