ZOFRI - SVE

Especificación Técnica de
WebService Generar Inventario

Versión 1.0
20/08/2010
 Tabla de Contenidos

1. Objetivo del Documento 3

1.1 Definiciones, Acrónimos y Abreviaciones 3
1.2 Referencias 3

2. WebService Generar Inventario 4

2.1 Objetivo 4
2.2 WSDL 4
2.3 Características del servicio 4

3. Métodos del WebService 5

3.1 WebMethod “emitirInformeInventario” 5
3.1.1 Objetivo 5
3.1.2 Descripción 5
3.1.3 Características del método 5
3.1.4 Formato de Parámetros de Entrada 5
3.1.5 Ejemplo XML de entrada del servicio 7
3.1.6 Formato de Parámetros de Salida 7
3.1.7 Ejemplo XML de salida del servicio 8

4. Mensajes informativos de respuestas del servicio 11

Especificación Técnica de WebService Generar Versión Template: 1.0 Fecha:20/08/10

Inventario
ZOFRI - SVE

Confidencial Página 2 de 11
1. Objetivo del Documento
El objetivo del presente documento consiste en exponer las especificaciones técnicas del
servicio web generar inventario para el Proyecto Servicios de Visación Electrónica -
ZOFRI.

1.1 Definiciones, Acrónimos y Abreviaciones

Definición Significado
WebMethod Método web que implementa una cierta funcionalidad dentro de un servicio
web.
WebService Servicio web que contiene WebMethods para poder brindar funcionalidad e
información de otros sistemas.

Acrónimo Significado
http Hypertext Transfer Protocol (Protocolo de transferencia de hipertexto)
SOAP Simple Object Access Protocol http://www.w3.org/TR/soap/
SVE Servicios de Visación Electrónica
XML Extensible Markup Language (Lenguaje de Marcas)

Abreviación Significado
No Aplica

1.2 Referencias
Título Fecha Autor
No Aplica

Especificación Técnica de WebService Generar Versión Template: 1.0 Fecha:20/08/10

Inventario
ZOFRI - SVE

Confidencial Página 3 de 11
2. WebService Generar Inventario

2.1 Objetivo

El objetivo del servicio es permitir que los usuarios: Usuario Empresa, Usuario Aduana,
Usuario Agente Aduana y Usuario Zofri, puedan obtener los inventarios: Actual, Mensual
y de Fecha de Corte a través de la aplicación SVE.

2.2 WSDL

El WSDL del servicio Web se encuentra en la siguiente dirección:

http://198.41.32.146/sveProcDocWSN/Emision?WSDL

2.3 Características del servicio

 Protocolo: HTTP

 Estándar: SOAP

 Seguridad: Autenticación previa de Usuario y Password para la obtención de

Token.

Especificación Técnica de WebService Generar Versión Template: 1.0 Fecha:20/08/10

Inventario
ZOFRI - SVE

Confidencial Página 4 de 11
3. Métodos del WebService

3.1 WebMethod “emitirInformeInventario”

3.1.1 Objetivo
Permitir que los usuarios: Usuario Empresa, Usuario Aduana, Usuario Agente Aduana y
Usuario Zofri, puedan obtener los inventarios: Actual, Mensual y de Fecha de Corte.

3.1.2 Descripción
Toda vez que un usuario desee emitir un inventario (mensual, actual o de fecha de
corte) podrá invocar al servicio mediante el cual el sistema SVE procesará dicha
solicitud, devolviéndole una respuesta del resultado de la ejecución llevada a cabo. Esta
respuesta incluye un documento adjunto (PDF, CSV o XML) en donde se presentará la
información solicitada según corresponda el caso.

3.1.3 Características del método

 Sentido: Usuarios ZOFRI  SVE

 Resultado: Síncrono.

 Pre-Condición: N/A.

 Implementador: ZOFRI S.A.

3.1.4 Formato de Parámetros de Entrada

Repetic Opcion
Nivel Estructura Tipo Dato Descripción
iones al
Corresponde al Rut de la empresa usuaria para la
Dv String cual se emitirá el informe.
Ejemplo:
0 1..1 S <wsn:rutEmpresa>
<java:Dv>1</java:Dv>
Nro Long <java:Nro>76048345</java:Nro>
</wsn:rutEmpresa>
Tipo de Formato de Salida del Inventario, esto
puede ser XML, PDF o CSV (Excel). En caso de que
no se informe o se informe uno incorrecto, el
0 tipoFormato String 1..1 S
formato de salida será XML.
Ejemplo
<wsn:tipoFormato>PDF</wsn:tipoFormato>
Corresponde a la fecha de corte en caso de que el
inventario sea por [F]echa de Corte.
0 fechaCorte Date 1..1 S Ejemplo:
<wsn:fechaCorte>2010-07-
30T10:10:10</wsn:fechaCorte>

Especificación Técnica de WebService Generar Versión Template: 1.0 Fecha:20/08/10

Inventario
ZOFRI - SVE

Confidencial Página 5 de 11
 Tipo del inventario ([A]ctual, [M]ensual, [F]echa
de Corte).
0 tipoInventario String 1..n S
Ejemplo:
<wsn:tipoInventario>M</wsn:tipoInventario>
Mes para el cual se requiere el inventario. Se
requiere cuando el tipoInventario es [M]ensual.
0 mes Integer 1..n S
Ejemplo:
<wsn:mes>7</wsn:mes>
Año para el cual se requiere el inventario. Se
requiere cuando el tipoInventario es [M]ensual.
0 anio Integer 1..1 S
Ejemplo:
<wsn:anio>2010</wsn:anio>

Código de Plantilla de Descriptores.

0 codigoPDM String 1..1 S Ejemplo:
<wsn:codigoPDM> </wsn:codigoPDM>

Código de Localidad.
Ejemplo:
0 codigoLocalidad String 1..1 S
<wsn:codigoLocalidad>ARI</wsn:codigoLocalidad
>
Nivel de Agrupación de tipo [U]bicación,
[L]ocalidad, [D]ocumento, [I]tem.
0 nivelAgrupacion String 1..1 S
Ejemplo:
<wsn:nivelAgrupacion>L</wsn:nivelAgrupacion>
Código Arancelario del item.
Ejemplo:
0 codigoArancelario String 1..1 S
<wsn:codigoArancelario>2</wsn:codigoArancelari
o>

Código de Dólar.
0 codigoDolar String 1..1 S Ejemplo:
<wsn:codigoDolar>13</wsn:codigoDolar>

Código de Estado del Documento.

codigoEstadoDocu Ejemplo:
0 String 1..1 S
mento <wsn:codigoEstadoDocumento>PENDIENTE</wsn
:codigoEstadoDocumento>

Stock Bloqueado, [S]i - [N]o.

0 stockBloqueado String 1..1 S Ejemplo:
<wsn:stockBloqueado>N</wsn:stockBloqueado>

Stock Disponible, [S]i - [N]o.

0 stockDisponible String 1..1 S Ejemplo:
<wsn:stockDisponible>S</wsn:stockDisponible>

Código de Tipo del Documento.

codigoTipoDocume Ejemplo:
0 String 1..1 S
nto <wsn:codigoTipoDocumento>101</wsn:codigoTip
oDocumento>
Código de Ubicacion.
Ejemplo:
0 codigoUbicacion String 1..1 S
<wsn:codigoUbicacion>RA-26-
019</wsn:codigoUbicacion>

Especificación Técnica de WebService Generar Versión Template: 1.0 Fecha:20/08/10

Inventario
ZOFRI - SVE

Confidencial Página 6 de 11
 Token de sesión
Ejemplo:
<cl:token>6b2377059511eb06a--c0502cb2-44-6-
0 token String 1..1 S d24e-3bdb bbe1-2f7d-2:d452a4254c0:6e15d-
b73a72585016b166-0c-5-2ab0-3426bd-49-
2b1b3bde -
6f1d627d15:a2224805671:d</cl:token>

NOTA: Para los Servicios Web Tipados que reciben parámetros de tipo String, Date o
BigDecimal, los mismos no admiten ser informados como opcionales ni nulos, en esos
casos se deberá utilizar los siguientes valores por defecto cuando se requiera no
informar un valor para el parámetro:

String: <texto></texto>
Date: <fecha>1900-01-01T00:00:00</fecha>
BigDecimal: <granDecimal>0</granDecimal>

3.1.5 Ejemplo XML de entrada del servicio

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cl="cl.zofri.sve"

xmlns:wsn="http://cl/zofri/sve/prd/wsn" xmlns:java="java:cl.zofri.sve.app.eo">
<soapenv:Header>
<cl:token>4a2df20b541f4e0a9--c5509961-94-e-c033-7a40 7e51-e848-2:149111b4599:0ba40-a6d922b040f1e1a4-0c-5-
9360-141e9c-31-0a907795 -1818724109:1bb1529407a:0</cl:token>
</soapenv:Header>
<soapenv:Body>
<wsn:emitirInformeInventario>
<wsn:rutEmpresa>
<java:Dv>2</java:Dv>
<java:Nro>15678839</java:Nro>
</wsn:rutEmpresa>
<wsn:tipoFormato>PDF</wsn:tipoFormato>
<wsn:fechaCorte>2010-07-30T10:10:10</wsn:fechaCorte>
<wsn:tipoInventario>A</wsn:tipoInventario>
<!--Optional:-->
<wsn:mes xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<!--Optional:-->
<wsn:anio xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<wsn:codigoPDM/>
<wsn:codigoLocalidad>IQQ</wsn:codigoLocalidad>
<wsn:nivelAgrupacion>L</wsn:nivelAgrupacion>
<wsn:codigoArancelario>444</wsn:codigoArancelario>
<wsn:codigoDolar>13</wsn:codigoDolar>
<wsn:codigoEstadoDocumento>VISADO</wsn:codigoEstadoDocumento>
<wsn:stockBloqueado>N</wsn:stockBloqueado>
<wsn:stockDisponible>N</wsn:stockDisponible>
<wsn:codigoTipoDocumento>101</wsn:codigoTipoDocumento>
<wsn:codigoUbicacion>RA-26-019</wsn:codigoUbicacion>
</wsn:emitirInformeInventario>
</soapenv:Body>
</soapenv:Envelope>

3.1.6 Formato de Parámetros de Salida

Tipo Repetici
Nivel Estructura Descripción
Dato ones

Especificación Técnica de WebService Generar Versión Template: 1.0 Fecha:20/08/10

Inventario
ZOFRI - SVE

Confidencial Página 7 de 11
 Código de respuesta para el documento enviado
4 ResCodigo String 1..1
al proceso de visación.

Mensaje que representa la respuesta de la

4 ResMensaje String 1..1
invocación al servicio de visación.

Severidad del mensaje de respuesta que

4 ResSeveridad String 1..1
devuelve el servicio.

emitirInformeInventarioRespo Documento adjunto que se genera al ejecutar el

4 Attach 1..1
nse servicio

3.1.7 Ejemplo XML de salida del servicio

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header>
<cl:token xmlns:cl="cl.zofri.sve">4327f90a5417460c9--b5b07941-94-3-4013-7846 7e81-e84d-
d:2411519499a:9bf45-367992a0407161c4-0b-b-7340-141394-11-08967798 -
181d7d4201:5b9192a497f:5</cl:token>
<cl:respuesta xmlns:cl="cl.zofri.sve">
<java:resCodigo xmlns:java="java:cl.zofri.sve.utl.bo">0</java:resCodigo>
<java:resMensaje xmlns:java="java:cl.zofri.sve.utl.bo">Se ejecutó correctamente el
servicio.</java:resMensaje>
<java:resSeveridad xmlns:java="java:cl.zofri.sve.utl.bo">O</java:resSeveridad>
</cl:respuesta>
</env:Header>
<env:Body>
<m:emitirInformeInventarioResponse xmlns:m="http://cl/zofri/sve/prd/wsn">
<return href="cid:return" xmlns="http://cl/zofri/sve/prd/wsn"/>
</m:emitirInformeInventarioResponse>
</env:Body>
</env:Envelope>

Especificación Técnica de WebService Generar Versión Template: 1.0 Fecha:20/08/10

Inventario
ZOFRI - SVE

Confidencial Página 8 de 11
A continuación se presenta un ejemplo de un XML de salida del servicio en forma gráfica
utilizando la herramienta SOAPUI, en donde se puede apreciar que en la pestaña
Attachments(1) (ver recuadro rojo) se generó el documento adjunto:

Para poder ver el documento generado, se debe seleccionar el icono , mismo que se
encuentra dentro el recuadro verde de la pantalla anterior.

Hecho esto, se desplegará una pantalla en la cual debe registrar el nombre y la

extensión del documento adjunto y luego presionar el botón Guardar, tal cual se
presenta en la siguiente pantalla:

Especificación Técnica de WebService Generar Versión Template: 1.0 Fecha:20/08/10

Inventario
ZOFRI - SVE

Confidencial Página 9 de 11
Presionado el botón Guardar, se desplegará el siguiente mensaje, del cual debe
seleccionar la opción “Si”

Presionada la opción mencionada, se desplegará el documento adjunto, para el caso del

ejemplo un PDF:

Especificación Técnica de WebService Generar Versión Template: 1.0 Fecha:20/08/10

Inventario
ZOFRI - SVE

Confidencial Página 10 de 11
4. Mensajes informativos de respuestas del servicio

Código Severidad Descripción

Mensaje (2)
(1)
0 O La operación se ejecutó exitosamente.
-1 E Se ha producido una excepción en el sistema. El servicio se
ejecutó con problemas.

(1) Códigos de Mensajes:

 0: OK
 -1: ERROR
 1 a 999999: WARNING

(2) Niveles de Severidad de los Mensajes:

 O: OK
 E: ERROR
 W: WARNING

Especificación Técnica de WebService Generar Versión Template: 1.0 Fecha:20/08/10

Inventario
ZOFRI - SVE

Confidencial Página 11 de 11