Upload service
Contents
Description of the interface
ComprobarServicio method
EnviarCatalogo method
EnviarIncremental method
EnviarBaja method
Data Structure ElementoError
Result codes
Introduction
Interface offered by Movistar to facilitate the sending of content catalogs to external platforms.
Description of the interface
This web service uses SOAP protocol, and is accessible through the following URLs:
Development environment:
https://pex1des.dof6.com/wsMovistarPEX.asmx
Production environment:
https://pex1.dof6.com/wsMovistarPEX.asmx
The web service provides the following methods for information exchange:
-
ComprobarServicio: Allows verifying the connection to the web service.
-
EnviarCatalogo: To send content catalogs.
-
EnviarIncremental: To send content additions and modifications.
-
EnviarBaja: To notify content cancellations.
ComprobarServicio method
By means of this method, it is possible to check if the web service is online.
Input parameters: None
Output parameters:
|
Name
|
Type
|
Description
|
|
Estado
|
String
|
Web service status
|
EnviarCatalogo method
This method is used to send a complete catalog of contents in an xml document. Since this is the complete catalog, the contents that have been sent previously and do not appear in this file will be considered as a cancellation and therefore deleted.
Input parameters:
|
Name
|
Type
|
Description
|
|
xmlCatalogo
|
xmlDocument
|
Catalog of contents in xml format
|
Output parameters:
|
Name
|
Type
|
Description
|
|
FechaCreacion
|
DateTime
|
xml document creation date
|
|
Catalogo
|
String
|
Catalog Type
|
|
Proveedor
|
String
|
Catalog provider
|
|
CanalVinculado
|
String
|
Movistar channel associated to the catalog
|
|
Codigo
|
Integer
|
Process result code
|
|
Mensaje
|
String
|
Process result message
|
|
ElementosError
|
ElementoError[]
|
Collection of objects ElementError
|
EnviarIncremental method
This method allows you to send additions and modifications of catalog contents in an xml document.
Input parameters:
|
Name
|
Type
|
Description
|
|
xmlIncremental
|
xmlDocument
|
Additions and modifications in xml format
|
Output parameters:
|
Name
|
Type
|
Description
|
|
FechaCreacion
|
DateTime
|
xml document creation date
|
|
Catalogo
|
String
|
Catalog type
|
|
Proveedor
|
String
|
Catalog provider
|
|
CanalVinculado
|
String
|
Movistar channel associated to the catalog
|
|
Codigo
|
Integer
|
Process result code
|
|
Mensaje
|
String
|
Process result message
|
|
ElementosError
|
ElementoError[]
|
Collection of objects ElementError
|
EnviarBaja method
This method allows sending catalog content deletions in an xml document. If the identifier of a grouping is reported, all the dependent contents of the grouping will be deleted in addition to the grouping itself. A grouper will not be deleted if the identifier of the grouper is not reported, even if all the dependent contents have been deleted.
Input parameters:
|
Name
|
Type
|
Description
|
|
xmlBaja
|
xmlDocument
|
Catalog downloads in xml format
|
Output parameters:
|
Name
|
Type
|
Description
|
|
FechaCreacion
|
DateTime
|
xml document creation date
|
|
Catalogo
|
String
|
Catalog type
|
|
Proveedor
|
String
|
Catalog provider
|
|
CanalVinculado
|
String
|
Movistar channel associated to the catalog
|
|
Codigo
|
Integer
|
Process result code
|
|
Mensaje
|
String
|
Process result message
|
|
ElementosError
|
ElementoError[]
|
Collection of objects ElementError
|
Data Structure ElementoError
It is used to record the result of the analysis of the elements of the received xml document.
The structure has the following fields:
|
Name
|
Type
|
Description
|
|
TipoElemento
|
String
|
Type of xml element analyzed
|
|
TipoMensaje
|
String
|
Can be warning or error
|
|
Id
|
String
|
Element identifier
|
|
Nombre
|
String
|
Element title or name
|
|
Descripcion
|
String
|
Details of the error or warning
|
|
IdContenedor
|
String
|
Parent element identifier
|
Result codes
Executions of the methods offered by the web service may return the following codes:
|
Code
|
Message
|
|
0
|
Correct execution
|
|
1
|
File processed with errors
|
|
-1
|
Error reading xml document
|
|
-2
|
Validation error
|
|
-10
|
Uncontrolled error
|
