API / Device

Entity Description:

PoliteMail places a cookie on the recipient’s device that is used to open a tracked email. For example, if the Device that was used to open a tracked email was an iPad, a cookie is placed on the iPad enabling PoliteMail to track the number of devices per recipient. In otherwords, the number of iPads that were used to open the email.

Properties

NameDescriptionTypeAdditional
Information
ID
Int32
CookieID
String
CreationDate
DateTime


Entity Statement

if you are using versions earlier than 5.0, substitute "ssv3" for "api" for each Request listed below.

Creating a Device

Request

POST /api/odata/Devices

Content-Type 

application/json

Request body

{
"ID":0","CookieID":"0","CreationDate":"2014-12-01T19:58:00.155Z"
}

Response body

{
"ID":1,"CookieID":0,"CreationDate":"2014-12-02T03:11:00.155Z"
}
Deleting a Device
 Request
 DELETE /api/odata/Devices(1)
 Response Headers
 HTTP/1.1 204 No Content
Getting a Device
 Request
 GET /ssv3/odata/Devices(1)
 Content-Type 
 application/json
 Response body
 {
"ID":1,"CookieID":0,"CreationDate":"2014-12-02T03:11:00.155Z"
}
Updating a Device
 Request
 PUT /api/odata/Devices(1)
 Content-Type 
 application/json
 Request body
 {
"ID":"0","CookieID":"0","CreationDate":"2014-12-01T19:58:00.155Z"
}
 Response Headers
 HTTP/1.1 204 No Content
Getting all Devices
 Request
 GET /api/odata/Devices
 Content-Type
 application/json
 Response body
 "value":[{
"ID":0,"CookieID":0,"CreationDate":"2014-12-01T19:58:00.155Z"
},{
"ID":1,"CookieID":0,"CreationDate":"2014-12-02T03:11:00.155Z"
}]