EditorService

/editor/v1/job/{id}

Mount Point: /editor/v1/job/{id}

GET

Obtenir le résultat de l'intégration des produits par id:
Cette activité est disponible aux éditeurs. Après un envoi réussi d’un flux de produits, l’éditeur doit appeler ce service pour obtenir le résultat du traitement de son flux. La fréquence d'appel à ce service doit être conforme au paramètre poll renvoyé dans l'objet jobParams. Si le flux est en cours ou en attente d'intégration le retour est 204 (no content).

Parameters

name description type default
id Requis. L'id du flux retourné dans l'objet jobParams. path

Response Body

element: job
media types: application/json

Job: L'objet Job contenant la réponse de l'intégration des produits.

/editor/v1/product/{idEditor}/{idProductEditor}

Mount Point: /editor/v1/product/{idEditor}/{idProductEditor}

DELETE

Permet de supprimer un produit par son id :
Cette activité est disponible aux éditeurs. Après l'envoi de l'id à cette méthode, le produit est supprimé et déréfenrencé de l'oeuvre

Parameters

name description type default
idEditor Requis. L'id de l'éditeur. path
idProductEditor Requis. L'id du produit de l'éditeur. path

Response Body

element: (custom)
media types: application/json

Http response.

/editor/v1/products

Mount Point: /editor/v1/products

POST

Intègre les produits:
Cette activité est disponible aux éditeurs. Un éditeur envoie son flux par un appel à ce service, la réponse sera un objet jobParams contenant l'id du flux de produits envoyé ainsi que la période de polling à attendre pour vérifier les résultats de l'intégration.
Ce traitement du flux sera déclenché ultérieurement par le système. Ainsi, l’éditeur doit appeler l’API de vérification afin d’obtenir le résultat du traitement.

diagrame

Dans les attributs de l’editorTitle, afin de matcher


Request Body

element: editorProductsFeed
media types: application/json

Requis. Liste de Produits que l'éditeur veut intégrer.

Response Body

element: jobParams
media types: application/json

jobParams: L'objet jobParams.

GET

Obtenir la liste des produits pour un editeur.
La réponse sera les fiches complètes des produits (dont l'ID oeuvre) pour l'editeur.

Parameters

name description type default
start Optionnel. Numéro du premier product renvoyé. query 0
rsz Optionnel. Nombre de produit par page. query 4

Response Body

element: responseDataEditorProducts
media types: application/json

ResponseDataEditorProducts: Une liste paginé des produits pour l'éditeur.

/editor/v1/products/{idEditor}

Mount Point: /editor/v1/products/{idEditor}

DELETE

Permet de supprimer l'ensemble des produits d'un editeur.
Cette activité est disponible aux éditeurs. Les produits sont supprimés et déréfenrencés des oeuvres

Parameters

name description type default
idEditor Requis. L'id de l'éditeur. path

Response Body

element: (custom)
media types: application/json

Http response.

/editor/v1/products/{idEditor}/{idProductEditor}

Mount Point: /editor/v1/products/{idEditor}/{idProductEditor}

DELETE

Permet de supprimer l'ensemble des produits d'une oeuvre pour un editeur.
Elle se base sur l'un des identifiants des produits de cette oeuvre. Cette activité est disponible aux éditeurs. Après l'envoi de l'id à cette méthode, les produits sont supprimés et déréfenrencés de l'oeuvre

Parameters

name description type default
idEditor Requis. L'id de l'éditeur. path
idProductEditor Requis. L'id d'un des produits de l'éditeur. path

Response Body

element: (custom)
media types: application/json

Http response.

/editor/v1/title/{id}

Mount Point: /editor/v1/title/{id}

GET

Obtenir une oeuvre (par id) et ses produits pour un editeur.
La réponse sera la fiche complète d’une oeuvre avec toutes les métadonnées publiques ainsi que tous les produits VoD/DVD disponibles pour l'editeur.

Parameters

name description type default
id Requis. L'id de l'oeuvre. path

Response Body

element: title
media types: application/json

Http response.