Sistema de Información de Sanidad Exterior (SISAEX IV) Servicio Web de Presentación de Declaraciones por parte de los Operadores Económicos Descripción Funcional 25 de Abril de 2007
Contenido CONTENIDO...2 1. INTRODUCCIÓN...3 2. DESCRIPCIÓN DEL SERVICIO WEB...4 2.1. FIRMA DIGITAL DE LAS PETICIONES...5 2.2. DOCUMENTACIÓN ADJUNTA...7 2.3. COMPRESIÓN DE DATOS...8 3. INFORMACIÓN ASOCIADA A UNA DECLARACIÓN...9 ANEXO I. FICHERO DECLARACION.XSD...17 ANEXO II. FICHERO DECLARACIONES.WSDL...32 ANEXO III. CÓDIGOS DE RESULTADO DEVUELTOS POR EL SERVICIO WEB...33 ANEXO IV. CAMBIOS EN EL ESQUEMA RESPECTO A LA VERSIÓN ANTERIOR...35 CAMBIO EN EL NAMESPACE...36 DIRECCIONES DE ENTREGA...37 DOCUMENTOS SANITARIOS / VETERINARIOS...38 DOCUMENTACIÓN ADJUNTA...39 APELLIDOS DE LOS OPERADORES ECONÓMICOS...40 MEDIO DE TRANSPORTE...41 NUEVO TIPO LISTOFDELIVERYADDRESS...42 NUEVO TIPO LISTOFVETERINARYDOCUMENTS...43 NUEVOS TIPOS PARA ANEXAR DOCUMENTOS...44 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 2 de 45
1. Introducción Este documento recoge el Análisis Funcional del Servicio Web de Presentación de. Esta funcionalidad se engloba dentro del del Sistema de Información de Sanidad Exterior (SISAEX IV) del Ministerio de Sanidad y Consumo. El objetivo de este Servicio Web es permitir a los operadores económicos enviar al Módulo de Mercancías y Operadores Económicos toda la información correspondiente a la declaración (Parte 1 del DOCSM) de una manera automática, aprovechando las propias aplicaciones de gestión de los operadores económicos, y sin tener que volver a introducir los datos en SISAEX IV. En los anexos del presente documento se incluyen los dos ficheros que definen este Servicio Web: declaracion.xsd: donde se definen los tipos de datos. declaraciones.wsdl: donde se define el esquema de llamada al Servicio Web. 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 3 de 45
2. Descripción del Servicio Web Existen dos maneras de incorporar la información de las declaraciones telemáticas realizadas por los operadores económicos: Directamente en la aplicación, accediendo a la página web de SISAEX IV: https://sisaex4.msc.es. Mediante la recepción de las declaraciones a través de un Servicio Web ubicado en los servidores del MSC. En este documento se describe la segunda de estas alternativas. El Servicio Web estará publicado en las siguientes direcciones. Pilotaje: https://saexpiloto.msc.es/mercancias/webservices/registradeclaracionport?wsdl Producción: https://sisaex4.msc.es/mercancias/webservices/registradeclaracionport?wsdl De estas direcciones se puede descargar además la última versión disponible de los ficheros de definición del Servicio Web. La última versión del fichero de definición del esquema XSD está disponible en la dirección: https://saexpiloto.msc.es/mercancias/declaracion.xsd La llamada al Servicio Web se hará mediante el protocolo SOAP basado en Document (adjunto se proporciona la versión actual del esquema). Será necesaria una llamada por cada declaración a presentar. En esta llamada irán incluidos todos los datos necesarios de la declaración. El sistema devolverá un código de resultado cuyos valores se especifican en el Anexo 3 y, en caso de ser necesario, un texto con más información. 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 4 de 45
2.1. Firma Digital de las Peticiones Las peticiones enviadas deberán ser firmadas digitalmente. La firma digital será añadida después de haber completado toda la información, y deberá abarcar todo el documento. Se seguirá la propuesta para firma digital SOAP Security Extensions Digital Signature (http://www.w3.org/tr/soap-dsig/). Siguiendo este esquema, la petición será del tipo: <SOAP-ENV:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header> <SOAP-SEC:Signature xmlns:soap-sec="http://schemas.xmlsoap.org/soap/security/2000-12" SOAP-ENV:actor="some-URI" SOAP-ENV:mustUnderstand="1"> <ds:signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#"> <ds:signedinfo> <ds:canonicalizationmethod Algorithm="http://www.w3.org/TR/2000/CR-xml-c14n-20001026"> </ds:canonicalizationmethod> <ds:signaturemethod Algorithm="http://www.w3.org/2000/09/xmldsig#dsa-sha1"/> <ds:reference URI="#Body"> <ds:transforms> <ds:transform Algorithm="http://www.w3.org/TR/2000/CR-xml-c14n-20001026"/> </ds:transforms> <ds:digestmethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/> <ds:digestvalue>j6lwx3rvepo0vktmup4nbevu8nk=</ds:digestvalue> </ds:reference> </ds:signedinfo> <ds:signaturevalue>mc0cffrvltrlk=...</ds:signaturevalue> <ds:keyinfo> <ds:x509data> <!-- certificate chain --> <!--Signer cert, issuer CN=arbolCA,OU=FVT,O=IBM,C=US, serial 4--> <ds:x509certificate>miicxtcca..</ds:x509certificate> </ds:x509data> </ds:keyinfo> </ds:signature> </SOAP-SEC:Signature> </SOAP-ENV:Header> <SOAP-ENV:Body xmlns:soap-sec="http://schemas.xmlsoap.org/soap/security/2000-12" SOAP-SEC:id="Body">... </SOAP-ENV:Body> </SOAP-ENV:Envelope> Si el certificado digital utilizado para la conexión HTTPS no es el mismo utilizado para la firma de la petición (por ejemplo en el caso del DNI digital, que dispone de dos certificados diferentes, uno para autenticación y otro para firma digital) será obligatorio incluir el elemento KeyInfo, que contenga el certificado X509 con el que se firma (únicamente la parte pública) para permitir la posterior verificación. 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 5 de 45
Para facilitar las pruebas, en el entorno de pilotaje no será necesario firmar las peticiones. Sin embargo si se elige firmarlas se exigirá que sean correctas. De esta forma se garantiza que la firma digita no interfiere en el desarrollo del Servicio Web y que la firma digital se desarrolla de forma correcta. Los errores producidos durante la verificación de la firma digital se devolverán mediante faults de soap. Para este efecto se ha incluido en la descripción del servicio dos faults: FirmaDigitalIncorrectaFault, que será lanzada cuando se produzca un error en la verificación de la firma. Siempre que sea posible se incluirá un mensaje descriptivo del error. FirmaDigitalObligatoriaFault, que será lanzada en el entorno de producción cuando no se reciba firma digital. Como se ha comentado antes no será lanzada nunca en el entorno de pilotaje. 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 6 de 45
2.2. Documentación Adjunta Es posible el envío de documentación adjunta relativa al expediente. Esta documentación puede referirse, por ejemplo, a los impresos de tasa o facturas relativas a la mercancía. El fichero deberá tener como tipo tiff, jpg, gif o pdf. El tamaño máximo de los documentos a adjuntar será de 2 Mb, y se codificarán en Base 64. 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 7 de 45
2.3. Compresión de Datos El Servicio Web está preparado para recibir las peticiones comprimidas usando la codificación GZIP del estándar HTTP. La compresión se puede realizar tanto en la petición como en la respuesta. Aunque actualmente no es obligatorio utilizar esta opción, sí es altamente recomendable, con el fin de optimizar la utilización de la red, tanto del cliente como del MSC, y mejorar los tiempos de respuesta. Además es posible que en futuras versiones del Servicio Web sea obligatoria su utilización. Para indicar que el contenido de la petición está comprimido, se deberá utilizar la cabecera HTTP Content-Encoding: Content-Encoding: gzip Del mismo modo, para indicar que está preparado para recibir la respuesta comprimido, se deberá incluir la cabecera Accept-Encoding: Accept-Encoding: gzip 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 8 de 45
3. Información Asociada a una Declaración En este capítulo se describe la información asociada a la declaración que está contenida en el fichero XML. Tipo complejo: declaracion exportador Exportador EconomicOperator PifRah Código del Puesto de Inspección Fronterizo o del Recinto Aduanero Habilitado donde se presenta la declaración CompetentAuthorityCode string (7) CentroInspeccion Centro de inspección InspectionCenterCode String(4) destinatario Destinatario EconomicOperator Interesado Interesado en la carga EconomicOperator importador Importador EconomicOperator paisdeorigen País de origen CountryISOCode string (2) paisdeprocedencia País de procedencia CountryISOCode string (2) direccionesdeentrega Lista de direcciones de entrega de la mercancía ListOfDeliveryAddresses fechallegada Fecha de llegada de la mercancía Timestamp 1 documentosveterinarios Lista de Documentos Sanitarios/Veterinarios ListOfVeterinaryDocuments establecimientosdeorigen Lista de establecimientos de origen ListOfEstablishmentsOfOrigin mediotransporte Medio de transporte MeansOfTransport Productos Lista de productos ListOfCommodities contenedores Lista de contenedores y precintos ListOfSealsContainers destinodeclarado Destino declarado de la mercancía DeclaratedDestiny conformeconue Si la mercancía es conforme con la UE SatisfactoryCheck enumerado 2 fechadeclaracion Fecha de la declaración DateOfDeclaration documentosadjuntos Lista de documentos anexos ListOfAttachments 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 9 de 45
1 String con el formato: aaaa-mm-dd hh:mm 2 Valores posibles: satisfactory, notsatisfactory Tipo complejo: EconomicOperator Nif NIF/NIE/CIF del operador económico NIF string (12) Nombre Nombre del operador económico EOName string (100) direccionoperador Dirección del operador económico Address Tipo Tipo de operador económico EOType Enumerado 1 numautorizacion Nº autorización del operador económico ApprovalNumber string (20) 1 Valores posibles: responsible, importer, exporter, other Tipo complejo: Address Calle Nombre de la calle Street string (255) Ciudad Ciudad y código postal City codigoisopais Código ISO del país CountryISOCode string (2) Tipo complejo: City codpostal Código postal PostalCode string (15) Nombre Nombre de la ciudad CityName string (50) 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 10 de 45
Tipo complejo: ListOfDeliveryAddresses direccionentrega Dirección de entrega DeliveryAddress Tipo complejo: DeliveryAddress Direccion Dirección de entrega Address numautorizacion Nº autorización de la dirección de entrega ApprovalNumber string (20) Tipo complejo: ListOfVeterinaryDocuments documentoveterinario Documento Sanitario / Veterinario VeterinaryDocument Tipo complejo: VeterinaryDocument Numero Número del documento VeterinaryDocumentNumber string (32) fechaexpedicion Fecha de expedición Date 1 1 Formato: aaaa-mm-dd Tipo complejo: ListOfEstablishmentsOfOrigin establecimientoorigen Establecimiento de origen EstablishmentOfOrigin 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 11 de 45
Tipo complejo: EstablishmentOfOrigin Nombre Nombre del establecimiento de origen EstablishmentName string (32) Tipo Tipo de establecimiento de origen EOType Enumerado 1 numautorizacion Nº autorización establecimiento de origen ApprovalNumber string (20) codigoisopais País del establecimiento CountryISOCode string(2) 1 Valores posibles: responsible, importer, exporter, other Tipo complejo: MeansOfTransport Medio Tipo de medio de transporte MeansType Enumerado 1 identificacion Identificación del medio de transporte Identification string (32) numconocimiento Número de conocimiento o partida Document string (32) numvagonvehiculoremolque Número de vagón/vehículo/remolque WagonNumber String(20) 1 Valores posibles: tren, avion, buque, carretera Tipo complejo: ListOfCommodities Producto Producto Commodity 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 12 de 45
Tipo complejo: Commodity Temperature Temperatura de conservación Temperature enumerado 1 Package Bultos Packages CommodityCode Código TARIC del producto CommodityCode string (10) GrossWeight Peso bruto 2 nonnegativedecimal NetWeight Peso neto 2 nonnegativedecimal 1 Valores posibles: refrigerado, congelado, ambiente 2 En kilogramos, con un máximo de dos decimales (separados por un punto) Tipo complejo: Packages numbultos Número de bultos nonnegativeinteger tipobultos Tipo de bulto TypeOfPackaging string (20) Tipo complejo: ListOfSealsContainers precintocontenedor Combinación nº contenedor y nº precinto SealContainer Tipo complejo: SealsContainer Precinto Número de precinto SealNumber string (32) contenedor Número de contenedor ContainerNumber string (20) 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 13 de 45
Tipo complejo: DeclaratedDestiny Deberá ser uno de los siguientes valores: transbordoa Si la mercancía realiza trasbordo a otro PIF de la UE o a un país tercero TranshipmentTo Transito Si la mercancía está destinada al tránsito a un país tercero TransitToThirdCountry parareimportacion Si la mercancía es para reimportación ForReImport paramercadointerior Si la mercancía es para mercado interior ForInternalMarket paramercanciasnoconformes Si la mercancía es no conforme ForNonConformingConsignments Tipo complejo: TranshipmentTo Deberá ser uno de los siguientes valores: Pif PIF de destino del trasbordo CompetentAuthorityCode string (7) paistercero País tercero de destino del trasbordo CountryISOCode string (2) Tipo complejo: TransitToThirdCountry Deberá ser uno de los siguientes valores: paistercero País tercero de destino del tránsito CountryISOCode string (2) pifsalida PIF de salida del tránsito CompetentAuthorityCode string (7) Tipo complejo: ForInternalMarket Tipo Tipo de mercado interior InternalMarketType Enumerado 1 descripcionextra Descripción del uso en caso de seleccionar tipo de mercado interior otro string (150) 1 Valores posibles: consumohumano, alimentacionanimal, usofarmaceutico, usotecnico, otro Tipo complejo: ForReImport 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 14 de 45
Nombre Nombre del establecimiento EstablishmentName string (32) direccionestablecimiento Dirección del establecimiento Address numautorizacion Nº autorización del establecimiento ApprovalNumber string (20) Tipo complejo: ForNonConformingConsignments destinonoconforme Tipo de destino de la mercancía NonConformingConsignmentValue enumerado 1 identificacion Número de destino de la mercancía RegisteredNumber string (20) puerto Puerto, si el destino es un buque Port string (20) 1 Valores posibles: depositoaduanero, zonafranca, provisionistamaritimo, buque Tipo complejo: DateOfDeclaration Name Nombre del operador económico Name string (100) SignatureDate Fecha de firma de la declaración Date 1 1 Formato: aaaa-mm-dd Tipo complejo: ListOfAttachments Adjunto Documento adjunto Attachment 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 15 de 45
Tipo complejo: Attachment Nombre Nombre del archivo, incluida la extensión FileName string (100) Tipo Tipo de documento adjunto DocumentType int descripción Descripción del documento adjunto DocumentDescription string (100) fichero Fichero propiamente dicho, codificado en Base64 y con un tamaño máximo de 2Mb File xbase64binar y (2097152) 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 16 de 45
Anexo I. Fichero declaracion.xsd <xs:schema xmlns="http://sisaex4.msc.es/sisaexns" xmlns:xs="http://www.w3.org/2001/xmlschema" targetnamespace="http://sisaex4.msc.es/sisaexns" elementformdefault="qualified"> <xs:element name="peticion" type="peticionregistro"> <xs:element name="respuesta" type="response"> <xs:complextype name="peticionregistro"> Petición de registro de una o varias declaraciones <xs:element name="xmlschemaversion" type="xmlschemaversion"> <xs:element name="fechaenvio" type="timestamp"> <xs:element name="expediente" type="declaracion" maxoccurs="1"> <xs:complextype name="response"> Respuesta proporcionada por el sistema a una petición de registro <xs:element name="fechaenvio" type="timestamp"> Se corresponde con la fecha de envío de la petición <xs:element name="codigorespuesta" type="xs:int"> <xs:element name="descrrespuesta" type="xs:string"> <xs:complextype name="declaracion"> Describe los detalles de la declaración presentada <xs:element name="exportador" type="economicoperator"> <xs:element name="pifrah" type="competentauthoritycode"> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 17 de 45
minoccurs="0"> minoccurs="0"> <xs:element name="centroinspeccion" type="inspectioncentercode" <xs:element name="destinatario" type="economicoperator"> <xs:element name="interesado" type="economicoperator"> <xs:element name="importador" type="economicoperator"> <xs:element name="paisdeorigen" type="countryisocode"> <xs:element name="paisdeprocedencia" type="countryisocode"> <xs:element name="direccionesdeentrega" type="listofdeliveryaddresses" <xs:element name="fechallegada" type="timestamp"> <xs:element name="documentosveterinarios" type="listofveterinarydocuments"> <xs:element name="establecimientosdeorigen" type="listofestablishmentsoforigin" minoccurs="0"> <xs:element name="mediotransporte" type="meansoftransport"> <xs:element name="productos" type="listofcommodities"> <xs:element name="contenedores" type="listofsealscontainers" minoccurs="0"> <xs:element name="destinodeclarado" type="declarateddestiny"> <xs:element name="conformeconue" type="satisfactorycheck"> <xs:element name="fechadeclaracion" type="dateofdeclaration"> <xs:element name="documentosadjuntos" minoccurs="0" type="listofattachments"> <xs:complextype name="declarateddestiny"> Destino declaraco de la mercancía <xs:choice> <xs:element name="transbordoa" type="transhipmentto"> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 18 de 45
<xs:element name="transito" type="transittothirdcountry"> <xs:element name="parareimportacion" type="forreimport"> <xs:element name="paramercadointerior" type="forinternalmarket"> <xs:element name="paramercanciasnoconformes" type="fornonconformingconsignments"> </xs:choice> <xs:complextype name="economicoperator"> El operador económico es un Actor del sistema: Exportador, Importador, etc. <xs:element name="nif" type="nif"> <xs:element name="nombre" type="eoname"> <xs:element name="direccionoperador" type="address"> <xs:element name="tipo" type="eotype" minoccurs="0"> <xs:element name="numautorizacion" type="approvalnumber" minoccurs="0"> <xs:simpletype name="eoname"> Nombre del Operador económico <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="100"></xs:maxlength> <xs:simpletype name="eotype"> Tipo del operador económico <xs:restriction base="xs:nmtoken"> <xs:enumeration value="responsible"></xs:enumeration> <xs:enumeration value="importer"></xs:enumeration> <xs:enumeration value="exporter"></xs:enumeration> <xs:enumeration value="other"></xs:enumeration> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 19 de 45
<xs:simpletype name="approvalnumber"> Número de autorización del operador <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="20"></xs:maxlength> <xs:simpletype name="nif"> NIF/NIE/CIF del operador económico <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="12"></xs:maxlength> <xs:complextype name="address"> Dirección <xs:element name="calle" type="street"> <xs:element name="ciudad" type="city"> <xs:element name="codigoisopais" type="countryisocode"> <xs:simpletype name="street"> Nombre de la calle <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="255"></xs:maxlength> <xs:complextype name="city"> Ciudad y código postal <xs:element name="codpostal" type="postalcode" minoccurs="0"> <xs:element name="nombre" type="cityname"> <xs:simpletype name="postalcode"> Representa un código postal 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 20 de 45
<xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="15"></xs:maxlength> <xs:simpletype name="cityname"> Nombre de la ciudad <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="50"></xs:maxlength> <xs:simpletype name="countryisocode"> Código ISO de dos caracteres: BE, FR, NL,... <xs:restriction base="xs:string"> <xs:pattern value="[a-z][a-z]"></xs:pattern> <xs:simpletype name="competentauthoritycode"> Código Animo del PIF / RAH. El tamaño es de 7 dígitos para los Pifs y cuatro para los Rah <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="7"></xs:maxlength> <xs:simpletype name="inspectioncentercode"> Código del Centro de Inpeccción, Si el pif dispusiera de el <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="4"></xs:maxlength> <xs:complextype name="veterinarydocument"> Documento Sanitario/Veterinario <xs:element name="numero" type="veterinarydocumentnumber"> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 21 de 45
<xs:element name="fechaexpedicion" type="date"> <xs:simpletype name="veterinarydocumentnumber"> Número de documento Sanitario/Veterinario <xs:restriction base="xs:string"> <xs:minlength value="1"> </xs:minlength> <xs:maxlength value="32"></xs:maxlength> <xs:complextype name="listofestablishmentsoforigin"> Lista de establecimientos de origen <xs:element maxoccurs="unbounded" name="establecimientoorigen" type="establishmentoforigin"> <xs:complextype name="establishmentoforigin"> Establecimiento de Origen <xs:element name="nombre" type="establishmentname"> <xs:element name="tipo" type="eotype" minoccurs="0"> <xs:element name="numautorizacion" type="approvalnumber"> <xs:element name="codigoisopais" type="countryisocode"> <xs:simpletype name="establishmentname"> Nombre de un establecimiento de origen <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="32"></xs:maxlength> <xs:complextype name="meansoftransport"> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 22 de 45
Medio de transporte <xs:element name="medio" type="meanstype"> <xs:element name="identificacion" type="identification"> <xs:element name="numconocimiento" type="document" minoccurs="0"> <xs:element name="numvagonvehiculoremolque" type="wagonnumber" minoccurs="0"> <xs:simpletype name="meanstype"> Tipo de medio de tranporte <xs:restriction base="xs:nmtoken"> <xs:enumeration value="tren"></xs:enumeration> <xs:enumeration value="avion"></xs:enumeration> <xs:enumeration value="buque"></xs:enumeration> <xs:enumeration value="carretera"></xs:enumeration> <xs:simpletype name="identification"> Identificación del medio de transporte <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="32"></xs:maxlength> <xs:simpletype name="document"> Nº de conocimiento o partida dependiendiendo del tipo de transporte <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="32"></xs:maxlength> <xs:simpletype name="wagonnumber"> Número de vagón/vehículo/remolque 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 23 de 45
<xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="20"></xs:maxlength> <xs:complextype name="packages"> Bultos <xs:element name="numbultos" type="nonnegativeinteger"> <xs:element name="tipobultos" type="typeofpackaging"> <xs:simpletype name="typeofpackaging"> Tipo de los bultos <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="20"></xs:maxlength> <xs:simpletype name="temperature"> Temperatura de conservacón <xs:restriction base="xs:nmtoken"> <xs:enumeration value="refrigerado"></xs:enumeration> <xs:enumeration value="congelado"></xs:enumeration> <xs:enumeration value="ambiente"> </xs:enumeration> <xs:simpletype name="commoditycode"> Código Taric del producto <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="10"></xs:maxlength> <xs:complextype name="listofcommodities"> Lista de productos 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 24 de 45
<xs:element maxoccurs="unbounded" name="producto" type="commodity"> <xs:complextype name="commodity"> Producto incluido en un expediente <xs:element name="temperature" type="temperature"> <xs:element name="package" type="packages"> <xs:element name="commoditycode" type="commoditycode"> <xs:element name="grossweight" type="nonnegativedecimal"> <xs:element name="netweight" type="nonnegativedecimal"> <xs:complextype name="listofsealscontainers"> Lista de combinaciones Precinto / Contenedor <xs:element maxoccurs="unbounded" name="precintocontenedor" type="sealcontainer"> <xs:complextype name="sealcontainer"> Combinación de un número de contenedor y un número de precinto <xs:element name="precinto" type="sealnumber"> <xs:element name="contenedor" type="containernumber"> <xs:simpletype name="sealnumber"> Número de precinto <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="20"></xs:maxlength> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 25 de 45
<xs:simpletype name="containernumber"> Número de contenedor <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="20"></xs:maxlength> <xs:complextype name="transhipmentto"> Usado cuando la mercancía realiza transbordo a otro pif de la unión o a un país tercero <xs:choice> <xs:element name="pif" type="competentauthoritycode"> <xs:element name="paistercero" type="countryisocode"> </xs:choice> <xs:complextype name="transittothirdcountry"> La mercancía está destinada al transito a un país tercero. Será necesario indicar el pif de salida de la unión europea y el país final de destino de la mercancía <xs:element name="paistercero" type="countryisocode"> <xs:element name="pifsalida" type="competentauthoritycode"> <xs:complextype name="forinternalmarket"> Para mercado interior <xs:element name="tipo" type="internalmarkettype"/> <xs:element name="descripcionextra" type="xs:string"> Obligatorio completar este campo si el tipo de mercado interior es 'otro' <xs:simpletype name="internalmarkettype"> Tipo de mercado interior <xs:restriction base="xs:nmtoken"> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 26 de 45
<xs:enumeration value="consumohumano"></xs:enumeration> <xs:enumeration value="alimentacionanimal"></xs:enumeration> <xs:enumeration value="usofarmaceutico"></xs:enumeration> <xs:enumeration value="usotecnico"></xs:enumeration> <xs:enumeration value="otro"></xs:enumeration> <xs:complextype name="forreimport"> Para reimportación <xs:element name="nombre" type="establishmentname"> <xs:element name="direccionestablecimiento" type="address"> <xs:element name="numautorizacion" type="approvalnumber"> <xs:complextype name="fornonconformingconsignments"> Para partidas no conformes <xs:element name="destinonoconforme" type="nonconformingconsignmentvalue"> <xs:element name="identificacion" type="registerednumber"> <xs:element name="puerto" type="port" minoccurs="0"> <xs:simpletype name="registerednumber"> Número del destino de la mercancía no conforme <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="20"></xs:maxlength> <xs:simpletype name="port"> Nombre del puerto si el destino de la mercancía no conforme es un buque <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 27 de 45
<xs:maxlength value="20"></xs:maxlength> <xs:simpletype name="nonconformingconsignmentvalue"> Tipo de destino de mercancía no conforme <xs:restriction base="xs:nmtoken"> <xs:enumeration value="depositoaduanero"> </xs:enumeration> <xs:enumeration value="zonafranca"></xs:enumeration> <xs:enumeration value="provisionistamaritimo"> </xs:enumeration> <xs:enumeration value="buque"></xs:enumeration> <xs:complextype name="deliveryaddress"> Dirección de entrega <xs:element name="direccion" type="address"> <xs:element name="numautorizacion" type="approvalnumber"> <xs:complextype name="dateofdeclaration"> Person filling the details of the consignment presented <xs:element name="name" type="name"> <xs:element name="signaturedate" type="date"> <xs:simpletype name="satisfactorycheck"> Satisfactory check <xs:restriction base="xs:nmtoken"> <xs:enumeration value="satisfactory"></xs:enumeration> <xs:enumeration value="notsatisfactory"></xs:enumeration> <xs:simpletype name="nonnegativedecimal"> Non negative decimal format <xs:restriction base="xs:decimal"> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 28 de 45
<xs:simpletype name="nonnegativeinteger"> Non negative integer format <xs:restriction base="xs:int"> <xs:minexclusive value="0"></xs:minexclusive> <xs:simpletype name="date"> Date format <xs:restriction base="xs:date"> <xs:pattern value="\d{4}-\d{2}-\d{2}"></xs:pattern> <xs:simpletype name="name"> Name of an Economic Operator <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="100"></xs:maxlength> <xs:simpletype name="timestamp"> Timestamp format <xs:restriction base="xs:datetime"> <xs:pattern value="\d{4}-\d{2}-\d{2} \d{2}:\d{2}"> </xs:pattern> <xs:simpletype name="xmlschemaversion"> Version of the XML Schema used to validate the XML file <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="32"></xs:maxlength> <xs:simpletype name="userauthenticationstring"> String object that may hold a user name or a user password <xs:restriction base="xs:string"> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 29 de 45
<xs:minlength value="5"></xs:minlength> <xs:maxlength value="80"></xs:maxlength> <xs:complextype name="listofdeliveryaddresses"> Lista de direcciones de entrega <xs:element maxoccurs="unbounded" name="direccionentrega" type="deliveryaddress"> <xs:complextype name="listofveterinarydocuments"> Lista de documentos Sanitario/veterinarios <xs:element maxoccurs="unbounded" name="documentoveterinario" type="veterinarydocument"> <xs:complextype name="listofattachments"> Lista de documentos anexos a una declaración <xs:element maxoccurs="unbounded" name="adjunto" type="attachment"> <xs:complextype name="attachment"> Documento anexo a una declaración <xs:element name="nombre" type="filename"> <xs:element name="tipo" type="documenttype"> <xs:element name="descripcion" type="documentdescription"> <xs:element name="fichero" type="file"> <xs:simpletype name="filename"> Nombre del fichero adjuntado. Sólo están permitidas las extensiones.jpg,.gif,.tif,.tiff y.pdf 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 30 de 45
<xs:restriction base="xs:string"> <xs:minlength value="4"></xs:minlength> <xs:maxlength value="100"></xs:maxlength> <xs:simpletype name="documenttype"> Código del tipo de documento. <xs:restriction base="xs:int"> <xs:minexclusive value="0"/> <xs:maxexclusive value="1000"/> <xs:simpletype name="documentdescription"> Descripción (en texto libre) del documento <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="100"></xs:maxlength> <xs:simpletype name="file"> Fichero codificado en Base64, con una longitud máxima de 2Mb (2097152 bytes) <xs:restriction base="xs:base64binary"> <xs:maxlength value="2097152"></xs:maxlength> </xs:schema> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 31 de 45
Anexo II. Fichero declaraciones.wsdl <?xml version="1.0" encoding="utf-8"?> <wsdl:definitions xmlns:wsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xs="http://www.w3.org/2001/xmlschema" xmlns:tns="sisaexns" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:ssx="sisaexns" targetnamespace="sisaexns" name="sisaexwebservice"> <wsdl:types> <xs:schema attributeformdefault="qualified" elementformdefault="qualified" targetnamespace="sisaexns"> <xs:import namespace="sisaexns" schemalocation="declaracion.xsd"/> </xs:schema> </wsdl:types> <wsdl:message name="registradeclaracionin"> <wsdl:part name="data" element="ssx:peticion" /> </wsdl:message> <wsdl:message name="registradeclaracionout"> <wsdl:part name="data" element="ssx:respuesta" /> </wsdl:message> <wsdl:porttype name="registradeclaracionport"> <wsdl:operation name="registradeclaracion"> <wsdl:input message="tns:registradeclaracionin" /> <wsdl:output message="tns:registradeclaracionout" /> </wsdl:operation> </wsdl:porttype> <wsdl:binding name="registradeclaracionbinding" type="tns:registradeclaracionport"> <wsoap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document" /> <wsdl:operation name="registradeclaracion"> <wsoap:operation soapaction="" style="document" /> <wsdl:input> <wsoap:body use="literal" /> </wsdl:input> <wsdl:output> <wsoap:body use="literal" /> </wsdl:output> </wsdl:operation> </wsdl:binding> <wsdl:service name="registradeclaracionservice"> <wsdl:port name="registradeclaracionport" binding="tns:registradeclaracionbinding"> <wsoap:address location="http://localhost:8000/pruebaservicioweb/services/pruebaservicioweb.wsdl" /> </wsdl:port> </wsdl:service> </wsdl:definitions> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 32 de 45
Anexo III. Códigos de Resultado Devueltos por el Servicio Web CÓDIGO NOMBRE DESCRIPCIÓN 0 PETICION_REGISTRADA El expediente ha sido correctamente registrado en el sistema. En la descripción se devuelve el número de expediente asignado por SISAEX 1 ERROR_USUARIO_NO_AUTORIZADO El usuario no está autorizado para el envío de declaraciones en ese recinto (tanto si es un PIF como si es un RAH). Esto puede suceder porque el usuario correspondiente al certificado digital con el que se envía la declaración no tiene los permisos adecuados o no está autorizado en el recinto en cuestión 2 ERROR_USUARIO_PENDIENTE La solicitud de alta del usuario no ha sido aún tramitada 3 ERROR_USUARIO_RECHAZADO La solicitud de alta ha sido tramitada, y el usuario rechazado 4 ERROR_NIF_INCORRECTO El NIF/CIF especificado en el exportador, el importador, el interesado o el destinatario es incorrecto. Se incluye como descripción de la respuesta el campo que ha provocado el error; por ejemplo: El NIF del destinatario es incorrecto 5 ERROR_PRODUCTO_DESCONOCIDO Uno de los productos enviados no se encuentra en la base de datos de SISAEX 6 ERROR_PRODUCTO_NO_VALIDO Uno de los productos no es válido en el recinto. Puede producirse si el producto no es susceptible de inspección, si el producto es OA y el recinto un RAH, si el producto es NOA y el recinto un PIF o si el producto está repetido 7 ERROR_TIPO_BULTO_DESCONOCIDO El tipo de bulto no se encuentra en la base de datos 8 ERROR_PESOS_INCORRECTOS En alguno de los productos el peso neto es mayor que el peso bruto 9 ERROR_CENTRO_INSPECCION_DESCONOCID O El Centro de Inspección no se encuentra en la base de datos de SISAEX 10 ERROR_CAMPO_OBLIGATORIO Se produce un error de validación de campos del expediente. Se incluye una descripción del error; por ejemplo: Los campos Temperatura, Nº de Bultos, Peso Bruto y Peso Neto son obligatorios El campo País de Procedencia es obligatorio Si se detectan varios errores de este tipo, se pueden devolver todos ellos, separados entre sí por ; Se devuelven también con este código de error los errores en la secuencia de fechas; por ejemplo: "El campo Fecha de Llegada no puede ser inferior al día actual" 100 ERROR_DESCONOCIDO Error no controlado en los casos anteriores, por ejemplo cuando la petición no se ajusta al esquema XSD, o cuando existe algún error en los servidores del MSC. Si es un problema en la petición se adjunta un texto descriptivo del problema, aunque como este texto lo proporciona directamente el sistema el texto está en inglés. 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 33 de 45
Además, es posible recibir también respuestas http estándar, y las aplicaciones que se conecten al Servicio Web deberían estar preparadas para tratarlas. En particular si el certificado digital no es correcto (no es de alguna de las entidades certificadoras aceptadas por el MSC) o el usuario no está registrado en SISAEX, se recibirá el error 403 (Forbiden). Esto es así porque por seguridad, el control del acceso al sistema lo realiza un componente diferente de la aplicación. 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 34 de 45
Anexo IV. Cambios en el Esquema Respecto a la Versión Anterior Se relacionan en este Anexo todos los cambios realizados en el esquema declaracion.xsd, para facilitar la adaptación a la nueva versión del Servicio Web. 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 35 de 45
Cambio en el Namespace El namespace pasa a ser http://sisaex4.msc.es/sisaexns en vez de únicamente SisaexNS. Además los elementos pasan a ser por defecto qualified : Antes <xs:schema xmlns="sisaexns" xmlns:xs="http://www.w3.org/2001/xmlschema" targetnamespace="sisaexns"> Ahora <xs:schema xmlns="http://sisaex4.msc.es/sisaexns" xmlns:xs="http://www.w3.org/2001/xmlschema" targetnamespace="http://sisaex4.msc.es/sisaexns" elementformdefault="qualified"> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 36 de 45
Direcciones de Entrega Las direcciones de entrega pasan a estar englobadas dentro de un elemento de lista, con tipo ListOfDeliveryAddress: Antes <xs:element name="direccionentrega" type="deliveryaddress" minoccurs="0" maxoccurs="unbounded"> Ahora <xs:element name="direccionesdeentrega" type="listofdeliveryaddresses" minoccurs="0"> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 37 de 45
Documentos Sanitarios / Veterinarios Los documentos sanitarios / veterinarios pasan a estar englobados dentro de un documento de lista, con tipo ListOfVeterinaryDocuments. Antes <xs:element name="documentosveterinarios" type="veterinarydocument" maxoccurs="unbounded"> Ahora <xs:element name="documentosveterinarios" type="listofveterinarydocuments"> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 38 de 45
Documentación Adjunta Se ha introducido un nuevo elemento en el tipo Declaracion de cara a soportar el envío de documentos anexos (ver documento de Descripción Funcional). <xs:element name="documentosadjuntos" minoccurs="0" type="listofattachments"/> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 39 de 45
Apellidos de los Operadores Económicos Se ha eliminado el campo apellidos del tipo EconomicOperator. Antes <xs:complextype name="economicoperator"> <xs:element name="nif" type="nif"> <xs:element name="nombre" type="eoname"> <xs:element name="apellidos" type="eoname" minoccurs="0"> <xs:element name="direccionoperador" type="address"> <xs:element name="tipo" type="eotype" minoccurs="0"> <xs:element name="numautorizacion" type="approvalnumber" minoccurs="0"> Ahora <xs:complextype name="economicoperator"> <xs:element name="nif" type="nif"> <xs:element name="nombre" type="eoname"> <xs:element name="direccionoperador" type="address"> <xs:element name="tipo" type="eotype" minoccurs="0"> <xs:element name="numautorizacion" type="approvalnumber" minoccurs="0"> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 40 de 45
Medio de Transporte Se ha cambiado el nombre del elemento que representa al tipo de medio de transporte dentro del tipo MeansOfTransport, para evitar la confusión con el medio de transporte propiamente dicho. Antes <xs:complextype name="meansoftransport"> <xs:element name="mediotransporte" type="meanstype"> <xs:element name="identificacion" type="identification"> <xs:element name="numconocimiento" type="document" minoccurs="0"> <xs:element name="numvagonvehiculoremolque" type="wagonnumber" minoccurs="0"> Ahora <xs:complextype name="meansoftransport"> <xs:element name="medio" type="meanstype"> <xs:element name="identificacion" type="identification"> <xs:element name="numconocimiento" type="document" minoccurs="0"> <xs:element name="numvagonvehiculoremolque" type="wagonnumber" minoccurs="0"> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 41 de 45
Nuevo Tipo ListOfDeliveryAddress El nuevo tipo contendrá una lista de 1 n direcciones de entrega. <xs:complextype name="listofdeliveryaddresses"> Lista de direcciones de entrega <xs:element maxoccurs="unbounded" name="direccionentrega" type="deliveryaddress"> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 42 de 45
Nuevo Tipo ListOfVeterinaryDocuments Contendrá una lista de 1 n documentos Sanitarios/Veterinarios. <xs:complextype name="listofveterinarydocuments"> Lista de documentos Sanitario/veterinarios <xs:element maxoccurs="unbounded" name="documentoveterinario" type="veterinarydocument"> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 43 de 45
Nuevos Tipos para Anexar Documentos <xs:complextype name="listofattachments"> Lista de documentos anexos a una declaración <xs:element maxoccurs="unbounded" name="adjunto" type="attachment"> <xs:complextype name="attachment"> Documento anexo a una declaración <xs:element name="nombre" type="filename"> <xs:element name="tipo" type="documenttype"> <xs:element name="descripcion" type="documentdescription"> <xs:element name="fichero" type="file"> <xs:simpletype name="filename"> Nombre del fichero adjuntado. Sólo están permitidas las extensiones.jpg,.gif,.tif,.tiff y.pdf <xs:restriction base="xs:string"> <xs:minlength value="4"></xs:minlength> <xs:maxlength value="100"></xs:maxlength> <xs:simpletype name="documenttype"> Código del tipo de documento. <xs:restriction base="xs:int"> <xs:minexclusive value="0"/> <xs:maxexclusive value="1000"/> <xs:simpletype name="documentdescription"> Descripción (en texto libre) del documento <xs:restriction base="xs:string"> <xs:minlength value="1"></xs:minlength> <xs:maxlength value="100"></xs:maxlength> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 44 de 45
<xs:simpletype name="file"> Fichero codificado en Base64, con una longitud máxima de 2Mb (2097152 bytes) <xs:restriction base="xs:base64binary"> <xs:maxlength value="2097152"></xs:maxlength> 25/04/2007 MSC-SISAEXIV-AF-XMLOE-03.doc Página 45 de 45
Sistema de Información de Sanidad Exterior (SISAEX IV) Servicio Web de Consulta por parte de los Operadores Económicos Descripción Funcional 25 de Abril de 2007
Descripción Funcional del Servicio Web de Consulta por parte de los Operadores Económicos Contenido CONTENIDO...2 1. INTRODUCCIÓN...3 2. DESCRIPCIÓN DEL SERVICIO WEB...4 2.1. DESCARGA DE TIPOS DE BULTO...5 2.2. DESCARGA DE TIPOS DE DOCUMENTO...6 2.3. CONSULTA DEL ESTADO DEL EXPEDIENTE...7 2.4. COMPRESIÓN DE DATOS...9 3. INFORMACIÓN ASOCIADA A LAS CONSULTAS...10 ANEXO I. FICHERO DESCARGAS.WSDL...12 ANEXO II. FAULTS DEVUELTAS POR EL SERVICIO WEB...16 25/04/2007 MSC-SISAEXIV-AF-SWCOE-01.doc Página 2 de 16
Descripción Funcional del Servicio Web de Consulta por parte de los Operadores Económicos 1. Introducción Este documento recoge el Análisis Funcional del Servicio Web de Consulta por parte de los Operadores Económicos. Esta funcionalidad se engloba dentro del Módulo de Mercancías y Operadores Económicos del Sistema de Información de Sanidad Exterior (SISAEX IV) del Ministerio de Sanidad y Consumo (MSC). El objetivo de este Servicio Web es permitir a los operadores económicos conocer el estado en el que se encuentran las declaraciones presentadas, así como los datos necesarios para el envío de dichas declaraciones mediante el Servicio Web de Presentación de Declaraciones. En los anexos del presente documento se incluye el fichero que define este Servicio Web. 25/04/2007 MSC-SISAEXIV-AF-SWCOE-01.doc Página 3 de 16
Descripción Funcional del Servicio Web de Consulta por parte de los Operadores Económicos 2. Descripción del Servicio Web El Servicio Web está dividido en tres operaciones, cada una de ellas destinada a la descarga de distintos datos: DescargarTipoBulto: descarga los distintos tipos de bulto existentes en el sistema. DescargarTipoDocumentacion: descarga los distintos tipos de documentación que es posible adjuntar a las declaraciones presentadas. ConsultarEstadoExpediente: consulta el estado actual del expediente y, en su caso, devuelve también los códigos NRC para el despacho de la mercancía. El Servicio Web estará publicado en las siguientes direcciones: Pilotaje: https://saexpiloto.msc.es/mercancias/webservices/descargasport?wsdl Producción: https://sisaex4.msc.es/mercancias/webservices/descargasport?wsdl La llamada al Servicio Web se hará mediante el protocolo SOAP basado en Document (adjunto se proporciona la versión actual del esquema). A continuación se describe cada una de las operaciones. 25/04/2007 MSC-SISAEXIV-AF-SWCOE-01.doc Página 4 de 16
Descripción Funcional del Servicio Web de Consulta por parte de los Operadores Económicos 2.1. Descarga de Tipos de Bulto La operación destinada a la descarga de los tipos de bulto existentes en el sistema se denomina DescargarTipoBulto. Recibe como parámetro un documento vacío (destinado únicamente a realizar la llamada) y devuelve una lista de tipo ListaTipoBultoType, según el siguiente esquema: <xsd:element name="tipobultoresponse" type="tns:listatipobultotype" /> <xsd:element name="tipobultorequest" /> <xsd:complextype name="listatipobultotype"> <xsd:sequence> <xsd:element name="tipobulto" type="tns:tipobultotype" maxoccurs="unbounded" minoccurs="0"> </xsd:element> </xsd:sequence> </xsd:complextype> <xsd:complextype name="tipobultotype"> <xsd:sequence> <xsd:element name="codigo" type="xsd:int"></xsd:element> <xsd:element name="descripcion" type="xsd:string"></xsd:element> </xsd:sequence> </xsd:complextype> 25/04/2007 MSC-SISAEXIV-AF-SWCOE-01.doc Página 5 de 16
Descripción Funcional del Servicio Web de Consulta por parte de los Operadores Económicos 2.2. Descarga de Tipos de Documento La operación destinada a la descarga de los tipos de documentos existentes en el sistema se denomina DescargarTipoDocumentacion. Recibe como parámetro un documento vacío (destinado únicamente a realizar la llamada) y devuelve una lista de tipo ListaTipoDocumentacionType, según el siguiente esquema: <xsd:element name="tipodocumentacionrequest"/> <xsd:element name="tipodocumentacionresponse" type="tns:listatipodocumentaciontype" /> <xsd:complextype name="listatipodocumentaciontype"> <xsd:sequence> <xsd:element name="tipodocumentacion" type="tns:tipodocumentaciontype" maxoccurs="unbounded" minoccurs="0"> </xsd:element> </xsd:sequence> </xsd:complextype> <xsd:complextype name="tipodocumentaciontype"> <xsd:sequence> <xsd:element name="codigo" type="xsd:int"></xsd:element> <xsd:element name="descripcion" type="xsd:string"></xsd:element> </xsd:sequence> </xsd:complextype> 25/04/2007 MSC-SISAEXIV-AF-SWCOE-01.doc Página 6 de 16
Descripción Funcional del Servicio Web de Consulta por parte de los Operadores Económicos 2.3. Consulta del Estado del Expediente La operación destinada a la consulta del estado actual en el que se encuentra el expediente se denomina ConsultarEstadoExpediente. Recibe como parámetro un elemento de tipo EstadoExpedienteRequestType y devuelve una lista de tipo EstadoExpedienteType, según el siguiente esquema: <xsd:element name="estadoexpedienterequest" type="tns:estadoexpedienterequesttype"/> <xsd:element name="estadoexpedienteresponse" type="tns:estadoexpedientetype"/> <xsd:complextype name="estadoexpedienterequesttype"> <xsd:sequence> <xsd:element name="codigoexpediente" type="xsd:string"/> </xsd:sequence> </xsd:complextype> <xsd:complextype name="estadoexpedientetype"> <xsd:sequence> <xsd:element name="tipo" type="tns:tipoestadoexpedientetype"/> <xsd:element name="apto" type="xsd:boolean" minoccurs="0"/> <xsd:element name="listanrc" type="tns:listanrctype" minoccurs="0"/> </xsd:sequence> </xsd:complextype> <xsd:simpletype name="tipoestadoexpedientetype"> <xsd:restriction base="xsd:string"> <xsd:enumeration value="inicial"/> <xsd:enumeration value="definitivo"/> <xsd:enumeration value="entramite"/> <xsd:enumeration value="cerrado"/> <xsd:enumeration value="anulado"/> </xsd:restriction> </xsd:simpletype> <xsd:complextype name="listanrctype"> <xsd:sequence> <xsd:element name="nrcproducto" type="tns:nrcproductotype" maxoccurs="unbounded"/> </xsd:sequence> </xsd:complextype> <xsd:complextype name="nrcproductotype"> <xsd:sequence> <xsd:element name="codigoproducto" type="xsd:string"/> <xsd:element name="nrc" type="xsd:string"/> </xsd:sequence> </xsd:complextype> Es decir, para cada expediente se devuelve el estado en el que se encuentra, si ha sido declarado apto o no apto (sólo para los estados En Tramite y Cerrado), y un listado de pares producto-nrc, para todos los productos del expediente. Este listado sólo se enviará en el caso de expedientes cerrados declarados aptos. 25/04/2007 MSC-SISAEXIV-AF-SWCOE-01.doc Página 7 de 16
Descripción Funcional del Servicio Web de Consulta por parte de los Operadores Económicos En caso de que el código de expediente no tenga el formato correcto se devolverá la fault CodigoIncorrectoFault, y en caso de que el expediente no haya sido encontrado ExpedienteNoEncontradoFault. 25/04/2007 MSC-SISAEXIV-AF-SWCOE-01.doc Página 8 de 16
Descripción Funcional del Servicio Web de Consulta por parte de los Operadores Económicos 2.4. Compresión de Datos El Servicio Web está preparado para recibir las peticiones comprimidas usando la codificación GZIP del estándar HTTP. La compresión se puede realizar tanto en la petición como en la respuesta. Aunque actualmente no es obligatorio utilizar esta opción, sí es altamente recomendable, con el fin de optimizar la utilización de la red, tanto del cliente como del MSC, y mejorar los tiempos de respuesta. Además es posible que en futuras versiones del servicio sea obligatoria su utilización. Para indicar que el contenido de la petición está comprimido, se deberá utilizar la cabecera HTTP content-encoding: Content-Encoding: gzip Del mismo modo, para indicar que está preparado para recibir la respuesta comprimido, se deberá incluir la cabecera Accept-Encoding: Accept-Encoding: gzip 25/04/2007 MSC-SISAEXIV-AF-SWCOE-01.doc Página 9 de 16
Descripción Funcional del Servicio Web de Consulta por parte de los Operadores Económicos 3. Información Asociada a las Consultas En este capítulo se describe la información asociada a las consultas que está contenida en el fichero WSDL. Tipo complejo: ListaTipoBultoType tipobulto Lista de Tipos de Bulto TipoBultoType Tipo complejo: TipoBultoType codigo Código del tipo de bulto int descripcion Descripción del tipo string Tipo complejo: ListaTipoDocumentacionType tipodocumentacion Lista de tipos de documentación TipoDocumentacionType Tipo complejo: TipoDocumentacionType codigo Código del tipo de documentación int descripcion Descripción del tipo string 25/04/2007 MSC-SISAEXIV-AF-SWCOE-01.doc Página 10 de 16