Exodus interfaces

Lists exodus interfaces and parameters they accept
Interface Description Parameters

XMLTV

Specification: http://wiki.xmltv.org
Example link: xmltv.xml?channel=FI1&lang=fi&duration=1d

Generates program schedule information in xmltv format that is used by some external parties.

Without channel and lang parameters this produces a listing of programs for all channels provided by TV7. If channel is defined, only information about that channel is shown.

Metadata is provided in all languages that are defined in Exodus database. If lang is defined metadata is provided only in that single language. If programs title is not defined in that language then string "Untitled" is used.

All timestamps are formatted in UTC as per xmltv specification.

Category refers to DVB category, which means program genre defined in ETSI specification EN 300 468. I have made here a screen capture of the specification where categories are listed. Usage of category gives possibility to implement e.g. search by program genre (movies, sport etc) in STB (set-top box). Category value is given in hexadecimal format (e.g. "2A").

channel
Chooses the channel
Optional: If omitted info for all channels is shown
Possible values: FI1, ET1, SV1, FPL, FPS, RU1
lang
Chooses metadata language
Optional: If omitted, metadata is shown for all languages defined in Exodus.
Format: ISO 639-1 two-letter language code
start
From which timepoint to start listing the broadcasts
Default: Today from start of day in selected channel's timezone.
         If no channel is specified then in UTC.
Format: dd.MM.yyyy
end | duration
end and duration are alternatives.
If however you use both, end takes precedence.
End must be after start and duration bigger than 0
Default: 1 week after start (1w)

end
Include broadcasts if their start is before or at the end point
Format: dd.MM.yyyy

duration
Duration is added to start and thus end is formed.
Format: 0w0d
    Case-insensitive.
    All components are optional.
    0 == one or more digits
    W == weeks
    D == days

Press

Example link: press.txt

Generates program schedule information in plain text that is sent by email to different newspapers that publish tv schedule information.

Note. Header for a new day is put at the time when the first day is set to start.

format
Chooses the the format, either long short
Default: long
Possible values: long, short
channel
Chooses the channel
Default: FI1
Possible values: FI1, ET1, SV1, FPL, FPS, RU1
lang
Chooses metadata language
Default: fi
Format:ISO 639-1 two-letter language code
start
From which timepoint to start listing the broadcasts
Default: Today 08:30
Format: dd.MM.yyyy[@HH:mm]
end | duration
end and duration are alternatives.
If however you use both, end takes precedence.
End must be after start and duration bigger than 0
Default: 70d (10 weeks after start)

end
Include broadcasts if their start is before or at the end point
Format: dd.MM.yyyy[@HH:mm]

duration
Duration is added to start and thus end is formed.
Format: 0w0d0h0m
    Case-insensitive.
    All components are optional.
    0 == one or more digits
    W == weeks
    D == days
    H == hours
    M == minutes

Image

Example link: image?pnid=303

Returns images stored in Exodus id | pnid
id = Unique id of an image
pnid = program node id
Program has at most on image in exodus so you can retrieve an image
by specifying the program node it is attached to.
Required: true
Format: a positive integer
nocache
This api has a memory cache.
If you want to make sure that the image is retrieved from Exodus db
and not from cache, set this parameter to true.
Default: false
Format: true|false

Oasys

Example link: oasys

Generates simple text file that can be imported using Oasys Importer channel
Chooses the channel
Default: FI1
Possible values: FI1, ET1, SV1, FPL
bids
Provides a list of broadcast ids that are listed in ascending order if they are
from the (possibly implicitly) specified channel.

This is an alternative to start, end, duration parameters.
start
From which timepoint to start listing the broadcasts
Default: Now, rounded to closest 5 minute
Format: dd.MM.yyyy[@HH:mm]
end | duration
end and duration are alternatives.
If however you use both, end takes precedence.
End must be after start and duration bigger than 0
Default: 24h (24 hours after start)

end
Include broadcasts if their start is before or at the end point
Format: dd.MM.yyyy[@HH:mm]

duration
Duration is added to start and thus end is formed.
Format: 0w0d0h0m
    Case-insensitive.
    All components are optional.
    0 == one or more digits
    W == weeks
    D == days
    H == hours
    M == minutes

Programs

[DEPRECATED]

Example link: programs.xml

Generates program schedule information in a custom xml format that is used by some external parties. The information is specified for a single channel and single metadata language. channel
Chooses the channel
Default: FI1
Possible values: FI1, ET1, SV1, FPL, FPS, RU1
lang
Chooses metadata language
Default: fi
Format: ISO 639-1 two-letter language code
start
From which timepoint to start listing the broadcasts
Default: 3 days before today at start of day
Format: dd.MM.yyyy
end | duration
end and duration are alternatives.
If however you use both, end takes precedence.
End must be after start and duration bigger than 0
Default: 3 weeks after start (3w)

end
Include broadcasts if their start is before or at the end point
Format: dd.MM.yyyy

duration
Duration is added to start and thus end is formed.
Format: 0w0d
    Case-insensitive.
    All components are optional.
    0 == one or more digits
    W == weeks
    D == days

Epg

[DEPRECATED]

Example link: epg.xml

Generates Electronic Program Guide (EPG) information in xml format acceptable to Sofia Digital's Epg Manager. channel
Chooses the channel
Default: FI1
Possible values: FI1, ET1, SV1, FPL, FPS, RU1
lang
Chooses metadata language
Default: fi
Format: ISO 639-1 two-letter language code
start
From which timepoint to start listing the broadcasts
Default: 3 days before today at start of day
Format: dd.MM.yyyy
end | duration
end and duration are alternatives.
If however you use both, end takes precedence.
End must be after start and duration bigger than 0
Default: 24d (24 days after start)

end
Include broadcasts if their start is before or at the end point
Format: dd.MM.yyyy

duration
Duration is added to start and thus end is formed.
Format: 0w0d
    Case-insensitive.
    All components are optional.
    0 == one or more digits
    W == weeks
    D == days