Rest API

Rest API

The public part of REST API provide programmatic access to read Anee data only users whose profile is marked as public.

Links

• Github project page
• Github wiki page
• API documentation

Authorization

---

As identifier for public part of API is used route parameter username.

Group Tracks

Track collection [/v1/{username}/tracks/{?limit}]

• Parameters
  • limit (number, optional)
  • username (string, required)

Retrieve [GET]

• Response 200 (application/json)

    [
        {
            "id": 6,
            "distance": 0,
            "time_inseconds": 575,
            "max_speed": 755,
            "date": "2015-02-11T14:23:39+01:00",
            "pinned": true,
            "transport": {
                "id": "2",
                "name": "cycling"
            },
            "place": {
                "id": "2",
                "name": "Sevilla"
            },
            "place_to": {
                "id": 3,
                "name": "Granada"
            }
        },
        {
            "id": 7,
            "distance": 0,
            "time_inseconds": 575,
            "max_speed": 755,
            "date": "2015-02-11T14:23:39+01:00",
            "pinned": true,
            "transport": {
                "id": "2",
                "name": "cycling"
            },
            "place": {
                "id": "2",
                "name": "Sevilla"
            },
            "place_to": {
                "id": 3,
                "name": "Granada"
            }
        } 
    ]
  

Track [/v1/{username}/tracks/{id}]

• Parameters
  • id (number, optional)
  • username (string, required)

Retrieve [GET]

• Response 200 (application/json)

    {
        "id": 6,
        "distance": 0,
        "time_inseconds": 575,
        "max_speed": 755,
        "date": "2015-02-11T14:23:39+01:00",
        "pinned": true,
        "transport": {
            "id": "2",
            "name": "cycling"
        },
        "place": {
            "id": "2",
            "name": "Sevilla"
        },
        "place_to": {
            "id": 3,
            "name": "Granada"
        }
    }   
  

Group Places

Place collection [/v1/{username}/places/{?limit}]

• Parameters
  • limit (number, optional)
  • username (string, required)

Retrieve [GET]

• Response 200 (application/json)

    [
        {
            id: 3
            name: "Seville"
            tracks: 0
            photos: 0
        },
        {
            id: 4
            name: "Granada"
            tracks: 0
            photos: 0
        }
    ]
  

Place [/v1/{username}/places/{id}]

• Parameters
  • id (number, optional)
  • username (string, required)

Retrieve [GET]

• Response 200 (application/json)

    {
        id: 3
        name: "Seville"
        tracks: 0
        photos: 0
    }
  

Group Photos

Photo collection [/v1/{username}/photos/{?limit}]

• Parameters
  • limit (number, optional)
  • username (string, required)

Retrieve [GET]

• Response 200 (application/json)

    {
        "id": 3,
        "file_name": "example.png",
        "date": "2015-02-11T14:41:09+01:00",    
        "place": {
            "id": "2",
            "name": "Sevilla"
        },
        "track": {
            "id": "6",
            "name": "Near Sevilla"
        }
    },
    {
        "id": 4,
        "file_name": "example2.png",
        "date": "2015-02-11T14:41:09+01:00",    
        "place": {
            "id": "2",
            "name": "Sevilla"
        },
        "track": {
            "id": "6",
            "name": "Near Sevilla"
        }
    }
  

Photo [/v1/{username}/photos/{id}]

• Parameters
  • id (number, optional)
  • username (string, required)

Retrieve [GET]

• Response 200 (application/json)

    {
        "id": 3,
        "file_name": "example.png",
        "date": "2015-02-11T14:41:09+01:00",    
        "place": {
            "id": "2",
            "name": "Sevilla"
        },
        "track": {
            "id": "6",
            "name": "Near Sevilla"
        }
    }