API / Read

Entity Description:

Read is an entity if the PoliteMail Tracking feature. Read tracks the open rate, recipient, Browser, device used, device manufacturer, along with the Time Read (how long a recipient has the email open to Read the information).

 

Properties

Name Description Type Additional
Information
ID Int32
RefID Int32
OwnerID Int32
IPAddress String
UserAgent String
Browser String
Version String
IsMobile Boolean
MobileDeviceManufacturer String
MobileDeviceModel String
Latitude Decimal
Longitude Decimal
BrowserLanguage String
FullUserAgent String
Referrer String
Email String
TimeRead Decimal
ReadDate DateTime

 

Entity Statement

Creating a Read
Request
POST /ssv3/odata/Reads
Content-Type     
application/json
Request body
{
“ID”:”0″,”RefID”:”0″,”OwnerID”:”0″,”IPAddress”:”0.0.0.0″,”UserAgent”:”Example User Agent”,”Browser”:”Example Browser”,”Version”:”Example Version”,”IsMobile”:true,”MobileDeviceManufacturer”:”Example Manufacturer”,”MobileDeviceModel”:”Example Model”,”Latitude”:”0.00000″,”Longitude”:”0.00000″,”BrowserLanguage”:”Example Language”,”FullUserAgent”:”Example Full User Agent”,”Referrer”:”Example Referrer”,”Email”:”Example Email”,”TimeRead”:”0.00000”,
“ReadDate”:”2014-12-12T04:40:20.155Z”
}
Response body
{
“ID”:1,”RefID”:0,”OwnerID”:0,”IPAddress”:”0.0.0.0″,”UserAgent”:”Example User Agent”,”Browser”:”Example Browser”,”Version”:”Example Version”,”IsMobile”:true,”MobileDeviceManufacturer”:”Example Manufacturer”,”MobileDeviceModel”:”Example Model”,”Latitude”:0.00000,”Longitude”:0.00000,”BrowserLanguage”:”Example Language”,”FullUserAgent”:”Example Full User Agent”,”Referrer”:”Example Referrer”,”Email”:”Example Email”,”TimeRead”:0.00000,
“ReadDate”:”2014-12-12T04:40:20.155Z”
}
Deleting a Read
  Request
  DELETE /ssv3/odata/Reads(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a Read
  Request
  GET /ssv3/odata/Reads(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”RefID”:0,”OwnerID”:0,”IPAddress”:”0.0.0.0″,”UserAgent”:”Example User Agent”,”Browser”:”Example Browser”,”Version”:”Example Version”,”IsMobile”:true,”MobileDeviceManufacturer”:”Example Manufacturer”,”MobileDeviceModel”:”Example Model”,”Latitude”:0.00000,”Longitude”:0.00000,”BrowserLanguage”:”Example Language”,”FullUserAgent”:”Example Full User Agent”,”Referrer”:”Example Referrer”,”Email”:”Example Email”,”TimeRead”:0.00000,”
ReadDate”:”2014-12-12T04:40:20.155Z”
}
Updating a Read
  Request
  PUT /ssv3/odata/Reads(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”RefID”:”0″,”OwnerID”:”0″,”IPAddress”:”0.0.0.0″,”UserAgent”:”Example User Agent”,”Browser”:”Example Browser”,”Version”:”Example Version”,”IsMobile”:true,”MobileDeviceManufacturer”:”Example Manufacturer”,”MobileDeviceModel”:”Example Model”,”Latitude”:”0.00000″,”Longitude”:”0.00000″,”BrowserLanguage”:”Example Language”,”FullUserAgent”:”Example Full User Agent”,”Referrer”:”Example Referrer”,”Email”:”Example Email”,”TimeRead”:”0.00000”,
“ReadDate”:”2014-12-12T04:40:20.155Z”
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Reads
  Request
  GET /ssv3/odata/Reads
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”RefID”:0,”OwnerID”:0,”IPAddress”:0.0.0.0,”UserAgent”:”Example User Agent”,”Browser”:”Example Browser”,”Version”:”Example Version”,”IsMobile”:true,”MobileDeviceManufacturer”:”Example Manufacturer”,”MobileDeviceModel”:”Example Model”,”Latitude”:”0.00000″,”Longitude”:”0.00000″,”BrowserLanguage”:”Example Language”,”FullUserAgent”:”Example Full User Agent”,”Referrer”:”Example Referrer”,”Email”:”Example Email”,”TimeRead”:0.00000,
“ReadDate”:”2014-12-12T04:40:20.155Z”
},{
“ID”:1,”RefID”:0,”OwnerID”:0,”IPAddress”:”0.0.0.0″,”UserAgent”:”Example User Agent”,”Browser”:”Example Browser”,”Version”:”Example Version”,”IsMobile”:true,”MobileDeviceManufacturer”:”Example Manufacturer”,”MobileDeviceModel”:”Example Model”,”Latitude”:0.00000,”Longitude”:0.00000,”BrowserLanguage”:”Example Language”,”FullUserAgent”:”Example Full User Agent”,”Referrer”:”Example Referrer”,”Email”:”Example Email”,”TimeRead”:0.00000,
“ReadDate”:”2014-12-12T04:40:20.155Z”
}]