CU - BUSCAR LISTAS DE DISTRIBUCIÓN

Permite buscar listas de distribución en base a un criterio de búsqueda. Si se desea, el resultado de la búsqueda se podrá obtener paginado para evitar resultados masivos. En caso de éxito, la operación devolverá una lista conteniendo todas las listas de distribución solicitadas. En caso de error, se devuelve un Fault indicando el error producido (véase sección “Lista distribución Exception”).

Interfaz

diagram
Figure 1. Interfaz

Entrada del servicio

A continuación se muestra el modelo de datos que se utiliza cuando se desea invocar a esta operación.

diagram
Figure 2. Modelo de datos utilizado

A continuación se detallan cada uno de los parámetros pasados en la invocación de la operación.

Parámetro Descripción Tipo

uriTercero

URI del tercero por el cual se desea ralizar la búsqueda. Si este parámetro es añadido, el servicio dará todas aquellas listas de distribución en las que el tercero sea miembro de ella.

String

nombreListaDistribucion

Nombre asignado a la lista de distribución por el cual se desea hacer la búsqueda de las listas de distribución.

String

fechaVigencia

Fecha en la cual la lista de distribución será vigente. Si este parámetro es rellenado, el servicio devolverá aquellas listas de distribución que será vigentes en la fecha pasada.

Date

borrada

Permite restringir la búsqueda de las listas de distribución a aquellas que se hayan borrado o no.

Boolean

posicionPrimerResultado

Posición del primer resultado a devolver en aquellas búsquedas en que se desee paginación.

Int

numeroResultados

Máximo número de resultados devueltos en la búsqueda.

Int

Un ejemplo típico de invocación de esta operación es el que se muestra a continuación.

Ejemplo de entrada.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
             xmlns:ser="http://platino.gobcan.es/servicios/edmyce/listasdistribucion"
             xmlns:dom="http://platino.gobcan.es/servicios/edmyce/dominio/listasdistribucion">
  <soapenv:Header/>
  <soapenv:Body>
    <ser:buscarListasDistribucion>
      <ser:criterioBusqueda>
        <dom:uriTercero>platino://gobcan.es/servicios/terceros/xxx-xxx-xxx</dom:uriTercero>
      </ser:criterioBusqueda>
    </ser:buscarListasDistribucion>
  </soapenv:Body>
</soapenv:Envelope>

Salida del servicio

A continuación se muestra el modelo de datos que devuelve el Servicio en respuesta a una invocación con éxito de esta operación.

diagram
Figure 3. Campos de la respuesta como un diagrama de clases

A continuación se detallan cada uno de los parámetros devueltos tras la invocación de la operación.

Parámetro Descripción Tipo

nombreListaDistribucion

Nombre asignado a la lista de distribución. Este nombre debe de ser único, es decir, un organismo no puede crear dos listas de distribución con el mismo nombre, tiene un tamaño máximo de 255 caracteres.

String

descripcion

Descripción asociada al área. Debe de contener como máximo 4000 caracteres.

String

fechaInicioVigencia

Fecha en la cual la lista de distribución empieza a ser vigente.

Date

fechaFinVigencia

Fecha en la cual la lista de distribución finaliza.

Date

uriListaDistribucion

URI que identifica unívocamente a la lista de distribución.

String

borrada

Indica si la lista de distribución esta marcada como borrada o no.

Boolean

numeroTotalResultados

Número total de listas de distribución que concuerdan con la búsqueda seleccionada. Nótese que este valor puede o no coincidir con el número total de listas de distribución devuelto en la consulta, que viene fijado por numeroResultados.

Int

Un ejemplo típico de respuesta de esta operación es el que se muestra a continuación.

Ejemplo de salida
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
             xmlns:ser="http://platino.gobcan.es/servicios/edmyce/listasdistribucion"
             xmlns:dom="http://platino.gobcan.es/servicios/edmyce/dominio/listasdistribucion">
  <soapenv:Header/>
  <soapenv:Body>
    <ser:buscarListasDistribucionResponse>
      <ser:resultado>
        <ser:listasDistribucion>
          <dom:listaDistribucion>
            <dom:nombreListaDistribucion>NombreListaDistribucion_1</dom:nombreListaDistribucion>
            <dom:descripcion>Descripción NUEVA</dom:descripcion>
            <dom:fechaInicioVigencia>2008-01-01</dom:fechaInicioVigencia>
            <dom:fechaFinVigencia>2009-01-01</dom:fechaFinVigencia>
            <dom:uriListaDistribucion>platino://gobcan.es/servicios/edmyce/listaDistribucion/xxx-xxx-xxx</dom:uriListaDistribucion>
            <dom:borrada>false</dom:borrada>
          </dom:listaDistribucion>
        </ser:listasDistribucion>
        <ser:numeroTtalResultados>1</ser:numeroTtalResultados>
      </ser:resultado>
    </ser:buscarListasDistribucionResponse>
  </soapenv:Body>
</soapenv:Envelope>