Módulo API

api/cyb/caja

---

...

---

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)
nombre	Filtro opcional
nota	Filtro opcional
contacto	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
nombre
nota
contacto
saldo
monSiglas

---

get

____

Request:

id	ID del objeto

Response:

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

Campos de master:

Status de Respuesta:

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

---

create

____

Request:

master

Valores de las propiedades del nuevo objeto

Campos para master:

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

---

update

____

Request:

id	ID del objeto a actualizar
master	Valores de las propiedades del objeto

Campos para master:

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
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

---

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

---

recalcularSaldo

____

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

---

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

____

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

____

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