Latest revision as of 20:00, 29 June 2017

WalkYourPlace contiene una api rest con el cual es posible conseguir los scores si se le envían los datos a traves de una URL en formato GET.

Las peticiones se hacen bajo la url http://146.155.17.19:17080/api y las variables se envían posterior a un '?' en la misma, éstos deben ir separados por un '&'

Por ejemplo:

http://146.155.17.19:17080/api?mode=walkscore&start_point=-33.465,-70.676

Modos de viaje

Walkscore model

Para obtener el score simulando el sistema que utiliza Walkscore.com son necesarias las siguientes variables en la petición:

• start_point : El punto a evaluar, las coordenadas deben ser escritas sin un espacio de separación. Por Ej: -33.465,-70.676
• radius (opcional): Es el radio de la circunferencia a evaluar, por defecto se encuentra con el valor 1.25.
• demographic (opcional): Es la opción demográfica con el cual queremos que los datos sean evaluados (default = Young Adult (20-30) ).

Ejemplos:

http://146.155.17.19:17080/api?mode=walkscore&start_point=-33.465,-70.676

http://146.155.17.19:17080/api?mode=walkscore&start_point=-33.465,-70.676&radius=1.5

http://146.155.17.19:17080/api?mode=walkscore&start_point=-33.465,-70.676&demographic=Lawrence-Frank%20Adult

Cycling model

Para obtener el score cuando una persona viaja en bicicleta son necesarias las siguientes variables en la petición:

• start_point : El punto a evaluar, las coordenadas deben ser escritas sin un espacio de separación. Por Ej: -33.465,-70.676
• biking_time_period : El tiempo de viaje en minutos.
• demographic (opcional): Es la opción demográfica con el cual queremos que los datos sean evaluados (default = Young Adult (20-30) ).
• Escenario (opcional): Es el escenario con el cual se requiere hacer la evaluación (default=1 información de OTP sobre el territorio chileno)

Ejemplos:

http://146.155.17.19:17080/api?mode=bike&start_point=-33.465,-70.676&biking_time_period=10

http://146.155.17.19:17080/api?mode=bike&start_point=-33.465,-70.676&biking_time_period=8&demographic=Lawrence-Frank%20Adult

walking model

Para obtener el score cuando una persona caminando son necesarias las siguientes variables en la petición:

• start_point : El punto a evaluar, las coordenadas deben ser escritas sin un espacio de separación. Por Ej: -33.465,-70.676
• walking_time_period : El tiempo de caminata en minutos.
• walking_speed : La velocidad de caminata en [metros/segundos]
• demographic (opcional): Es la opción demográfica con el cual queremos que los datos sean evaluados (default = Young Adult (20-30) ).
• Escenario (opcional): Es el escenario con el cual se requiere hacer la evaluación (default=1 información de OTP sobre el territorio chileno)

Ejemplos:

http://146.155.17.19:17080/api?mode=walk&start_point=-33.465,-70.676&walking_time_period=10&walking_speed=1.25

http://146.155.17.19:17080/api?mode=walk&start_point=-33.465,-70.676&walking_time_period=10&walking_speed=1.25&demographic=Lawrence-Frank%20Adult

Transit & walking model

Para obtener el score cuando una persona caminando y utilizando el transporte público son necesarias las siguientes variables en la petición:

• start_point : El punto a evaluar, las coordenadas deben ser escritas sin un espacio de separación. Por Ej: -33.465,-70.676
• walking_time_period : El tiempo de caminata en minutos.
• walking_speed : La velocidad de caminata en [metros/segundos]
• walking_start_time : Es la hora de comienzo del viaje, importante para las rutas del transporte público, se expresa en hora, minutos y segundos (Ej: 14:00:00)
• bus_waiting_time : Es el tiempo en minutos de cuanto esperaría a que el bus llegue al apradero
• bus_riding_time : Es el tiempo de viaje arriba de un transporte público
• demographic (opcional): Es la opción demográfica con el cual queremos que los datos sean evaluados (default = Young Adult (20-30) ).
• Escenario (opcional): Es el escenario con el cual se requiere hacer la evaluación (default=1 información de OTP sobre el territorio chileno)

Ejemplos

http://146.155.17.19:17080/api?mode=transit&start_point=-33.465,-70.676&walking_time_period=10&walking_speed=1.25&walking_start_time=14:00:00&bus_waiting_time=9&bus_riding_time=9

Car model

Para obtener el score cuando una persona viaja en auto son necesarias las siguientes variables en la petición:

• start_point : El punto a evaluar, las coordenadas deben ser escritas sin un espacio de separación. Por Ej: -33.465,-70.676
• car_time_period : El tiempo de viaje en minutos.
• demographic (opcional): Es la opción demográfica con el cual queremos que los datos sean evaluados (default = Young Adult (20-30) ).
• Escenario (opcional): Es el escenario con el cual se requiere hacer la evaluación (default=1 información de OTP sobre el territorio chileno)

Ejemplo:

http://146.155.17.19:17080/api?mode=car&start_point=-33.465,-70.676&car_time_period=10

Representación de resultados

Los resultados son entregados en formato JSON con la siguiente estructura:

{"walkshed": 
 {"type":"Polygon",
  "coordinates":,				# Coordenadas del polígono
  "properties": 
    {"type": "Walkshed", 
	 "area": 0,				# Area abarcada por el polígono
	 "score": "0",				# Puntaje de WYP
	 "crime_index": 0, 
	 "color": ""
	 }
 }, 
 "poi": 
  {"type": "FeatureCollection", 
   "features": [ 				# Puntos considerados
    {"type": "Feature",
	 "geometry": 
	 {"type": "Point", 
	  "coordinates":			# Coordenadas del punto
	 }, 
	 "properties": 
	  {"name": "", 				# Nombre del atractivo
	   "type": "", 				# Tipo
	   "icon": ""
	  }
	},...]					# Pueden ser muchos puntos más
  }
}