Tabla de Contenidos
Generalidades
Método
POST
Formato
Puertos posibles
- 8000
Direcciones ip posibles
- local: 192.168.1.125
- wan: 86.109.112.43
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: alv2512
Otros
Para los ejemplos, se ha utilizado “Postman v9.19.0”
Datos de clientes
Procedimiento
XALV_IKV_CLIENTES
Resultados
- S_CLAVE VARCHAR(10),
- S_EMPRESA VARCHAR(60),
- S_TIPO_TERCERO VARCHAR(10),
- S_COD_TERCERO VARCHAR(60),
- S_RAZON_SOCIAL VARCHAR(60),
- S_DENOMINACION VARCHAR(60),
- S_COD_POSTAL VARCHAR(60),
- S_POBLACION VARCHAR(60),
- S_PROVINCIA VARCHAR(60),
- S_CIF_NIF VARCHAR(60),
- S_TELEFONO VARCHAR(60),
- S_CORREO_E VARCHAR(254)
Comportamiento
Devuelve los datos de todos los clientes activos.
Ejemplo
Cuerpo del método post
{
"version" : "1.2",
"metodo" : "Select",
"opciones" : { "metaData":true },
"params" : ["XALV_IKV_CLIENTES", []]
}
Resultado
{
"version": "1.1",
"result": [
[
"ALR",
"ALVEMACO RENTACAR S.L",
"CL",
"000020",
"CONTRATOS ALQUILER CONTADO",
"CONTRATOS ALQUILER CONTADO",
"",
"",
"",
"",
"",
null
],
[
"ALR",
"ALVEMACO RENTACAR S.L",
"CL",
"001037",
"AYUNTAMIENTO TINEO",
"AYUNTAMIENTO TINEO",
"33870",
"TINEO",
"ASTURIAS",
"P3307300H",
"985800232",
"manuelfg@tineo.es"
],
[
"ALR",
"ALVEMACO RENTACAR S.L",
"CL",
"001600",
"ALBA GARCIA, HIGINIO",
"ALBA GARCIA, HIGINIO",
"33690",
"LUGO DE LLANERA",
"ASTURIAS",
"14773224W",
"646 20 84 85",
null
],
[
"ALR",
"ALVEMACO RENTACAR S.L",
"CL",
"002114",
"TABLEROS Y PUENTES,S.A.",
"TAPUSA",
"33202",
"GIJON",
"ASTURIAS",
"A33615931",
"985336611/653840799",
null
],
[
"ALR",
"ALVEMACO RENTACAR S.L",
"CL",
"001715",
"PROCOIN,S.L.",
"PROCOIN,S.L.",
"33221",
"LLANERA",
"ASTURIAS",
"B33046046",
"985980808 / 985262113",
null
],
. . . .
Datos de documentos de entrega
Procedimiento
XALV_IKV_CONTRATOS
Parámetros
- P_CLIENTES VARCHAR(4096): Lista de códigos de clientes separados por comas.
- P_FEC_DESDE TIMESTAMP: Fecha desde, en formato dd-mm-aaaa
- P_FEC_HASTA TIMESTAMP: Fecha hasta, en formato dd-mm-aaaa
- P_NRO_CTO_PPAL VARCHAR(20): Número de documento principal
Los valores de los parámetros se rodean de dobles comillas.
Si algún parámetro ha de omitirse, se ha de poner el literal NULL en su lugar, sin las comillas.
Comportamiento
Devuelve los datos de los documentos de entrega que cumplen los criterios dados por los parámetros.
En los ejemplos se puede ver más claro esto.
Resultados
- S_DOCUMENTO_ENTREGA VARCHAR(10),
- S_TIPO_TERCERO VARCHAR(10),
- S_CODIGO_CLIENTE VARCHAR(10),
- S_RAZON_CLIENTE VARCHAR(60),
- S_DENOMINACION_CLIENTE VARCHAR(60),
- S_CODIGO_OBRA VARCHAR(10),
- S_DESCRIPCION_OBRA VARCHAR(60),
- S_DESCRIPCION_VEHICULO VARCHAR(60),
- S_OBSERVACIONES VARCHAR(254),
- S_REFERENCIA VARCHAR(20),
- S_MATRICULA VARCHAR(20),
- S_PRECIO_DIA NUMERIC(17,5),
- S_PRECIO_MES NUMERIC(17,5),
- S_FRANQUICIA NUMERIC(17,5),
- S_TODORIESGO VARCHAR(10),
- S_PRECIO_TODORIESGO NUMERIC(17,5),
- S_CODIGO_SEGURO VARCHAR(10),
- S_DIAS_ALQUILER INTEGER,
- S_PLAZO_CONTRATO VARCHAR(10),
- S_VENCIMIENTO TIMESTAMP,
- S_MAX_KMDIA NUMERIC(17,5),
- S_PRECIO_KMEXCESO NUMERIC(17,5),
- S_CONTRATO VARCHAR(20),
- S_DNI_ENTREGA VARCHAR(20),
- S_NOMBRE_ENTREGA VARCHAR(60),
- S_FECHA_ENTREGA TIMESTAMP,
- S_FECHA_INICIOCTO TIMESTAMP,
- S_KM_ENTREGA NUMERIC(17,5),
- S_IMPORTE_COMBUSTIBLE NUMERIC(17,5),
- S_NIVEL_COMBUSTIBLE VARCHAR(10),
- S_ACCESORIOS VARCHAR(4096): Lista de accesorios separados por coma.
Los parámetros se corresponden con la lista proporcionada por Jorge Santos.
Ejemplo 1
Todos los documentos de entrega del cliente número 005662
{
"version" : "1.2",
"metodo" : "Select",
"opciones" : { "metaData":true },
"params" : ["XALV_IKV_CONTRATOS", ["005662", NULL, NULL, NULL]]
}
Ejemplo 2
Todos los documentos de entrega del mes de enero
{
"version" : "1.2",
"metodo" : "Select",
"opciones" : { "metaData":true },
"params" : ["XALV_IKV_CONTRATOS", [NULL, "1-1-2023", "1-31-2023", NULL]]
}
Ejemplo 3
Los documentos de entrega del 13 de enero de los clientes 005662 y 011604
{
"version" : "1.2",
"metodo" : "Select",
"opciones" : { "metaData":true },
"params" : ["XALV_IKV_CONTRATOS", ["005662,011604", "13-1-2023", "13-1-2023", NULL]]
}
Ejemplo 4
El documento de entrega correspondiente al contrato número 234989099
{
"version" : "1.2",
"metodo" : "Select",
"opciones" : { "metaData":true },
"params" : ["XALV_IKV_CONTRATOS", [NULL, NULL, NULL, "234989099"]]
}
Datos de documentos de recogida
Procedimiento
XALV_IKV_RECOGIDAS
Parámetros
- P_CLIENTES VARCHAR(4096): Lista de códigos de clientes separados por comas.
- P_FEC_DESDE TIMESTAMP: Fecha desde, en formato dd-mm-aaaa
- P_FEC_HASTA TIMESTAMP: Fecha hasta, en formato dd-mm-aaaa
- P_NRO_CTO_PPAL VARCHAR(20): Número de documento principal
Los valores de los parámetros se rodean de dobles comillas.
Si algún parámetro ha de omitirse, se ha de poner el literal NULL en su lugar, sin las comillas.
Comportamiento
Una recogida tiene como identificativo el mismo que el del documento de entrega a él vinculado.
Este procedimiento devuelve los datos concernientes a la finalización del alquiler de los documentos de entrega.
Funciona de forma análoga al procedimiento XALV_IKV_CONTRATOS, con el que comparte gran parte de los datos. Así pues, el procedimiento XALV_IKV_RECOGIDAS presenta los mismos registros que XALV_IKV_CONTRATOS, exceptuando aquéllos para los que no exista “Fecha de recogida”.
El período de selección de fechas se realiza sobre “Fecha de recogida”.
Resultados
- S_DOCUMENTO_ENTREGA VARCHAR(10),
- S_TIPO_TERCERO VARCHAR(10),
- S_CODIGO_CLIENTE VARCHAR(10),
- S_RAZON_CLIENTE VARCHAR(60),
- S_DENOMINACION_CLIENTE VARCHAR(60),
- S_CODIGO_OBRA VARCHAR(10),
- S_DESCRIPCION_OBRA VARCHAR(60),
- S_DESCRIPCION_VEHICULO VARCHAR(60),
- S_OBSERVACIONES VARCHAR(254),
- S_REFERENCIA VARCHAR(20),
- S_MATRICULA VARCHAR(20),
- S_PRECIO_DIA NUMERIC(17,5),
- S_PRECIO_MES NUMERIC(17,5),
- S_FRANQUICIA NUMERIC(17,5),
- S_TODORIESGO VARCHAR(10),
- S_PRECIO_TODORIESGO NUMERIC(17,5),
- S_CODIGO_SEGURO VARCHAR(10),
- S_DIAS_ALQUILER INTEGER,
- S_PLAZO_CONTRATO VARCHAR(10),
- S_VENCIMIENTO TIMESTAMP,
- S_MAX_KMDIA NUMERIC(17,5),
- S_PRECIO_KMEXCESO NUMERIC(17,5),
- S_CONTRATO VARCHAR(20),
- S_DNI_RECOGIDA VARCHAR(20),
- S_NOMBRE_RECOGIDA VARCHAR(60),
- S_FECHA_RECOGIDA TIMESTAMP,
- S_FECHA_BAJA TIMESTAMP,
- S_KM_RECOGIDA NUMERIC(17,5),
- S_IMPORTE_RELLENO NUMERIC(17,5),
- S_NIVEL_COMBUSTIBLE VARCHAR(10): a la recogida, se entiende.
- S_ACCESORIOS VARCHAR(4096): Lista de accesorios separados por coma.
Tipos de accesorio
Dado que, según el documento de requerimientos facilitado por Jorge Santos, es preciso actualizar en Smart los accesorios para un documento de entrega, se facilita esta interfaz para proporcionar la lista de los que están registrados en la aplicación.
Procedimiento
XALV_IKV_TIPOS_ACCESORIO
Resultado
- S_ACCESORIO VARCHAR(10))
Actualizaciones de Smart
Los siguientes servicios permiten actualizar ciertos datos de los documentos de entrega registrados en Smart.
En todos los casos, si la actualización se realiza correctamente, el resultado será el texto “OK”.
Cambiar el DNI del conductor
Procedimiento para la entrega
XALV_IKV_DNI_ENTREGA
Procedimiento para la recogida
XALV_IKV_DNI_RECOGIDA
Parámetros
- P_DOCUMENTO_ENTREGA VARCHAR(10),
- P_DNI VARCHAR(20))
Resultado
- S_RESULTADO VARCHAR(60)
Ejemplo
{
"version" : "1.2",
"metodo" : "Select",
"params" : ["XALV_IKV_DNI_ENTREGA", ["234989099", "B12345678"]]
}
Cambiar las fechas
Procedimiento para la fecha de entrega
XALV_IKV_FECHA_ENTREGA
Procedimiento para la fecha de recogida
XALV_IKV_FECHA_RECOGIDA
Procedimiento para la fecha de baja
XALV_IKV_FECHA_BAJA
Parámetros
- P_DOCUMENTO_ENTREGA VARCHAR(10),
- P_FECHA TIMESTAMP)
Resultado
- S_RESULTADO VARCHAR(60))
Ejemplo
{
"version" : "1.2",
"metodo" : "Select",
"params" : ["XALV_IKV_FECHA_BAJA", ["234989099", "01-11-2022"]]
}
Cambiar kilómetros del vehículo
Procedimiento para los kilómetros de entrega
XALV_IKV_KM_ENTREGA
Procedimiento para los kilómetros de recogida
XALV_IKV_KM_RECOGIDA
Parámetros
- P_DOCUMENTO_ENTREGA VARCHAR(10),
- P_KM NUMERIC(17,5))
Resultado
- S_RESULTADO VARCHAR(60))
Cambiar el nivel de combustible
Procedimiento para le entrega
XALV_IKV_NIVEL_COMBUSTIBLE
Procedimiento para la recogida
XALV_IKV_NIVEL_COMBUSTIBLE_REC
Parámetros
- P_DOCUMENTO_ENTREGA VARCHAR(10),
- P_NIVEL VARCHAR(10))
Resultado
- S_RESULTADO VARCHAR(60))
Cambiar nombre del conductor
Procedimiento para la entrega
XALV_IKV_NOMBRE_ENTREGA
Procedimiento para la recogida
XALV_IKV_NOMBRE_RECOGIDA
Parámetros
- P_DOCUMENTO_ENTREGA VARCHAR(10),
- P_NOMBRE VARCHAR(20))
Resultado
- S_RESULTADO VARCHAR(60))
Registrar los accesorios
Procedimiento para la entrega
XALV_IKV_ACCESORIOS
Procedimiento para la recogida
XALV_IKV_ACCESORIOS_RECOGIDA
Parámetros
- P_DOCUMENTO_ENTREGA VARCHAR(10),
- P_LISTA_ACCESORIOS VARCHAR(4096): Lista de tipos de accesorio separados por comas. Ver la consulta de tipos de accesorio más arriba.