Cada una de las secciones de este tema proporciona varios ejemplos de solicitudes y respuestas para diferentes cargas útiles de las API de Avails.
Ejemplos de PutAvailsAPI
Ejemplo de solicitud PutAvailsFullExtract para un episodio de un canal SVOD
En este ejemplo se muestra cómo realizar una operación PutAvailsFullExtract para una combinación de título, línea de negocio y territorio para dos canales de suscripción diferentes. El primer canal tiene dos periodos de disponibilidad y el segundo canal tiene uno solo.
Carga útil de la primera solicitud:
{
"avail": {
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"ALID": "demoALID",
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "demoALID",
"WorkType": "Episode",
"EpisodeMetadata": {
"TitleInternalAlias": [
"Avail Strikes Back: Season 1, Episode 2"
],
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Avail Strikes Back: Season 1"
],
"SeasonNumber": {
"Number": 1
},
"NumberOfEpisodes": 77
},
"SeriesMetadata": {
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"Avail Strikes Back"
],
"NumberOfSeasons": 4
}
}
}
],
"Transaction": [
{
"_TransactionID": "availId123",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "mgm_plus_subscription"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
},
{
"_TransactionID": "availId456",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "mgm_plus_subscription"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": false
}
]
}
]
}
}
Carga útil de la segunda solicitud:
{
"avail": {
"ALID": "demoALID_For_Season_01",
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "demoALID_For_Season_01",
"WorkType": "Season",
"SeasonMetadata": {
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Avail Strikes Back: Season 1"
],
"SeasonNumber": {
"Number": 1
},
"NumberOfEpisodes": 77,
"SeriesMetadata": {
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"Avail Strikes Back"
],
"NumberOfSeasons": 4
}
}
}
],
"Transaction": [
{
"_TransactionID": "availId789season",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "SD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "A4K"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": false
}
]
}
]
}
}
Ejemplo de solicitud PutAvailsFullExtract para una película FVOD
Este ejemplo muestra cómo realizar una operación PutAvailsFullExtract para una combinación de título, línea de negocio y territorio para una película gratuita.
Carga útil de la solicitud:
{
"avail": {
"ALID": "demoALID",
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "demoALID",
"WorkType": "Movie",
"Metadata": {
"TitleInternalAlias": [
"Harry Potter and Marge Simpson"
]
}
}
],
"Transaction": [
{
"_TransactionID": "availId123movie",
"LicenseType": "FVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "FVOD"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
},
{
"_TransactionID": "availId456movie",
"LicenseType": "FVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "FVOD"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "Exclusive",
"Boolean": false
}
]
}
]
}
}
Ejemplo de solicitud PutAvailsFullExtract para una película TVOD
Este ejemplo muestra cómo realizar una operación PutAvailsFullExtract para una combinación de título, línea de negocio y territorio para una película TVOD. Este ejemplo contiene los tipos de licencia EST, VOD y POEST.
Carga útil de la solicitud:
{
"avail": {
"ALID": "demoALID",
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "demoALID",
"WorkType": "Movie",
"Metadata": {
"TitleInternalAlias": [
"Harry Potter and Marge Simpson"
]
}
}
],
"Transaction": [
{
"_TransactionID": "availId123movie",
"LicenseType": "VOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "SRP",
"Money": {
"value": 8.99,
"_currency": "USD"
}
},
{
"_termName": "WSP",
"Money": {
"value": 7.99,
"_currency": "USD"
}
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
},
{
"_TransactionID": "availId456movie",
"LicenseType": "EST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "SRP",
"Money": {
"value": 19.99,
"_currency": "USD"
}
},
{
"_termName": "WSP",
"Money": {
"value": 18.99,
"_currency": "USD"
}
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "Exclusive",
"Boolean": false
},
{
"_termName": "AnnounceDate",
"Event": "2022-05-22T10:00:00Z"
}
]
},
{
"_TransactionID": "availId789movie",
"LicenseType": "POEST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "SRP",
"Money": {
"value": 18.99,
"_currency": "USD"
}
},
{
"_termName": "WSP",
"Money": {
"value": 17.99,
"_currency": "USD"
}
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "Exclusive",
"Boolean": false
},
{
"_termName": "AnnounceDate",
"Event": "2022-05-22T10:00:00Z"
},
{
"_termName": "SuppressionLiftDate",
"Event": "2022-07-24T10:00:00Z"
}
]
}
]
}
}
Ejemplo de solicitud PutAvailsPartialExtract para una película TVOD
Este ejemplo muestra cómo realizar una operación PutAvailsPartialExtract para una combinación de título y territorio utilizando TransactionID como identificador del periodo de disponibilidad.
Carga útil de la solicitud:
{
"avail": {
"ALID": "demoALID",
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Disposition": {
"EntryType": "PartialExtract"
},
"Licensor": {
"DisplayName": "prodtest"
},
"Asset": [
{
"_contentID": "demoALID",
"WorkType": "Movie",
"Metadata": {
"TitleInternalAlias": [
"Harry Potter and Marge Simpson"
]
}
}
],
"Transaction": [
{
"_TransactionID": "availId123movie",
"LicenseType": "VOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "SRP",
"Money": {
"value": 8.99,
"_currency": "USD"
}
},
{
"_termName": "WSP",
"Money": {
"value": 7.99,
"_currency": "USD"
}
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
}
]
}
}
Ejemplo de PutAvailsPartialExtract
REQUEST
Method: PUT
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/transactions/demoTransactionId
Body:
{
"avail": {
"Transaction": [
{
"Territory": [
{
"country": "US"
}
],
"Start": "2023-03-14T09:00:00Z",
"FormatProfile": {
"value": "UHD"
},
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "prime"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
],
"End": "2029-05-22T10:00:00Z",
"ContractID": "CPH",
"_TransactionID": "demoTransactionId",
"LicenseRightsDescription": "DAB",
"HoldbackLanguage": [
{
"_asset": "subtitle",
"value": "fr-CA"
},
{
"_asset": "audio",
"value": "fr-CA"
}
],
"LicenseType": "SVOD",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
]
}
],
"ALID": "demoAlid",
"Disposition": {
"EntryType": "PartialExtract"
},
"Asset": [
{
"EpisodeMetadata": {
"TitleInternalAlias": [
"Test Title Name"
],
"SeriesMetadata": {
"NumberOfSeasons": 4,
"SeriesTitleInternalAlias": [
"Test Series Title Name"
],
"SeriesContentID": "demoALID_For_Series"
},
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"NumberOfEpisodes": 77,
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Test Season Title Name"
],
"SeasonNumber": {
"Number": 1
}
}
},
"WorkType": "Episode",
"_contentID": "demoAlid"
}
],
"Licensor": {
"DisplayName": "testlicensor"
}
}
}
RESPONSE
StatusCode: 200
Body:
{
"success": true,
"validationErrors": []
}
Ejemplo de lote de PutAvailsPartialExtract
REQUEST
Method: POST
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/batch/put
Body:
{
"requestItems": [
{
"requestItemId": "TestRequest1",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId1",
"body": {
"avail": { ... }
}
},
{
"requestItemId": "TestRequest2",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId2",
"body": {
"avail": { ... }
}
}
]
}
RESPONSE
StatusCode: 200
Body:
{
"responseItems": [
{
"requestItemId": "TestRequest1",
"success": true
},
{
"requestItemId": "TestRequest2",
"success": true
}
]
}
Ejemplos de GetAvailsAPI
Ejemplo de GetAvailsFullExtract
REQUEST
Method: GET
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/full-extract/demoAlid?territory=US&businessLine=PRIME_SUBSCRIPTION
RESPONSE
StatusCode: 200
Body:
{
"avail": {
"ALID": "demoAlid",
"Asset": [
{
"EpisodeMetadata": {
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"NumberOfEpisodes": 77,
"SeasonContentID": "demoALID_For_Season_01",
"SeasonNumber": {
"Number": 1
},
"SeasonTitleInternalAlias": [
"AvailStrikesBack:Season1"
]
},
"SeriesMetadata": {
"NumberOfSeasons": 4,
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"AvailStrikesBack"
]
},
"TitleInternalAlias": [
"TestTitleName"
]
},
"WorkType": "Episode",
"_contentID": "demoAlid"
}
],
"Licensor": {
"DisplayName": "testlicensor"
},
"Transaction": [
{
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"ContractID": "CPH",
"End": "2029-05-22T10:00:00Z",
"FormatProfile": {
"value": "UHD"
},
"HoldbackLanguage": [
{
"_asset": "subtitle",
"value": "fr-CA"
},
{
"_asset": "audio",
"value": "fr-CA"
}
],
"LicenseRightsDescription": "DAB",
"LicenseType": "SVOD",
"Start": "2023-03-14T09:00:00Z",
"Terms": [
{
"Text": "prime",
"_termName": "ChannelIdentity"
},
{
"Text": "Yes",
"_termName": "Download"
},
{
"Duration": "PT720H",
"_termName": "RentalDuration"
},
{
"Duration": "PT48H",
"_termName": "WatchDuration"
},
{
"Money": {
"_currency": "USD",
"value": 15.99
},
"_termName": "SRP"
},
{
"Boolean": true,
"_termName": "Exclusive"
},
{
"_termName": "ExclusiveAttributes"
}
],
"Territory": [
{
"country": "US"
}
]
}
]
},
"success": true
}
Ejemplo de GetAvailsPartialExtract
REQUEST
Method: GET
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/transactions/demoTransactionId
RESPONSE
StatusCode: 200
Body:
{
"avail": {
"Transaction": [
{
"Territory": [
{
"country": "US"
}
],
"Start": "2023-03-14T09:00:00Z",
"FormatProfile": {
"value": "UHD"
},
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "prime"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
],
"End": "2029-05-22T10:00:00Z",
"ContractID": "CPH",
"_TransactionID": "demoTransactionId",
"LicenseRightsDescription": "DAB",
"HoldbackLanguage": [
{
"_asset": "subtitle",
"value": "fr-CA"
},
{
"_asset": "audio",
"value": "fr-CA"
}
],
"LicenseType": "SVOD",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
]
}
],
"ALID": "demoAlid",
"Disposition": {
"EntryType": "PartialExtract"
},
"Asset": [
{
"EpisodeMetadata": {
"TitleInternalAlias": [
"Test Title Name"
],
"SeriesMetadata": {
"NumberOfSeasons": 4,
"SeriesTitleInternalAlias": [
"Test Series Title Name"
],
"SeriesContentID": "demoALID_For_Series"
},
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"NumberOfEpisodes": 77,
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Test Season Title Name"
],
"SeasonNumber": {
"Number": 1
}
}
},
"WorkType": "Episode",
"_contentID": "demoAlid"
}
],
"Licensor": {
"DisplayName": "testlicensor"
}
}
}
Ejemplo de lote de GetAvailsPartialExtract
REQUEST
Method: POST
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/batch/get
Body:
{
"requestItems": [
{
"requestItemId": "TestRequest1",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId1"
},
{
"requestItemId": "TestRequest2",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId2"
}
]
}
RESPONSE
StatusCode: 200
Body:
{
"responseItems": [
{
"avail": { ... },
"requestItemId": "TestRequest1",
"success": true
},
{
"avail": { ... },
"requestItemId": "TestRequest2",
"success": true
}
]
}
Ejemplos de DeleteAvailsAPI
Ejemplo de DeleteAvailsFullExtract
REQUEST
Method: Delete
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/full-extract/demoAlid?territory=US&businessLine=PRIME_SUBSCRIPTION&contractId=CPH
RESPONSE:
{
"success": true
}
Ejemplo de DeleteAvailsPartialExtract
REQUEST
Method: Delete
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/transactions/demoTransactionId
RESPONSE:
{
"success": true
}
Ejemplo de lote de DeleteAvailsPartialExtract
REQUEST
Method: POST
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/batch/delete
Body:
{
"requestItems": [
{
"requestItemId": "TestRequest1",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId1"
{
"requestItemId": "TestRequest2",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId2"
}
]
}
RESPONSE
StatusCode: 200
Body:
{
"responseItems": [
{
"requestItemId": "TestRequest1",
"success": true
},
{
"requestItemId": "TestRequest2",
"success": true
}
]
}
Ejemplos de ValidateAvailsAPI
Ejemplo de ValidateAvailsFullExtract
REQUEST
Method: POST
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/full-extract/demoAlid/validate
Body:
{
"avail": {
"ALID": "demoAlid",
"Asset": [
{
"EpisodeMetadata": {
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"NumberOfEpisodes": 77,
"SeasonContentID": "demoALID_For_Season_01",
"SeasonNumber": {
"Number": 1
},
"SeasonTitleInternalAlias": [
"AvailStrikesBack:Season1"
]
},
"SeriesMetadata": {
"NumberOfSeasons": 4,
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"AvailStrikesBack"
]
},
"TitleInternalAlias": [
"TestTitleName"
]
},
"WorkType": "Episode",
"_contentID": "demoAlid"
}
],
"Licensor": {
"DisplayName": "testlicensor"
},
"Transaction": [
{
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"ContractID": "CPH",
"End": "2029-05-22T10:00:00Z",
"FormatProfile": {
"value": "UHD"
},
"HoldbackLanguage": [
{
"_asset": "subtitle",
"value": "fr-CA"
},
{
"_asset": "audio",
"value": "fr-CA"
}
],
"LicenseRightsDescription": "DAB",
"LicenseType": "SVOD",
"Start": "2023-03-14T09:00:00Z",
"Terms": [
{
"Text": "prime",
"_termName": "ChannelIdentity"
},
{
"Text": "Yes",
"_termName": "Download"
},
{
"Duration": "PT720H",
"_termName": "RentalDuration"
},
{
"Duration": "PT48H",
"_termName": "WatchDuration"
},
{
"Money": {
"_currency": "USD",
"value": 15.99
},
"_termName": "SRP"
},
{
"Boolean": true,
"_termName": "Exclusive"
},
{
"_termName": "ExclusiveAttributes"
}
],
"Territory": [
{
"country": "US"
}
]
}
]
}
}
RESPONSE
StatusCode: 200
Body:
{
"success": true,
"validationErrors": []
}
Ejemplo de ValidatePartialFullExtract
REQUEST
Method: POST
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/transactions/demoTransactionId/validate
Body:
{
"avail": {
"Transaction": [
{
"Territory": [
{
"country": "US"
}
],
"Start": "2023-03-14T09:00:00Z",
"FormatProfile": {
"value": "UHD"
},
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "prime"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
],
"End": "2029-05-22T10:00:00Z",
"ContractID": "CPH",
"_TransactionID": "demoTransactionId",
"LicenseRightsDescription": "DAB",
"HoldbackLanguage": [
{
"_asset": "subtitle",
"value": "fr-CA"
},
{
"_asset": "audio",
"value": "fr-CA"
}
],
"LicenseType": "SVOD",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
]
}
],
"ALID": "demoAlid",
"Disposition": {
"EntryType": "PartialExtract"
},
"Asset": [
{
"EpisodeMetadata": {
"TitleInternalAlias": [
"Test Title Name"
],
"SeriesMetadata": {
"NumberOfSeasons": 4,
"SeriesTitleInternalAlias": [
"Test Series Title Name"
],
"SeriesContentID": "demoALID_For_Series"
},
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"NumberOfEpisodes": 77,
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Test Season Title Name"
],
"SeasonNumber": {
"Number": 1
}
}
},
"WorkType": "Episode",
"_contentID": "demoAlid"
}
],
"Licensor": {
"DisplayName": "testlicensor"
}
}
}
RESPONSE
StatusCode: 200
Body:
{
"success": true,
"validationErrors": []
}
Ejemplo de lote de ValidatePartialFullExtract
REQUEST
Method: POST
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/batch/validate
Body:
{
"requestItems": [
{
"requestItemId": "TestRequest1",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId1/validate",
"body": {
"avail": { ... }
}
{
"requestItemId": "TestRequest2",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId2/validate",
"body": {
"avail": { ... }
}
}
]
}
RESPONSE
StatusCode: 200
Body:
{
"responseItems": [
{
"requestItemId": "TestRequest1",
"success": true
},
{
"requestItemId": "TestRequest2",
"success": true
}
]
}
Ejemplos de Avail
Ejemplo de Avail de la temporada de suscripción a Prime
{
"avail": {
"ALID": "demoAlid",
"Disposition": {
"EntryType": "PartialExtract"
},
"Licensor": {
"DisplayName": "testLicensor"
},
"Asset": [
{
"_contentID": "demoAlid",
"WorkType": "Season",
"SeasonMetadata": {
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Example: Season 1"
],
"SeasonNumber": {
"Number": 1
},
"NumberOfEpisodes": 77,
"SeriesMetadata": {
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"Example"
],
"NumberOfSeasons": 4
}
}
}
],
"Transaction": [
{
"_TransactionID": "demoTransactionId",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "prime"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
}
]
}
}
Ejemplo de Avail de canales SVOD
{
"avail": {
"ALID": "demoAlid",
"Disposition": {
"EntryType": "PartialExtract"
},
"Licensor": {
"DisplayName": "testLicensor"
},
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Asset": [
{
"_contentID": "demoAlid",
"WorkType": "Episode",
"EpisodeMetadata": {
"TitleInternalAlias": [
"Example: Season 1, Episode 2"
],
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Example: Season 1"
],
"SeasonNumber": {
"Number": 1
},
"NumberOfEpisodes": 77
},
"SeriesMetadata": {
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"Example"
],
"NumberOfSeasons": 4
}
}
}
],
"Transaction": [
{
"_TransactionID": "exampleTransactionId",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "exampleBenefitId"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
}
]
}
}
Ejemplo de Avail de una película FVOD
{
"avail": {
"ALID": "demoAlid",
"Disposition": {
"EntryType": "PartialExtract"
},
"Licensor": {
"DisplayName": "testLicensor"
},
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Asset": [
{
"_contentID": "demoAlid",
"WorkType": "Movie",
"Metadata": {
"TitleInternalAlias": [
"Example Movie Title"
]
}
}
],
"Transaction": [
{
"_TransactionID": "exampleTransactionId",
"LicenseType": "FVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "FIXED_FEE",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "FVOD"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "Exclusive",
"Boolean": false
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
}
]
}
}
Ejemplo de Avail de una película TVOD
{
"avail": {
"ALID": "demoAlid",
"Disposition": {
"EntryType": "PartialExtract"
},
"Licensor": {
"DisplayName": "testLicensor"
},
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Asset": [
{
"_contentID": "demoAlid",
"WorkType": "Movie",
"Metadata": {
"TitleInternalAlias": [
"Example Movie Title"
]
}
}
],
"Transaction": [
{
"_TransactionID": "exampleTransactionId",
"LicenseType": "VOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "SRP",
"Money": {
"value": 8.99,
"_currency": "USD"
}
},
{
"_termName": "WSP",
"Money": {
"value": 7.99,
"_currency": "USD"
}
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
}
]
}
}