{"apiVersion":"5.1.1","swaggerVersion":"1.1","basePath":"https://api.composer.nprstations.org/v1","resourcePath":"/ucs","apis":[{"path":"/ucs/search","description":"Search","operations":[{"parameters":[{"name":"ucs","description":"UCS ID","dataType":"string","paramType":"query"},{"name":"name","description":"Call Letters","dataType":"string","paramType":"query"},{"name":"enable_sx_reporting","description":"true or false for whether SX reporting is enabled. ","dataType":"string","paramType":"query"},{"name":"fullname","description":"Full Name","dataType":"string","paramType":"query"},{"name":"legacy","description":"Legacy Stream ID","dataType":"string","paramType":"query"},{"name":"match","description":"Type of Text Search (Defaults to Exact)","dataType":"string","required":false,"allowMultiple":true,"allowableValues":{"valueType":"LIST","values":["startswith","exact"]},"defaultValue":"startswith","paramType":"query"}],"httpMethod":"GET","notes":"This endpoint will search UCS documents.","errorResponses":[{"code":400,"reason":"invalid ucs","errors":[]},{"code":404,"reason":"no results found List[UCS]"},{"code":500,"reason":"server error "}],"nickname":"search","summary":"Search","customFields":{"description":"Search","path":"/ucs/search","method":"GET","params":[{"name":"ucs","description":"UCS ID","dataType":"string","paramType":"query"},{"name":"name","description":"Call Letters","dataType":"string","paramType":"query"},{"name":"enable_sx_reporting","description":"true or false for whether SX reporting is enabled. ","dataType":"string","paramType":"query"},{"name":"fullname","description":"Full Name","dataType":"string","paramType":"query"},{"name":"legacy","description":"Legacy Stream ID","dataType":"string","paramType":"query"},{"name":"match","description":"Type of Text Search (Defaults to Exact)","dataType":"string","required":false,"allowMultiple":true,"allowableValues":{"valueType":"LIST","values":["startswith","exact"]},"defaultValue":"startswith","paramType":"query"}],"responseClass":"List[UCS]","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"List[UCS]"}]},{"path":"/ucs/list","description":"Get all UCSs","operations":[{"parameters":[],"httpMethod":"GET","notes":"This endpoint will return all the UCS in the API that the token can see.","errorResponses":[{"code":404,"reason":"no results found ucs"},{"code":403,"reason":"no permission for UCS Read"}],"nickname":"list","summary":"List","customFields":{"description":"Get all UCSs","path":"/ucs/list","method":"GET","params":[],"responseClass":"List[UCS]","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"List[UCS]"}]},{"path":"/ucs/list/export","description":"Export all UCS's","operations":[{"parameters":[],"httpMethod":"GET","notes":"This endpoint will export all the UCS in the API that the token can see.","errorResponses":[{"code":404,"reason":"no results found ucs"},{"code":403,"reason":"no permission for UCS Read"}],"nickname":"exportList","summary":"List","customFields":{"description":"Export all UCS's","path":"/ucs/list/export","method":"GET","params":[],"responseClass":"List[UCS]","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"List[UCS]"}]},{"path":"/ucs/{id}","description":"Get a UCS","operations":[{"parameters":[{"name":"id","description":"UCS ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"GET","notes":"This endpoint will return a specific UCS.","errorResponses":[{"code":400,"reason":"invalid id","errors":[]},{"code":404,"reason":"ucs not found"},{"code":500,"reason":"server error "}],"nickname":"get","summary":"Get","customFields":{"description":"Get a UCS","path":"/ucs/{id}","method":"GET","params":[{"name":"id","description":"UCS ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"responseClass":"UCS","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"UCS"}]},{"path":"/ucs/{id}/{dates}/episodes","description":"Whats on a given date","operations":[{"parameters":[{"name":"id","description":"UCS ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"},{"name":"dates","description":"Date format YYYY-MM-DD. If two values are provided, separated by a comma, will return all episodes between the two date values","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"},{"name":"explain","description":"Experimental - Turn on the explain information. (Default Ignore).","dataType":"string","required":false,"allowMultiple":true,"allowableValues":{"valueType":"LIST","values":["ignore","true"]},"defaultValue":"ignore","paramType":"query"}],"httpMethod":"GET","notes":"Returns all the episodes for a given UCS and a date range","errorResponses":[{"code":400,"reason":"invalid ucs","errors":[]},{"code":404,"reason":"ucs not found"},{"code":403,"reason":"no permission for UCS Read"},{"code":500,"reason":"server error "}],"nickname":"Find-by-Date","summary":"Episodes By Date","customFields":{"description":"Whats on a given date","path":"/ucs/{id}/{dates}/episodes","method":"GET","params":[{"name":"id","description":"UCS ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"},{"name":"dates","description":"Date format YYYY-MM-DD. If two values are provided, separated by a comma, will return all episodes between the two date values","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"},{"name":"explain","description":"Experimental - Turn on the explain information. (Default Ignore).","dataType":"string","required":false,"allowMultiple":true,"allowableValues":{"valueType":"LIST","values":["ignore","true"]},"defaultValue":"ignore","paramType":"query"}],"responseClass":"List[Episode]","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"List[Episode]"}]},{"path":"/ucs/{id}/programs","description":"All programs for a UCS.","operations":[{"parameters":[{"name":"id","description":"UCS ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"GET","notes":"This endpoint will return all programs for a given UCS as an array of program objects. No Authentication needed.","errorResponses":[{"code":400,"reason":"invalid id","errors":[]},{"code":404,"reason":"ucs not found"},{"code":404,"reason":"no results found List[program]"},{"code":500,"reason":"server error "}],"nickname":"programs","summary":"Programs","customFields":{"description":"All programs for a UCS.","path":"/ucs/{id}/programs","method":"GET","params":[{"name":"id","description":"UCS ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"responseClass":"List[Program]","preliminaryCallbacks":[],"requestSignature":"token"},"responseClass":"List[Program]"}]},{"path":"/ucs/all/provision","description":"Provision episodes for all UCS programs.","operations":[{"parameters":[{"name":"ucs","description":"UCS ID or Wildcard Character","dataType":"string","required":false,"allowMultiple":true,"paramType":"query"},{"name":"program","description":"(Optional) Program ID","dataType":"string","required":false,"allowMultiple":false,"paramType":"query"},{"name":"now","description":"(Optional) Date to start (defaults to today)","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"05-10-2026","paramType":"query"},{"name":"days","description":"(Optional) Days from now to provision (defaults to 365)","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":365,"paramType":"query"}],"httpMethod":"GET","notes":"This endpoint will process the provisioning logic for all programs for a UCS.               This will query and generate new episodes for 365 days into the future. There               are undocumented filter options for the provisioning date.               Warning: Can take about 30 seconds to complete.","errorResponses":[{"code":400,"reason":"invalid ucs","errors":[]},{"code":404,"reason":"ucs not found"},{"code":403,"reason":"no permission for Provision Create"},{"code":500,"reason":"server error "}],"nickname":"provision","summary":"Provision","customFields":{"description":"Provision episodes for all UCS programs.","path":"/ucs/all/provision","method":"GET","params":[{"name":"ucs","description":"UCS ID or Wildcard Character","dataType":"string","required":false,"allowMultiple":true,"paramType":"query"},{"name":"program","description":"(Optional) Program ID","dataType":"string","required":false,"allowMultiple":false,"paramType":"query"},{"name":"now","description":"(Optional) Date to start (defaults to today)","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"05-10-2026","paramType":"query"},{"name":"days","description":"(Optional) Days from now to provision (defaults to 365)","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":365,"paramType":"query"}],"responseClass":"UCS","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"UCS"}]},{"path":"/ucs/all/onboarding","description":"Provision episodes for stream being onboarded.","operations":[{"parameters":[{"name":"ucs","description":"UCS ID or Wildcard Character","dataType":"string","required":false,"allowMultiple":true,"paramType":"query"},{"name":"program","description":"(Optional) Program ID","dataType":"string","required":false,"allowMultiple":false,"paramType":"query"},{"name":"now","description":"(Optional) Date to start (defaults to today)","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"05-10-2026","paramType":"query"},{"name":"days","description":"(Optional) Days from now to provision (defaults to 365)","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":365,"paramType":"query"}],"httpMethod":"GET","notes":"This endpoint will process the provisioning logic for all programs for a UCS.               Warning: Can take about 30 seconds to complete.","errorResponses":[{"code":400,"reason":"invalid ucs","errors":[]},{"code":404,"reason":"ucs not found"},{"code":403,"reason":"no permission for Provision Create"},{"code":500,"reason":"server error "}],"nickname":"provision","summary":"onBoarding","customFields":{"description":"Provision episodes for stream being onboarded.","path":"/ucs/all/onboarding","method":"GET","params":[{"name":"ucs","description":"UCS ID or Wildcard Character","dataType":"string","required":false,"allowMultiple":true,"paramType":"query"},{"name":"program","description":"(Optional) Program ID","dataType":"string","required":false,"allowMultiple":false,"paramType":"query"},{"name":"now","description":"(Optional) Date to start (defaults to today)","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"05-10-2026","paramType":"query"},{"name":"days","description":"(Optional) Days from now to provision (defaults to 365)","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":365,"paramType":"query"}],"responseClass":"UCS","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"UCS"}]},{"path":"/ucs/{id}","description":"Update UCS","operations":[{"parameters":[{"name":"id","description":"UCS ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"},{"name":"body","description":"UCS Update Object","dataType":"UCS","required":true,"allowMultiple":false,"paramType":"body"}],"httpMethod":"PUT","notes":"This route provides the ability to update a specific              ucs timezone, affiliate links etc.","errorResponses":[{"code":400,"reason":"invalid ucs","errors":[]},{"code":404,"reason":"ucs not found"},{"code":403,"reason":"no permission for UCS Update"},{"code":500,"reason":"server error undefined"}],"nickname":"update","summary":"Update","customFields":{"description":"Update UCS","path":"/ucs/{id}","method":"PUT","params":[{"name":"id","description":"UCS ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"},{"name":"body","description":"UCS Update Object","dataType":"UCS","required":true,"allowMultiple":false,"paramType":"body"}],"responseClass":"UCS","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"UCS"}]},{"path":"/ucs/{id}/checkForConflicts","description":"Create a UCS","operations":[{"parameters":[{"name":"id","description":"UCS ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"},{"name":"body","description":"Airtime Object","dataType":"Airtime","required":true,"allowMultiple":false,"paramType":"body"},{"name":"limit","description":"number of specific conflicts to return per program per airtime","dataType":"string","paramType":"query"},{"name":"sort","description":"1 (ascending) or -1 (descending).  Default: 1 (ascending).","dataType":"integer","paramType":"query"}],"httpMethod":"POST","notes":"This route takes an Airtime (or list of Airtimes) from a program and compares it to the schedule for this UCS to determine whether there are conflicts","errorResponses":[{"code":500,"reason":"server error undefined"},{"code":400,"reason":"invalid Invalid Data","errors":[]}],"nickname":"checkForConflicts","summary":"Test airtime","customFields":{"description":"Create a UCS","path":"/ucs/{id}/checkForConflicts","method":"POST","params":[{"name":"id","description":"UCS ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"},{"name":"body","description":"Airtime Object","dataType":"Airtime","required":true,"allowMultiple":false,"paramType":"body"},{"name":"limit","description":"number of specific conflicts to return per program per airtime","dataType":"string","paramType":"query"},{"name":"sort","description":"1 (ascending) or -1 (descending).  Default: 1 (ascending).","dataType":"integer","paramType":"query"}],"responseClass":"Airtime","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"Airtime"}]},{"path":"/ucs","description":"Create a UCS","operations":[{"parameters":[{"name":"body","description":"UCS Object","dataType":"UCS","required":true,"allowMultiple":false,"paramType":"body"}],"httpMethod":"POST","notes":"This route provides the ability to create a UCS.","errorResponses":[{"code":500,"reason":"server error undefined"},{"code":403,"reason":"no permission for UCS Created"},{"code":400,"reason":"invalid Invalid Data","errors":[]}],"nickname":"create","summary":"Create","customFields":{"description":"Create a UCS","path":"/ucs","method":"POST","params":[{"name":"body","description":"UCS Object","dataType":"UCS","required":true,"allowMultiple":false,"paramType":"body"}],"responseClass":"UCS","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"UCS"}]},{"path":"/ucs/{id}","description":"Delete a UCS","operations":[{"parameters":[{"name":"id","description":"UCS ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"DELETE","notes":"This endpoint is disabled on production.","errorResponses":[{"code":400,"reason":"invalid id","errors":[]},{"code":404,"reason":"ucs not found"},{"code":403,"reason":"no permission for UCS Delete"},{"code":500,"reason":"server error "}],"nickname":"delete","summary":"Delete","customFields":{"description":"Delete a UCS","path":"/ucs/{id}","method":"DELETE","params":[{"name":"id","description":"UCS ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"responseClass":"UCS","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"UCS"}]},{"path":"/ucs/{legacy}/upgrade","description":"Upgrade a UCS Programs & Episodes","operations":[{"parameters":[{"name":"legacy","description":"Legacy Composer UCS ID (hint: ucs_#)","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"GET","notes":"This will upgrade all programs and episodes to use the UCS ID, in place of the old HR ID.","errorResponses":[{"code":400,"reason":"invalid legacy id (UCS_#)","errors":[]},{"code":404,"reason":"ucs not found"},{"code":403,"reason":"no permission for UCS Create"},{"code":500,"reason":"server error "}],"nickname":"update-ids","summary":"Upgrade Programs and Episodes","customFields":{"description":"Upgrade a UCS Programs & Episodes","path":"/ucs/{legacy}/upgrade","method":"GET","params":[{"name":"legacy","description":"Legacy Composer UCS ID (hint: ucs_#)","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"responseClass":"UCS","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"UCS"}]},{"path":"/ucs/sx/export","description":"Export Playlists","operations":[{"parameters":[{"name":"id","description":"UCS","dataType":"string","required":true,"allowMultiple":false,"paramType":"query"},{"name":"episode","description":"Episode ID (optional)","dataType":"string","required":false,"allowMultiple":false,"paramType":"query"},{"name":"start","description":"Start Date (YYYY-MM-DD)","dataType":"string","required":true,"allowMultiple":false,"paramType":"query"},{"name":"end","description":"End Date (YYYY-MM-DD)","dataType":"string","required":true,"allowMultiple":false,"paramType":"query"},{"name":"name","description":"File Name","dataType":"string","required":true,"allowMultiple":false,"paramType":"query"},{"name":"delineator","description":"Delineator (Comma (Default) or Tab)","dataType":"string","required":true,"allowMultiple":false,"allowableValues":{"valueType":"LIST","values":["tab","comma"]},"defaultValue":"tab","paramType":"query"},{"name":"quoted","description":"Quote Enclosed (Default is no)","dataType":"string","required":true,"allowMultiple":false,"allowableValues":{"valueType":"LIST","values":["no","yes"]},"defaultValue":"no","paramType":"query"},{"name":"exportType","description":"An optional parameter for location of file, either 's3' or 'sxServer'.  Default: 's3'","dataType":"string","required":false,"paramType":"query"}],"httpMethod":"GET","notes":"This endpoint will process and generate an SX or CSV export file.","errorResponses":[{"code":404,"reason":"Entity not found"},{"code":500,"reason":"server error "}],"nickname":"SXReport","summary":"Playlists Export","customFields":{"description":"Export Playlists","path":"/ucs/sx/export","method":"GET","params":[{"name":"id","description":"UCS","dataType":"string","required":true,"allowMultiple":false,"paramType":"query"},{"name":"episode","description":"Episode ID (optional)","dataType":"string","required":false,"allowMultiple":false,"paramType":"query"},{"name":"start","description":"Start Date (YYYY-MM-DD)","dataType":"string","required":true,"allowMultiple":false,"paramType":"query"},{"name":"end","description":"End Date (YYYY-MM-DD)","dataType":"string","required":true,"allowMultiple":false,"paramType":"query"},{"name":"name","description":"File Name","dataType":"string","required":true,"allowMultiple":false,"paramType":"query"},{"name":"delineator","description":"Delineator (Comma (Default) or Tab)","dataType":"string","required":true,"allowMultiple":false,"allowableValues":{"valueType":"LIST","values":["tab","comma"]},"defaultValue":"tab","paramType":"query"},{"name":"quoted","description":"Quote Enclosed (Default is no)","dataType":"string","required":true,"allowMultiple":false,"allowableValues":{"valueType":"LIST","values":["no","yes"]},"defaultValue":"no","paramType":"query"},{"name":"exportType","description":"An optional parameter for location of file, either 's3' or 'sxServer'.  Default: 's3'","dataType":"string","required":false,"paramType":"query"}],"responseClass":"","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"void"}]},{"path":"/ucs/sx/batchexport","description":"Trigger a batch of playlist exports for Sound Exchange Processing.","operations":[{"parameters":[{"name":"exportAll","description":"true or false for whether exports should be executed for ALL UCSs.  If this is true, then an export will be executed for all UCSs that have the flag enable_sx_reporting.  If this is false and there is no body parameter, the the request will fail.  If this is true, but there is also a (valid) body  value, the UCS ID list within the body will be given priority.","dataType":"boolean","required":false,"paramType":"query"},{"name":"body","description":"A JSON array of UCS ID strings.","dataType":"string","required":true,"allowMultiple":false,"paramType":"body"},{"name":"exportStartDate","description":"The start of the content export date range (usually a specific quarter for the current year). Required.","dataType":"string","required":true,"paramType":"query"},{"name":"exportEndDate","description":"The end of the content export date range (usually a specific quarter for the current year). Required.","dataType":"string","required":true,"paramType":"query"},{"name":"filenamePart","description":"An optional parameter for passing in a custom string that will form part of the filename of the output file.","dataType":"string","required":false,"paramType":"query"},{"name":"exportType","description":"An optional parameter for location of file, either 's3' or 'sxServer'.  Default: 'sxServer'","dataType":"string","required":false,"paramType":"query"}],"httpMethod":"POST","notes":"This endpoint accepts a list of UCS IDs and a date range (a specific quarter) to create content exports for sound exchange processing.  A batch of jobs (one job per export) is created to process all exports.  It returns the batchID of the newly created batch, if successful.","errorResponses":[{"code":400,"reason":"invalid id","errors":[]},{"code":404,"reason":"ucs not found"}],"nickname":"SXBatchExport","customFields":{"path":"/ucs/sx/batchexport","method":"POST","description":"Trigger a batch of playlist exports for Sound Exchange Processing.","params":[{"name":"exportAll","description":"true or false for whether exports should be executed for ALL UCSs.  If this is true, then an export will be executed for all UCSs that have the flag enable_sx_reporting.  If this is false and there is no body parameter, the the request will fail.  If this is true, but there is also a (valid) body  value, the UCS ID list within the body will be given priority.","dataType":"boolean","required":false,"paramType":"query"},{"name":"body","description":"A JSON array of UCS ID strings.","dataType":"string","required":true,"allowMultiple":false,"paramType":"body"},{"name":"exportStartDate","description":"The start of the content export date range (usually a specific quarter for the current year). Required.","dataType":"string","required":true,"paramType":"query"},{"name":"exportEndDate","description":"The end of the content export date range (usually a specific quarter for the current year). Required.","dataType":"string","required":true,"paramType":"query"},{"name":"filenamePart","description":"An optional parameter for passing in a custom string that will form part of the filename of the output file.","dataType":"string","required":false,"paramType":"query"},{"name":"exportType","description":"An optional parameter for location of file, either 's3' or 'sxServer'.  Default: 'sxServer'","dataType":"string","required":false,"paramType":"query"}],"preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"void"}]},{"path":"/ucs/sx/import","description":"Import Multiday Playlist","operations":[{"parameters":[{"name":"ucs","description":"UCS ID","dataType":"string","required":false,"allowMultiple":false,"paramType":"query"},{"name":"program","description":"Optional - Program ID (will limit the import to episodes for program)","dataType":"string","paramType":"query"},{"name":"file","description":"Start Date","dataType":"file","required":true,"allowMultiple":false,"paramType":"body","defaultValue":true},{"name":"data","description":"Raw Data (Used for non-file import).  Optional - CSV string with return characters. Use in place of file.","dataType":"string","required":true,"allowMultiple":false,"paramType":"body","defaultValue":true},{"name":"importType","description":"importType (sx (Default) or general)","dataType":"string","required":true,"allowMultiple":false,"allowableValues":{"valueType":"LIST","values":["sx","general"]},"defaultValue":"sx","paramType":"query"}],"httpMethod":"POST","notes":"This endpoint will import and process multiday playlists.","errorResponses":[{"code":404,"reason":"Entity not found"},{"code":500,"reason":"server error "}],"nickname":"Upload-Playlist","summary":"Import Playlists","customFields":{"description":"Import Multiday Playlist","path":"/ucs/sx/import","method":"POST","params":[{"name":"ucs","description":"UCS ID","dataType":"string","required":false,"allowMultiple":false,"paramType":"query"},{"name":"program","description":"Optional - Program ID (will limit the import to episodes for program)","dataType":"string","paramType":"query"},{"name":"file","description":"Start Date","dataType":"file","required":true,"allowMultiple":false,"paramType":"body","defaultValue":true},{"name":"data","description":"Raw Data (Used for non-file import).  Optional - CSV string with return characters. Use in place of file.","dataType":"string","required":true,"allowMultiple":false,"paramType":"body","defaultValue":true},{"name":"importType","description":"importType (sx (Default) or general)","dataType":"string","required":true,"allowMultiple":false,"allowableValues":{"valueType":"LIST","values":["sx","general"]},"defaultValue":"sx","paramType":"query"}],"responseClass":"","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"void"}]},{"path":"/ucs/sx/bmatimport","description":"Import Multiday Playlist","operations":[{"parameters":[{"name":"file","description":"Start Date","dataType":"file","required":true,"allowMultiple":false,"paramType":"body","defaultValue":true}],"httpMethod":"POST","notes":"This endpoint will import and process multiday playlists for BMAT.","errorResponses":[{"code":404,"reason":"Entity not found"},{"code":500,"reason":"server error "}],"nickname":"Upload-Bmat-Playlist","summary":"Import BMAT Playlists","customFields":{"description":"Import Multiday Playlist","path":"/ucs/sx/bmatimport","method":"POST","params":[{"name":"file","description":"Start Date","dataType":"file","required":true,"allowMultiple":false,"paramType":"body","defaultValue":true}],"responseClass":"","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"void"}]},{"path":"/ucs/sx/logs/add","description":"upload S3","operations":[{"parameters":[{"name":"file","description":"Upload file","dataType":"file","required":true,"allowMultiple":false,"paramType":"body","defaultValue":true}],"httpMethod":"POST","notes":"This will upload a file to S3","errorResponses":[{"code":500,"reason":"server error "}],"nickname":"LogsAdd","summary":"This will upload a file to S3","customFields":{"description":"upload S3","path":"/ucs/sx/logs/add","method":"POST","params":[{"name":"file","description":"Upload file","dataType":"file","required":true,"allowMultiple":false,"paramType":"body","defaultValue":true}],"responseClass":"File","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"File"}]},{"path":"/ucs/sx/station_reporting_dates/{station_name}","description":"upload S3","operations":[{"parameters":[{"name":"station_name","description":"Station Name","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"GET","notes":"This will get the reporting dates of a station","errorResponses":[{"code":500,"reason":"server error "}],"nickname":"StationReportingGet","summary":"This will get the reporting dates of a station","customFields":{"description":"upload S3","path":"/ucs/sx/station_reporting_dates/{station_name}","method":"GET","params":[{"name":"station_name","description":"Station Name","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"responseClass":"File","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"File"}]},{"path":"/ucs/sx/station_reporting_dates/add","description":"upload S3","operations":[{"parameters":[],"httpMethod":"POST","notes":"This will upload the station reporting dates to S3","errorResponses":[{"code":500,"reason":"server error "}],"nickname":"StationReportingAdd","summary":"This will upload the station reporting dates to S3","customFields":{"description":"upload S3","path":"/ucs/sx/station_reporting_dates/add","method":"POST","params":[],"responseClass":"File","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"File"}]},{"path":"/ucs/sx/stream_patterns/{station_name}","description":"Get stream_patterns based on the station name","operations":[{"parameters":[{"name":"station_name","description":"Station Name","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"GET","notes":"This will return the information of a stream pattern","errorResponses":[{"code":500,"reason":"server error "}],"nickname":"getStreamPatternInfo","summary":"This will return the information of a stream pattern","customFields":{"description":"Get stream_patterns based on the station name","path":"/ucs/sx/stream_patterns/{station_name}","method":"GET","params":[{"name":"station_name","description":"Station Name","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"responseClass":"","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"void"}]},{"path":"/ucs/sx/stream_patterns","description":"Updates stream_patterns information based on the station name and stream pattern","operations":[{"parameters":[{"name":"body","description":"A JSON with the station name: [{\n\"stream_patterns\": [{\n\"stream_id\": \"id\",\n\"station_name\": \"station_name\",\n\"stream_patter\": \"\",\n\"ftp_host\": \"ftp_host\",\n\"ftp_user\": \"ftp_user\",\n\"ftp_password\": \"ftp_password\",\n\"remote_path\": \"remote_path\",\n\"log_type\": \"log_type\",\n\"active\": 1,\n\"log_timezone\": \"log_timezone\"\n}],\n\"deleted_patterns_ids\": [\"value\", \"value\"]\n}]","dataType":"string","required":true,"allowMultiple":false,"paramType":"body"}],"httpMethod":"PUT","notes":"This will update the information of a stream pattern based on station name and stream pattern","errorResponses":[{"code":500,"reason":"server error "}],"nickname":"updateStreamPatternInfo","summary":"This will update the information of a stream pattern based on station name and stream pattern","customFields":{"description":"Updates stream_patterns information based on the station name and stream pattern","path":"/ucs/sx/stream_patterns","method":"PUT","params":[{"name":"body","description":"A JSON with the station name: [{\n\"stream_patterns\": [{\n\"stream_id\": \"id\",\n\"station_name\": \"station_name\",\n\"stream_patter\": \"\",\n\"ftp_host\": \"ftp_host\",\n\"ftp_user\": \"ftp_user\",\n\"ftp_password\": \"ftp_password\",\n\"remote_path\": \"remote_path\",\n\"log_type\": \"log_type\",\n\"active\": 1,\n\"log_timezone\": \"log_timezone\"\n}],\n\"deleted_patterns_ids\": [\"value\", \"value\"]\n}]","dataType":"string","required":true,"allowMultiple":false,"paramType":"body"}],"responseClass":"","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"void"}]},{"path":"/ucs/sx/logs/list/{station_name}","description":"Get all files uploaded from C2","operations":[{"parameters":[{"name":"station_name","description":"Station Name","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"GET","notes":"This will get the files from S3 uploaded for a given station","errorResponses":[{"code":500,"reason":"server error "}],"nickname":"LogsList","summary":"This will get the files from S3 uploaded for a given station","customFields":{"description":"Get all files uploaded from C2","path":"/ucs/sx/logs/list/{station_name}","params":[{"name":"station_name","description":"Station Name","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"method":"GET","responseClass":"File","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"File"}]},{"path":"/ucs/sx/logs/rowsCount/{file_name}","description":"Get the uploaded file processed rows count","operations":[{"parameters":[{"name":"file_name","description":"File Name","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"GET","notes":"This will get the count of processed rows for a specific file","errorResponses":[{"code":500,"reason":"server error "}],"nickname":"fileProcessedRowCount","summary":"This will get the count of processed rows for a specific file","customFields":{"description":"Get the uploaded file processed rows count","path":"/ucs/sx/logs/rowsCount/{file_name}","params":[{"name":"file_name","description":"File Name","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"method":"GET","responseClass":"File","requestSignature":"token"},"responseClass":"File"}]},{"path":"/ucs/sx/logs/delete/{ucs}/{file_name}","description":"Delete the file from S3 based on its filename","operations":[{"parameters":[{"name":"ucs","description":"The UCS of the station","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"},{"name":"file_name","description":"File Name","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"DELETE","notes":"This will get the count of processed rows for a specific file","errorResponses":[{"code":500,"reason":"server error "}],"nickname":"fileProcessedRowCount","summary":"This will get the count of processed rows for a specific file","customFields":{"description":"Delete the file from S3 based on its filename","path":"/ucs/sx/logs/delete/{ucs}/{file_name}","params":[{"name":"ucs","description":"The UCS of the station","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"},{"name":"file_name","description":"File Name","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"method":"DELETE","responseClass":"File","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"File"}]}],"models":{"UCS":{"id":"UCS","properties":{"station_id":{"type":"string","description":"Parent Station ID","required":false},"name":{"type":"string","description":"Short Name","required":true},"fullname":{"type":"string","description":"Stream/UCS Timezone","required":true},"timezone":{"type":"string","description":"Stream/UCS Timezone (-12 to 12)","required":true,"default":"EST"},"itunes_affiliate_id":{"type":"string","description":"Apple Itunes ID","required":false},"amazon_affiliate_id":{"type":"string","description":"Amazon ID","required":false},"arkiv_affiliate_id":{"type":"string","description":"Arkiv ID","required":false},"websitelink":{"type":"string","description":"Program Format","required":false}}},"Episode":{"id":"Episode","properties":{"airtime":{"type":"string","description":"Array of start, end and date for when it will play.","required":true},"event_id":{"type":"string","description":"Internal Program ID.","required":true},"playlist":{"type":"string","description":"Program Description","required":false},"program_id":{"type":"string","description":"Parent Program ID","required":true},"ucs":{"type":"string","description":"Parent UCS","required":true},"program":{"type":"string","description":"Nested Program Document.","required":true}}},"Program":{"id":"Program","properties":{"name":{"type":"string","description":"","required":true},"program_url":{"type":"string","description":"HTTP URL for a program page.","required":false},"program_desc":{"type":"string","description":"Program Description","required":false},"ucs":{"type":"string","description":"UCS ID","required":true},"program_format":{"type":"string","description":"Program Format","required":false},"facebook":{"type":"string","description":"Facebook URL","required":false},"twitter":{"type":"string","description":"Twitter URL","required":false},"widget_config":{"album_art":{"type":"string","description":"Display album art in widget","required":false},"label":{"type":"string","description":"Display label in widget","required":false},"catalog_number":{"type":"string","description":"Display catalog number art in widget","required":false},"host_display":{"type":"string","description":"Display host in widget","required":false},"custom_fields":{"type":"string","description":"Display custom fields in widget","required":false},"episode_notes":{"type":"string","description":"Display episode notes in widget","required":false},"make_default":{"type":"string","description":"Make these settings the widget default","required":false},"host_allow":{"type":"string","description":"Allow host to modify settings in widget","required":false}},"recurrences":{"type":"array","description":"Array of Airtime models.","required":false,"default":[{"start_time":"23:00","end_time":"24:00","days":"Mon,Tue,Wed","start_date":"2012-01-01","end_date":"2012-02-01","no_end_date":false}]},"hosts":{"type":"array","description":"Array of Host models","required":false,"default":[{"name":"","email":""}]}}}}}