POST api/poi/createedit
Create or edit POIs
Request Information
URI Parameters
None.
Body Parameters
The CreateEditPOIRequestModel made
CreateEditPOIRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Token |
The token returned after login used for authentication |
string |
None. |
| UserID |
The user id returned after login used for authentication |
unsigned integer |
None. |
| PolygonPOIList |
The list of polygon POIs being created / edited - Can be null |
Collection of PolygonPOI |
None. |
| RadiusPOIList |
The list of radius POIs being created / edited - Can be null |
Collection of RadiusPOI |
None. |
Request Formats
application/json, text/json
Sample:
{
"Token": "sample string 1",
"UserID": 2,
"PolygonPOIList": [
{
"PolygonPointList": [
{
"Latitude": 1.1,
"Longitude": 2.1,
"Order": 3
},
{
"Latitude": 1.1,
"Longitude": 2.1,
"Order": 3
}
],
"POIID": 1,
"POIName": "sample string 2",
"GroupId": 1
},
{
"PolygonPointList": [
{
"Latitude": 1.1,
"Longitude": 2.1,
"Order": 3
},
{
"Latitude": 1.1,
"Longitude": 2.1,
"Order": 3
}
],
"POIID": 1,
"POIName": "sample string 2",
"GroupId": 1
}
],
"RadiusPOIList": [
{
"Latitude": 1.1,
"Longitude": 2.1,
"Street": "sample string 3",
"Town": "sample string 4",
"Country": "sample string 5",
"Postcode": "sample string 6",
"Radius": 7,
"POIID": 8,
"POIName": "sample string 9",
"GroupId": 1
},
{
"Latitude": 1.1,
"Longitude": 2.1,
"Street": "sample string 3",
"Town": "sample string 4",
"Country": "sample string 5",
"Postcode": "sample string 6",
"Radius": 7,
"POIID": 8,
"POIName": "sample string 9",
"GroupId": 1
}
]
}
application/xml, text/xml
Sample:
<CreateEditPOIRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Token>sample string 1</Token>
<UserID>2</UserID>
<PolygonPOIList>
<PolygonPOI>
<POIID>1</POIID>
<POIName>sample string 2</POIName>
<GroupId>1</GroupId>
<PolygonPointList>
<PolygonPoint>
<Latitude>1.1</Latitude>
<Longitude>2.1</Longitude>
<Order>3</Order>
</PolygonPoint>
<PolygonPoint>
<Latitude>1.1</Latitude>
<Longitude>2.1</Longitude>
<Order>3</Order>
</PolygonPoint>
</PolygonPointList>
</PolygonPOI>
<PolygonPOI>
<POIID>1</POIID>
<POIName>sample string 2</POIName>
<GroupId>1</GroupId>
<PolygonPointList>
<PolygonPoint>
<Latitude>1.1</Latitude>
<Longitude>2.1</Longitude>
<Order>3</Order>
</PolygonPoint>
<PolygonPoint>
<Latitude>1.1</Latitude>
<Longitude>2.1</Longitude>
<Order>3</Order>
</PolygonPoint>
</PolygonPointList>
</PolygonPOI>
</PolygonPOIList>
<RadiusPOIList>
<RadiusPOI>
<POIID>8</POIID>
<POIName>sample string 9</POIName>
<GroupId>1</GroupId>
<Latitude>1.1</Latitude>
<Longitude>2.1</Longitude>
<Street>sample string 3</Street>
<Town>sample string 4</Town>
<Country>sample string 5</Country>
<Postcode>sample string 6</Postcode>
<Radius>7</Radius>
</RadiusPOI>
<RadiusPOI>
<POIID>8</POIID>
<POIName>sample string 9</POIName>
<GroupId>1</GroupId>
<Latitude>1.1</Latitude>
<Longitude>2.1</Longitude>
<Street>sample string 3</Street>
<Town>sample string 4</Town>
<Country>sample string 5</Country>
<Postcode>sample string 6</Postcode>
<Radius>7</Radius>
</RadiusPOI>
</RadiusPOIList>
</CreateEditPOIRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A CreateEditPOIResponseModel on success
CreateEditPOIResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| POIDetailList |
A list of the POI details |
Collection of POIDetail |
None. |
| POICount |
A count of the POIs made / edited |
unsigned integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"POIDetailList": [
{
"POIName": "sample string 1",
"POIID": 2
},
{
"POIName": "sample string 1",
"POIID": 2
}
],
"POICount": 1
}
application/xml, text/xml
Sample:
<CreateEditPOIResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<POIDetailList>
<POIDetail>
<POIName>sample string 1</POIName>
<POIID>2</POIID>
</POIDetail>
<POIDetail>
<POIName>sample string 1</POIName>
<POIID>2</POIID>
</POIDetail>
</POIDetailList>
<POICount>1</POICount>
</CreateEditPOIResponseModel>