DRAFT: Delta between API 20140530 and 20141201

[Slugger]

If /available returned objects with a user friendly description of what it does that would be nice to be able to display to the user.

[
{
"type": "COUNTRIES",
"description": "Retrieve a list of countries for which data is available."
}
]

[rkulagow]

Preliminary lineups support for DVB satellite at 19.2E and 28.2E is available through:

https://json.schedulesdirect.org/201412 ... 2E-default

and

https://json.schedulesdirect.org/201412 ... 2E-default

Currently, these are direct-access only through the above URLs; they won't appear in the list of headends / lineups while I determine the best way to present them.

The channel lineups are also under development; additional stations will be added as time permits in the next few days.

[rkulagow]

Updated responses.

There were inconsistencies in the naming of things in prior versions of the API.

Effective 2015-03-23, your code should now expect the following:

- Where "type" used to appear as "Cable", "Antenna", "Satellite", etc. This field is now known as "transport" to match other responses.
- Where "ID" was used in various places, the field is now named "lineup", because that is what it actually contains.

Places where this was updated:

GET /lineups
"type" -> "transport" for the lineups that you are subscribed to.

GET /headends
"type" -> "transport" for the lineups that are in the headends in a postal code.

GET /status
"ID" -> "lineup" in the "lineups" element that indicates which lineups the user is subscribed to.

[rkulagow]

Done.

GET /available

[
{
"type": "COUNTRIES",
"description": "List of countries which are available."
},
{
"type": "DVB-S",
"description": "List of satellites which are available."
}
]

GET /available/DVB-S

[
{
"longitude": "28.2E"
},
{
"longitude": "19.2E"
}
]

I'm still thinking (and looking for suggestions) on the best way to treat DVB; I don't want to make "available" become a synonym for getting the lineups in a postal code.

Should "DVB" be a country that doesn't require a postal code, and which returns each satellite as an individual lineup?

[rkulagow]

"DVB" is now a country that you can request lineups for. Postal code is not required.

The response will look like:

Code: Select all

[
    {
        "headend": "DVB-S",
        "transport": "Satellite",
        "location": "Global",
        "lineups": [
            {
                "name": "DVB-19.2E-DEFAULT",
                "lineup": "DVB-19.2E-DEFAULT",
                "uri": "/20141201/lineups/DVB-19.2E-DEFAULT"
            },
            {
                "name": "DVB-28.2E-DEFAULT",
                "lineup": "DVB-28.2E-DEFAULT",
                "uri": "/20141201/lineups/DVB-28.2E-DEFAULT"
            }
        ]
    }
]

Your code may now add the DVB lineups like any other.

"DVB" now also appears in the list of GET /available as a country.

[gtb]

"DVB" is now a country that you can request lineups for. Postal code is not required.

I am going to suggest that you only use one of the "user-assigned" ISO Alpha-3 codes for this. Technically, DVB is assignable at some future time. Yes, the user-assigned code space is a bit ugly, but it is safer. XXX (a "user-assigned" code) is available, and is used for people of unspecified nationality for machine readable passports.

[rkulagow]

I had originally used "ZZZ" and it's simple enough to switch back to that. Since satellite listings are new there shouldn't be too many code updates on clients as far as I know.

[gtb]

I had originally used "ZZZ" and it's simple enough to switch back to that. Since satellite listings are new there shouldn't be too many code updates on clients as far as I know.

Sounds good to me. Thanks!

[rkulagow]

Done. The "country" will now be "ZZZ" for Satellite (like it used to be)

[gtb]

Done. The "country" will now be "ZZZ" for Satellite (like it used to be)

Question (not clear what the answer should be). Should the "region" (returned when "COUNTRIES" is requested from /available/COUNTRIES) be something like "DVB Satellite" rather than ZZZ (the country ZZZ (in the list of countries in a region)) makes sense, but regions are otherwise things like "Latin America", or "Europe". "DVB Satellite" makes (to me) a little more sense than a region of "ZZZ".