Professional Documents
Culture Documents
Bandeja de salida
Carga masiva
Consulta de reportes
Contenido
Definicin de los casos de uso para la Bandeja de Salida a travs de Web Services
Los siguientes son los casos de uso de las operaciones que podrn utilizar las personas u organizaciones:
Obtener las URLs del servicio web y del servlet para acceder a la bandeja de salida.
Consultar el nmero de documento que representa una salida de informacin por envo de archivos.
Consultar el listado de archivos que pertenecen a una salida de informacin por envo de archivos.
Descargar archivos desde la bandeja de salida.
A continuacin se definen cada uno de los casos de uso como operaciones de los Web Services y
operaciones ofrecidas por el servlet.
getURLsBSA
DESCRIPCIN
Permite obtener la url del servicio web que va a atender las peticiones de
correspondientes al WebService - Acceder Bandeja de Salida, y la url del
servlet que permite descargar archivos.
PARMETROS DE ENTRADA
Nombre
Descripcin
Tipo de dato o
Elemento XSD
formato
int
PARMETROS DE SALIDA
Nombre
Descripcin
Tipo de dato o
Elemento XSD
getURLsBSAReturn
getURLsBSA.xsd
consultarDocumentoSalida
DESCRIPCIN
PARMETROS DE ENTRADA
Nombre
Descripcin
Tipo de dato o
Elemento XSD
identificadorOrigen
string
Nombre
Descripcin
Tipo de dato o
Elemento XSD
consultarDocumentoSalidaReturn
consultarDocumentoSalida.xsd
PARMETROS DE SALIDA
Nombre
operacin consultarArchivosSalida
DESCRIPCIN
PARMETROS DE ENTRADA
Nombre
Descripcin
Tipo de dato o
Elemento XSD
numero Solicitud
long
Descripcin
Tipo de dato o
Elemento XSD
PARMETROS DE SALIDA
Nombre
consultarArchivosSalida.xsd
Valor
Descripcin
tipoIdentificacion
identificacin
tipoOrganizacion
nitOrganizacion
password
Valor
Descripcin
operacion
numeroSolicitud
long
idArchivo
int
Valor
Descripcin
stream
Respuesta servlet
archivos.xsd
RESPUESTA
Nombre
Configuracin de Seguridad
Protocolo HTTPS
El protocolo de comunicacin establecido para conectarse al Web Service y al servlet de la DIAN es
HTTPS.
Certificados Digitales
Los certificados digitales que se utilizarn para validar el mensaje SOAP deben ser emitidos por una
Entidad Certificadora autorizada por la Superintendencia de Industria y Comercio.
Estos certificados deben ser de tipo Servidor Seguro que permitan generar firmas automatizadas.
WS-Security
Como mecanismo de seguridad para el envo y recepcin de los mensajes SOAP, se establece el
estndar internacional WS-Security.
Los mensajes SOAP tendrn que cumplir las siguientes caractersticas:
Un ejemplo es el siguiente:
<soapenv:Header>
<ns1:accesoMUISCA xmlns:ns1=http://www.dian.gov.co/ws/seguridad
soapenv:actor=http://schemas.xmlsoap.org/soap/actor/next soapenv:mustUnderstand=0"
ns1:tipoOrganizacion=NIT_ORGANIZACION ns1:nitOrganizacion=99999999"
ns1:tipoIdentificacion=SISns1:identificacion=99999999"
ns1:password=XXXXXX></ ns1:accesoMUISCA>
</soapenv:Header>
Autenticacin va Servlet
Para la autenticacin ante el DIAN a travs del servlet, se deben utilizar los siguientes parmetros,
que viajarn por header del request:
tipoOrganizacion: Tipo de la organizacin que va a realizar la autenticacin. Los tipos de
organizaciones permitidos estn definidos en el XSD.
nitOrganizacion: Corresponde al NIT de la organizacin que va a acceder. Este es requerido
nicamente cuando el tipo de organizacin sea NIT_ORGANIZACION.
tipoIdentificacion: Tipo de documento de identificacin del usuario que solicita el acceso. Los
tipos de documentos de identificacin permitidos estn definidos en el XSD.
identificacion: Nmero de identificacin del usuario.
password: Contrasea de acceso a la DIAN.
El servicio de presentacin de informacin por envo de archivos a travs de web service (sistema a
sistema), permite de manera general a los usuarios del mismo, las siguientes opciones:
Realizar una solicitud de carga de archivos,
Consultar el estado del procesamiento de la solicitud,
Recibir la comunicacin respectiva cuando se finalice el procesamiento.
En forma detallada a travs del nuevo servicio, podrn realizarse las siguientes operaciones, bien sea
que se trate de personas u organizaciones:
Preguntar URLs.
Reservar nmeros de documentos.
Obtener el rango de consecutivos para los archivos a cargar.
Presentar solicitud de envo de archivos.
Consultar el estado de la solicitud.
Consultar archivos de la bandeja de entrada.
Eliminar archivos de la bandeja de entrada.
Colocar archivos en la bandeja de entrada.
Colocar los archivos con error de una solicitud en la bandeja de salida.
Descargar los archivos con error de una solicitud de la bandeja de salida.
Los siguientes son las operaciones que deben implementar las personas u organizaciones para recibir
respuesta relacionada con el procesamiento de solicitudes:
Informar fin de procesamiento de una solicitud de envo de archivos.
Informar fin de colocacin de archivos de error en la bandeja de salida.
10
A continuacin se definen cada una de las operaciones de los Web Services as como de las operaciones
ofrecidas por el servlet.
11
Nombre Operacin
getURLs
DESCRIPCIN
PARMETROS DE ENTRADA
Nombre
Descripcin
Tipo de dato o
Elemento XSD
formato
int
Nombre
Descripcin
Tipo de dato o
Elemento XSD
getURLsReturn
getURLs.xsd
PARAMETROS DE SALIDA
12
Nombre Operacin
reservarNumerosDocumento
DESCRIPCIN
PARMETROS DE ENTRADA
Nombre
Descripcin
Tipo de dato o
Elemento XSD
cantidadConsecutivos
Cantidad de nmeros de
documentos que se desean
reservar.
int
formato
int
version
int
Nombre
Descripcin
Tipo de dato o
Elemento XSD
reservarNumeros
DocumentoReturn
reservarNumerosDocumento.xsd
PARMETROS DE SALIDA
13
Nombre Operacin
consultarRangoConsecutivos
DESCRIPCIN
PARMETROS DE ENTRADA
Nombre
Descripcin
Tipo de dato o
Elemento XSD
cantidadConsecutivos
int
formato
int
version
int
Nombre
Descripcin
Tipo de dato o
Elemento XSD
consultarRango
ConsecutivosReturn
consultarRangoConsecutivos.xsd
PARMETROS DE SALIDA
14
Nombre Operacin
presentarSolicitud
DESCRIPCIN
PARAMETROS DE ENTRADA
Nombre
Descripcin
Tipo de dato o
Elemento XSD
xmlDocSolicitud
xmlDocSolicitud.xsd
Nombre
Descripcin
Tipo de dato o
Elemento XSD
reservarNumeros
DocumentoReturn
presentarSolicitud.xsd
PARAMETROS DE SALIDA
15
consultarSolicitud
DESCRIPCIN
PARAMETROS DE ENTRADA
Nombre
Descripcin
Tipo de dato o
Elemento XSD
numeroSolicitud
long
Nombre
Descripcin
Tipo de dato o
Elemento XSD
consultarSolicitudReturn
consultarSolicitud.xsd
PARAMETROS DE SALIDA
16
2.5. Colocar los archivos con error de una solicitud en la bandeja de salida
Nombre operacin
colocarArchivosBandejaSalida
DESCRIPCIN
PARMETROS DE ENTRADA
Nombre
Descripcin
Tipo de dato o
Elemento XSD
numeroSolicitud
long
PARMETROS DE SALIDA
17
Nombre
Descripcin
Tipo de dato o
Elemento XSD
colocarArchivosBandeja
SalidaReturn
colocarArchivosBandejaSalida.xsd
Nombre Operacin
consultarArchivosBandejaEntrada
DESCRIPCIN
PARMETROS DE ENTRADA
Nombre
Descripcin
Tipo de dato o
Elemento XSD
formato
int
version
int
Nombre
Descripcin
Tipo de dato o
Elemento XSD
consultarArchivosBandeja
EntradaReturn
consultarArchivosBandejaEntrada.xsd
PARAMETROS DE SALIDA
18
Nombre Operacin
eliminarArchivosBandejaEntrada
DESCRIPCIN
PARMETROS DE ENTRADA
Nombre
Descripcin
Tipo de dato o
Elemento XSD
xmlNomArchivos
xmlNomArchivos.xsd
PARMETROS DE SALIDA
19
Nombre
Descripcin
Tipo de dato o
Elemento XSD
eliminarArchivoBandeja
EntradaReturn
eliminarArchivoBandejaEntrada.xsd
DESCRIPCIN
Valor
Descripcin
tipoIdentificacion
identificacion
tipoOrganizacion
nitOrganizacion
password
20
Valor
Descripcin
operacion
nombreArchivo
Dmuisca_ccmmmmmv
vaaaacccccccc.xml
o
Dmuisca_ccmmm
mmvvaaaacccccccc.zip
o
signDmuisca_ccmmmmmv
vaaaacccccccc.xml.xml
Dmuisca_ccmmmmmv
vaaaacccccccc.xmlcc:
Concepto (Insercin = 01 Reemplazo =
02).mmmmm: Formato.vv: Versin del
formato.aaaa: Ao de envo.cccccccc :
Consecutivo de envo por ao.
Valor
Descripcin
Valor
Descripcin
21
Configuracin de Seguridad
IPs autorizadas por la DIAN
El servicio ofrecido debe contar con una direccin pblica vlida en Internet para poder consumir las
operaciones de los Web Services ofrecidos por carga Masiva. Esta direccin debe ser informada a la
DIAN para su autorizacin. Solamente desde las direcciones autorizadas se podr acceder a estas
operaciones.
Protocolo HTTPS
El protocolo de comunicacin establecido para conectarse al Web Service y al servlet de la DIAN es
HTTPS.
Certificados Digitales
Los certificados digitales que se utilizarn para validar el mensaje SOAP deben ser emitidos por una
Entidad Certificadora autorizada por la Superintendencia de Industria y Comercio.
Estos certificados deben ser de tipo Servidor Seguro que permitan generar firmas automatizadas.
WS-Security
Como mecanismo de seguridad para el envo y recepcin de los mensajes SOAP, se establece el
estndar internacional WS-Security.
Los mensajes SOAP tendrn que cumplir las siguientes caractersticas:
22
23
Autenticacin va Servlet
Para la autenticacin ante el DIAN a travs del servlet, se deben utilizar los siguientes parmetros,
que viajarn por el header del request:
tipoOrganizacion: Tipo de la organizacin que va a realizar la autenticacin. Los tipos de
organizaciones permitidos estn definidos en el XSD.
nitOrganizacion: Corresponde al NIT de la organizacin que va a acceder. Este es requerido
nicamente cuando el tipo de organizacin sea NIT_ORGANIZACION.
tipoIdentificacion: Tipo de documento de identificacin del usuario que solicita el acceso. Los
tipos de documentos de identificacin permitidos estn definidos en el XSD.
identificacion: Nmero de identificacin del usuario.
password: Contrasea de acceso a la DIAN.
24
Especificacin tcnica
La solicitud de presentacin de informacin por envo de archivos a travs de WebService, se debe
hacer por medio de un XML que viaja por SOAP y que cumpla las siguientes especificaciones:
25
El archivo debe contener un elemento nico raz llamado solEnvio, que a su vez contendr toda la
informacin de la solicitud del envi:
Atributo
Casilla
Denominacin
casilla
Tipo
Longitud
Obligatoria
Observaciones
cpt
42
Concepto
int
fmt
40
Cdigo Formato
int
ver
41
Versin Formato
int
anoVig
43
Ao Informado
int
Formato AAAA
perVig
44
Periodo Informado
int
0 = Si es un formato aperidico.
nomArch
46
33
numArch
47
Cantidad de Archivos
int
numReg
48
Nmero Total de
Registros de los
Archivos de Envio.
int
numSolAnt
49
long
15
26
No. de Solicitud
Anterior
string
1 = Insercin
2 = Reemplazo
3 = Reemplazo Parcial
Dmuisca_ccmmmmmvvaaaacccccccc.xml
cc: Concepto (Insercin = 01
Reemplazo = 02).
mmmmm: Formato.
vv: Versin del formato.
aaaa: Ao de envo.
cccccccc: Consecutivo de envo por ao.
Dentro del elemento raz, encontramos otros 3 elementos que se describen a continuacin.
Informacin del interesado
Este elemento nico llamado interesado, contiene la siguiente informacin.
Atributo
Casilla
Denominacion
casilla
Tipo
Longitud
tdoc
25
Tipo de documento de
identificacin
int
nid
26
int
12
Obligatoria
S
Observaciones
27
Casilla
Denominacion
casilla
Tipo
Longitud
tdoc
33
Tipo de documento de
identificacin
int
nid
34
int
12
Obligatoria
S
Observaciones
2. Validaciones
Validaciones Generales
El archivo debe contener todos los campos definidos para el encabezado y estos campos deben
estar correctamente diligenciados.
La informacin del contenido del archivo debe corresponder al esquema XSD entregado.
Los atributos que registran valores numricos, se reportan con valores numricos positivos, sin
signos ni puntuaciones, segn lo reportado por el informante o en su defecto con cero (0).
Validaciones en solEnvio
El nmero de la solicitud anterior es requerido si el concepto es reemplazo o reemplazo parcial.
3. Esquema XSD
A continuacin se incluye el esquema XSD para esta especificacin tcnica.
Solicitud de Presentacin de Informacin por Envo De Archivos a Travs de WebService
28
Definicin de los casos de uso para la consulta de un reporte a travs de Web Services
Los siguientes son los casos de uso de las operaciones que podrn utilizar las personas u organizaciones:
Consultar un reporte
Recibir la respuesta del reporte
A continuacin se definen cada uno de los casos de uso como operaciones de los Web Services y
operaciones ofrecidas por el servlet.
consultarReporte
DESCRIPCIN
Nombre
Descripcin
Tipo de dato o
Elemento XSD
xmlReporteMuisca
Reportes.xsd
Nombre
Descripcin
Tipo de dato o
Elemento XSD
idOperacion
Identificador nico de la
solicitud del reporte
PARAMETROS DE SALIDA
29
recibirRespuestaMUISCA
DESCRIPCIN
PARAMETROS DE ENTRADA
Nombre
Descripcin
Tipo de dato o
Elemento XSD
xmlRespuesta
RespuestaServicioMuisca.xsd
Configuracin de Seguridad
IPs autorizadas por la DIAN
El servicio ofrecido debe contar con una direccin pblica vlida en Internet para poder consumir las
operaciones de los Web Services ofrecidos por arquitectura. Esta direccin debe ser informada a la
DIAN para su autorizacin. Solamente desde las direcciones autorizadas se podr acceder a estas
operaciones.
Protocolo HTTPS
El protocolo de comunicacin establecido para conectarse al Web Service y al servlet de la DIAN es
HTTPS.
Certificados Digitales
Los certificados digitales que se utilizaran para validar el mensaje SOAP deben ser emitidos por una
Entidad Certificadora autorizada por la Superintendencia de Industria y Comercio.
Estos certificados deben ser de tipo Servidor Seguro que permitan generar firmas automatizadas.
30
WS-Security
Como mecanismo de seguridad para el envo y recepcin de los mensajes SOAP, se establece el
estndar internacional WS-Security.
Los mensajes SOAP tendrn que cumplir las siguientes caractersticas:
Para la peticin SOAP:
Estar firmado digitalmente.
Contener el elemento Timestamp, el cual indica la fecha y hora en que se crea la peticin, y la
fecha y hora en que expira el mensaje.
Para la autenticacin ante el DIAN se deber usar el elemento accesoMUISCA (que se puede
encontrar en: http://muisca.dian.gov.co/ws-eys/xsd/seguridad/accesoMUISCA.xsd) en la cabecera
(Header) del mensaje SOAP. Esta cabecera est definida en el WSDL del Web Service. La inclusin
de este elemento dentro de la cabecera del mensaje SOAP vara dependiendo de la plataforma
usada. Este elemento usa los siguientes atributos para permitir el acceso a DIAN:
- tipoOrganizacion: Tipo de la organizacin que va a realizar la autenticacin. Los tipos de
organizaciones permitidos estn definidos en el XSD.
- nitOrganizacion: Corresponde al NIT de la organizacin que va a acceder. Este es requerido
nicamente cuando el tipo de organizacin sea NIT_ORGANIZACION.
- tipoIdentificacion: Tipo de documento de identificacin del usuario que solicita el acceso. Los
tipos de documentos de identificacin permitidos estn definidos en el XSD.
- identificacion: Nmero de identificacin del usuario.
- password: Contrasea de acceso a la DIAN.
Un ejemplo es el siguiente:
<soapenv:Header>
...
<ns1:accesoMUISCA xmlns:ns1=http://www.dian.gov.co/ws/seguridad soapenv:actor=http:
/schemas.xmlsoap.org/soap/actor/next soapenv:mustUnderstand=0"
ns1:tipoOrganizacion=NIT_ORGANIZACION ns1:nitOrganizacion=99999999"
ns1:tipoIdentificacion=SISns1:identificacion=99999999" ns1:password=XXXXXX></
ns1:accesoMUISCA>
</soapenv:Header>
31
Autenticacin va Servlet
Para la autenticacin ante el DIAN a travs del servlet, se deben utilizar los siguientes parmetros,
que viajarn por header del request:
tipoOrganizacion: Tipo de la organizacin que va a realizar la autenticacin. Los tipos de
organizaciones permitidos estn definidos en el XSD.
nitOrganizacion: Corresponde al NIT de la organizacin que va a acceder. Este es requerido
nicamente cuando el tipo de organizacin sea NIT_ORGANIZACION.
tipoIdentificacion: Tipo de documento de identificacin del usuario que solicita el acceso. Los
tipos de documentos de identificacin permitidos estn definidos en el XSD.
identificacion: Nmero de identificacin del usuario.
password: Contrasea de acceso a la DIAN.
32