¡Esta es una revisión vieja del documento!
Tabla de Contenidos
Generalidades
Método
POST
Formato
Puertos posibles
- 8000
Direcciones ip posibles
- local: 192.168.3.81
Credenciales usuario
Estas credenciales no son precisas para la interfaz, pero se indican aquí para que el administrador de Smart pueda establecer restricciones o privilegios de acceso a tablas y procedimientos.
- Id: WEB
- Contraseña: en7dE93z
Otros
Para los ejemplos, se ha utilizado “Postman v8.0.4”
Ticket: #223382
Datos del cliente
Procedimiento
XATJ_NZK_DATOS_CLIENTE
Parámetros
- P_CIF_NIF VARCHAR(20)
Resultados
- S_CODIGO VARCHAR(10),
- S_RAZON_SOCIAL VARCHAR(60),
- S_DIRECCION VARCHAR(60),
- S_COD_POSTAL VARCHAR(20),
- S_POBLACION VARCHAR(60),
- S_TELEFONO VARCHAR(60),
- S_CORREO_E VARCHAR(254)
Comportamiento
Devuelve la información relativa al primer cliente que el sistema encuentre cuyo CIF/NIF coincida con el introducido como parámetro.
En caso de que no se encuentre ninguno, el parámetro S_RAZON_SOCIAL tendrá el valor <INEXISTENTE>.
Ejemplo
Cuerpo del método post
{ "version" : "1.2", "metodo" : "Raw", "opciones" : { "metaData":true }, "comandos" : [ { "sql":"SELECT * FROM XATJ_NZK_DATOS_CLIENTE(:CifNif)", "params": { "CifNif" : "B70180823"} } ] }
Resultado
{ "version": "1.2", "resultados": [ { "estado": "OK", "metaData": { "S_CODIGO": { "tipo": "ftString", "etiqueta": "Código" }, "S_RAZON_SOCIAL": { "tipo": "ftString", "etiqueta": "Razón social" }, "S_DIRECCION": { "tipo": "ftString", "etiqueta": "Dirección" }, "S_COD_POSTAL": { "tipo": "ftString", "etiqueta": "Cód. postal" }, "S_POBLACION": { "tipo": "ftString", "etiqueta": "Población" }, "S_TELEFONO": { "tipo": "ftString", "etiqueta": "Teléfono" }, "S_CORREO_E": { "tipo": "ftString", "etiqueta": "Correo electrónico" } }, "datos": [ { "S_CODIGO": "027893", "S_RAZON_SOCIAL": "CHF SOLUCIONES CERRAJERAS, S.L.", "S_DIRECCION": "LUGAR AGRA - NOVA S/N POUSADA", "S_COD_POSTAL": "15881", "S_POBLACION": "BOQUEIXON", "S_TELEFONO": "628263544", "S_CORREO_E": "administracion@chfsolucionescerrajeras.es" } ] } ] }
Relación de obras activas de un cliente
Procedimiento
XATJ_NZK_OBRAS_CLIENTE
Parámetros
- P_CODIGO VARCHAR(20)
Resultados
- S_CODIGO VARCHAR(10),
- S_DESCRIPCION VARCHAR(60),
- S_DESCRIPCION2 VARCHAR(60),
- S_DESCRIPCION3 VARCHAR(60),
- S_DESCRIPCION4 VARCHAR(60),
- S_POBLACION VARCHAR(60)
Comportamiento
Devuelve una relación de las obras activas del cliente identificado mediante el parámetro P_CODIGO. Este identificativo puede ser el CIF/NIF o el código que devuelve el procedimiento XATJ_NZK_DATOS_CLIENTE.
Ejemplo
Cuerpo
{ "version" : "1.2", "metodo" : "Raw", "opciones" : { "metaData":true }, "comandos" : [ { "sql":"SELECT * FROM XATJ_NZK_OBRAS_CLIENTE(:Codigo)", "params": { "Codigo" : "B70180823"} } ] }
Resultado
{ "version": "1.2", "resultados": [ { "estado": "OK", "metaData": { "S_CODIGO": { "tipo": "ftString", "etiqueta": "Código" }, "S_DESCRIPCION": { "tipo": "ftString", "etiqueta": "Descripción" }, "S_DESCRIPCION2": { "tipo": "ftString", "etiqueta": "Descripción 2" }, "S_DESCRIPCION3": { "tipo": "ftString", "etiqueta": "Descripción 3" }, "S_DESCRIPCION4": { "tipo": "ftString", "etiqueta": "Descripción 4" }, "S_POBLACION": { "tipo": "ftString", "etiqueta": "Población" } }, "datos": [ { "S_CODIGO": "OB040472", "S_DESCRIPCION": "Sus instalaciones Boqueixon", "S_DESCRIPCION2": null, "S_DESCRIPCION3": null, "S_DESCRIPCION4": null, "S_POBLACION": "BOQUEIXON" }, { "S_CODIGO": "OB040577", "S_DESCRIPCION": "Nave Bein Sport P. Ind. de Palas de Rei", "S_DESCRIPCION2": null, "S_DESCRIPCION3": null, "S_DESCRIPCION4": null, "S_POBLACION": "BOQUEIXON" }, { "S_CODIGO": "OB040579", "S_DESCRIPCION": "P. Tambre", "S_DESCRIPCION2": null, "S_DESCRIPCION3": null, "S_DESCRIPCION4": null, "S_POBLACION": "BOQUEIXON" }, { "S_CODIGO": "OB040597", "S_DESCRIPCION": "Lalín ", "S_DESCRIPCION2": null, "S_DESCRIPCION3": null, "S_DESCRIPCION4": null, "S_POBLACION": "BOQUEIXON" }, { "S_CODIGO": "OB041369", "S_DESCRIPCION": "A Golada, Pontevedra", "S_DESCRIPCION2": null, "S_DESCRIPCION3": null, "S_DESCRIPCION4": null, "S_POBLACION": "BOQUEIXON" }, { "S_CODIGO": "OB041649", "S_DESCRIPCION": "Avicola O Porto, Sobrado (A Coruña)", "S_DESCRIPCION2": null, "S_DESCRIPCION3": null, "S_DESCRIPCION4": null, "S_POBLACION": "BOQUEIXON" }, { "S_CODIGO": "OB041990", "S_DESCRIPCION": "Candido, Lalín (Pontevedra)", "S_DESCRIPCION2": null, "S_DESCRIPCION3": null, "S_DESCRIPCION4": null, "S_POBLACION": "BOQUEIXON" }, { "S_CODIGO": "OB042125", "S_DESCRIPCION": "Toques, A Coruña", "S_DESCRIPCION2": "SOLER", "S_DESCRIPCION3": null, "S_DESCRIPCION4": null, "S_POBLACION": "BOQUEIXON" }, { "S_CODIGO": "OB042418", "S_DESCRIPCION": "Pepito, Toques, A Coruña", "S_DESCRIPCION2": "SOLER", "S_DESCRIPCION3": null, "S_DESCRIPCION4": null, "S_POBLACION": "BOQUEIXON" }, { "S_CODIGO": "OB043062", "S_DESCRIPCION": "Cristina, Toques, A Coruña", "S_DESCRIPCION2": null, "S_DESCRIPCION3": null, "S_DESCRIPCION4": null, "S_POBLACION": "BOQUEIXON" }, { "S_CODIGO": "OB043201", "S_DESCRIPCION": "GASOLINERA A BÁSCULA ( MEICENDE )", "S_DESCRIPCION2": "Comisión: Soler Gabín", "S_DESCRIPCION3": null, "S_DESCRIPCION4": null, "S_POBLACION": "BOQUEIXON" } ] } ] }
Estado de depósitos de un cliente
Procedimiento
XATJ_NZK_ESTADO_DEPOSITO
Parámetros
- P_CODIGO VARCHAR(20)
Resultados
- S_NOM_TERCERO VARCHAR(60),
- S_COD_ALMACEN VARCHAR(10),
- S_NOM_ALMACEN VARCHAR(60),
- S_ARTICULO VARCHAR(10),
- S_NOM_ARTICULO VARCHAR(60),
- S_CANTIDAD NUMERIC(17,5),
- S_NRO_SERIE VARCHAR(20),
- S_COD_CTO_ALQ VARCHAR(10)
Comportamiento
Presenta la información precisa para la elaboración del informe de “estado de depósitos” para el cliente con el identificativo facilitado en P_CODIGO. Este identificativo puede ser el CIF/NIF o el código que devuelve el procedimiento XATJ_NZK_DATOS_CLIENTE.
Ejemplos
Estado de depósitos filtrando por nombre de artículo
Relación de los contratos emitidos a un cliente
Procedimiento
XATJ_NZK_CONTRATOS_CLIENTE2
Parámetros
- P_CODIGO VARCHAR(20),
- P_VIVOS VARCHAR(1)
Resultados
- S_COD_CTO_ALQ VARCHAR(10),
- S_FECHA TIMESTAMP,
- S_COD_OBRA VARCHAR(10),
- S_LUGAR_TRABAJO VARCHAR(120)
Comportamiento
Relación de los números de contrato emitidos a un cliente.
El parámetro P_VIVOS sirve para filtrar según se indica a continuación:
- “S”: sólo mostrará contratos que a la fecha de la consulta tengan material pendiente de devolución, independientemente de si se han facturado estos contratos o no.
- “N”: sólo los contratos sin material pendiente de recoger.
- Si no se indica parámetro, se mostrarán todos los contratos.
El P_CODIGO puede ser el CIF/NIF o el código que devuelve el procedimiento XATJ_NZK_DATOS_CLIENTE.
Ejemplos
Contratos vivos
{ "version" : "1.2", "metodo" : "Raw", "opciones" : { "metaData":true }, "comandos" : [ { "sql":"SELECT * FROM XATJ_NZK_CONTRATOS_CLIENTE2(:Codigo, :Vivos)", "params": { "Codigo" : "027893", "Vivos" : "S"} } ] }
Todos los contratos ordenados por fecha en forma descendente
{ "version" : "1.2", "metodo" : "Raw", "opciones" : { "metaData":true }, "comandos" : [ { "sql":"SELECT * FROM XATJ_NZK_CONTRATOS_CLIENTE2(:Codigo, :Vivos) ORDER BY S_FECHA DESC", "params": { "Codigo" : "027893"} } ] }
Datos para la elaboración de un contrato
Procedimiento
XATJ_NZK_DATOS_CONTRATO
Parámetros
- P_COD_CTO_ALQ VARCHAR(10)
Resultados
- S_COD_CTO VARCHAR(10),
- S_FECHA TIMESTAMP,
- S_FECHA_ALTA TIMESTAMP,
- S_FECHA_VTO TIMESTAMP,
- S_NOMBRE VARCHAR(120),
- S_CIF_NIF VARCHAR(60),
- S_DIRECCION VARCHAR(60),
- S_PROVINCIA VARCHAR(60),
- S_COD_POSTAL VARCHAR(20),
- S_POBLACION VARCHAR(60),
- S_TELEFONO VARCHAR(60),
- S_COD_OBRA VARCHAR(10),
- S_LUGAR_TRABAJO VARCHAR(60),
- S_FORMA_PAGO VARCHAR(120),
- S_SOLICITANTE VARCHAR(254),
- S_ENTREGADO_A VARCHAR(60),
- S_NRO_PEDIDO VARCHAR(20),
- S_COD_PRODUCTO VARCHAR(10),
- S_DESCRIPCION_LIN VARCHAR(175),
- S_CANTIDAD NUMERIC(17,5),
- S_COD_UDAD VARCHAR(10),
- S_PRECIO NUMERIC(17,5),
- S_COD_UDAD_PRECIO VARCHAR(10),
- S_PORC_DTO NUMERIC(17,5),
- S_NOM_TERCERO_TRANS VARCHAR(60),
- S_VEHICULO VARCHAR(10)
Comportamiento
En P_COD_CTO_ALQ se habrá de indicar alguno de los valores obtenidos de ATJ_NZK_CONTRATOS_CLIENTE2.S_COD_CTO_ALQ.
Ejemplo
{ "version" : "1.2", "metodo" : "Raw", "opciones" : { "metaData":true }, "comandos" : [ { "sql":"SELECT * FROM XATJ_NZK_DATOS_CONTRATO(:Contrato)", "params": { "Contrato" : "S19-002991"} } ] }
Facturas a descargar
Procedimiento
XATJ_NZK_DESCARGA_FACTURAS
Parámetros
- P_CODIGO VARCHAR(10)
Resultados
- S_NRO_FACTURA VARCHAR(10),
- S_FECHA_EMISION TIMESTAMP,
- S_COD_OBRA VARCHAR(10),
- S_DESC_OBRA VARCHAR(60),
- S_RUTA VARCHAR(1024)
Comportamiento
Devuelve los datos fundamentales de las facturas del cliente, así como la URL local para proceder a su descarga o visualización.
Ejemplo
{ "version" : "1.2", "metodo" : "Raw", "opciones" : { "metaData":true }, "comandos" : [ { "sql":"SELECT * FROM XATJ_NZK_DESCARGA_FACTURAS(:Codigo) ORDER BY S_FECHA_EMISION DESC", "params": { "Codigo" : "027893"} } ] }