Visualizations
WhenHub API
Schedule Object
The schedule object contains all of the information you will need about a specific schedule, including any Event Objects. It is one of the two most common data objects that you will be working with when using the WhenHub API. The basic structure is as follows
Schedule Object Parameters
Name | Description | Read Only(?) |
|---|---|---|
curator | The curator field describes who created the schedule. | |
calendarType | This field only has one value at the moment, but we have plans to expand the features of our platform that will eventually offer more options. | |
scope | When a user creates a schedule, they have the option to make it viewable to the public or to only themselves. The scope field defines which option they have chosen as either 'public' or 'private' | |
sync | Defines whether or not this calendar is synchronized with a Google calendar. | |
viewCode | A specific viewCode is provided for schedules whose scope is marked as private. Appending this parameter to the Whencast's URL will allow the private schedule to be viewed with that link. | Read Only |
tags | Tags help a user categorize their schedules. As there can be many tags to a schedule, this value is an array of all the tags a user has added. You might see a couple tags you did not enter in the array, don't worry about those, they are for WhenHub Admin and don't affect the information or look of your schedule. | |
featured | The featured field, who's value is either 'true' or 'false', defines whether or not the schedule is featured on the Hubs Page. This field is not controlled by the user, WhenHub Admin. handles that. | Read Only |
Events Array | Array of events objects. See Understanding the Event Object for more information. | |
Media Object | The default image for the schedule. |
Schedule Object Sample
{
"calendar": {
"calendarType": "absolute"
},
"name": "Hello!",
"description": "Welcome to WhenHub! This is a sample schedule that will give you an overview of the primary WhenHub features.",
"curator": "WhenHub Curator",
"scope": "public",
"views": 4054,
"sync": false,
"viewCode": "Z26uRTW",
"tags": [
"home",
"order:0"
],
"featured": true,
"id": "57c443f4e899ed5809ffc36e",
"userId": "562fc4e3c6a01fb8058bc910",
"createdAt": "2016-08-29T14:17:24.000Z",
"updatedAt": "2017-01-31T16:25:33.000Z",
"createdBy": "562fc4e3c6a01fb8058bc910",
"updatedBy": "562fc4e3c6a01fb8058bc910",
"_sources": [],
"hub": "business",
"media": [
{
"type": "image",
"url": "https://whenhub.blob.core.windows.net/media/57c443f4e899ed5809ffc36e/smiley_face.jpg",
"autoScaled": true,
"id": "583dec0d451c991b0c5d3cd6",
"scheduleId": "57c443f4e899ed5809ffc36e",
"createdAt": "2016-11-29T20:58:53.000Z",
"updatedAt": "2016-11-29T20:58:53.000Z",
"createdBy": "562fc4e3c6a01fb8058bc910",
"updatedBy": "562fc4e3c6a01fb8058bc910"
}
],
"events": [
{
"when": {
"period": "month",
"relative": null,
"startDate": "2017-01",
"startTimezone": "America/Los_Angeles",
"endDate": null,
"endTimezone": null,
"recurrenceRule": null,
"recurrenceException": null
},
"name": "Welcome to Whenhub",
"description": "<p class=\"ql-align-justify\">Welcome to Whenhub! Thanks for trying out our platform. With the Whenhub you can create dynamic visualizations, publish them anywhere you wish and allow people to easily consume and connect with your content. Whether you are using time to tell a story, promoting a calendar of events, or sharing a simple schedule, Whenhub is your new publishing tool for the past, present and future.</p><p class=\"ql-align-justify\"><br></p><p class=\"ql-align-justify\"><br></p>",
"order": 0,
"customFieldData": {},
"id": "57ced9e52de542601e971c37",
"createdAt": "2016-09-06T14:59:49.000Z",
"updatedAt": "2017-01-23T16:37:20.000Z",
"createdBy": "562fc4e3c6a01fb8058bc910",
"updatedBy": "562fc4e3c6a01fb8058bc910",
"scheduleId": "57c443f4e899ed5809ffc36e",
"primaryAction": {
"url": "https://www.whenhub.com/wp-content/uploads/2016/10/WhenHub-Overview-Infographic.pdf",
"label": "WhenHub InfoGraphic"
},
"cleanDescription": "Welcome to Whenhub! Thanks for being part of how the future will communicate and interact with time....",
"gridImageUrl": "https://whenhub.blob.core.windows.net/media/57c443f4e899ed5809ffc36e/100/whenhub.jpg",
"rowIndex": 14,
"media": [
{
"type": "image"
"url": "https://whenhub.blob.core.windows.net/media/57c443f4e899ed5809ffc36e/whenhub.jpg",
"name": "",
"autoScaled": true,
"sources": [],
"id": "583dec4cf1b13608d05140ea",
"eventId": "57ced9e52de542601e971c37",
"createdAt": "2016-11-29T20:59:56.000Z",
"updatedAt": "2016-11-29T20:59:56.000Z",
"createdBy": "562fc4e3c6a01fb8058bc910",
"updatedBy": "562fc4e3c6a01fb8058bc910"
}
]
}
]
}
Updated 3 years ago
What's Next
| Understanding the Event Object |