Version 8.3.8
Back |
WsAccountPreference
Returns preference with their values for a given account
URL Format
/ws/ws_account_preference/api/{app_token}/mode/json/apiv/5?name={name}
Parameters
| Name | Req | Type | Description |
|---|---|---|---|
| app_token |  |
string | The api token for the given account. You can find the api token when navigating through account->api accounts |
| apiv | |
integer | The api version; only version 5 supported. |
| name | string | filter for name of the preference. Asterisk could be used for partial search. | |
| title | string | filter for title of the preference. Asterisk could be used for partial search. | |
| sortby | string | The column to sort by. Can be {name,title} |
Request Headers
| Name |
|---|
Possible Responses
- 319 Preferences Found
- 101 Invalid client token.
- 102 Invalid app token.
- 659 Invalid Client
- 659 Preferences not found
- 1041 Invalid sort params
Example Response
{
"response": {
"success": {
"code": 319,
"message": "Preferences Found",
"details": ""
},
"WsAccountPreferenceResponse": {
"preference": [
{
"id": 1,
"title": "New Programs added to:",
"displayGroupID": 1,
"description": "Prepend programs to beginning of list, or append programs to the end of the list.",
"name": "program_in",
"uiType": "radio",
"options": "{\"0\": \"Top\",\"-1\": \"Bottom\"}",
"isRequired": 0,
"preferencevalue": "0"
},
{
"id": 3,
"title": "Media Bin sort:",
"displayGroupID": 1,
"description": "Default sort column for a clients Media Bin",
"name": "mb_sort",
"uiType": "select",
"options": "{\"name asc\": \"By Title Ascending\", \n\"name desc\": \"By Title Descending\", \"dateModified asc\": \"By Date Modified Ascending\",\n\"dateModified desc\": \"By Date Modified Descending\"}",
"isRequired": 0,
"preferencevalue": "dateModified desc"
},
{
"id": 2,
"title": "Bypass transcoding checked",
"displayGroupID": 3,
"description": "Bypass transcoding for compatible files when added",
"name": "bypass_tc",
"uiType": "radio",
"options": "{\"0\": \"Off\", \"1\":\"On\"}",
"isRequired": 0,
"preferencevalue": "0"
},
{
"id": 7,
"title": "Default Asset and Program Timezone",
"displayGroupID": 0,
"description": "Default Asset and Program Timezone",
"name": "programTimezone",
"uiType": "select",
"options": "",
"isRequired": 0,
"preferencevalue": "America\/New_York"
},
{
"id": 8,
"title": "Publish Program by default",
"displayGroupID": 0,
"description": "Enable\/Diable publishing program by default",
"name": "publishProgram",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 11,
"title": "Default Audio Transcoding Profile",
"displayGroupID": 3,
"description": "Default Audio Transcoding Profile",
"name": "defaultAudioProfile",
"uiType": "select",
"isRequired": 0,
"preferencevalue": "621"
},
{
"id": 10,
"title": "Default Video Transcoding Profile",
"displayGroupID": 3,
"description": "Default Video Transcoding Profile",
"name": "defaultVideoProfile",
"uiType": "select",
"isRequired": 0,
"preferencevalue": "563"
},
{
"id": 9,
"title": "Show Transcoding Profile to child accounts",
"displayGroupID": 3,
"description": "Show Transcoding Profile to child accounts",
"name": "showChildProfile",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 12,
"title": "Allow Appstudio to be used in project by Child Account",
"displayGroupID": 2,
"description": "Allow Appstudio to be used in project by Child Account",
"name": "showAppstudioToChild",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "0"
},
{
"id": 13,
"title": "Allow Appstudio to be imported by Child Account",
"displayGroupID": 2,
"description": "Show Appstuio Players to Child Account",
"name": "allowAppstudioImportToChild",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 14,
"title": "Default View For Live Projects",
"displayGroupID": 1,
"description": "Default View For Live Projects",
"name": "defaultLiveView",
"uiType": "radio",
"options": "{\"list\": \"list\",\"calendar\": \"calendar\"}",
"isRequired": 0,
"preferencevalue": "list"
},
{
"id": 15,
"title": "Show Asset Poster Image",
"displayGroupID": 0,
"description": "Show Asset Poster Image",
"name": "showAssetPoster",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\":\n\"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 16,
"title": "Assets per Page",
"displayGroupID": 1,
"description": "Assets per Page",
"name": "rowperpage",
"uiType": "select",
"options": "{\"20\": \"20\",\"40\":\n\"40\",\"60\": \"60\",\"80\":\"80\",\"100\":\"100\"}",
"isRequired": 0,
"preferencevalue": "100"
},
{
"id": 17,
"title": "Auto Rename Asset Titles that Already Exist",
"displayGroupID": 3,
"description": "Automatically appends asset titles with \"-1,2,3..\" if\nanother asset with the same title exists",
"name": "autoRenameAssetTitle",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 19,
"title": "Allow asset and program level geo filters",
"displayGroupID": 0,
"description": "Enable\/Diable the ability to apply geo filters to assets and programs",
"name": "assetProgramGeofilters",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "0"
},
{
"id": 20,
"title": "Show inactive custom players by default",
"displayGroupID": 2,
"description": "Show inactive custom players by default",
"name": "showInactiveCustomPlayers",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "0"
},
{
"id": 23,
"title": "Facebook Default Single Appstudio Player",
"displayGroupID": 2,
"description": "Facebook Default Single Appstudio Player",
"name": "ASfacebookSingle",
"uiType": "select",
"options": "",
"isRequired": 0,
"preferencevalue": null
},
{
"id": 26,
"title": "Facebook Default Category AppStudio Player",
"displayGroupID": 2,
"description": "Facebook Default Category AppStudio Player",
"name": "ASfacebookCategory",
"uiType": "select",
"isRequired": 0,
"preferencevalue": null
},
{
"id": 28,
"title": "Facebook Default Playlist AppStudio Player",
"displayGroupID": 2,
"description": "Facebook Default Playlist AppStudio Player",
"name": "ASfacebookPlaylist",
"uiType": "text",
"isRequired": 0,
"preferencevalue": null
},
{
"id": 27,
"title": "AppStudio Facebook Live Player",
"displayGroupID": 2,
"description": "AppStudio Facebook Live Player",
"name": "ASfacebookLive",
"uiType": "select",
"isRequired": 0,
"preferencevalue": null
},
{
"id": 29,
"title": "Allow Playlist Rules To Remove Assets",
"displayGroupID": 0,
"description": "Allows playlist rules to remove assets when they no longer match a rule",
"name": "playlistRulesRemoveAssets",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"validationMsg": "",
"preferencevalue": "1"
},
{
"id": 24,
"title": "Sphinx search custom index file",
"displayGroupID": 5,
"description": "",
"name": "sphinxIndex",
"uiType": "default",
"isRequired": 0,
"preferencevalue": "multicastdev_main multicastdev_delta"
},
{
"id": 25,
"title": "Sphinx search custom port",
"displayGroupID": 5,
"description": "Sphinx search custom port for custom index file",
"name": "sphinxPort",
"uiType": "default",
"isRequired": 0,
"preferencevalue": "9313"
},
{
"id": 32,
"title": "Disable Global Transcoding Profiles",
"displayGroupID": 3,
"description": "Disable Global Transcoding Profiles",
"name": "disableGlobalTranscoding",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "0"
},
{
"id": 33,
"title": "Utilize CDN for \"File\" Asset Type",
"displayGroupID": 6,
"description": "Uploads \"File\" Assets to CDN",
"name": "enableBinaryFileCdn",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 35,
"title": "Show Metadata on MediaBin",
"displayGroupID": 0,
"description": "Show Metadata on Mediabin",
"name": "showMetadata",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 36,
"title": "Default Years till Program Expiration",
"displayGroupID": 0,
"description": "The number of years untill a program expires",
"name": "programEndDateExpiration",
"uiType": "text",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 34,
"title": "Utilize CDN for \"Image\" Asset Type",
"displayGroupID": 6,
"description": "Uploads \"Image\" Assets to CDN",
"name": "enableImageCdn",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "0"
},
{
"id": 39,
"title": "Use unique Codec Rendition in Asset Smils",
"displayGroupID": 3,
"description": "Use unique Codec Rendtion in Asset Smils",
"name": "uniqueSmilRendition",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 40,
"title": "Does KIT handle starting and stopping Live Streams?",
"displayGroupID": 5,
"description": "Does KIT handle starting and stopping Live Streams?",
"name": "doesKITstartStreams",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 41,
"title": "Allow Project Categories to Have Individual Programs",
"displayGroupID": 0,
"description": "When adding a program to a category project, each category will have a separate instance of the program.",
"name": "individualCategoryPrograms",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "0"
},
{
"id": 43,
"title": "Enable Sibling to edit assets",
"displayGroupID": 0,
"description": "Enable Sibling to edit assets",
"name": "enableAssetEdit",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 45,
"title": "Default Project Security Filter",
"displayGroupID": 4,
"description": "Default Project Security Filter",
"name": "defPrjSecurityFil",
"uiType": "select",
"isRequired": 0,
"preferencevalue": "0"
},
{
"id": 46,
"title": "Default Project Referrer Security Domain List",
"displayGroupID": 4,
"description": "Default Project Referrer Security",
"name": "defPrjReferrerDomains",
"uiType": "text",
"isRequired": 0,
"preferencevalue": "0"
},
{
"id": 47,
"title": "Default Project Referrer Security Message",
"displayGroupID": 4,
"description": "Default Project Referrer Security Message",
"name": "defPrjReferrerMes",
"uiType": "text",
"isRequired": 0,
"preferencevalue": "0"
},
{
"id": 48,
"title": "Enforce metadata requirements on API calls",
"displayGroupID": 0,
"description": "Enforce metadata requirements on API calls",
"name": "apiMetaReq",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "0"
},
{
"id": 49,
"title": "Sync Asset Metadata to Program Metadata",
"displayGroupID": 0,
"description": "Syncs all available default metadata fields from the asset to associated programs.",
"name": "syncAssetPrograms",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 2,
"title": "Bypass transcoding checked",
"displayGroupID": 3,
"description": "Bypass transcoding for compatible files when added",
"name": "bypass_tc",
"uiType": "radio",
"options": "{\"0\": \"Off\", \"1\":\"On\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 39,
"title": "Use unique Codec Rendition in Asset Smils",
"displayGroupID": 3,
"description": "Use unique Codec Rendtion in Asset Smils",
"name": "uniqueSmilRendition",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 2,
"title": "Bypass transcoding checked",
"displayGroupID": 3,
"description": "Bypass transcoding for compatible files when added",
"name": "bypass_tc",
"uiType": "radio",
"options": "{\"0\": \"Off\", \"1\":\"On\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 2,
"title": "Bypass transcoding checked",
"displayGroupID": 3,
"description": "Bypass transcoding for compatible files when added",
"name": "bypass_tc",
"uiType": "radio",
"options": "{\"0\": \"Off\", \"1\":\"On\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 41,
"title": "Allow Project Categories to Have Individual Programs",
"displayGroupID": 0,
"description": "When adding a program to a category project, each category will have a separate instance of the program.",
"name": "individualCategoryPrograms",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 50,
"title": "Does Piksel schedule the live events?",
"displayGroupID": 5,
"description": "Does Piksel schedule the live events",
"name": "scheduleEvents",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 51,
"title": "Empty Recycle Bin Delay",
"displayGroupID": 0,
"description": "Determine how long items will reside in the recycle bin before permanently being removed",
"name": "emptyRecycleBin",
"uiType": "select",
"options": "{\"0\":\"Immediately\",\"86400\":\"After 24 Hours\",\"172800\":\"After 48 Hours\",\"259200\":\"After 72 Hours\"}",
"isRequired": 0,
"validationMsg": "",
"preferencevalue": "0"
},
{
"id": 55,
"title": "Default Publish to YouTube Value",
"displayGroupID": 7,
"description": "Sets the default value of YouTube publish asset setting",
"name": "defaultYoutubePublishVal",
"uiType": "radio",
"options": "{\"1\": \"Yes\",\"0\": \"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 56,
"title": "YouTube Title Sync Field",
"displayGroupID": 7,
"description": "Sets the metaname field to be associated with title for YouTube publishing",
"name": "defaultYoutubeTitle",
"uiType": "select",
"isRequired": 0,
"preferencevalue": "false"
},
{
"id": 57,
"title": "YouTube Description Sync Field",
"displayGroupID": 7,
"description": "Sets the metaname field to be associated with description for YouTube publishing",
"name": "defaultYoutubeDescription",
"uiType": "select",
"isRequired": 0,
"preferencevalue": "false"
},
{
"id": 58,
"title": "YouTube Keyword Sync Field",
"displayGroupID": 7,
"description": "Sets the metaname field to be associated with tags for YouTube publishing",
"name": "defaultYoutubeTags",
"uiType": "select",
"isRequired": 0,
"preferencevalue": "false"
},
{
"id": 59,
"title": "Default Player Width",
"displayGroupID": 8,
"description": "Default width on single asset embed",
"name": "defaultWidth",
"uiType": "text",
"isRequired": 0,
"preferencevalue": "200"
},
{
"id": 61,
"title": "Auto Play",
"displayGroupID": 8,
"description": "Play on load",
"name": "defaultAutoplay",
"uiType": "radio",
"options": "{\"1\":\"Yes\",\"0\":\"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 62,
"title": "Auto Resize",
"displayGroupID": 8,
"description": "Auto Resize",
"name": "defaultResize",
"uiType": "radio",
"options": "{\"1\":\"Yes\",\"0\":\"No\"}",
"isRequired": 0,
"preferencevalue": "1"
},
{
"id": 60,
"title": "Default Player Height",
"displayGroupID": 8,
"description": "Default Player Height",
"name": "defaultHeight",
"uiType": "text",
"isRequired": 0,
"preferencevalue": "200"
}
]
}
}
}
English
日本語
Français
Deutsch
Español