API WebService - nilehmann/FiscalizaTuColegio GitHub Wiki

Table of Contents

Ingresar Denuncia

Enviar petición post con la variable denuncia que contiene un objeto json serializado. Si el correo ya se encuentra en la base de datos la informacion del usuario se actualiza

 url: "http://fiscalizatucolegio.cadcc.cl/reclamos/add"
 type: POST
 json data: {
   texto: (string),
   titulo: (string),
   correo: (string, mail format),
   nombre: (string),
   telefono: (string),  //Puede estar ausente
   fotos: (arrayof string),  //Arrego de codificaciones base64, puede estar ausente
   categoria: (int), //id categoria
   categoria_usuario: (int),  //id categoria de usuario
   colegio: (int) //rbd colegio
 }
Ejemplo
 var denuncia = {
   titulo: 'Mi denuncia',
   texto: 'El techo se llueve',
   correo: '[email protected]',
   nombre: 'Yamir',
   categoria: 1,
   categoria_usuario: 2,
   colegio: 453
   fotos: ["sfjsdiiwkekjhfs==", "sldkfsldkfj=="],
 }
 $.post("http://fiscalizatucolegio.cadcc.cl/reclamos/add",
        {denuncia: JSON.stringify(denuncia)},
        function(data){console.log(data)}
 );

Responses

El servidor responde un objeto json serializado. La propiedad status indica si la operación fue realizada con éxito

FATAL ERROR

Si la petición post no contiene la variable denuncia o esta tiene un formato incorrecto el servidor responde FATAL ERROR.

 response: {status: "FATAL ERROR", error: <Explicación error>}
ERROR

Si el objeto enviado proporciona información incorrecta (correo con mal formato, campos vacios, categoria inexistente, etc) el servidor responde ERROR indicando que campos contenian errores junto con una descripción.

 response: {status: "ERROR", errors: {"correo": "Correo inválido"}}
OK

Si la denuncia fue ingresada, el servidor responde OK.

 response: {status: "OK"}

Listar Colegios

Listar colegios pertenecientes a una comuna.

 url: http://fiscalizatucolegio.cadcc.cl/colegios/listar/{id_comuna}
 response: {rbd1: nombre1, rbd2: nombre2,...}
 ej: {"8485":"LICEO INSTITUTO NACIONAL", "8487":"LICEO JAVIERA CARRERA"}

Listar Denuncias

Lista 'limit' denuncias partiendo de la denuncia 'offset'. Responde además la cantidad total de denuncias.

 url: http://fiscalizatucolegio.cadcc.cl/reclamos/{offset}/{limit}
 response: {denuncias: [denuncia1, denuncia2,...], cantidad: n}
 info denuncia: {
   Denuncia: {
     titulo: titulo,
     texto: texto
   }
   Imagenes: [src1, src2,...], //Direcciones imagenes para usar por ejemplo en src de tag img
   Colegio:{
     rbd: rbd,
     nombre: nombre
   }
 }

Listar Comunas

 url: http://fiscalizatucolegio.cadcc.cl/comunas/listar/{id_region}
 response: {id1: nombre, id2: nombre2...}

Listar Regiones

 url: http://fiscalizatucolegio.cadcc.cl/regiones/listar/
 response: {id1: region1, id2; region2,...}

Get Data

Devuelve informacion de categorias, categorias de usuarios y comunas

 url: http://fiscalizatucolegio.cadcc.cl/reclamos/getData
 response: {comunas: [...], categorias: [...], categoria_usuarios: [...]}
⚠️ **GitHub.com Fallback** ⚠️