Entity Description:
Location is an entity used by PoliteMail to track a recipient’s geolocation. The results will be displayed in the Metrics section of PoliteMail.
Properties
| Name | Description | Type | Additional Information |
| ID | String | ||
| LatLong | Collection (Decimal) | ||
| Count | Int32 | ||
| Event | String |
Entity Statement
if you are using versions earlier than 5.0, substitute "ssv3" for "api" for each Request listed below.
| Creating a Location | |
| Request | |
| POST /api/odata/Locations | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","LatLong":"0.00000","Count":"0","Event":"Example Event" } | |
| Response body | |
| { "ID":1,"LatLong":0.00000,"Count":0,"Event":"Example Event" } | |
| Deleting a Location | |
| Request | |
| DELETE /api/odata/Locations(1) | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting a Location | |
| Request | |
| GET /api/odata/Locations(1) | |
| Content-Type | |
| application/json | |
| Response body | |
| { "ID":1,"LatLong":0.00000,"Count":0,"Event":"Example Event" } | |
| Updating a Location | |
| Request | |
| PUT /api/odata/Locations(1) | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","LatLong":"0.00000","Count":"0","Event":"Example Event" } | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting all Locations | |
| Request | |
| GET /api/odata/Locations | |
| Content-Type | |
| application/json | |
| Response body | |
| "value":[{ "ID":0,"LatLong":0.00000,"Count":0,"Event":"Example Event" },{ "ID":1,"LatLong":0.00000,"Count":0,"Event":"Example Event" }] | |
