endpoints

Home	Sprints	User Stories	Requisitos	EAP	Arquitetura	Configuração	Endpoints	Mockups	Problemas	Banco de Dados

Endpoints.

GET Piscinas

Descrição: Endpoint que retorna uma lista de piscinas do usuário com informações básicas da piscina e resumo das condições da piscina.

Tela de utilização: Dashboard

Exemplo request: http://localhost:5000/pools/user/{ID_USUARIO}

GET piscinas response ^[show/hide]


[
    {
        "doesUserKnowTheVolume": true,
        "format": "Retangular",
        "id": "12345",
        "key": "-Ldzr4vOUPGOnCSQm_Lm",
        "name": "Piscina do Renan",
        "source": "Água de rede",
        "uid": "g0gWwpxxFCRni02nrR9Wldm97iI3",
        "volume": "25000",
        "sumUp": {
            "inventory": "low",
            "status": "okay"
        }
    },
    {
        "doesUserKnowTheVolume": true,
        "format": "Retangular",
        "id": "12346",
        "key": "-Ldzr4vOUPGOnCSQm_LR",
        "name": "Segunda Piscina do Renan",
        "source": "Água de rede",
        "uid": "g0gWwpxxFCRniewaewaea7iI3",
        "volume": "50000",
        "sumUp": {
            "inventory": "low",
            "status": "okay"
        }
    }
]

GET Piscina detalhada

Descrição: Endpoint que retorna um objeto com informações básicas da piscina e informações detalhadas do estoque, estado atual de cada medida controlada pelo hardware e resumos da interpretação dessas informações

Tela de utilização: Piscina detalhada

Exemplo request: http://localhost:5000/pools/{ID_PISCINA}

GET piscina detalhada response ^[show/hide]


{
    "config": {
        isSummer: true,
        notification: false,
        automatic: false,
        time: date
    },
    "doesUserKnowTheVolume": true,
    "format": "Retangular",
    "id": "12345",
    "key": "-Ldzr4vOUPGOnCSQm_Lm",
    "name": "Piscina do Renan",
    "source": "Água de rede",
    "uid": "g0gWwpxxFCRni02nrR9Wldm97iI3",
    "volume": "50",
    "idPiscina": 8,
    "inventory": {
        "chlorine": {
            "actual": 58,
            "max": 100,
            "level": "good"
        },
        "PH": {
            "actual": 89,
            "max": 100,
            "level": "good"
        },
        "alkalinity": {
            "actual": 25,
            "max": 100,
            "level": "low"
        }
    },
    "status": {
        "chlorine": {
            "measure": 2,
            "level": "okay"
        },
        "PH": {
            "measure": 7.2,
            "level": "okay"
        },
        "alkalinity": {
            "measure": 110,
            "level": "okay"
        }
    }
}