source: indico/doc/guides/ExportAPI/exporters/categ.rst @ 05e29d

hello-world-walkthroughipv6v0.98-seriesv0.98.2v0.98.3v0.98b2v0.99v1.0v1.1
Last change on this file since 05e29d was cd4e48, checked in by Jose Benito <jose.benito.gonzalez@…>, 21 months ago

[REF] Refactoring Export interface

  • Fixed bug in RE (not accepting white space for location in path)
  • Moving getQueryParams (ExportInterface?) to getParams (Exporter)
  • Renamed class Exporter to HTTPAPIHook, and all sub-classes
  • Renamed class ExportInterface? to DataFetcher?, and all sub-classes
  • Renamed variable urlParams to pathParams, and qdata to queryParams
  • Move contrib/* to rst doc
  • Adding examples and missing information to the documentation
  • Missing i18n strings
  • Property mode set to 100644
File size: 2.8 KB

Categories

URL Format

/export/categ/ID.TYPE

The ID can be either a single category ID or a - separated list.

Parameters

Param Short Description
location l Only include events taking place at the specified location. The * and ? wildcards may be used.
room r Only include events taking place in the specified room. The * and ? wildcards may be used.

Detail Levels

events

Returns basic data about the events in the category.

This is the result of the following the query https://my.indico/export/categ/2.json?from=today&to=today&pretty=yes:

{
    "count": 2,
    "_type": "HTTPAPIResult",
    "complete": true,
    "url": "https://my.indico/export/categ/2.json?from=today&to=today&pretty=yes",
    "ts": 1308841641,
    "results": [
        {
            "category": "TEST Category",
            "startDate": {
                "date": "2011-06-17",
                "tz": "Europe/Zurich",
                "time": "08:00:00"
            },
            "_type": "Conference",
            "endDate": {
                "date": "2011-06-30",
                "tz": "Europe/Zurich",
                "time": "18:00:00"
            },
            "description": "",
            "title": "Test EPayment",
            "url": "http://pcituds07.cern.ch/indico/conferenceDisplay.py?confId=137344",
            "location": "CERN",
            "_fossil": "conferenceMetadata",
            "timezone": "Europe/Zurich",
            "type": "conference",
            "id": "137344",
            "room": "1-1-025"
        },
        {
            "category": "TEST Category",
            "startDate": {
                "date": "2011-06-23",
                "tz": "Europe/Zurich",
                "time": "08:00:00"
            },
            "_type": "Conference",
            "endDate": {
                "date": "2011-06-24",
                "tz": "Europe/Zurich",
                "time": "18:00:00"
            },
            "description": "",
            "title": "Export Test",
            "url": "http://pcituds07.cern.ch/indico/conferenceDisplay.py?confId=137346",
            "location": "CERN",
            "_fossil": "conferenceMetadata",
            "timezone": "Europe/Zurich",
            "type": "meeting",
            "id": "137346",
            "room": null
        }
    ]
}
Note: See TracBrowser for help on using the repository browser.