GET Api/POIZone?clientID={clientID}&poiZoneID={poiZoneID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientID | globally unique identifier |
Required |
|
| poiZoneID | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
POIZone| Name | Description | Type | Additional 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": "964c70df-ea13-4288-9785-958cb8d2000b",
"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": "754e40a6-2239-46c5-99e2-8dc6d2a386fd",
"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": [
"f3cc1325-f546-47d3-b1af-6d4e0580c20b",
"c011718c-5d6f-4328-9cac-e5fddbbb5675"
],
"POIGroup": {
"POIGroupID": "3512fc58-ed5b-4f8e-ad74-78b3545e61f9",
"Name": "sample string 2",
"ClientID": "d9717099-5ea2-4598-af49-c7eaaf76efc4",
"PartnerID": "f31bc8d1-7e06-4527-8a11-8dd863ff4c1a"
}
}
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>754e40a6-2239-46c5-99e2-8dc6d2a386fd</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>d9717099-5ea2-4598-af49-c7eaaf76efc4</ClientID>
<Name>sample string 2</Name>
<POIGroupID>3512fc58-ed5b-4f8e-ad74-78b3545e61f9</POIGroupID>
<PartnerID>f31bc8d1-7e06-4527-8a11-8dd863ff4c1a</PartnerID>
</POIGroup>
<POIType>None</POIType>
<POIZoneID>964c70df-ea13-4288-9785-958cb8d2000b</POIZoneID>
<POIZoneIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>f3cc1325-f546-47d3-b1af-6d4e0580c20b</d2p1:guid>
<d2p1:guid>c011718c-5d6f-4328-9cac-e5fddbbb5675</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>