| Endpoint | Parámetros de entrada | Retorno | Ejemplo |
|---|---|---|---|
| https://geneacity.life/API/getHouses/ Retorna el listado descriptivo de las viviendas que se encuentran 400 píxeles a la izquierda a la derecha hacia arriba o hacia abajo de la posición brindada |
x: Eje x de la posición actual del jugador y: Eje y de la posición actual del jugador |
JSON con la lista de casas cercanas a la posición brindada Componentes del JSON:
|
https://geneacity.life/API/getHouses/?x=250&y=250 |
| https://geneacity.life/API/getHousesResidents/ Retorna el listado descriptivo de las personas que residen en una determinda vivienda |
houseId: Identificador de la casa a consultar |
JSON con la lista de personas que residen en la vivienda solicitada Componentes del JSON:
|
https://geneacity.life/API/getHousesResidents/?houseId=22 |
| https://geneacity.life/API/getAvailableInhabitants/ Retorna el listado descriptivo de las personas que habitan en el juego limitando el resultado a habitantes en un área de 10.000x10.000 píxeles sobre la posición solicitada. |
x: coordenada X a consultar y: coordenada Y a consultar |
JSON con la lista de personas cercanas al punto solicitado y que se mantienen vivas, sin unión a otra persona y que no hayan sido ya solicitadas por otro usuario Componentes del JSON:
|
https://geneacity.life/API/getAvailableInhabitants/?x=10000&y=10000 |
| https://geneacity.life/API/getAvailableInhabitants/ Selecciona un habitante disponible para iniciar partida. Una vez seleccionado este habitante ya no podrá ser seleccionada por ningún otro jugador. El jugador seleccionado debe estar soltero y vivo. |
id: identificador del habitante |
JSON con el estado de la selección de los habitantes disponibles. Componentes del JSON:
|
https://geneacity.life/API/selectAvailableInhabitant/?id=5 |
| https://geneacity.life/API/getInhabitantInformation/ Brinda la información referente a un determinado habitante (Se encuentre vivo o no). |
id: identificador del habitante |
JSON con el estado de la selección del habitante. Componentes del JSON:
|
https://geneacity.life/API/getInhabitantInformation/?id=5 |
| https://geneacity.life/API/createInhabitantUnion/ Permite la unión entre dos personas y la construcción de una nueva casa donde estos habitarán. De la spersonas se verificará que deban estar solteras, tener entre 18 y 45 años y ser de género opuesto. De las casas se verificará que no exista otra casa cercana (a menos de 50 píxeles) |
idInhabitant1: identificador del primer habitante a unir idInhabitant2: identificador del segundo habitante a unir newHouseXPostition: Posición x de la nueva casa newHouseyPostition: Posición y de la nueva casa |
JSON con el estado de la unión. Componentes del JSON:
|
https://geneacity.life/API/createInhabitantUnion/?idInhabitant1=4&idInhabitant2=5&newHouseXPostition=70&newHouseYPostition=70 |
| https://geneacity.life/API/createChildren/ Permite crear un nuevo individuo a partir de un padre o madre seleccionado. Se verifica que los padres esten vivos y en un rango de edad entre 21 y 40 años. El nombre del hijo o hija tendrá un límite de 50 caracteres. Al nuevo individuo se le asignan los padres correspondientes y la casa de sus procreadores. |
name: Nombre del nuevo individuo idInhabitant: Identificador del padre o la madre que invoca la creación del individuo gender: Género del nuevo individuo age: Este atributo es opcional si no se indica el nuevo individuo se registra con edad de 0 años. Si indican un valor les permitirá asignar una edad válidad para que se pueda casar y tener hijos y de esta forma hacer pruebas más rápidamente sin esperar a que el sistema aumente la edad automáticamente. |
JSON con el estado de la unión. Componentes del JSON:
|
https://geneacity.life/API/createChildren/?name=Angeline6&idInhabitant=4&gender=Male&age=18 |