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
Creating a Location | |
Request | |
POST /ssv3/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 /ssv3/odata/Locations(1) | |
Response Headers | |
HTTP/1.1 204 No Content | |
Getting a Location | |
Request | |
GET /ssv3/odata/Locations(1) | |
Content-Type | |
application/json | |
Response body | |
{ "ID":1,"LatLong":0.00000,"Count":0,"Event":"Example Event" } |
|
Updating a Location | |
Request | |
PUT /ssv3/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 /ssv3/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" }] |