source: indico/indico/htdocs/ihelp/html/_sources/ExportAPI/exporters/categ.txt @ 187ed2

hello-world-walkthroughipv6v0.98-seriesv0.98.2v0.98.3v0.99v1.0v1.1
Last change on this file since 187ed2 was 187ed2, checked in by Pedro Ferreira <jose.pedro.ferreira@…>, 15 months ago

[DOC] Doc update

  • Property mode set to 100644
File size: 2.9 KB
Line 
1Categories
2===============
3
4URL Format
5----------
6*/export/categ/ID.TYPE*
7
8The ID can be either a single category ID or a *-* separated list.
9
10
11Parameters
12----------
13
14========  =====  ==========================================================
15Param     Short  Description
16========  =====  ==========================================================
17location  l      Only include events taking place at the specified location.
18                 The `*` and `?` wildcards may be used.
19room      r      Only include events taking place in the specified room.
20                 The `*` and `?` wildcards may be used.
21type      T      Only include events of the specified type. Must be one of:
22                 simple_event (or lecture), meeting, conference
23========  =====  ==========================================================
24
25
26Detail Levels
27-------------
28
29events
30~~~~~~
31
32Returns basic data about the events in the category.
33
34This is the result of the following the query https://my.indico/export/categ/2.json?from=today&to=today&pretty=yes::
35
36    {
37        "count": 2,
38        "_type": "HTTPAPIResult",
39        "complete": true,
40        "url": "https://my.indico/export/categ/2.json?from=today&to=today&pretty=yes",
41        "ts": 1308841641,
42        "results": [
43            {
44                "category": "TEST Category",
45                "startDate": {
46                    "date": "2011-06-17",
47                    "tz": "Europe/Zurich",
48                    "time": "08:00:00"
49                },
50                "_type": "Conference",
51                "endDate": {
52                    "date": "2011-06-30",
53                    "tz": "Europe/Zurich",
54                    "time": "18:00:00"
55                },
56                "description": "",
57                "title": "Test EPayment",
58                "url": "http://pcituds07.cern.ch/indico/conferenceDisplay.py?confId=137344",
59                "location": "CERN",
60                "_fossil": "conferenceMetadata",
61                "timezone": "Europe/Zurich",
62                "type": "conference",
63                "id": "137344",
64                "room": "1-1-025"
65            },
66            {
67                "category": "TEST Category",
68                "startDate": {
69                    "date": "2011-06-23",
70                    "tz": "Europe/Zurich",
71                    "time": "08:00:00"
72                },
73                "_type": "Conference",
74                "endDate": {
75                    "date": "2011-06-24",
76                    "tz": "Europe/Zurich",
77                    "time": "18:00:00"
78                },
79                "description": "",
80                "title": "Export Test",
81                "url": "http://pcituds07.cern.ch/indico/conferenceDisplay.py?confId=137346",
82                "location": "CERN",
83                "_fossil": "conferenceMetadata",
84                "timezone": "Europe/Zurich",
85                "type": "meeting",
86                "id": "137346",
87                "room": null
88            }
89        ]
90    }
Note: See TracBrowser for help on using the repository browser.