Documentación API

Documentación API

La "API" requiere ningún tipo de autenticación para el acceso y/o usoLas siguientes secciones describen las diversas tareas que se pueden realizar.


Categorías

Las categorías se recuperan mediante el envío de una solicitud HTTP GET.

Parámetros opcionales de la solicitud:

 Parámetro 
 Descripción
 Ejemplo
 catid  Obtiene la categoría con el id específico. 
 &by=catid&id=5 

Países 

Los países se recuperan mediante el envío de una solicitud HTTP GET.

 
 Parámetro 
 Descripción
 Ejemplo
 countryid  Obtiene el país utilizando su id. &by=countryid&id=186
 coutryiso  Obtiene el país utilizando la iso que le identifica  &by=countryiso&iso=PY 
 countryname   Obtiene el país utilizando su nombre.  &by=countryname&name=Paraguay 

Ubicaciones 

Ubicaciones se recuperan mediante el envío de una solicitud HTTP GET. 

 
 Parámetro 
 Descripción
 Ejemplo
 locid  Obtiene una ubicación utilizando su id. &by=locid&id=12
 countryid  Obtiene una ubicación mediante el id del país al que pertenece.   &by=countryid&id=12 

Comentarios 

Los comentarios son recuperados mediante el envío de una solicitud HTTP GET.

 
 Parámetro 
 Descripción
 Ejemplo
 reportid  Obtiene todos los comentarios para un reporte específico.
 El id del reporte debe ser especificado.
 &by=reportid&id=73 
 approved   Obtiene todos los comentarios aprobados.  &by=approved 

Reportes

Los reportes se recuperan mediante el envío de una solicitud HTTP GET .

Parámetros opcionales de la solicitud:

 Parámetro 
 Descripción
 Ejemplo
 sinceid  Recupera los últimos ids de los reporte.  &by=sinceid&id=10
 maxid  Recupera el número máximo del reporte.  &by=maxid&id=500
 incidentid  Recupera un solo reporte utilizando su id.
 &by=incidentid&id=50
 locname  Obtiene reportes etiquetados con un nombre de ubicación específica.
 &by=locname&name=Paraguay 
 locid  Obtiene reportes etiquetados con un id especifico de la ubicación.
 &by=locid&id=12
 catname  Obtiene reportes que pertenecen a un nombre de categoría específica. 
 &by=catname&name=Health
 catid  Obtiene reportes que pertenecen a una categoría con un id específico.
 &by=catid&id=12

Valores retornados
La solicitud de informes devuelve JSON.
El campo de error contiene el mensaje y el código. Una lista de reportes sin errores debe contener message = "No Error" y el código = 0.
- El campo payload contiene la lista de reportes, y cuenta con campos de primer nivel, los incidents.
- Los campos de nivel superior retornados por cada incidente contienen multimedia, incidencia, CustomFields, comentarios, categorías.
- Los campos de reportes son:

 Parámetro
 Descripción
 Ejemplo
 incidentid  -  -
 incidenttitle  -  -
 incidentdescription   -  -
 incidentdate  -  -
 incidentactive  Bandera para el reporte aprobado.  1=approved, 0=unapproved 
 incidentverified  Bandera para el reporte verificado.   1=verified, 0-unverified
 incidentmode  Modo de enviar los reportes.  1=web
 locationid  -  -
 locationname  -  -
 locationlatitude  -  -
 locationlongitude  -  -

Enviar un Reporte

Un reporte se presenta mediante el envío de una solicitud HTTP POST.

Parámetros obligatorios de la solicitud:

 Parámetro 
 Descripción
 Ejemplo
 incident_title   El titulo del reporte.   Prueba api post 
 incident_description   La descripción del reporte.   Mucha gente esta tirando papeles en la calle. 
 incident_date  La fecha del reporte. (mm/dd/yyyy). 
 10/17/2015
 incident_hour  La hora del reporte.
 10
 incident_minute  Los minutos del reporte. 
 53
 incident_ampm  Si es am o pm.
 am
 incident_category  El id categoría del reporte. Se separan por comas
 si 
son mas de una categoría. 
 20,21
 latitude  La latitud dentro territorio paraguayo.  -27.0899
 longitude  La longitud dentro territorio paraguayo.  -55.8955
 location_name  La ubicación que este dentro del territorio paraguayo.   Itapúa
 task  -   report


Parámetros opcionales de la solicitud:

 Parámetro
 Descripción
 Ejemplo
 person_first  Nombre de la persona.   Pedro
 person_last  Apellido de la persona.  Salazar
 person_email   Email de la persona.  psalazar@derte.org.py 
 person_phone  Teléfono de la persona.  59598xxxxxxx
 incident_photo[]   Archivos subidos   File
 incident_video[]  Video.    http://www.youtube.com/watch?v=08pVpBq706k 
 incident_newsp[]   Links.    http://www.google.com

Con la API se pueden obtener en formato json y xml. Lo único que se tiene que agregar es el parámetro resp con el valor json o xml. 
Ejemplo:
- http://www.elavizor.org.py/api?task=incidents&resp=json