Entity Description:
UserProfile is the profile information about the User that is used in PoliteMail for sending tracked email and Metric information.
PoliteMail also defines the User a Role in the system and level of access and sharing the user has within the system (e.g. Last Login, UserType, Business unit, etc…). There are three User types: Administration, Manager, and User.
Properties
| Name | Description | Type | Additional Information |
| ID | Int32 | ||
| ActiveState | Boolean | ||
| FirstName | String | ||
| MiddleName | String | ||
| LastName | String | ||
| Title | String | ||
| ShowTag | Boolean | ||
| CreationDate | DateTime | ||
| Prefix | String | ||
| Suffix | String | ||
| RequirePasswordReset | Boolean | ||
| Phone | String | ||
| Cell | String | ||
| Fax | String | ||
| LastLogin | DateTime | ||
| UserType | Int16 | ||
| BusinessID | Int32 | ||
| RegionID | Int32 |
Entity Statement
if you are using versions earlier than 5.0, substitute "ssv3" for "api" for each Request listed below.
| Creating an UserProfile | |
| Request | |
| POST /api/odata/UserProfiles | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","ActiveState":true,"FirstName":"Example First Name", "MiddleName":"Example Middle Name","LastName": "Example Last Name","Title":"Example Title","ShowTag":false, "CreationDate":"2014-12-10T12:00:00.000Z","Prefix": "Example Prefix","Suffix":"Example Suffix","RequirePasswordReset" :false,"Phone":"(000) 000-0000","Cell":"(000) 000-0000", "Fax":"(000) 000-0000","LastLogin":"2014-12-12T01:00:00.000Z","UserType":"0","BusinessID":"0","RegionID":"0" } | |
| Response body | |
| { "ID":1,"ActiveState":true,"FirstName":"Example First Name", "MiddleName":"Example Middle Name","LastName": "Example Last Name","Title":"Example Title","ShowTag":false, "CreationDate":"2014-12-17T12:25:00.000Z","Prefix": "Example Prefix","Suffix":"Example Suffix","RequirePasswordReset": false,"Phone":(000) 000-0000,Cell":"(000) 000-0000, "Fax":(000) 000-0000,"LastLogin":"2014-12-22T13:01:00.155Z","UserType":0,"BusinessID":0,"RegionID":0 } | |
| Deleting an UserProfile | |
| Request | |
| DELETE /api/odata/UserProfiles(1) | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting an UserProfile | |
| Request | |
| GET /api/odata/UserProfiles(1) | |
| Content-Type | |
| application/json | |
| Response body | |
| { "ID":1,"ActiveState":true,"FirstName":"Example First Name", "MiddleName":"Example Middle Name","LastName": "Example Last Name","Title":"Example Title", "ShowTag":false,"CreationDate":"2014-12-17T12:25:00.000Z", "Prefix":"Example Prefix","Suffix":"Example Suffix", "RequirePasswordReset":false,"Phone":(000) 000-0000,Cell":"(000) 000-0000, "Fax":(000) 000-0000,"LastLogin":"2014-12-22T13:01:00.155Z","UserType":0,"BusinessID":0,"RegionID":0 } | |
| Updating an UserProfile | |
| Request | |
| PUT /api/odata/UserProfiles(1) | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","ActiveState":true,"FirstName":"Example First Name", "MiddleName":"Example Middle Name","LastName": "Example Last Name","Title":"Example Title","ShowTag":false, "CreationDate":"2014-12-10T12:00:00.000Z","Prefix": "Example Prefix","Suffix":"Example Suffix", "RequirePasswordReset":false,"Phone":"(000) 000-0000", "Cell":"(000) 000-0000","Fax":"(000) 000-0000" ,"LastLogin":"2014-12-12T01:00:00.000Z","UserType":"0", "BusinessID":"0","RegionID":"0" } | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting all UserProfiles | |
| Request | |
| GET /api/odata/UserProfiles | |
| Content-Type | |
| application/json | |
| Response body | |
| "value":[{ "ID":"0","ActiveState":true,"FirstName":"Example First Name", "MiddleName":"Example Middle Name","LastName": "Example Last Name","Title":"Example Title","ShowTag":false, "CreationDate":"2014-12-10T12:00:00.000Z","Prefix": "Example Prefix","Suffix":"Example Suffix", "RequirePasswordReset":false,"Phone":"(000) 000-0000", "Cell":"(000) 000-0000","Fax":"(000) 000-0000","LastLogin":"2014-12-12T01:00:00.000Z","UserType":"0","BusinessID":"0","RegionID":"0" },{ "ID":1,"ActiveState":true,"FirstName":"Example First Name", "MiddleName":"Example Middle Name","LastName": "Example Last Name","Title":"Example Title","ShowTag": false,"CreationDate":"2014-12-17T12:25:00.000Z","Prefix": "Example Prefix","Suffix":"Example Suffix","RequirePasswordReset": false,"Phone":(000) 000-0000,Cell":"(000) 000-0000, "Fax":(000) 000-0000,"LastLogin":"2014-12-22T13:01:00.155Z","UserType":0,"BusinessID":0,"RegionID":0 }] | |
