GET api/polygonsByStop?stopId={stopId}&typeId={typeId}&includeVertexInfo={includeVertexInfo}

Fetches all the polygons of a given type that a stop is contained in

Request Information

URI Parameters

NameDescriptionTypeAdditional information
stopId

The id of the stop to use to filter the polygons.

 integer

Required
typeId

Polygon Type Id

 integer

None.
includeVertexInfo

Include or Exclude coordinates info in Polygon Object

 boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

The polygons that contain the specified stop

Collection of Polygon
NameDescriptionTypeAdditional information
PolyId

Gets or Sets Polygon Id

 integer

None.
PolyTypeId

Gets or Sets Polygon Type Id

 integer

None.
PolyAbbr

Gets or Sets Polygon Abbreviated Name

 string

None.
PolyName

Gets or Sets Polygon Name

 string

None.
FeatureClassCode

Gets or Sets Feature Class Code

 string

None.
PartNumber

Gets or Sets polygon part number

 integer

None.
ServiceBoundsCenter

Gets or Sets Polygon bound area center coordinates

 GeoPointOfDouble

None.
ServiceBoundsNeCorner

Gets or Sets Polygon bound area Top-Right coordinates

 GeoPointOfDouble

None.
ServiceBoundsSwCorner

Gets or Sets Polygon bound area Bottom-Left coordiates

 GeoPointOfDouble

None.
ServiceAreaCoordinates

Gets or Sets Polygon service area coordinates

 Collection of GeoPointOfDouble

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "polyId": 1,
    "polyTypeId": 1,
    "polyAbbr": "sample string 2",
    "polyName": "sample string 3",
    "featureClassCode": "sample string 4",
    "partNumber": 1,
    "serviceBoundsCenter": {
      "lat": 1.1,
      "long": 2.1
    },
    "serviceBoundsNeCorner": {
      "lat": 1.1,
      "long": 2.1
    },
    "serviceBoundsSwCorner": {
      "lat": 1.1,
      "long": 2.1
    },
    "serviceAreaCoordinates": [
      {
        "lat": 1.1,
        "long": 2.1
      },
      {
        "lat": 1.1,
        "long": 2.1
      }
    ]
  },
  {
    "polyId": 1,
    "polyTypeId": 1,
    "polyAbbr": "sample string 2",
    "polyName": "sample string 3",
    "featureClassCode": "sample string 4",
    "partNumber": 1,
    "serviceBoundsCenter": {
      "lat": 1.1,
      "long": 2.1
    },
    "serviceBoundsNeCorner": {
      "lat": 1.1,
      "long": 2.1
    },
    "serviceBoundsSwCorner": {
      "lat": 1.1,
      "long": 2.1
    },
    "serviceAreaCoordinates": [
      {
        "lat": 1.1,
        "long": 2.1
      },
      {
        "lat": 1.1,
        "long": 2.1
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPolygon xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <Polygon>
    <Bottom>1</Bottom>
    <FeatureClassCode>sample string 4</FeatureClassCode>
    <Left>1</Left>
    <NumVert>1</NumVert>
    <PartNumber>1</PartNumber>
    <PolyAbbr>sample string 2</PolyAbbr>
    <PolyId>1</PolyId>
    <PolyName>sample string 3</PolyName>
    <PolyTypeId>1</PolyTypeId>
    <PolyVertData>QEA=</PolyVertData>
    <Right>1</Right>
    <ServiceAreaCoordinates>
      <GeoPointOfdouble>
        <Lat>1.1</Lat>
        <Long>2.1</Long>
      </GeoPointOfdouble>
      <GeoPointOfdouble>
        <Lat>1.1</Lat>
        <Long>2.1</Long>
      </GeoPointOfdouble>
    </ServiceAreaCoordinates>
    <ServiceBoundsCenter>
      <Lat>1.1</Lat>
      <Long>2.1</Long>
    </ServiceBoundsCenter>
    <ServiceBoundsNeCorner>
      <Lat>1.1</Lat>
      <Long>2.1</Long>
    </ServiceBoundsNeCorner>
    <ServiceBoundsSwCorner>
      <Lat>1.1</Lat>
      <Long>2.1</Long>
    </ServiceBoundsSwCorner>
    <Top>1</Top>
    <VertList>
      <WorldPoint>
        <X>1</X>
        <Y>1</Y>
      </WorldPoint>
      <WorldPoint>
        <X>1</X>
        <Y>1</Y>
      </WorldPoint>
    </VertList>
  </Polygon>
  <Polygon>
    <Bottom>1</Bottom>
    <FeatureClassCode>sample string 4</FeatureClassCode>
    <Left>1</Left>
    <NumVert>1</NumVert>
    <PartNumber>1</PartNumber>
    <PolyAbbr>sample string 2</PolyAbbr>
    <PolyId>1</PolyId>
    <PolyName>sample string 3</PolyName>
    <PolyTypeId>1</PolyTypeId>
    <PolyVertData>QEA=</PolyVertData>
    <Right>1</Right>
    <ServiceAreaCoordinates>
      <GeoPointOfdouble>
        <Lat>1.1</Lat>
        <Long>2.1</Long>
      </GeoPointOfdouble>
      <GeoPointOfdouble>
        <Lat>1.1</Lat>
        <Long>2.1</Long>
      </GeoPointOfdouble>
    </ServiceAreaCoordinates>
    <ServiceBoundsCenter>
      <Lat>1.1</Lat>
      <Long>2.1</Long>
    </ServiceBoundsCenter>
    <ServiceBoundsNeCorner>
      <Lat>1.1</Lat>
      <Long>2.1</Long>
    </ServiceBoundsNeCorner>
    <ServiceBoundsSwCorner>
      <Lat>1.1</Lat>
      <Long>2.1</Long>
    </ServiceBoundsSwCorner>
    <Top>1</Top>
    <VertList>
      <WorldPoint>
        <X>1</X>
        <Y>1</Y>
      </WorldPoint>
      <WorldPoint>
        <X>1</X>
        <Y>1</Y>
      </WorldPoint>
    </VertList>
  </Polygon>
</ArrayOfPolygon>