Query by ID

Guides are a collection of ShowSchedules on a specified day or time.

GET: /guides/{id}
{
    "2018-07-04": [
        {
            "from": "00:00:00",
            "until": "02:00:00",
            "offset": 0,
            "limit": 7200,
            // Rule that created this schedule
            "rules": {
                "id": "e165d807-bab2-488-a247-00db27397c72",
                "created_on": "2018-06-07T07:35:28+00:00",
                "changed_on": "2018-06-12T17:51:45+00:00",
                "label": "ShowSchedule",
                "offset": 0,
                "limit": 7200,
                "valid_from": "2018-06-04",
                "valid_until": null,
                "exception": false,
                "days": [
                    "1",
                    "2",
                    "3",
                    "4",
                    "5"
                ]
            },
            // Program Scheduled
            "show": {
                "id": "58f9f68f-c35-4dd0-9055-e95dbdf3d139",
                "created_on": "2018-06-12T17:27:36+00:00",
                "changed_on": "2018-06-26T08:17:02+00:00",
                "published_on": "2018-06-26T08:17:01+00:00",
                "unpublish_on": null,
                "label": "Show",
                "status": "published",
                "slug": null,
                "body": "",
                "name": "Star Morning Show"
            },
            // Scheduled users in this episode
            "users": {
                // Tag Id (type of scheduling like DJ, Producer, Newsreader) 
                "586643d3-0c02-43fe-80bf-fba9590aa41b": [
                    {
                        "id": "97926b24-75c8-40d6-bf5-779d8ec77548",
                        "created_on": "2018-06-12T17:46:05+00:00",
                        "changed_on": "2018-06-12T17:51:39+00:00",
                        "last_seen": "2018-06-12T17:46:05+00:00",
                        "label": "Person",
                        "preposition": "",
                        "initials": "",
                        "firstname": "Carolien",
                        "prefix_lastname": "",
                        "lastname": "de Bruijn",
                        "nickname": null,
                        "tracking": true
                    },
                    {
                        "id": "d06fc0d7-ccd3-4467-bd0c-6bd97341fbbf",
                        "created_on": "2018-06-12T17:46:19+00:00",
                        "changed_on": null,
                        "last_seen": "2018-06-12T17:46:19+00:00",
                        "label": "Person",
                        "preposition": "",
                        "initials": "",
                        "firstname": "Paul",
                        "prefix_lastname": "",
                        "lastname": "Kronenburg",
                        "nickname": null,
                        "tracking": true
                    }
                ]
            }
        }
        // ..... more
    ]
}

Arguments

The following arguments are available or required when querying a collection:

argumenttyperequireddescription
fromStringfalseYYY-MM-DD
untilStringfalseYYY-MM-DD
exceptionsBooleanfalseSet this to TRUE for production env.
show.idStringfalseFilter guides for a specfied Show id.

Was this article helpful?

We’d love to learn from your feedback