Escolar Documentos
Profissional Documentos
Cultura Documentos
3
Descripcin de servicios web (XML Web
Services)
Documento Confidencial
ndice de Contenidos
NDICE DE CONTENIDOS ................................................................................. 2
INTRODUCCIN ............................................................................................... 3
SERVICIOS DISPONIBLES................................................................................ 4
ESTRUCTURA MENSAJE DE RESPUESTA ..................................................................................... 5
MTODO SENDDOCUMENTS () ............................................................................................. 6
MTODO RECOVERDOCUMENT () .......................................................................................... 7
MTODO RECOVERRECEIVEDDOCUMENT () ............................................................................... 8
MTODO RECEIVEDOCUMENTS () ......................................................................................... 9
MTODO CONFIRMDOCUMENTRECEPTION () ............................................................................. 9
MTODO SEARCHSENTDOCUMENTS () .................................................................................. 10
MTODO SEARCHRECEIVEDDOCUMENTS () ............................................................................. 11
MTODO DOCUMENTINFO() .............................................................................................. 12
MTODO DOCUMENTTRACKING() ........................................................................................ 13
Documento Confidencial
Introduccin
El presente documento tiene como objetivo describir los mtodos expuestos por el
Servicio Web del Sign@ture Server. El consumo de estos mtodos va a permitir la
integracin de softwares de terceros con la plataforma Sign@ture va Servicio Web
XML.
Documento Confidencial
Servicios disponibles
Sign@ture Server provee servicios WEB que pueden ser accedido desde la URL:
http://server_name/Sign@webservices/Core.asmx donde server_name es el
nombre o la direccin IP del servidor donde se encuentra instalado Sign@ture Server.
Si se desea obtener la descripcin (WSDL) del Web Service puede hacerse a travs de
la URL http://server-name/Sign@webservices/Core.asmx?WSDL.
Los mtodos disponibles son:
SendDocuments ()
RecoverDocument ()
RecoverReceivedDocument ()
ReceiveDocuments ()
ConfirmDocumentReception ()
SearchSentDocuments ()
SearchReceivedDocuments ()
DocumentInfo ()
DocumentTracking ()
Documento Confidencial
Documento Confidencial
Mtodo SendDocuments ()
Este mtodo permite enviar documentos electrnicos a Sign@ture Server, los
documentos tienen que pertenecer al grupo de documentos Enviados (Emitidos).
Descripcin de Parmetros
SendDocuments(string Subscriber, string UserName, string Password, string xml)
Parmetro
Descripcin
Validacin
Suscriber
UserName
Password
Contrasea asociada al
usuario.
xml
Documento Confidencial
Mtodo RecoverDocument ()
Este mtodo permite recuperar documentos electrnicos emitidos (Documentos
Enviados) almacenados en Sign@ture Server.
Descripcin de Parmetros
RecoverDocument (string Subscriber, string UserName, string Password, string
DocumentType, long DocumentNumber, string Format)
Parmetro
Descripcin
Validacin
Suscriber
UserName
Password
Contrasea asociada al
usuario.
DocumentType
DocumentNumber
Format
Documento Confidencial
Mtodo RecoverReceivedDocument ()
Este mtodo permite recuperar documentos electrnicos recibidos (Documentos
Recibidos) almacenados en Sign@ture Server.
Descripcin de Parmetros
RecoverReceivedDocument(string Subscriber, string UserName, string Password,
string Sender, string DocumentType, long DocumentNumber, string Format)
Parmetro
Descripcin
Validacin
Suscriber
UserName
Password
Contrasea asociada al
usuario.
Sender
DocumentType
DocumentNumber
Format
Documento Confidencial
Mtodo ReceiveDocuments ()
Este mtodo permite recuperar documentos electrnicos recibidos (Documentos
Recibidos) almacenados en Sign@ture Server y que esten pendientes de descarga
desde la plataforma .
Descripcin de Parmetros
ReceiveDocuments(string Subscriber, string UserName, string Password)
Parmetro
Descripcin
Validacin
Suscriber
UserName
Password
Contrasea asociada al
usuario.
Mtodo ConfirmDocumentReception ()
Este mtodo permite confirmar la recepcin de un documento electrnico en
Sign@ture Server .
Descripcin de Parmetros
ConfirmDocumentReception(string Subscriber, string UserName, string Password, long
IdDocument)
Parmetro
Descripcin
Validacin
Suscriber
UserName
Password
Contrasea asociada al
usuario.
IdDocument
Documento Confidencial
Mtodo SearchSentDocuments ()
Este mtodo permite recuperar documentos electrnicos emitidos (Documentos
Enviados) almacenados en Sign@ture Server en correspondencia con criterios
avanzados que se especifican como parmetros.
Descripcin de Parmetros
SearchSentDocuments ( string Subscriber, string UserName, string Password,
string
DocumentType,
short
TopN,
string
Receiver,
long
NumberFrom,
long NumberTo, DateTime DateFrom, DateTime DateTo, decimal AmountFrom,
decimal AmountTo, string DivisionCode)
Parmetro
Suscriber
UserName
Password
DocumentType
TopN
Receiver
NumberFrom
NumberTo
DateFrom
DateTo
AmountFrom
AmountTo
DivisionCode
Descripcin
Validacin
Contrasea asociada al
usuario.
Tipo del documento.
Mximo de Documentos a
recuperar.
Cdigo de empresa (RUT, RFC,
CNPJ, CUIT, etc..) receptora
del Documento.
Lmite inferior del rango de
folios de documentos que se
quiere recuperar.
Lmite superior del rango de
folios de documentos que se
quiere recuperar.
Lmite inferior del rango de
fecha de documentos que se
quiere recuperar.
Lmite superior del rango de
fecha de documentos que se
quiere recuperar.
Lmite inferior del rango de
monto de documentos que se
quiere recuperar.
Lmite superior del rango de
monto de documentos que se
quiere recuperar.
Identificador de la Divisin a la
que esta asociada el
documento en la plataforma
10
Documento Confidencial
Mtodo SearchReceivedDocuments ()
Este mtodo permite recuperar documentos electrnicos recibidos (Documentos
Recibidos) almacenados en Sign@ture Server en correspondencia con criterios
avanzados que se especifican como parmetros.
Descripcin de Parmetros
SearchReceivedDocuments( string Subscriber, string UserName, string Password,
string DocumentType, short TopN, string Sender, long NumberFrom, long NumberTo,
DateTime DateFrom, DateTime DateTo, decimal AmountFrom, decimal AmountTo,
string DivisionCode)
Parmetro
Suscriber
UserName
Password
DocumentType
TopN
Sender
NumberFrom
NumberTo
DateFrom
DateTo
AmountFrom
AmountTo
DivisionCode
Descripcin
Validacin
Contrasea asociada al
usuario.
Tipo del documento.
Mximo de Documentos a
recuperar.
Cdigo de empresa (RUT, RFC,
CNPJ, CUIT, etc..) emisora del
Documento.
Lmite inferior del rango de
nmero de documentos que se
quiere recuperar.
Lmite superior del rango de
folios de documentos que se
quiere recuperar.
Lmite inferior del rango de
fecha de documentos que se
quiere recuperar.
Lmite superior del rango de
fecha de documentos que se
quiere recuperar.
Lmite inferior del rango de
monto de documentos que se
quiere recuperar.
Lmite superior del rango de
monto de documentos que se
quiere recuperar.
Identificador de la Divisin a la
que esta asociada el
documento en la plataforma
11
Documento Confidencial
Mtodo DocumentInfo()
Este mtodo permite recuperar informacin
almacenados en Sign@ture Server.
de
los
documentos
electrnicos
Descripcin de Parmetros
DocumentInfo(string Subscriber, string UserName, string Password, string Sender,
string DocumentType, long DocumentNumber)
Parmetro
Suscriber
UserName
Password
Descripcin
Validacin
DocumentType
Contrasea asociada al
usuario.
Cdigo de empresa (RUT, RFC,
CNPJ, CUIT, etc..) emisora del
Documento.
Tipo del documento.
DocumentNumber
Sender
12
Documento Confidencial
Mtodo DocumentTracking()
Este mtodo permite recuperar el histrico de los cambios de estado de los
documentos electrnicos almacenados en Sign@ture Server.
Descripcin de Parmetros
DocumentTracking(string Subscriber, string UserName, string Password, string
Sender, string DocumentType, long DocumentNumber)
Parmetro
Suscriber
UserName
Password
Descripcin
Validacin
DocumentType
Contrasea asociada al
usuario.
Cdigo de empresa (RUT, RFC,
CNPJ, CUIT, etc..) emisora del
Documento.
Tipo del documento.
DocumentNumber
Sender
13