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
POIZoneName | 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": "bb698e78-7960-49ef-8e7e-e0269b989288", "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": "b97d7161-91d7-478d-a084-a88e5c905e4c", "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": [ "6d361e31-e88d-46c4-a454-d6a3cbfe5539", "83cb9992-d958-4a42-b5f7-8d1474c74435" ], "POIGroup": { "POIGroupID": "27ecb760-1c21-4808-84db-79bb26afb6fd", "Name": "sample string 2", "ClientID": "58daa332-3291-42aa-8064-ed1c2c938ba7", "PartnerID": "f8c1eefc-bbed-4845-9235-3361e6dbcf8e" } }
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>b97d7161-91d7-478d-a084-a88e5c905e4c</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>58daa332-3291-42aa-8064-ed1c2c938ba7</ClientID> <Name>sample string 2</Name> <POIGroupID>27ecb760-1c21-4808-84db-79bb26afb6fd</POIGroupID> <PartnerID>f8c1eefc-bbed-4845-9235-3361e6dbcf8e</PartnerID> </POIGroup> <POIType>None</POIType> <POIZoneID>bb698e78-7960-49ef-8e7e-e0269b989288</POIZoneID> <POIZoneIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>6d361e31-e88d-46c4-a454-d6a3cbfe5539</d2p1:guid> <d2p1:guid>83cb9992-d958-4a42-b5f7-8d1474c74435</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>