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 | Blank Value Allowed? | Description / Value |
| mfPackageId | NO | |
| mfTitleId | NO | @param mfPackageId : |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Add a Title to Subscription
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| mfSubscriptionId | NO | subscription id in mediafirst |
| mfTitleId | NO | title id in mediafirst |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Create or Update Package Offer by Id
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | 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 |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
create or update package with id
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| mfPackageId | NO | |
| name | NO | 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. |
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 | Blank Value Allowed? | 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 |
Create or Update Title Offer by Id
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | 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. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Create Package Offer
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | 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 |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| offerId |
create package without id
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | 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 |
Create an offer for title.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | 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 |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| offerId |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | 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. |
Delete package
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| mfPackageId | NO | package id from mediafirst |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| mfTitleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Forces a title offer to expire.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| mfTitleId | NO | title id in mediafirst |
| offerId | NO | id of offer |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfTitleId | MediaFirst title Id |
| mfTitleStatus | the title status shuld be these values: "Succeeded", "Failed", "Canceled", "Timeout". |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | 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 | Blank Value Allowed? | 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 | Blank Value Allowed? | Description / Value |
| mfPackageId | NO | |
| mfTitleId | NO | @param mfPackageId : |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Remove a Title from Subscription
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| mfSubscriptionId | NO | subscription id in mediafirst |
| mfTitleId | NO | title id in mediafirst |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| imagePath | NO | the full file path of the image |
| imageType | NO | Poster or KeyArt |
| mfTitleId | NO | title id in mediafirst |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Updates the network associated with a title
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| mfTitleId | NO | |
| networkId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Updates playback restrictions that are currently supported at the title level.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| mfTitleId | NO | title id in mediafirst |
| restrictions | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
upload package image
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| mfPackageId | NO | mediafirst package id |
| imageType | NO | Image type: poster or keyArt |
| imagePath | NO | image path |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | 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 |
| © 2002 - 2017 Ericsson Television Inc. |
| All Rights Reserved. |