Web Service de Calidad de datos identificativos

Transcripción

1 Web Service de Calidad de datos identificativos Autor: AEAT Fecha: 27/11/2015 Versión: 1.0 Revisiones Edi. Rev. Fecha Descripción A(*) Páginas /11/2015 Versión inicial A Todas (*) Acción: A= Añadir; R= Reemplazar Índice: 1. INTRODUCCIÓN UTILIZACIÓN DEL WEB SERVICE CONTROL DE VERSIONES Versión SERVICIO WEB VNIFV1.WSDL MENSAJE DE PETICIÓN DE DATOS NIF Apellidos y Nombre o Razón Social MENSAJE DE RESPUESTA DE DATOS. 4 Impreso: 02/12/2015 Página: 1/7

2 6.1. NIF Apellidos y Nombre o Razón Social MENSAJE DE ERROR DEFINICIÓN SERVICIO Y ESQUEMAS Definición del servicio VNifV1.wsdl Mensaje de entrada VNifV1Ent.xsd Mensaje de salida correcta VNifV1Sal.xsd URL de acceso al servicio 6 9. EJEMPLOS Mensaje de entrada Mensaje de respuesta Mensaje de respuesta con error 7 Impreso: 02/12/2015 Página: 2/7

3 1. Introducción. Este servicio web se ofrece con la finalidad de ayudar a los declarantes de declaraciones informativas a identificar y comprobar el alta en el censo de la AEAT de los declarados en dichas declaraciones. 2. Utilización del web service. El posible uso para otras finalidades o el abuso de este servicio podrá suponer el bloqueo del acceso al mismo, de forma temporal o permanente. La información proporcionada por este servicio web se realiza consultando los datos identificativos disponibles en el momento. Esta información podría variar si se producen posteriores cambios en los datos identificativos. 3. Control de versiones. 3.1 Versión 1.0. Versión inicial. 4. Servicio web VNifV1.wsdl. Este Servicio requiere tener instalado un certificado de usuario admitido por la AEAT en el ordenador desde el que se produzca el envío de la información. La representación gráfica del servicio web es la siguiente: En la definición de este servicio se describe que el mensaje de entrada se basa en el esquema VNifV1Ent.xsd y que la respuesta cuando no se detectan errores en la entrada y el contribuyente se encuentra censado en la AEAT se basa en el esquema VNifV1Sal.xsd. En caso contrario, la respuesta consistirá en un mensaje SOAP Fault. La representación gráfica de los datos del mensaje de entrada es la siguiente: Impreso: 02/12/2015 Página: 3/7

4 La representación gráfica de los datos del mensaje de salida es la siguiente: 5. Mensaje de Petición de datos. El mensaje de petición no requerirá firma digital. 5.1 NIF. Descripción: NIF de la persona física o jurídica sobre la que se quiere efectuar la consulta de verificación. Formato: Alfanumérico de 9 caracteres. Obligatorio: Sí 5.2 Apellidos y Nombre o Razón Social. Descripción: Apellidos y Nombre de la persona física o Razón Social de la persona jurídica sobre la que se quiere efectuar la consulta de verificación. Formato: Alfanumérico. Obligatorio: Obligatorio para personas físicas. Opcional en personas jurídicas. 6. Mensaje de Respuesta. El mensaje de respuesta no tendrá firma digital NIF. Descripción: NIF de la persona física o jurídica, validado y ajustado a 9 posiciones con ceros no significativos si fuera necesario. Formato: Alfanumérico Apellidos y Nombre o Razón Social. Descripción: En caso de persona física, Apellidos y Nombre recibidos en el mensaje de petición. En caso de persona jurídica, Razón Social tal como se encuentra en el censo de contribuyentes de la AEAT. Formato: Alfanumérico. 7. Mensaje de error. Cualquier error producirá un mensaje SOAP FAULT como respuesta. El faultstring contendrá el motivo del rechazo. Codigo[-1].No identificado Impreso: 02/12/2015 Página: 4/7

5 8. Definición del servicio y Esquemas. 8.1 Definición del servicio VNifV1.wsdl La definición del servicio se puede consultar en la dirección s/vnifv1.wsdl y su contenido es el siguiente: <?xml version="1.0" encoding="utf-8"?> <wsdl:definitions xmlns:vnifv1=" it/ws/vnifv1.wsdl" xmlns:vnifv1ent=" /jdit/ws/vnifv1ent.xsd" xmlns:vnifv1sal=" /jdit/ws/vnifv1sal.xsd" xmlns:wsdl=" xmlns:wsdlsoap=" xmlns:xsd=" /jdit/ws/vnifv1.wsdl"> <wsdl:types> <schema elementformdefault="qualified" /jdit/ws/vnifv1.wsdl" xmlns:vnifv1ent=" /jdit/ws/vnifv1ent.xsd" xmlns:vnifv1sal=" /jdit/ws/vnifv1sal.xsd" xmlns=" <xsd:import namespace=" ws/vnifv1ent.xsd" schemalocation="vnifv1ent.xsd"/> <xsd:import namespace=" ws/vnifv1sal.xsd" schemalocation="vnifv1sal.xsd"/> </schema> </wsdl:types> <wsdl:message name="entrada"> <wsdl:part name="vnifv1ent" element="vnifv1ent:vnifv1ent"/> </wsdl:message> <wsdl:message name="salida"> <wsdl:part name="vnifv1sal" element="vnifv1sal:vnifv1sal"/> </wsdl:message> <wsdl:porttype name="vnifv1"> <wsdl:operation name="vnifv1"> <wsdl:input name="entrada" message="vnifv1:entrada"/> <wsdl:output name="salida" message="vnifv1:salida"/> </wsdl:operation> </wsdl:porttype> <wsdl:binding name="vnifv1soapbinding" type="vnifv1:vnifv1"> <wsdlsoap:binding style="document" transport=" <wsdl:operation name="vnifv1"> <wsdlsoap:operation soapaction="" style="document"/> <wsdl:input name="entrada"> <wsdlsoap:body use="encoded"/> </wsdl:input> <wsdl:output name="salida"> <wsdlsoap:body use="literal"/> </wsdl:output> </wsdl:operation> </wsdl:binding> <wsdl:service name="vnifv1service"> <!--Puerto para conexiones desde internet en PRO --> <wsdl:port name="vnifport1" binding="vnifv1:vnifv1soapbinding"> <wsdlsoap:address location=" JDIT/ws/VNifV1SOAP"/> </wsdl:port> </wsdl:service> </wsdl:definitions> 8.2 Mensaje de entrada VNifV1Ent.xsd El diseño del esquema de entrada se puede consultar en la dirección s/vnifv1ent.xsd Impreso: 02/12/2015 Página: 5/7

6 y su contenido es el siguiente: <?xml version="1.0" encoding="utf-8"?> <schema xmlns=" xmlns:vnifv1ent=" /jdit/ws/vnifv1ent.xsd" /jdit/ws/vnifv1ent.xsd" elementformdefault="qualified"> Esquema para solicitar la verificación de un NIF <element name="vnifv1ent" type="vnifv1ent:vnifv1ent"/> <complextype name="vnifv1ent"> Nif : Nif a verificar Nombre: Nombre o Razón Social <sequence> <element name="nif" type="string"/> <element name="nombre" type="string"/> </sequence> </complextype> </schema> 8.3 Mensaje de salida correcta VNifV1Sal.xsd El diseño del esquema de salida se puede consultar en la dirección s/vnifv1sal.xsd y su contenido es el siguiente: <?xml version="1.0" encoding="utf-8"?> <schema xmlns=" xmlns:vnifv1sal=" /jdit/ws/vnifv1sal.xsd" /jdit/ws/vnifv1sal.xsd" elementformdefault="qualified"> Esquema de respuesta del servico de verificación de NIF. <element name="vnifv1sal" type="vnifv1sal:vnifv1sal"/> <complextype name="vnifv1sal"> Nif : Nif verificado Nombre: Razón Social en caso de Persona Jurídica. En caso de Persona Física se responde un eco de los datos de entrada por temas de Protección de Datos Personales <sequence> <element name="nif" type="string"/> <element name="nombre" type="string"/> </sequence> </complextype> </schema> 8.4 URL de acceso al servicio La URL es la siguiente: Impreso: 02/12/2015 Página: 6/7

7 9. Ejemplos. 9.1 Mensaje de entrada <soapenv:envelope xmlns:soapenv=" xmlns:vnif=" <soapenv:header/> <soapenv:body> <vnif:vnifv1ent> <vnif:nif> r </vnif:nif> <vnif:nombre> ESPAÑOL ESPAÑOL JUAN </vnif:nombre> </vnif:vnifv1ent> </soapenv:body> </soapenv:envelope> 9.2 Mensaje de respuesta <env:envelope xmlns:env=" xmlns:xsd=" xmlns:xsi=" <env:body> <VNifV1Sal:VNifV1Sal xmlns:vnifv1sal=" rt/jdit/ws/vnifv1sal.xsd"> <VNifV1Sal:Nif> R </VNifV1Sal:Nif> <VNifV1Sal:Nombre>ESPAÑOL ESPAÑOL JUAN</VNifV1Sal:Nombre> </VNifV1Sal:VNifV1Sal> </env:body> </env:envelope> 9.3 Mensaje de respuesta con error <env:envelope xmlns:env=" <env:body> <env:fault> <faultcode>env:client</faultcode> <faultstring>codigo[-1].no identificado</faultstring> </env:fault> </env:body> </env:envelope> Impreso: 02/12/2015 Página: 7/7