API

Módulo API

api/agn/cupon

...

getlist

____

https://restelix.com/api/agn/cupon/getlist

Request:

`numpagina`	Opcional. Página actual. Default: 0
`renglonespagina`	Opcional. Renglones por página. Default: 20
`orden`	Opcional. Campo(s) para ordenar la lista (Ej: fecha:A)
`fields`	Opcional. Lista de campos a incluir en `lista` (separados por coma)
`folio`	Filtro opcional
`referencia`	Filtro opcional
`fecha`	Filtro opcional
`fecha_g`	Filtro opcional
`fecha_l`	Filtro opcional
`idagencia`	Filtro opcional
`agencia`	Filtro opcional
`idhospedaje`	Filtro opcional
`huesped_hospedaje`	Filtro opcional
`idhabitacion`	Filtro opcional
`habitacion`	Filtro opcional
`idreservacion`	Filtro opcional
`clave_reservacion`	Filtro opcional
`idreservagrupo`	Filtro opcional
`clave_reservagrupo`	Filtro opcional
`responsable`	Filtro opcional
`tp`	Filtro opcional
`st`	Filtro opcional

Response:

`code`	Código HTTP
`st`	Status de la llamada
`msg`	Descripción del Status
`numregistros`	Número total de registros
`numpaginas`	Número de páginas en base a `renglonespagina`
`numpagina`	Número de página actual
`renglonespagina`	Número de renglones por página
`lista`	Arreglo de registros que cumplen con los filtros
`fields`	Arreglo de los campos incluidos en la lista
`filtro`	Arreglo asociativo campo:valor de los filtros aplicados
`orden`	Campo(s) empleados para ordenar de la lista

Campos de lista:

`id`
`folio`
`numfolio`
`referencia`
`fecha`
`idagencia`
`agencia`
`idhospedaje`
`huesped_hospedaje`
`idhabitacion`
`habitacion`
`idreservacion`
`clave_reservacion`
`referencia_reservacion`
`huesped_reservacion`
`folio_reservacion`
`subtotal`
`iva`
`importe`
`responsable`
`tp`
`tipo`
`st`
`status`

getlist_csv

____

https://restelix.com/api/agn/cupon/getlist_csv

Request:

Ver getlist

Response:

`code`	Código HTTP
`st`	Status de la llamada
`msg`	descripción del Status
`filename`	Nombre del archivo
`archivo`	Contenido del archivo base64

get

____

https://restelix.com/api/agn/cupon/get

Request:

`id`	ID del objeto

Response:

`code`	Código HTTP
`st`	Status de la llamada
`msg`	descripción del Status
`master`
`detail`

Campos de master:

`id`
`prefijo`
`numfolio`
`referencia`
`idagencia`
`idhospedaje`
`idreservacion`
`idreservagrupo`
`fecha`
`fecha_ingreso`
`fecha_egreso`
`tp`
`st`
`id_htlSegmento`
`id_htlSubSegmento`
`id_htlPaquete`
`idresponsable`
`fecha_cancelo`
`hora_cancelo`
`idusuario_cancelo`
`motivo_cancelo`
`noches`
`vp`
`adultos`
`menores`
`infantes`
`id_htlHuesped`
`h1_nombre`
`h1_apellidos`
`h1_sx`
`h1_re`
`h1_fechanac`
`h1_email`
`h1_celular`
`h1_telefono`
`h1_nota`
`h1_pin`
`direccion`
`ciudad`
`estado`
`pais`
`cp`
`empresa`
`id_cltCliente`
`ft_nombre`
`ft_rfc`
`ft_regIDTrib`
`ft_calle`
`ft_noexterior`
`ft_nointerior`
`ft_colonia`
`ft_ciudad`
`ft_municipio`
`ft_estado`
`ft_pais`
`ft_cp`
`ft_email`
`ft_idregimen`
`rate_subtotal`
`rate_sinpropina`
`rate_sinimpuestos`
`rate_hospedaje`
`rate_alimentos`
`rate_bebidas`
`rate_propina`
`rate_iva`
`rate_ish`
`rate_importe`
`rate_noche`
`subtotal`
`iva`
`ish`
`importe`
`saldo`
`totalfacturado`
`notas`
`folio`
`tipo`
`status`
`clave_agencia`
`agencia`
`huesped_hospedaje`
`idhabitacion`
`habitacion`
`clave_reservacion`
`referencia_reservacion`
`huesped_reservacion`
`folio_reservacion`
`responsable`

Campos de detail:

Status de Respuesta:

`001`	OK
`C021`	Falta parámetro de búsqueda
`C022`	Objeto no encontrado

get_pdf

____

https://restelix.com/api/agn/cupon/get_pdf

Request:

`id`	ID del objeto

Response:

`code`	Código HTTP
`st`	Status de la llamada
`msg`	descripción del Status
`clave`	Clave del objeto
`folio`	Folio del objeto
`filename`	Nombre del archivo
`archivo`	Contenido del archivo base64

get_docx

____

https://restelix.com/api/agn/cupon/get_docx

Request:

`id`	ID del objeto
`idformato`	ID del formato

Response:

`code`	Código HTTP
`st`	Status de la llamada
`msg`	descripción del Status
`clave`	Clave del objeto
`folio`	Folio del objeto
`filename`	Nombre del archivo
`archivo`	Contenido del archivo base64

Status de Respuesta:

`001`	OK
`C021`	Falta parámetro de búsqueda
`C022`	Objeto no encontrado
`C099`	Error en los datos. Regresa el arreglo 'err' con la lista de errores

create

____

https://restelix.com/api/agn/cupon/create

Request:

master Valores de las propiedades del nuevo objeto

Campos para master:

`prefijo`
`numfolio`
`referencia`
`idagencia`
`idhospedaje`
`idreservacion`
`idreservagrupo`
`fecha`
`fecha_ingreso`
`fecha_egreso`
`tp`
`st`
`id_htlSegmento`
`id_htlSubSegmento`
`id_htlPaquete`
`idresponsable`
`fecha_cancelo`
`hora_cancelo`
`idusuario_cancelo`
`motivo_cancelo`
`noches`
`vp`
`adultos`
`menores`
`infantes`
`id_htlHuesped`
`h1_nombre`
`h1_apellidos`
`h1_sx`
`h1_re`
`h1_fechanac`
`h1_email`
`h1_celular`
`h1_telefono`
`h1_nota`
`h1_pin`
`direccion`
`ciudad`
`estado`
`pais`
`cp`
`empresa`
`id_cltCliente`
`ft_nombre`
`ft_rfc`
`ft_regIDTrib`
`ft_calle`
`ft_noexterior`
`ft_nointerior`
`ft_colonia`
`ft_ciudad`
`ft_municipio`
`ft_estado`
`ft_pais`
`ft_cp`
`ft_email`
`ft_idregimen`
`rate_subtotal`
`rate_sinpropina`
`rate_sinimpuestos`
`rate_hospedaje`
`rate_alimentos`
`rate_bebidas`
`rate_propina`
`rate_iva`
`rate_ish`
`rate_importe`
`rate_noche`
`subtotal`
`iva`
`ish`
`importe`
`saldo`
`totalfacturado`
`notas`
`folio`
`tipo`
`status`
`clave_agencia`
`agencia`
`huesped_hospedaje`
`idhabitacion`
`habitacion`
`clave_reservacion`
`referencia_reservacion`
`huesped_reservacion`
`folio_reservacion`
`responsable`

Response:

`code`	Código HTTP
`st`	Status de la llamada
`msg`	descripción del Status
`id`	ID del objeto creado

Status de Respuesta:

`001`	OK
`C099`	Error en los datos. Regresa el arreglo 'err' con la lista de errores

delete

____

https://restelix.com/api/agn/cupon/delete

Request:

`id`	ID del objeto a borrar

Response:

`code`	Código HTTP
`st`	Status de la llamada
`msg`	descripción del Status

Status de Respuesta:

`001`	OK
`C021`	Falta parámetro de búsqueda
`C022`	Objeto no encontrado
`C023`	Existen registros asociados

cancel

____

https://restelix.com/api/agn/cupon/cancel

Request:

`id`	ID del objeto a cancelar
`motivo`	Motivo de la cancelación

Response:

`code`	Código HTTP
`st`	Status de la llamada
`msg`	descripción del Status

Status de Respuesta:

`001`	OK
`C021`	Falta parámetro de búsqueda
`C022`	Objeto no encontrado

file_list

____

https://restelix.com/api/agn/cupon/file_list

Request:

`id`	ID del objeto

Response:

`code`	Código HTTP
`st`	Status de la llamada
`msg`	descripción del Status
`archivos`	Lista de archivos. Estructura: [ruta, filename, ext, size]
`disco`	Valores del disco: cuota, uso, libre, uso_p

file_upload

____

https://restelix.com/api/agn/cupon/file_upload

Request:

`id`	ID del objeto
`filename`	Nombre del archivo con extensión
`archivo`	Contenido del archivo en Base64

Response:

`code`	Código HTTP
`st`	Status de la llamada
`msg`	descripción del Status
`archivos`	Lista de archivos. Estructura: [ruta, filename, ext, size]
`disco`	Valores del disco: cuota, uso, libre, uso_p

Status de Respuesta:

`001`	OK
`C021`	Falta parámetro de búsqueda
`C022`	Objeto no encontrado
`F032`	Espacio de disco saturado
`F033`	Falta nombre del archivo
`F034`	Falta el archivo
`F035`	Tamaño del archivo supera máximo permitido

file_delete

____

https://restelix.com/api/agn/cupon/file_delete

Request:

`id`	ID del objeto
`filename`	Nombre del archivo a borrar

Response:

`code`	Código HTTP
`st`	Status de la llamada
`msg`	descripción del Status

Status de Respuesta:

`001`	OK
`C021`	Falta parámetro de búsqueda
`C022`	Objeto no encontrado
`F033`	Falta nombre del archivo
`F036`	No se puede borrar el archivo

facturar

____

https://restelix.com/api/agn/cupon/facturar

Request:

`id`	ID del objeto

Response:

`code`	Código HTTP
`st`	Status de la llamada
`msg`	descripción del Status

Status de Respuesta:

`001`	OK
`C021`	Falta parámetro de búsqueda
`C022`	Objeto no encontrado
`C023`	Existen registros asociados
`C024`	Faltan datos
`C030`	Campo requerido
`C031`	Valor requerido
`C032`	Valor requerido (no cero)
`C033`	Valor inferior al mínimo
`C034`	Valor superior al máximo
`C035`	Valor fuera del rango
`C036`	Valor duplicado
`C037`	Valor incorrecto
`C041`	Acción no permitida
`C042`	Requiere autorización
`F032`	Espacio de disco saturado
`F033`	Falta nombre del archivo
`F034`	Falta el archivo
`F035`	Tamaño del archivo supera máximo permitido
`F036`	No se puede borrar el archivo
`F042`	Falta ID del formato
`F043`	Plantilla del formato no encontrada o asignada