SharePoint

Servicio de carga

Contenido

Descripción de la interfaz

Método ComprobarServicio

Método EnviarCatalogo

Método EnviarIncremental

Método EnviarBaja

Estructura de datos ElementoError

Códigos de resultado

Introducción

Interfaz ofrecida por Movistar para facilitar a las plataformas externas el envío de catálogos de contenidos.


Descripción de la interfaz

Este servicio web utiliza protocolo SOAP, y es accesible mediante las siguientes URL:

Entorno de desarrollo:

https://pex1des.dof6.com/wsMovistarPEX.asmx

Entorno de producción:

https://pex1.dof6.com/wsMovistarPEX.asmx


El servicio web ofrece los siguientes métodos para el intercambio de información:

  • ComprobarServicio: Permite verificar la conexión con el servicio web.
  • EnviarCatalogo: Para realizar el envío de catálogos de contenidos.
  • EnviarIncremental: Permite enviar altas y modificaciones de contenidos.
  • EnviarBaja: Para notificar bajas de contenidos.

Método ComprobarServicio

Por medio de este método se puede verificar si el servicio web está en línea.

Parámetros de entrada: No tiene

Parámetros de salida:

Nombre

Tipo

Descripción

Estado

String

Estado del servicio web

Método EnviarCatalogo

Este método sirve para enviar un catálogo completo de contenidos en un documento xml. Al tratarse del catálogo completo, los contenidos que se hubieran enviado con anterioridad y no figuren en este fichero, serán considerados como baja, y por tanto eliminados.

Parámetros de entrada:

Nombre

Tipo

Descripción

xmlCatalogo

xmlDocument

Catálogo de contenidos en formato xml

 

Parámetros de salida:

Nombre

Tipo

Descripción

FechaCreacion

DateTime

Fecha de creación del documento xml

Catalogo

String

Tipo de catálogo

Proveedor

String

Proveedor del catálogo

CanalVinculado

String

Canal Movistar asociado al catálogo

Codigo

Integer

Código del resultado del proceso

Mensaje

String

Mensaje del resultado del proceso

ElementosError

ElementoError[]

Colección de objetos ElementoError


Método EnviarIncremental

Este método permite enviar altas y modificaciones de contenidos del catálogo en un documento xml.

Parámetros de entrada:

Nombre

Tipo

Descripción

xmlIncremental

xmlDocument

Altas y modificaciones en formato xml

 

Parámetros de salida:

Nombre

Tipo

Descripción

FechaCreacion

DateTime

Fecha de creación del documento xml

Catalogo

String

Tipo de catálogo

Proveedor

String

Proveedor del catálogo

CanalVinculado

String

Canal Movistar asociado al catálogo

Codigo

Integer

Código del resultado del proceso

Mensaje

String

Mensaje del resultado del proceso

ElementosError

ElementoError[]

Colección de objetos ElementoError


Método EnviarBaja

Este método permite enviar bajas de contenidos del catálogo en un documento xml. Si se informa el identificador de un agrupador, se eliminarán además del propio agrupador, todos los contenidos dependientes del mismo. Un agrupador no será eliminado si no se informa el identificador del mismo, aunque se hayan dado de baja todos los contenidos dependientes.

Parámetros de entrada:

Nombre

Tipo

Descripción

xmlBaja

xmlDocument

Bajas del catálogo en formato xml

 

Parámetros de salida:

Nombre

Tipo

Descripción

FechaCreacion

DateTime

Fecha de creación del documento xml

Catalogo

String

Tipo de catálogo

Proveedor

String

Proveedor del catálogo

CanalVinculado

String

Canal Movistar asociado al catálogo

Codigo

Integer

Código del resultado del proceso

Mensaje

String

Mensaje del resultado del proceso

ElementosError

ElementoError[]

Colección de objetos ElementoError


Estructura de datos ElementoError

Se utiliza para registrar el resultado del análisis de los elementos del documento xml recibido.

La estructura tiene los siguientes campos:

Nombre

Tipo

Descripción

TipoElemento

String

Tipo de elemento xml analizado

TipoMensaje

String

Puede ser aviso o error

Id

String

Identificador del elemento

Nombre

String

Título o nombre del elemento

Descripcion

String

Detalle del error o aviso

IdContenedor

String

Identificador del elemento padre


Códigos de resultado

Las ejecuciones de los métodos ofrecidos por el servicio web pueden devolver los siguientes códigos:

Código

Mensaje

0

Ejecución correcta

1

Fichero procesado con errores

-1

Error de lectura del documento xml

-2

Error de validación

-10

Error no controlado