GET Api/POIZone?clientID={clientID}&poiZoneID={poiZoneID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientID

globally unique identifier

Required
poiZoneID

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

POIZone
NameDescriptionTypeAdditional information
POIZoneID

globally unique identifier

None.
Name

string

None.
Description

string

None.
Color

string

None.
Radius

integer

None.
Points

Collection of TupleOfDoubleAndDouble

None.
CenterPoint

TupleOfDoubleAndDouble

None.
ClientID

globally unique identifier

None.
POICategoryType

POICategoryType

None.
PointsString

Collection of string

None.
LatList

Collection of decimal number

None.
LanList

Collection of decimal number

None.
CurrentLat

decimal number

None.
CurrentLon

decimal number

None.
POIType

POIType

None.
Distance

decimal number

None.
POIZoneIDs

Collection of globally unique identifier

None.
POIGroup

POIGroup

None.

Response Formats

application/json, text/json

Sample: 
{
  "POIZoneID": "ac6ad9a9-6a24-41f9-ae09-c7712345f773",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Color": "sample string 4",
  "Radius": 5,
  "Points": [
    {
      "m_Item1": 1.1,
      "m_Item2": 2.1
    },
    {
      "m_Item1": 1.1,
      "m_Item2": 2.1
    }
  ],
  "CenterPoint": {
    "m_Item1": 1.1,
    "m_Item2": 2.1
  },
  "ClientID": "498cb427-ea68-4cc4-88cd-b4f877b14485",
  "POICategoryType": 0,
  "PointsString": [
    "sample string 1",
    "sample string 2"
  ],
  "LatList": [
    1.1,
    2.1
  ],
  "LanList": [
    1.1,
    2.1
  ],
  "CurrentLat": 7.1,
  "CurrentLon": 8.1,
  "POIType": 0,
  "Distance": 9.1,
  "POIZoneIDs": [
    "0a23e7a8-5f29-41c2-b1bc-d527dec8b5aa",
    "b2a25c31-15e0-4a70-9528-37e852742c02"
  ],
  "POIGroup": {
    "POIGroupID": "c98c6a7b-6d9f-4fbe-934d-b2a8ab37ffbf",
    "Name": "sample string 2",
    "ClientID": "22ea4b8d-3fca-483c-82d5-fe52f7a7fd35",
    "PartnerID": "8e899673-09e3-4964-9f81-23c32b660d4d"
  }
}

application/xml, text/xml

Sample: 
<POIZone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetroot.Entity">
  <CenterPoint xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:m_Item1>1.1</d2p1:m_Item1>
    <d2p1:m_Item2>2.1</d2p1:m_Item2>
  </CenterPoint>
  <ClientID>498cb427-ea68-4cc4-88cd-b4f877b14485</ClientID>
  <Color>sample string 4</Color>
  <CurrentLat>7.1</CurrentLat>
  <CurrentLon>8.1</CurrentLon>
  <Description>sample string 3</Description>
  <Distance>9.1</Distance>
  <LanList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:double>1.1</d2p1:double>
    <d2p1:double>2.1</d2p1:double>
  </LanList>
  <LatList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:double>1.1</d2p1:double>
    <d2p1:double>2.1</d2p1:double>
  </LatList>
  <Name>sample string 2</Name>
  <POICategoryType>None</POICategoryType>
  <POIGroup>
    <ClientID>22ea4b8d-3fca-483c-82d5-fe52f7a7fd35</ClientID>
    <Name>sample string 2</Name>
    <POIGroupID>c98c6a7b-6d9f-4fbe-934d-b2a8ab37ffbf</POIGroupID>
    <PartnerID>8e899673-09e3-4964-9f81-23c32b660d4d</PartnerID>
  </POIGroup>
  <POIType>None</POIType>
  <POIZoneID>ac6ad9a9-6a24-41f9-ae09-c7712345f773</POIZoneID>
  <POIZoneIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>0a23e7a8-5f29-41c2-b1bc-d527dec8b5aa</d2p1:guid>
    <d2p1:guid>b2a25c31-15e0-4a70-9528-37e852742c02</d2p1:guid>
  </POIZoneIDs>
  <Points xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:TupleOfdoubledouble>
      <d2p1:m_Item1>1.1</d2p1:m_Item1>
      <d2p1:m_Item2>2.1</d2p1:m_Item2>
    </d2p1:TupleOfdoubledouble>
    <d2p1:TupleOfdoubledouble>
      <d2p1:m_Item1>1.1</d2p1:m_Item1>
      <d2p1:m_Item2>2.1</d2p1:m_Item2>
    </d2p1:TupleOfdoubledouble>
  </Points>
  <PointsString xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PointsString>
  <Radius>5</Radius>
</POIZone>