API / UserType

Entity Description:

UserType is the profile information about the User that is used in PoliteMail for sending tracked email and Metric information.

Properties

NameDescriptionTypeAdditional
Information
ID
Int32
Name
String

Entity Statement

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

Creating an UserType

Request

POST /api/odata/UserTypes

Content-Type 

application/json

Request body

{
“ID”:”0″,”Name”:”New User Type”
}

Response body

{
“ID”:1,”Name”:”New User Type”
}
Deleting an UserType
 Request
 DELETE /api/odata/UserTypes(1)
 Response Headers
 HTTP/1.1 204 No Content
Getting an UserType
 Request
 GET /api/odata/UserTypes(1)
 Content-Type 
 application/json
 Response body
 {
“ID”:1,”Name”:”New User Type”
}
Updating an UserType
 Request
 PUT /api/odata/UserTypes(1)
 Content-Type 
 application/json
 Request body
 {
“ID”:”0″,”Name”:”New User Type”
}
 Response Headers
 HTTP/1.1 204 No Content
Getting all UserTypes
 Request
 GET /api/odata/Lists
 Content-Type
 application/json
 Response body
 “value”:[{
“ID”:0,”Name”:”New User Type”
},{
“ID”:1,”Name”:”New User Type”
}]