Examples of Data Formats

In this article you will find examples for all supported data formats.


Table 1 Demo events
Text Start Date End Date
Meeting April 11, 2013 14:00 April 11, 2013 17:00
Conference April 15, 2013 12:00 April 18, 2013 19:00
Interview April 24, 2013 09:00 April 24, 2013 10:00

JSON

[
    {"id":"1", "text":"Meeting", "start_date":"04/11/2013 14:00",
        "end_date":"04/11/2013 17:00"},
    {"id":"2", "text":"Conference", "start_date":"04/15/2013 12:00", 
        "end_date":"04/18/2013 19:00"},
    {"id":"3", "text":"Interview", "start_date":"04/24/2013 09:00", 
        "end_date":"04/24/2013 10:00"}
]

JSON with Collections

This format will be useful if you need to pass some additional data collections. For example, it is useful when you want to load Timeline and Units sections from the server:

{ 
   "data":[
      {
          "id":"1",
          "start_date":"2015-03-02 00:00:00",
          "end_date":"2015-03-04 00:00:00",
          "text":"dblclick me!",
          "type":"1"
      },
      {
          "id":"2",
          "start_date":"2015-03-09 00:00:00",
          "end_date":"2015-03-11 00:00:00",
          "text":"and me!",
          "type":"2"
      },
      {
          "id":"3",
          "start_date":"2015-03-16 00:00:00",
          "end_date":"2015-03-18 00:00:00",
          "text":"and me too!",
          "type":"3"
      },
      { 
          "id":"4",
          "start_date":"2015-03-02 08:00:00",
          "end_date":"2015-03-02 14:10:00",
          "text":"Type 2 event",
          "type":"2"
      }
   ], 
   "collections": {                               "sections":[                                   {"value":"1","label":"Simple"},             {"value":"2","label":"Complex"},            {"value":"3","label":"Unknown"}          ]                                        }                                        }

XML

<data>
    <event id="1">
        <text><![CDATA[Meeting]]></text>
        <start_date>04/11/2013 14:00</start_date>
        <end_date>04/11/2013 17:00</end_date>
    </event>
    <event id="2">
        <text><![CDATA[Conference]]></text>
        <start_date>04/15/2013 12:00</start_date>
        <end_date>04/18/2013 19:00</end_date>
    </event>
    <event id="3">
        <text><![CDATA[Interview]]></text>
        <start_date>04/24/2013 09:00</start_date>
        <end_date>04/24/2013 10:00</end_date>
    </event>
</data>

iCal

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//dhtmlXScheduler//NONSGML v2.2//EN
DESCRIPTION:
BEGIN:VEVENT
DTSTART:20130411T140000
DTEND:20130411T170000
SUMMARY:Meeting
END:VEVENT
BEGIN:VEVENT
DTSTART:20130415
DTEND:20130418
SUMMARY:Conference
END:VEVENT
BEGIN:VEVENT
DTSTART:20130424T090000
DTEND:20130424T100000
SUMMARY:Interview
END:VEVENT
END:VCALENDAR

Data with Custom Properties

Let's consider an example when the initial set (presented above) has 2 custom properties:

  • room - the number of the room that the event will take place in.
  • holder - the name of the person responsible for the event.

JSON

[{
    "id":"1",
    "text":"Meeting",
    "start_date":"04/11/2013 14:00", 
    "end_date":"04/11/2013 17:00",
    "room":327,
    "holder":"James"
}]

XML

<data>
    <event id="1">
        <text><![CDATA[Meeting]]></text>
        <start_date>04/11/2013 14:00</start_date>
        <end_date>04/11/2013 17:00</end_date>
        <room>327</room>
        <holder><![CDATA[James]]></holder>
    </event>
</data>

iCal

Note, on the client side the names of properties (except for DTSTART, DTEND and SUMMARY) will be transformed from the upper to lower case: ROOM -> room, HOLDER -> holder.

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//dhtmlXScheduler//NONSGML v2.2//EN
DESCRIPTION:
BEGIN:VEVENT
DTSTART:20130411T140000
DTEND:20130411T170000
SUMMARY:Meeting
ROOM:327
HOLDER:James
END:VEVENT
END:VCALENDAR
Back to top