PROPERTIES
| Name | mediafirst |
| System ID | mf |
| Connection String | |
| Heartbeat Connection String |
SUPPORTED NODE
DEFINITIONS
* Indicates the message has been deprecated. Please use the replacement message(s) instead.
NODE DEFINITION
DETAILS
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| itemId | NO | The id of the item that is added to the storefront category |
| itemType | NO | The type of the item that is added to the storefront category |
| storefrontCategoryIds | NO | The id list contains the storefront category to which an item is added |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| addedCategoryIds | The list contains the storefront category ids that are added successfully |
| mfRequestIds | The request ids, speparated by a comma, returned by MediaFirst |
| errorMsg | Error Message |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| imageFolderPath | NO | The folder path of sprites. |
| mfTitleId | NO | The mediafirst title id. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst. |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| filePath | NO | The manifest file path. |
| width | NO | The keyframe's width. |
| mfTitleId | NO | The mediafirst title id. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfReuqestId | The request id returned by MediaFirst |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfServiceCollectionId | NO | |
| mfSubscriptionId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId |
Add title or TV Show to MF subscription or category
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfSeriesId | NO | |
| mfCategoryNames | NO | |
| mfTitleId | NO | |
| mfSubscriptionId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| isTVShow | |
| mfRequestId | |
| mfMatchStatus | |
| disableValidation | |
| successCategoryIdList | |
| errorMsg | |
| mfEncodedTitleList | |
| mfUniversalProgramId |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfPackageId | NO | |
| mfTitleId | NO | @param mfPackageId : |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
Add Title to Subscription Or Category
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfSubscriptionId | NO | Subscription id in MediaFirst |
| mfTitleId | NO | Title id in MediaFirst |
| mfCategoryNames | NO | Category Names List |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestIds | The request ids, speparated by a comma, returned by MediaFirst |
| successCategoryIdList | Added Successful CategoryId in MediaFirst |
| errorMsg | The error message while partially titles added successful |
Add a Title to Subscription
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfSubscriptionId | NO | subscription id in mediafirst |
| mfTitleId | NO | title id in mediafirst |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
Add TV Show to a Subscription
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfSubscriptionId | NO | Subscription id in MediaFirst |
| mfTvShowId | NO | TV Show id in MediaFirst |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
Add TV Show to Subscription Or Category
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfSubscriptionId | NO | Subscription id in MediaFirst |
| mfTvShowId | NO | TV Show id in MediaFirst |
| mfCategoryNames | NO | Category Names List |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestIds | The request ids, speparated by a comma, returned by MediaFirst |
| successCategoryIdList | Added Successful CategoryId in MediaFirst |
| errorMsg | The error message while partially titles added successful |
Create or Update Event Schedule in mediafirst.
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| eventExternalId | NO | |
| scheduleExternalId | NO | |
| name | NO | |
| actualStartUtc | NO | |
| actualEndUtc | NO | |
| startUtc | NO | |
| endUtc | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId |
Create or Update Event in mediafirst.
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| externalId | NO | External Id of the Event. |
| eventStatus | NO | Status of the Event. |
| eventType | NO | Event Type of the Event. For example, Game, Race, GeneralProgramming (default). |
| locationExternalId | NO | A location ExternalId of the Event. |
| showType | NO | value would of the ShowType is Event. |
| description | NO | An array of cultured descriptions of the Event. |
| labels | NO | An array containing all label information for the event. |
| name | NO | An array of cultured names of the Event. |
| shortName | NO | An array of cultured short names of the Event. |
| sortName | NO | An array of cultured sortname of the Event. |
| teamsRole | NO | dictionary of string, array of Role.Key determines the externalId of the team and value is Role of teamMembers. |
| isUpdate | NO | whether update the event. true: update the event, false: create event. |
| league | NO | league of Event |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
It is Create or Update Location.
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| isUpdate | NO | This operation is to Update or Create the Location |
| externalId | NO | External ID of the Location |
| locationType | NO | The locationType for Location |
| ownerId | NO | The ownerId for Location |
| name | NO | The name for Location |
| address | NO | The address for Location |
| description | NO | The description for Location |
| city | NO | The city for Location |
| state | NO | The state for Location |
| country | NO | The country for Location |
| culture | NO | It is the languge of name, address, description, city, state, country |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
| ouputExternalId | External ID of the Location when created or updated respone |
Such message helps us group multiple mediafirst title together
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfTitleIds | NO | Such parameter will be the MediaFirst title ids string which separated by comma. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst. |
Create or Update Package Offer by Id
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| offerGroup | NO | |
| endUtc | NO | |
| offerId | NO | |
| offerType | NO | |
| price | NO | |
| qualityLevels | NO | |
| rentalWindowSeconds | NO | |
| restrictions | NO | |
| startUtc | NO | |
| mfPackageId | NO | @param offerGroup : |
| offerTarget | NO | |
| termLanguage | NO | Offer term language |
| termDescription | NO | Offer term description |
| managedInHome | NO | Max VodStreams Inhome Managed |
| managedOutHome | NO | Max VodStreams Outhome Managed |
| reachInHome | NO | Max VodStreams Inhome UnManaged Reach |
| reachOutofHome | NO | Max VodStreams Outhome UnManaged Reach |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
create or update package with id
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfPackageId | NO | input mf package id |
| name | NO | #Required update the name of package |
| description | NO | update the description of package |
| culture | NO | The language for name and description |
| networkId | NO | The name of the network to which the package belongs. |
| isAdult | NO | Indicates whether the package |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
| outputMFPackageId | The package id from mediafirst |
Create or Update Production in MediaFirst
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| externalId | NO | External Id of the Production |
| displayName | NO | An array of cultured displayNames of the production. |
| eventScheduleExternalId | NO | The eventSchedules ExternalId associated with the production. |
| liveToOnDemand | NO | Indicates whether the production will be converted from live to on demand. |
| qualityLevel | NO | Quality Level of the production. E.g. SD, HD, Mobile, UHD, ReachSD, ReachHD, ReachUHD, etc. |
| role | NO | The event ProductionRole. E.g. Home, Away, National, Mobile, etc. |
| isUpdate | NO | whether update, true:update, false:create. |
| audioOnly | NO | True if the production is audioOnly, false otherwise. |
| geoPolicyIds | NO | Production Geo Policy IDs |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
If you are updating an existing subscription, you can modify only the name, description, and networkId properties
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| name | NO | Name of the subscription |
| description | NO | Description of the subscription. |
| networkId | NO | The name of the network to |
| mfSubscriptionId | NO | ID that you are supplying. Must be |
| culture | NO | language-country |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
Create or Update Title Offer by Id
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfTitleId | NO | title id in mediafirst |
| offerId | NO | |
| endUtc | NO | |
| offerType | NO | |
| price | NO | |
| restrictions | NO | |
| offerGroup | NO | |
| qualityLevels | NO | |
| startUtc | NO | |
| rentalWindowSeconds | NO | |
| offerTarget | NO | |
| termLanguage | NO | Offer term language |
| termDescription | NO | Offer term description. |
| managedInHome | NO | Max VodStreams Inhome Managed |
| managedOutHome | NO | Max VodStreams Outhome Managed |
| reachInHome | NO | Max VodStreams Inhome UnManaged Reach |
| reachOutofHome | NO | Max VodStreams Outhome UnManaged Reach |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
Create Package Offer
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| offerGroup | NO | |
| endUtc | NO | |
| offerType | NO | |
| price | NO | |
| qualityLevels | NO | |
| rentalWindowSeconds | NO | |
| restrictions | NO | |
| startUtc | NO | |
| mfPackageId | NO | mediafirst package ID |
| offerTarget | NO | |
| termLanguage | NO | Offer term language |
| termDescription | NO | Offer term description |
| managedInHome | NO | Max VodStreams Inhome Managed |
| managedOutHome | NO | Max VodStreams Outhome Managed |
| reachInHome | NO | Max VodStreams Inhome UnManaged Reach |
| reachOutofHome | NO | Max VodStreams Outhome UnManaged Reach |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| offerId | |
| mfRequestId | The request id returned by MediaFirst |
create package without id
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| name | NO | The package name |
| description | NO | the package description |
| culture | NO | The language for name and description |
| isAdult | NO | Indicates whether the package |
| networkId | NO | The name of the network to which the package belongs |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfPackageId | The package id from mediafirst |
| mfRequestId | The request id returned by MediaFirst |
Create person in mediafirst.
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| personList | NO | The list of the persons that will be added to mediafirst. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst. |
Create an offer for title.
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfTitleId | NO | title id in mediafirst |
| price | NO | Purchase price |
| startUtc | NO | The start date of the offer |
| endUtc | NO | The end date of the offer |
| offerGroup | NO | |
| rentalWindowSeconds | NO | |
| qualityLevels | NO | Content quality levels supported by the offer. |
| offerType | NO | Type of offer. Must be one of the |
| restrictions | NO | |
| offerTarget | NO | |
| termDescription | NO | Offer term Description. |
| termLanguage | NO | Offer term language |
| managedOutHome | NO | Max VodStreams Outhome Managed |
| managedInHome | NO | Max VodStreams Inhome Managed |
| reachInHome | NO | Max VodStreams Inhome UnManaged Reach |
| reachOutofHome | NO | Max VodStreams Outhome UnManaged Reach |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| offerId | |
| mfRequestId | The request id returned by MediaFirst |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| templateId | NO | Must match a job template that supports external ingest. |
| metadataPath | NO | Metadata describing the asset for external ingest. Must conform to one of these specifications: MR, ADI1.1, ADI3.0 |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| createTime | It is the create time of the title. The value is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC. |
| featureId | Mediafirst feature title Id |
| previewId | MediaFirst Preview Title Id |
| mfRequestId | The request id returned by MediaFirst |
Delete schedule for an event by schedule External id.
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| scheduleExternalId | NO | |
| eventExternalId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| externalId | YES | The external id of the event. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
This is to delete the Location resource by external ID.
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| externalId | NO | External ID of the Location. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
Delete package
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfPackageId | NO | package id from mediafirst |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
Delete Production By External Id
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| externalId | YES | The external id of the production. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MF. |
Delete production after removing service collection from subscription.
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| productionId | NO | |
| serviceCollectionId | NO | |
| subscriptionIds | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| requestId |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfSeriesId | NO | series id in mediafirst |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | mediafirst request id |
Delete Subscription by id
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfSubscriptionId | YES | Subscription id |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfTitleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfPackageId | NO | |
| offerId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
Forces a title offer to expire.
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfTitleId | NO | title id in mediafirst |
| offerId | NO | id of offer |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| storefrontCategoryNames | NO | The list contains storefront category name that need to query it's storefront category id from mediafirst.For example: web/Main/en-us/LiveTV. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| storefrontCategoryIds | The list contains storefront category id returned from mediafirst |
| mfRequestIds | The request ids, speparated by a comma, returned by MediaFirst |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| externalId | YES | The external id of the event. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| event | The json string of the event. |
| mfRequestId | The request id in MF. |
Get schedule for an event by schedule External ID.
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| eventExternalId | NO | |
| scheduleExternalId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| actualStartUtc | |
| actualEndUtc | |
| startUtc | |
| endUtc |
The GET operation returns Location resource using Location external id.
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| externalId | NO | External ID of the Location |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| locationType | The locationType for Location |
| ownerId | The ownerId for Location |
| name | The name for Location |
| address | The address for Location |
| description | The description for Location |
| city | The city for Location |
| state | The state for Location |
| country | The country for Location |
| culture | It is the languge of name, address, description, city, state, country |
| mfRequestId | The request id returned by MediaFirst |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| externalId | YES | The external id of the production. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| displayName | The display name of the production. |
| role | The role of the production |
| eventScheduleExternalId | The external id of the schedule. |
| qualityLevel | The quality level of the production. |
| mfRequestId | The request id returned by MF. |
| audioOnly | Its value can be true or false. |
| liveToOnDemand | Its value can be true or false. |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| externalId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfServiceCollectionId |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| externalId | YES | The external id of the team. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| name | The name of the team. |
| shortName | The short name of the team. |
| callLetters | The call letters of the team. |
| sortName | The sort name of the team. |
| mfRequestId | The request id returned by MF. |
| description | The description of the team. |
| league | The league of the team. |
| locationExternalId | The external id of the location. |
| conference | The conference of the team. |
| division | The division of the team. |
Get the title ingestion status in MF
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfTitleId | NO | #Required |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| status | The ingestion status of title |
| percentageCompleted | The completed percentage for ingestion |
| endUtc | The ingestion end time of title |
| mfRequestId | The request Id responded from MF |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfTitleId | NO | Title id in MediaFirst |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
| mfMatchStatus | Match status of the title returned by MediaFirst |
| mfSeriesId | Series id that Title belongs to in MediaFirst. If the Title is not part of Series, it will be an empty string. |
| mfEncodedTitles | The encoded titles generated by MF and each item is an json object string |
| mfUniversalProgramId | The Universal Program Id returned by MediaFirst |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| titleId1 | NO | |
| titleId2 | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfTitleId | MediaFirst title Id |
| mfTitleStatus | the title status shuld be these values: "Succeeded", "Failed", "Canceled", "Timeout". |
| mfRequestId | The request id returned by MediaFirst |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| successLogPathPrefix | NO | The configured success log |
| failureLogPathPrefix | NO | the configured failure log folder |
| titleNamePattern | NO | @param errorMessage : |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| errorMessage |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| startTime | NO | @param titleId : the title ID in MediaFirst format |
| mfTitleId | NO | the title ID in MediaFirst format |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| itemId | NO | The id of the item that is removed from the storefront category |
| itemType | NO | The type of the item that is removed from the storefront category |
| storefrontCategoryIds | NO | The id list contains the storefront category from which an item is removed |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestIds | The request ids, speparated by a comma, returned by MediaFirst |
| removedCategoryIds | The list contains the storefront category ids that are removed successfully |
| errorMsg | Error Message |
Remove serviceCollection from subscription
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| serviceCollectionId | NO | The service collection id from Mediafirst |
| mfSubscriptionIds | NO | A list of subscription id |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request Id responsed from Mediafirst |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfPackageId | NO | |
| mfTitleId | NO | @param mfPackageId : |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
Remove Title from Subscription Or Category
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfSubscriptionId | NO | Subscription id in MediaFirst |
| mfCategoryIds | NO | Category ids, separated by a comma, in MediaFirst |
| mfTitleId | NO | Title id in MediaFirst |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestIds | The request ids, speparated by a comma, returned by MediaFirst |
Remove a Title from Subscription
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfSubscriptionId | NO | subscription id in mediafirst |
| mfTitleId | NO | title id in mediafirst |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
Remove title from MF subscription or category
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfCategoryIds | NO | |
| mfTitleId | NO | |
| mfSubscriptionId | NO | |
| mfSeriesId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| isTVShow | |
| mfRequestId | |
| removeTVShow |
Remove TV Show from a Subscription
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfSubscriptionId | NO | Subscription id in MediaFirst |
| mfTvShowId | NO | TV Show id in MediaFirst |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
Remove TV Show from Subscription Or Category
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfSubscriptionId | NO | Subscription id in MediaFirst |
| mfCategoryIds | NO | Category ids, separated by a comma, in MediaFirst |
| mfTvShowId | NO | TV Show id in MediaFirst |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestIds | The request ids, speparated by a comma, returned by MediaFirst |
Unlink the given mediafirst title from a existing link.
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfTitleId | NO | Mediafirst title id |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfSeriesId | NO | series id in mediafirst |
| imageType | NO | image type |
| imagePath | NO | image path |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | mediafirst request id |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfSeriesId | NO | series id in mediafirst |
| name | NO | series name value |
| culture | NO | series culture value like en-us |
| description | NO | series description value |
| genres | NO | series genre names |
| startYear | NO | series publication year |
| endYear | NO | series license window end year |
| sortName | NO | series sort title name |
| roles | NO | series role and cast names. Note: not supported for this version! |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | mediafirst request id |
Update MF title deployment status.
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| deployedStatus | YES | Title deployment status to be updated. |
| mfTitleId | YES | MF title ID |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| imagePath | NO | the full file path of the image |
| imageType | NO | Poster or KeyArt |
| mfTitleId | NO | title id in mediafirst |
| imagePriority | NO | image priority. "Lowest" or "Hightest" |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
Updates the network associated with a title
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfTitleId | NO | |
| networkId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
Updates playback restrictions that are currently supported at the title level.
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfTitleId | NO | title id in mediafirst |
| restrictions | NO | |
| playbackDuration | NO | The time to limit playback. |
| storageDuration | NO | The time to limit storage. |
| drmProtectionSettings | NO | The DRM protection settings Json string. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
upload package image
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| mfPackageId | NO | mediafirst package id |
| imageType | NO | Image type: poster or keyArt |
| imagePath | NO | image path |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
REQUEST MESSAGE:
| Parameter Name | Required | Description / Value |
| imageType | NO | Type of the image. Can be one of |
| imagePath | NO | The location of image |
| mfSubscriptionId | NO | ID of the subscription. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfRequestId | The request id returned by MediaFirst |
| © MediaKind Inc, 2023. |
| All Rights Reserved. |