Endpoint Actividades

jueves 21 de septiembre de 2023

Lista de actividades

Method: GET URI: /api/v1/actividades

Este endpoint permite obtener un listado de actividades según los parámetros de búsqueda y ordenación.

Request

Headers
- Content-Type: application/json
- token: <string>
- secret:<string>
Params
- sort_column: campo por el que ordenar. Podrá ser: id, nombre. Por defecto será id.
- sort_type: indica el si la ordenación es ascendente o descendente. Podrá ser: asc o desc. Por defecto será asc.
- paginate_by: número de registros a mostrar. El mínimo será 1 y el máximo 100. Por defecto serán 10.
- page: número de página a mostrar. Por defecto será 1.
- nombre: valor a buscar en el campo nombre. La búsqueda se hará con un contiene.
- razon_fiscal: valor a buscar en el campo razon_fiscal. La búsqueda se hará con un contiene.
- razon_social: valor a buscar en el campo razon_social. La búsqueda se hará con un contiene.
- alias: valor a buscar en el campo alias. La búsqueda se hará con un contiene.
- tipo_actividad: valor a buscar en el campo tipo de actividades. La búsqueda se hará con un contiene.

Response 1: 200: existen datos

{ "status": 200, "page": 1, "paginate_by": 10, "records": 2, "data": [ { "id": 211, "nombre": "actividad 1", "fecha_inicio": "2023-02-26", "hora_inicio": null, "fecha_fin": "2023-02-27", "hora_fin": "14:38:00", "comentarios": "", "completada": false }, { "id": 258, "nombre": "actividad 2", "fecha_inicio": "2023-06-06", "hora_inicio": null, "fecha_fin": "2023-06-06", "hora_fin": "18:34:00", "comentarios": "", "completada": true },{ "id": 260, "nombre": "actividad 3", "fecha_inicio": "2023-06-07", "hora_inicio": null, "fecha_fin": null, "hora_fin": null, "comentarios": "", "completada": false } ] }

Response 2: 200: no existen datos

{ "status": 200, "page": 1, "paginate_by": 10, "records": 0, "data": [] }

Response 3: 400: petición errónea

{ "status": 400, "error": "Error en la Petición" }

Response 4: 402: petición no autorizada

{ "status": 402, "error": "No autorizado" }

Prueba la API de tu instalación aquí

Detalle de actividad

Method: GET URI: /api/v1/actividades

Este endpoint permite obtener el detalle de las actividades cuyo id coincide con el parámetro suministrado.