User
Users
Get my details
Responses
200
successful operation
application/json
Class User
userIdintegerOptional
The ID of this User
userNamestringOptional
The user name
userTypeIdintegerOptional
The user type ID
loggedInintegerOptional
Flag indicating whether this user is logged in or not
emailstringOptional
Email address of the user used for email alerts
homePageIdintegerOptional
The pageId of the Homepage for this User
homeFolderIdintegerOptional
This users home folder
lastAccessedintegerOptional
A timestamp indicating the time the user last logged into the CMS
newUserWizardintegerOptional
A flag indicating whether this user has see the new user wizard
retiredintegerOptional
A flag indicating whether the user is retired
isPasswordChangeRequiredintegerOptional
A flag indicating whether password change should be forced for this user
groupIdintegerOptional
The users user group ID
groupintegerOptional
The users group name
libraryQuotaintegerOptional
The users library quota in bytes
firstNamestringOptional
First Name
lastNamestringOptional
Last Name
phonestringOptional
Phone Number
ref1stringOptional
Reference field 1
ref2stringOptional
Reference field 2
ref3stringOptional
Reference field 3
ref4stringOptional
Reference field 4
ref5stringOptional
Reference field 5
playlistsanyOptional
An array of Playlists owned by this User
isSystemNotificationintegerOptional
Does this User receive system notifications.
isDisplayNotificationintegerOptional
Does this User receive system notifications.
isDataSetNotificationintegerOptional
Does this User receive DataSet notifications.
isLayoutNotificationintegerOptional
Does this User receive Layout notifications.
isLibraryNotificationintegerOptional
Does this User receive Library notifications.
isReportNotificationintegerOptional
Does this User receive Report notifications.
isScheduleNotificationintegerOptional
Does this User receive Schedule notifications.
isCustomNotificationintegerOptional
Does this User receive Custom notifications.
twoFactorTypeIdintegerOptional
The two factor type id
twoFactorSecretstringOptional
Two Factor authorisation shared secret for this user
twoFactorRecoveryCodesstring[]Optional
Two Factor authorisation recovery codes
get/user/me
GET /api/user/me HTTP/1.1
Accept: */*
200
successful operation
{
"userId": 1,
"userName": "text",
"userTypeId": 1,
"loggedIn": 1,
"email": "text",
"homePageId": 1,
"homeFolderId": 1,
"lastAccessed": 1,
"newUserWizard": 1,
"retired": 1,
"isPasswordChangeRequired": 1,
"groupId": 1,
"group": 1,
"libraryQuota": 1,
"firstName": "text",
"lastName": "text",
"phone": "text",
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text",
"groups": [
{
"groupId": 1,
"group": "text",
"isUserSpecific": 1,
"isEveryone": 1,
"description": "text",
"libraryQuota": 1,
"isSystemNotification": 1,
"isDisplayNotification": 1,
"isDataSetNotification": 1,
"isLayoutNotification": 1,
"isLibraryNotification": 1,
"isReportNotification": 1,
"isScheduleNotification": 1,
"isCustomNotification": 1,
"isShownForAddUser": 1,
"defaultHomepageId": "text",
"features": [
"text"
]
}
],
"campaigns": [
{
"campaignId": 1,
"ownerId": 1,
"type": "text",
"campaign": "text",
"isLayoutSpecific": 1,
"numberLayouts": 1,
"totalDuration": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1,
"cyclePlaybackEnabled": 1,
"playCount": 1,
"listPlayOrder": "text",
"targetType": "text",
"target": 1,
"startDt": 1,
"endDt": 1,
"plays": 1,
"spend": 1,
"impressions": 1,
"lastPopId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"layouts": [
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}
],
"media": [
{
"mediaId": 1,
"ownerId": 1,
"parentId": 1,
"name": "text",
"mediaType": "text",
"storedAs": "text",
"fileName": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"fileSize": 1,
"duration": 1,
"valid": 1,
"moduleSystemFile": 1,
"expires": 1,
"retired": 1,
"isEdited": 1,
"md5": "text",
"owner": "text",
"groupsWithPermissions": "text",
"released": 1,
"apiRef": "text",
"createdDt": "text",
"modifiedDt": "text",
"enableStat": "text",
"orientation": "text",
"width": 1,
"height": 1,
"folderId": 1,
"permissionsFolderId": 1
}
],
"events": [
{
"eventId": 1,
"eventTypeId": 1,
"campaignId": 1,
"commandId": 1,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"scheduleReminders": [
{
"scheduleReminderId": 1,
"eventId": 1,
"value": 1,
"type": 1,
"option": 1,
"isEmail": 1,
"reminderDt": 1,
"lastReminderDt": 1
}
],
"criteria": [],
"userId": 1,
"fromDt": 1,
"toDt": 1,
"isPriority": 1,
"displayOrder": 1,
"recurrenceType": "None",
"recurrenceDetail": 1,
"recurrenceRange": 1,
"recurrenceRepeatsOn": "text",
"recurrenceMonthlyRepeatsOn": 1,
"campaign": "text",
"command": "text",
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1,
"syncEvent": 1,
"syncTimezone": 1,
"shareOfVoice": 1,
"maxPlaysPerHour": 1,
"isGeoAware": 1,
"geoLocation": "text",
"actionTriggerCode": "text",
"actionType": "text",
"actionLayoutCode": "text",
"parentCampaignId": 1,
"syncGroupId": 1,
"dataSetId": 1,
"dataSetParams": 1,
"modifiedBy": 1,
"createdOn": "text",
"updatedOn": "text",
"name": "text",
"resolutionId": 1,
"layoutDuration": 1,
"backgroundColor": "text"
}
],
"playlists": null,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"dayParts": [
{
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1
}
],
"isSystemNotification": 1,
"isDisplayNotification": 1,
"isDataSetNotification": 1,
"isLayoutNotification": 1,
"isLibraryNotification": 1,
"isReportNotification": 1,
"isScheduleNotification": 1,
"isCustomNotification": 1,
"twoFactorTypeId": 1,
"twoFactorSecret": "text",
"twoFactorRecoveryCodes": [
"text"
]
}Search users
Query parameters
userIdintegerOptional
Filter by User Id
userNamestringOptional
Filter by User Name
userTypeIdintegerOptional
Filter by UserType Id
retiredintegerOptional
Filter by Retired
sortBystring · enumOptionalPossible values:
Specifies which field the results are sorted by. Used together with sortDir
sortDirstring · enumOptionalPossible values:
Sort direction
Responses
200
successful operation
application/json
get/user
GET /api/user HTTP/1.1
Accept: */*
200
successful operation
[
{
"userId": 1,
"userName": "text",
"userTypeId": 1,
"loggedIn": 1,
"email": "text",
"homePageId": 1,
"homeFolderId": 1,
"lastAccessed": 1,
"newUserWizard": 1,
"retired": 1,
"isPasswordChangeRequired": 1,
"groupId": 1,
"group": 1,
"libraryQuota": 1,
"firstName": "text",
"lastName": "text",
"phone": "text",
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text",
"groups": [
{
"groupId": 1,
"group": "text",
"isUserSpecific": 1,
"isEveryone": 1,
"description": "text",
"libraryQuota": 1,
"isSystemNotification": 1,
"isDisplayNotification": 1,
"isDataSetNotification": 1,
"isLayoutNotification": 1,
"isLibraryNotification": 1,
"isReportNotification": 1,
"isScheduleNotification": 1,
"isCustomNotification": 1,
"isShownForAddUser": 1,
"defaultHomepageId": "text",
"features": [
"text"
]
}
],
"campaigns": [
{
"campaignId": 1,
"ownerId": 1,
"type": "text",
"campaign": "text",
"isLayoutSpecific": 1,
"numberLayouts": 1,
"totalDuration": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1,
"cyclePlaybackEnabled": 1,
"playCount": 1,
"listPlayOrder": "text",
"targetType": "text",
"target": 1,
"startDt": 1,
"endDt": 1,
"plays": 1,
"spend": 1,
"impressions": 1,
"lastPopId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"layouts": [
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}
],
"media": [
{
"mediaId": 1,
"ownerId": 1,
"parentId": 1,
"name": "text",
"mediaType": "text",
"storedAs": "text",
"fileName": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"fileSize": 1,
"duration": 1,
"valid": 1,
"moduleSystemFile": 1,
"expires": 1,
"retired": 1,
"isEdited": 1,
"md5": "text",
"owner": "text",
"groupsWithPermissions": "text",
"released": 1,
"apiRef": "text",
"createdDt": "text",
"modifiedDt": "text",
"enableStat": "text",
"orientation": "text",
"width": 1,
"height": 1,
"folderId": 1,
"permissionsFolderId": 1
}
],
"events": [
{
"eventId": 1,
"eventTypeId": 1,
"campaignId": 1,
"commandId": 1,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"scheduleReminders": [
{
"scheduleReminderId": 1,
"eventId": 1,
"value": 1,
"type": 1,
"option": 1,
"isEmail": 1,
"reminderDt": 1,
"lastReminderDt": 1
}
],
"criteria": [],
"userId": 1,
"fromDt": 1,
"toDt": 1,
"isPriority": 1,
"displayOrder": 1,
"recurrenceType": "None",
"recurrenceDetail": 1,
"recurrenceRange": 1,
"recurrenceRepeatsOn": "text",
"recurrenceMonthlyRepeatsOn": 1,
"campaign": "text",
"command": "text",
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1,
"syncEvent": 1,
"syncTimezone": 1,
"shareOfVoice": 1,
"maxPlaysPerHour": 1,
"isGeoAware": 1,
"geoLocation": "text",
"actionTriggerCode": "text",
"actionType": "text",
"actionLayoutCode": "text",
"parentCampaignId": 1,
"syncGroupId": 1,
"dataSetId": 1,
"dataSetParams": 1,
"modifiedBy": 1,
"createdOn": "text",
"updatedOn": "text",
"name": "text",
"resolutionId": 1,
"layoutDuration": 1,
"backgroundColor": "text"
}
],
"playlists": null,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"dayParts": [
{
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1
}
],
"isSystemNotification": 1,
"isDisplayNotification": 1,
"isDataSetNotification": 1,
"isLayoutNotification": 1,
"isLibraryNotification": 1,
"isReportNotification": 1,
"isScheduleNotification": 1,
"isCustomNotification": 1,
"twoFactorTypeId": 1,
"twoFactorSecret": "text",
"twoFactorRecoveryCodes": [
"text"
]
}
]Add a new User
Body
userNamestringRequired
The User Name
emailstringOptional
The user email address
userTypeIdintegerRequired
The user type ID
homePageIdstring · enumRequiredPossible values:
The homepage to use for this User
libraryQuotaintegerOptional
The users library quota in kilobytes
passwordstringRequired
The users password
groupIdintegerRequired
The inital user group for this User
firstNamestringOptional
The users first name
lastNamestringOptional
The users last name
phonestringOptional
The users phone number
ref1stringOptional
Reference 1
ref2stringOptional
Reference 2
ref3stringOptional
Reference 3
ref4stringOptional
Reference 4
ref5stringOptional
Reference 5
newUserWizardintegerRequired
Flag indicating whether to show the new user guide
hideNavigationintegerRequired
Flag indicating whether to hide the navigation
isPasswordChangeRequiredintegerOptional
A flag indicating whether password change should be forced for this user
Responses
201
successful operation
application/json
post/user
POST /api/user HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 320
"userName='text'&email='text'&userTypeId=1&homePageId='statusdashboard.view'&libraryQuota=1&password='text'&groupId=1&firstName='text'&lastName='text'&phone='text'&ref1='text'&ref2='text'&ref3='text'&ref4='text'&ref5='text'&newUserWizard=1&hideNavigation=1&isPasswordChangeRequired=1"201
successful operation
{
"userId": 1,
"userName": "text",
"userTypeId": 1,
"loggedIn": 1,
"email": "text",
"homePageId": 1,
"homeFolderId": 1,
"lastAccessed": 1,
"newUserWizard": 1,
"retired": 1,
"isPasswordChangeRequired": 1,
"groupId": 1,
"group": 1,
"libraryQuota": 1,
"firstName": "text",
"lastName": "text",
"phone": "text",
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text",
"groups": [
{
"groupId": 1,
"group": "text",
"isUserSpecific": 1,
"isEveryone": 1,
"description": "text",
"libraryQuota": 1,
"isSystemNotification": 1,
"isDisplayNotification": 1,
"isDataSetNotification": 1,
"isLayoutNotification": 1,
"isLibraryNotification": 1,
"isReportNotification": 1,
"isScheduleNotification": 1,
"isCustomNotification": 1,
"isShownForAddUser": 1,
"defaultHomepageId": "text",
"features": [
"text"
]
}
],
"campaigns": [
{
"campaignId": 1,
"ownerId": 1,
"type": "text",
"campaign": "text",
"isLayoutSpecific": 1,
"numberLayouts": 1,
"totalDuration": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1,
"cyclePlaybackEnabled": 1,
"playCount": 1,
"listPlayOrder": "text",
"targetType": "text",
"target": 1,
"startDt": 1,
"endDt": 1,
"plays": 1,
"spend": 1,
"impressions": 1,
"lastPopId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"layouts": [
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}
],
"media": [
{
"mediaId": 1,
"ownerId": 1,
"parentId": 1,
"name": "text",
"mediaType": "text",
"storedAs": "text",
"fileName": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"fileSize": 1,
"duration": 1,
"valid": 1,
"moduleSystemFile": 1,
"expires": 1,
"retired": 1,
"isEdited": 1,
"md5": "text",
"owner": "text",
"groupsWithPermissions": "text",
"released": 1,
"apiRef": "text",
"createdDt": "text",
"modifiedDt": "text",
"enableStat": "text",
"orientation": "text",
"width": 1,
"height": 1,
"folderId": 1,
"permissionsFolderId": 1
}
],
"events": [
{
"eventId": 1,
"eventTypeId": 1,
"campaignId": 1,
"commandId": 1,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"scheduleReminders": [
{
"scheduleReminderId": 1,
"eventId": 1,
"value": 1,
"type": 1,
"option": 1,
"isEmail": 1,
"reminderDt": 1,
"lastReminderDt": 1
}
],
"criteria": [],
"userId": 1,
"fromDt": 1,
"toDt": 1,
"isPriority": 1,
"displayOrder": 1,
"recurrenceType": "None",
"recurrenceDetail": 1,
"recurrenceRange": 1,
"recurrenceRepeatsOn": "text",
"recurrenceMonthlyRepeatsOn": 1,
"campaign": "text",
"command": "text",
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1,
"syncEvent": 1,
"syncTimezone": 1,
"shareOfVoice": 1,
"maxPlaysPerHour": 1,
"isGeoAware": 1,
"geoLocation": "text",
"actionTriggerCode": "text",
"actionType": "text",
"actionLayoutCode": "text",
"parentCampaignId": 1,
"syncGroupId": 1,
"dataSetId": 1,
"dataSetParams": 1,
"modifiedBy": 1,
"createdOn": "text",
"updatedOn": "text",
"name": "text",
"resolutionId": 1,
"layoutDuration": 1,
"backgroundColor": "text"
}
],
"playlists": null,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"dayParts": [
{
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1
}
],
"isSystemNotification": 1,
"isDisplayNotification": 1,
"isDataSetNotification": 1,
"isLayoutNotification": 1,
"isLibraryNotification": 1,
"isReportNotification": 1,
"isScheduleNotification": 1,
"isCustomNotification": 1,
"twoFactorTypeId": 1,
"twoFactorSecret": "text",
"twoFactorRecoveryCodes": [
"text"
]
}Get the User object specified by the provided userId
Path parameters
userIdintegerRequired
Numeric ID of the User to get
Responses
200
successful operation
application/json
Class User
userIdintegerOptional
The ID of this User
userNamestringOptional
The user name
userTypeIdintegerOptional
The user type ID
loggedInintegerOptional
Flag indicating whether this user is logged in or not
emailstringOptional
Email address of the user used for email alerts
homePageIdintegerOptional
The pageId of the Homepage for this User
homeFolderIdintegerOptional
This users home folder
lastAccessedintegerOptional
A timestamp indicating the time the user last logged into the CMS
newUserWizardintegerOptional
A flag indicating whether this user has see the new user wizard
retiredintegerOptional
A flag indicating whether the user is retired
isPasswordChangeRequiredintegerOptional
A flag indicating whether password change should be forced for this user
groupIdintegerOptional
The users user group ID
groupintegerOptional
The users group name
libraryQuotaintegerOptional
The users library quota in bytes
firstNamestringOptional
First Name
lastNamestringOptional
Last Name
phonestringOptional
Phone Number
ref1stringOptional
Reference field 1
ref2stringOptional
Reference field 2
ref3stringOptional
Reference field 3
ref4stringOptional
Reference field 4
ref5stringOptional
Reference field 5
playlistsanyOptional
An array of Playlists owned by this User
isSystemNotificationintegerOptional
Does this User receive system notifications.
isDisplayNotificationintegerOptional
Does this User receive system notifications.
isDataSetNotificationintegerOptional
Does this User receive DataSet notifications.
isLayoutNotificationintegerOptional
Does this User receive Layout notifications.
isLibraryNotificationintegerOptional
Does this User receive Library notifications.
isReportNotificationintegerOptional
Does this User receive Report notifications.
isScheduleNotificationintegerOptional
Does this User receive Schedule notifications.
isCustomNotificationintegerOptional
Does this User receive Custom notifications.
twoFactorTypeIdintegerOptional
The two factor type id
twoFactorSecretstringOptional
Two Factor authorisation shared secret for this user
twoFactorRecoveryCodesstring[]Optional
Two Factor authorisation recovery codes
get/user/{userId}
GET /api/user/{userId} HTTP/1.1
Accept: */*
200
successful operation
{
"userId": 1,
"userName": "text",
"userTypeId": 1,
"loggedIn": 1,
"email": "text",
"homePageId": 1,
"homeFolderId": 1,
"lastAccessed": 1,
"newUserWizard": 1,
"retired": 1,
"isPasswordChangeRequired": 1,
"groupId": 1,
"group": 1,
"libraryQuota": 1,
"firstName": "text",
"lastName": "text",
"phone": "text",
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text",
"groups": [
{
"groupId": 1,
"group": "text",
"isUserSpecific": 1,
"isEveryone": 1,
"description": "text",
"libraryQuota": 1,
"isSystemNotification": 1,
"isDisplayNotification": 1,
"isDataSetNotification": 1,
"isLayoutNotification": 1,
"isLibraryNotification": 1,
"isReportNotification": 1,
"isScheduleNotification": 1,
"isCustomNotification": 1,
"isShownForAddUser": 1,
"defaultHomepageId": "text",
"features": [
"text"
]
}
],
"campaigns": [
{
"campaignId": 1,
"ownerId": 1,
"type": "text",
"campaign": "text",
"isLayoutSpecific": 1,
"numberLayouts": 1,
"totalDuration": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1,
"cyclePlaybackEnabled": 1,
"playCount": 1,
"listPlayOrder": "text",
"targetType": "text",
"target": 1,
"startDt": 1,
"endDt": 1,
"plays": 1,
"spend": 1,
"impressions": 1,
"lastPopId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"layouts": [
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}
],
"media": [
{
"mediaId": 1,
"ownerId": 1,
"parentId": 1,
"name": "text",
"mediaType": "text",
"storedAs": "text",
"fileName": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"fileSize": 1,
"duration": 1,
"valid": 1,
"moduleSystemFile": 1,
"expires": 1,
"retired": 1,
"isEdited": 1,
"md5": "text",
"owner": "text",
"groupsWithPermissions": "text",
"released": 1,
"apiRef": "text",
"createdDt": "text",
"modifiedDt": "text",
"enableStat": "text",
"orientation": "text",
"width": 1,
"height": 1,
"folderId": 1,
"permissionsFolderId": 1
}
],
"events": [
{
"eventId": 1,
"eventTypeId": 1,
"campaignId": 1,
"commandId": 1,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"scheduleReminders": [
{
"scheduleReminderId": 1,
"eventId": 1,
"value": 1,
"type": 1,
"option": 1,
"isEmail": 1,
"reminderDt": 1,
"lastReminderDt": 1
}
],
"criteria": [],
"userId": 1,
"fromDt": 1,
"toDt": 1,
"isPriority": 1,
"displayOrder": 1,
"recurrenceType": "None",
"recurrenceDetail": 1,
"recurrenceRange": 1,
"recurrenceRepeatsOn": "text",
"recurrenceMonthlyRepeatsOn": 1,
"campaign": "text",
"command": "text",
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1,
"syncEvent": 1,
"syncTimezone": 1,
"shareOfVoice": 1,
"maxPlaysPerHour": 1,
"isGeoAware": 1,
"geoLocation": "text",
"actionTriggerCode": "text",
"actionType": "text",
"actionLayoutCode": "text",
"parentCampaignId": 1,
"syncGroupId": 1,
"dataSetId": 1,
"dataSetParams": 1,
"modifiedBy": 1,
"createdOn": "text",
"updatedOn": "text",
"name": "text",
"resolutionId": 1,
"layoutDuration": 1,
"backgroundColor": "text"
}
],
"playlists": null,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"dayParts": [
{
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1
}
],
"isSystemNotification": 1,
"isDisplayNotification": 1,
"isDataSetNotification": 1,
"isLayoutNotification": 1,
"isLibraryNotification": 1,
"isReportNotification": 1,
"isScheduleNotification": 1,
"isCustomNotification": 1,
"twoFactorTypeId": 1,
"twoFactorSecret": "text",
"twoFactorRecoveryCodes": [
"text"
]
}Edit existing User
Path parameters
userIdintegerRequired
The user ID to edit
Body
userNamestringRequired
The User Name
emailstringOptional
The user email address
userTypeIdintegerRequired
The user type ID
homePageIdstring · enumRequiredPossible values:
The homepage to use for this User
libraryQuotaintegerOptional
The users library quota in kilobytes
newPasswordstringOptional
New User password
retypeNewPasswordstringOptional
Repeat the new User password
retiredintegerOptional
Flag indicating whether to retire this user
firstNamestringOptional
The users first name
lastNamestringOptional
The users last name
phonestringOptional
The users phone number
ref1stringOptional
Reference 1
ref2stringOptional
Reference 2
ref3stringOptional
Reference 3
ref4stringOptional
Reference 4
ref5stringOptional
Reference 5
newUserWizardintegerRequired
Flag indicating whether to show the new user guide
hideNavigationintegerRequired
Flag indicating whether to hide the navigation
isPasswordChangeRequiredintegerOptional
A flag indicating whether password change should be forced for this user
Responses
201
successful operation
application/json
put/user/{userId}
PUT /api/user/{userId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 350
"userName='text'&email='text'&userTypeId=1&homePageId='statusdashboard.view'&libraryQuota=1&newPassword='text'&retypeNewPassword='text'&retired=1&firstName='text'&lastName='text'&phone='text'&ref1='text'&ref2='text'&ref3='text'&ref4='text'&ref5='text'&newUserWizard=1&hideNavigation=1&isPasswordChangeRequired=1"201
successful operation
{
"userId": 1,
"userName": "text",
"userTypeId": 1,
"loggedIn": 1,
"email": "text",
"homePageId": 1,
"homeFolderId": 1,
"lastAccessed": 1,
"newUserWizard": 1,
"retired": 1,
"isPasswordChangeRequired": 1,
"groupId": 1,
"group": 1,
"libraryQuota": 1,
"firstName": "text",
"lastName": "text",
"phone": "text",
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text",
"groups": [
{
"groupId": 1,
"group": "text",
"isUserSpecific": 1,
"isEveryone": 1,
"description": "text",
"libraryQuota": 1,
"isSystemNotification": 1,
"isDisplayNotification": 1,
"isDataSetNotification": 1,
"isLayoutNotification": 1,
"isLibraryNotification": 1,
"isReportNotification": 1,
"isScheduleNotification": 1,
"isCustomNotification": 1,
"isShownForAddUser": 1,
"defaultHomepageId": "text",
"features": [
"text"
]
}
],
"campaigns": [
{
"campaignId": 1,
"ownerId": 1,
"type": "text",
"campaign": "text",
"isLayoutSpecific": 1,
"numberLayouts": 1,
"totalDuration": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1,
"cyclePlaybackEnabled": 1,
"playCount": 1,
"listPlayOrder": "text",
"targetType": "text",
"target": 1,
"startDt": 1,
"endDt": 1,
"plays": 1,
"spend": 1,
"impressions": 1,
"lastPopId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"layouts": [
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}
],
"media": [
{
"mediaId": 1,
"ownerId": 1,
"parentId": 1,
"name": "text",
"mediaType": "text",
"storedAs": "text",
"fileName": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"fileSize": 1,
"duration": 1,
"valid": 1,
"moduleSystemFile": 1,
"expires": 1,
"retired": 1,
"isEdited": 1,
"md5": "text",
"owner": "text",
"groupsWithPermissions": "text",
"released": 1,
"apiRef": "text",
"createdDt": "text",
"modifiedDt": "text",
"enableStat": "text",
"orientation": "text",
"width": 1,
"height": 1,
"folderId": 1,
"permissionsFolderId": 1
}
],
"events": [
{
"eventId": 1,
"eventTypeId": 1,
"campaignId": 1,
"commandId": 1,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"scheduleReminders": [
{
"scheduleReminderId": 1,
"eventId": 1,
"value": 1,
"type": 1,
"option": 1,
"isEmail": 1,
"reminderDt": 1,
"lastReminderDt": 1
}
],
"criteria": [],
"userId": 1,
"fromDt": 1,
"toDt": 1,
"isPriority": 1,
"displayOrder": 1,
"recurrenceType": "None",
"recurrenceDetail": 1,
"recurrenceRange": 1,
"recurrenceRepeatsOn": "text",
"recurrenceMonthlyRepeatsOn": 1,
"campaign": "text",
"command": "text",
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1,
"syncEvent": 1,
"syncTimezone": 1,
"shareOfVoice": 1,
"maxPlaysPerHour": 1,
"isGeoAware": 1,
"geoLocation": "text",
"actionTriggerCode": "text",
"actionType": "text",
"actionLayoutCode": "text",
"parentCampaignId": 1,
"syncGroupId": 1,
"dataSetId": 1,
"dataSetParams": 1,
"modifiedBy": 1,
"createdOn": "text",
"updatedOn": "text",
"name": "text",
"resolutionId": 1,
"layoutDuration": 1,
"backgroundColor": "text"
}
],
"playlists": null,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"dayParts": [
{
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1
}
],
"isSystemNotification": 1,
"isDisplayNotification": 1,
"isDataSetNotification": 1,
"isLayoutNotification": 1,
"isLibraryNotification": 1,
"isReportNotification": 1,
"isScheduleNotification": 1,
"isCustomNotification": 1,
"twoFactorTypeId": 1,
"twoFactorSecret": "text",
"twoFactorRecoveryCodes": [
"text"
]
}Delete user
Path parameters
userIdintegerRequired
Id of the user to delete
Query parameters
deleteAllItemsintegerOptional
Flag indicating whether to delete all items owned by that user
reassignUserIdintegerOptional
Reassign all items owned by this user to the specified user ID
Responses
204
successful operation
application/json
Class User
userIdintegerOptional
The ID of this User
userNamestringOptional
The user name
userTypeIdintegerOptional
The user type ID
loggedInintegerOptional
Flag indicating whether this user is logged in or not
emailstringOptional
Email address of the user used for email alerts
homePageIdintegerOptional
The pageId of the Homepage for this User
homeFolderIdintegerOptional
This users home folder
lastAccessedintegerOptional
A timestamp indicating the time the user last logged into the CMS
newUserWizardintegerOptional
A flag indicating whether this user has see the new user wizard
retiredintegerOptional
A flag indicating whether the user is retired
isPasswordChangeRequiredintegerOptional
A flag indicating whether password change should be forced for this user
groupIdintegerOptional
The users user group ID
groupintegerOptional
The users group name
libraryQuotaintegerOptional
The users library quota in bytes
firstNamestringOptional
First Name
lastNamestringOptional
Last Name
phonestringOptional
Phone Number
ref1stringOptional
Reference field 1
ref2stringOptional
Reference field 2
ref3stringOptional
Reference field 3
ref4stringOptional
Reference field 4
ref5stringOptional
Reference field 5
playlistsanyOptional
An array of Playlists owned by this User
isSystemNotificationintegerOptional
Does this User receive system notifications.
isDisplayNotificationintegerOptional
Does this User receive system notifications.
isDataSetNotificationintegerOptional
Does this User receive DataSet notifications.
isLayoutNotificationintegerOptional
Does this User receive Layout notifications.
isLibraryNotificationintegerOptional
Does this User receive Library notifications.
isReportNotificationintegerOptional
Does this User receive Report notifications.
isScheduleNotificationintegerOptional
Does this User receive Schedule notifications.
isCustomNotificationintegerOptional
Does this User receive Custom notifications.
twoFactorTypeIdintegerOptional
The two factor type id
twoFactorSecretstringOptional
Two Factor authorisation shared secret for this user
twoFactorRecoveryCodesstring[]Optional
Two Factor authorisation recovery codes
delete/user/{userId}
DELETE /api/user/{userId} HTTP/1.1
Accept: */*
204
successful operation
[
{
"userId": 1,
"userName": "text",
"userTypeId": 1,
"loggedIn": 1,
"email": "text",
"homePageId": 1,
"homeFolderId": 1,
"lastAccessed": 1,
"newUserWizard": 1,
"retired": 1,
"isPasswordChangeRequired": 1,
"groupId": 1,
"group": 1,
"libraryQuota": 1,
"firstName": "text",
"lastName": "text",
"phone": "text",
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text",
"groups": [
{
"groupId": 1,
"group": "text",
"isUserSpecific": 1,
"isEveryone": 1,
"description": "text",
"libraryQuota": 1,
"isSystemNotification": 1,
"isDisplayNotification": 1,
"isDataSetNotification": 1,
"isLayoutNotification": 1,
"isLibraryNotification": 1,
"isReportNotification": 1,
"isScheduleNotification": 1,
"isCustomNotification": 1,
"isShownForAddUser": 1,
"defaultHomepageId": "text",
"features": [
"text"
]
}
],
"campaigns": [
{
"campaignId": 1,
"ownerId": 1,
"type": "text",
"campaign": "text",
"isLayoutSpecific": 1,
"numberLayouts": 1,
"totalDuration": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1,
"cyclePlaybackEnabled": 1,
"playCount": 1,
"listPlayOrder": "text",
"targetType": "text",
"target": 1,
"startDt": 1,
"endDt": 1,
"plays": 1,
"spend": 1,
"impressions": 1,
"lastPopId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"layouts": [
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}
],
"media": [
{
"mediaId": 1,
"ownerId": 1,
"parentId": 1,
"name": "text",
"mediaType": "text",
"storedAs": "text",
"fileName": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"fileSize": 1,
"duration": 1,
"valid": 1,
"moduleSystemFile": 1,
"expires": 1,
"retired": 1,
"isEdited": 1,
"md5": "text",
"owner": "text",
"groupsWithPermissions": "text",
"released": 1,
"apiRef": "text",
"createdDt": "text",
"modifiedDt": "text",
"enableStat": "text",
"orientation": "text",
"width": 1,
"height": 1,
"folderId": 1,
"permissionsFolderId": 1
}
],
"events": [
{
"eventId": 1,
"eventTypeId": 1,
"campaignId": 1,
"commandId": 1,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"scheduleReminders": [
{
"scheduleReminderId": 1,
"eventId": 1,
"value": 1,
"type": 1,
"option": 1,
"isEmail": 1,
"reminderDt": 1,
"lastReminderDt": 1
}
],
"criteria": [],
"userId": 1,
"fromDt": 1,
"toDt": 1,
"isPriority": 1,
"displayOrder": 1,
"recurrenceType": "None",
"recurrenceDetail": 1,
"recurrenceRange": 1,
"recurrenceRepeatsOn": "text",
"recurrenceMonthlyRepeatsOn": 1,
"campaign": "text",
"command": "text",
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1,
"syncEvent": 1,
"syncTimezone": 1,
"shareOfVoice": 1,
"maxPlaysPerHour": 1,
"isGeoAware": 1,
"geoLocation": "text",
"actionTriggerCode": "text",
"actionType": "text",
"actionLayoutCode": "text",
"parentCampaignId": 1,
"syncGroupId": 1,
"dataSetId": 1,
"dataSetParams": 1,
"modifiedBy": 1,
"createdOn": "text",
"updatedOn": "text",
"name": "text",
"resolutionId": 1,
"layoutDuration": 1,
"backgroundColor": "text"
}
],
"playlists": null,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"dayParts": [
{
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1
}
],
"isSystemNotification": 1,
"isDisplayNotification": 1,
"isDataSetNotification": 1,
"isLayoutNotification": 1,
"isLibraryNotification": 1,
"isReportNotification": 1,
"isScheduleNotification": 1,
"isCustomNotification": 1,
"twoFactorTypeId": 1,
"twoFactorSecret": "text",
"twoFactorRecoveryCodes": [
"text"
]
}
]Permission data for the Entity and Object Provided.
Path parameters
entitystringRequired
The Entity
objectIdintegerRequired
The ID of the Object to return permissions for
Responses
200
successful operation
application/json
Class Permission
permissionIdintegerOptional
The ID of this Permission Record
entityIdintegerOptional
The Entity ID that this Permission refers to
groupIdintegerOptional
The User Group ID that this permission refers to
objectIdintegerOptional
The object ID that this permission refers to
isUserintegerOptional
A flag indicating whether the groupId refers to a user specific group
entitystringOptional
The entity name that this refers to
objectIdStringstringOptional
Legacy for when the Object ID is a string
groupstringOptional
The group name that this refers to
viewintegerOptional
A flag indicating whether view permission is granted
editintegerOptional
A flag indicating whether edit permission is granted
deleteintegerOptional
A flag indicating whether delete permission is granted
modifyPermissionsintegerOptional
A flag indicating whether modify permission permission is granted.
get/user/permissions/{entity}/{objectId}
GET /api/user/permissions/{entity}/{objectId} HTTP/1.1
Accept: */*
200
successful operation
[
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
]Set Permissions to users/groups for the provided entity.
Path parameters
entitystringRequired
The Entity
objectIdintegerRequired
The ID of the Object to set permissions on
Query parameters
groupIdsstring[]Required
Array of permissions with groupId as the key
ownerIdintegerOptional
Change the owner of this item. Leave empty to keep the current owner
Responses
204
successful operation
No content
post/user/permissions/{entity}/{objectId}
POST /api/user/permissions/{entity}/{objectId}?groupIds=text HTTP/1.1
Accept: */*
204
successful operation
No content
Permission data for the multiple Entities and Objects Provided.
Path parameters
entitystringRequired
The Entity
Query parameters
idsstringRequired
The IDs of the Objects to return permissions for
Responses
200
successful operation
application/json
Class Permission
permissionIdintegerOptional
The ID of this Permission Record
entityIdintegerOptional
The Entity ID that this Permission refers to
groupIdintegerOptional
The User Group ID that this permission refers to
objectIdintegerOptional
The object ID that this permission refers to
isUserintegerOptional
A flag indicating whether the groupId refers to a user specific group
entitystringOptional
The entity name that this refers to
objectIdStringstringOptional
Legacy for when the Object ID is a string
groupstringOptional
The group name that this refers to
viewintegerOptional
A flag indicating whether view permission is granted
editintegerOptional
A flag indicating whether edit permission is granted
deleteintegerOptional
A flag indicating whether delete permission is granted
modifyPermissionsintegerOptional
A flag indicating whether modify permission permission is granted.
get/user/permissions/{entity}
GET /api/user/permissions/{entity}?ids=text HTTP/1.1
Accept: */*
200
successful operation
[
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
]Set Permissions to users/groups for multiple provided entities.
Path parameters
entitystringRequired
The Entity type
Query parameters
idsintegerRequired
Array of object IDs
groupIdsstring[]Required
Array of permissions with groupId as the key
ownerIdintegerOptional
Change the owner of this item. Leave empty to keep the current owner
Responses
204
successful operation
No content
post/user/permissions/{entity}/multiple
POST /api/user/permissions/{entity}/multiple?ids=1&groupIds=text HTTP/1.1
Accept: */*
204
successful operation
No content
User preferences for non-state information, such as Layout designer zoom levels
Query parameters
preferencestringOptional
An optional preference
Responses
200
successful response
application/json
Class UserOption
userIdintegerOptional
The userId that this Option applies to
optionstringOptional
The option name
valuestringOptional
The option value
get/user/pref
GET /api/user/pref HTTP/1.1
Accept: */*
200
successful response
[
{
"userId": 1,
"option": "text",
"value": "text"
}
]Save User preferences for non-state information, such as Layout designer zoom levels
Body
Responses
204
successful operation
No content
post/user/pref
POST /api/user/pref HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 60
{
"preference": [
{
"userId": 1,
"option": "text",
"value": "text"
}
]
}204
successful operation
No content
Save User preferences from the Preferences form.
Body
navigationMenuPositionstringRequired
useLibraryDurationintegerOptional
showThumbnailColumnintegerOptional
rememberFolderTreeStateGloballyintegerOptional
Responses
204
successful operation
No content
put/user/pref
PUT /api/user/pref HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 116
"navigationMenuPosition='text'&useLibraryDuration=1&showThumbnailColumn=1&rememberFolderTreeStateGlobally=1"204
successful operation
No content
Last updated
Was this helpful?