HATEOAS

Hypermedia as the Engine of Application State (HATEOAS) är en standard i REST arkitekturen som gör att man kan skicka med hyperlänkar till närliggande funktionalitet. I TimeWave API 3 har du möjlighet att via parametern hateoas=1 eller hateoas= true aktivera HATEOAS länkar i svaret från endpointen.

exempel:

https://api.timewave.nu/v3/accounts/1?hateoas=1

{
    "data": {
        "id": 1,
        "name": "Försäljning städ privat",
        "number": "3010",
        "description": "",
        "deleted": false,
        "_links": [
            {
                "all": {
                    "href": "https://api.timewave.nu/v3/accounts",
                    "type": "GET",
                    "rel": "accounts"
                }
            },
            {
                "show": {
                    "href": "https://api.timewave.nu/v3/accounts/1",
                    "type": "GET",
                    "rel": "accounts"
                }
            },
            {
                "findById": {
                    "href": "https://api.timewave.nu/v3/accounts/findById/1",
                    "type": "GET",
                    "rel": "accounts"
                }
            },
            {
                "findByName": {
                    "href": "https://api.timewave.nu/v3/accounts/findByName/Försäljning städ privat",
                    "type": "GET",
                    "rel": "accounts"
                }
            },
            {
                "findByNumber": {
                    "href": "https://api.timewave.nu/v3/accounts/findByNumber/3010",
                    "type": "GET",
                    "rel": "accounts"
                }
            }
        ]
    }
}
© TimeWave AB