Skip to content
This repository has been archived by the owner on Dec 8, 2020. It is now read-only.

Get activities

MaurICT edited this page May 18, 2020 · 3 revisions

Retrieve list of activities

GET /api/activities

Parameters

Query string after (optional): Get all activities after this date/time. Format: yyyy-MM-dd or yyyy-MM-dd'T'HH:mm:ss

Example request(s):

GET /api/activities?after=2020-04-09
GET /api/activities?after=2020-04-09T12:34
GET /api/activities?after=2020-04-09T12:34:56

Example response:

{
    "status": "success",
    "count": 2,
    "activities": [
        {
            "eventID": 28,
            "title": "Chillavond",
            "description": "Effe lekker chillen in De Kist!",
            "when": "2020-05-15T19:30:00",
            "cost": 2
        },
        {
            "eventID": 29,
            "title": "Zeilen",
            "description": "Zeilen op het Veerse meer, effe Overstag gaan!",
            "when": "2020-05-22T18:30:00",
            "cost": 7.5
        },
    ]
}

Get activity by id

GET /api/activities/{id}

Parameters

URL parameter id (required): Get activity details by its id

Example request: GET https://stoverstag.nl/api/activities/29

Example response:

{
    "status": "success",
    "activity": {
        "eventID": 29,
        "title": "Zeilen",
        "description": "Zeilen op het Veerse meer, effe Overstag gaan!",
        "when": "2020-05-22T18:30:00",
        "cost": 7.5
    }
}

List activity id's

GET /api/activities/ids

Example response:

{
    "status": "success",
    "count": 21,
    "activities": [
        3,
        4,
        6,
        7,
        8,
        10,
        11,
        12,
        14,
        16
    ]
}

Retrieve "unfactured" activities, events that are not billed yet for the user

GET /api/activities/unfactured

Example response:

{
    "status": "success",
    "count": 1,
    "activities": [
        {
            "eventID": 22,
            "title": "Lasergame en sportavond",
            "description": "Lasergamen in een verlaten school, sportactiviteiten in de gymzaal",
            "when": "2020-02-22T19:30:00",
            "cost": 5
        }
    ]
}