RFC: Cross-reference programIDs to other languages

[rkulagow]

As the Schedules Direct service expands internationally, we've been told that an option to obtain the English-language (or others) programIDs would be useful.

The following example demonstrates the proposed functionality:

Code: Select all

{
    "EP000000060013": [
        {
            "programID": "EP000000060013",
            "titleLanguage": "en",
            "descriptionLanguage": "en"
        },
        {
            "programID": "EP012692210042",
            "titleLanguage": "en",
            "descriptionLanguage": "en-GB"
        }
    ],
    "EP006883590001": [
        {
            "programID": "EP006883590001",
            "titleLanguage": "en",
            "descriptionLanguage": "en"
        },
        {
            "programID": "EP009143120237",
            "titleLanguage": "en",
            "descriptionLanguage": "fr-CA"
        },
        {
            "programID": "EP012602100088",
            "titleLanguage": "en",
            "descriptionLanguage": "en-GB"
        },
        {
            "programID": "EP016178050088",
            "titleLanguage": "en",
            "descriptionLanguage": "sv"
        },
        {
            "programID": "EP018574310086",
            "titleLanguage": "en",
            "descriptionLanguage": "de"
        },
        {
            "programID": "EP018809220039",
            "titleLanguage": "en",
            "descriptionLanguage": "it"
        },
        {
            "programID": "EP019817400001",
            "titleLanguage": "en",
            "descriptionLanguage": "fi"
        },
        {
            "programID": "EP020127870069",
            "titleLanguage": "en",
            "descriptionLanguage": "no"
        }
    ],
    "EP016178050088": [
        {
            "programID": "EP006883590001",
            "titleLanguage": "en",
            "descriptionLanguage": "en"
        },
        {
            "programID": "EP009143120237",
            "titleLanguage": "en",
            "descriptionLanguage": "fr-CA"
        },
        {
            "programID": "EP012602100088",
            "titleLanguage": "en",
            "descriptionLanguage": "en-GB"
        },
        {
            "programID": "EP016178050088",
            "titleLanguage": "en",
            "descriptionLanguage": "sv"
        },
        {
            "programID": "EP018574310086",
            "titleLanguage": "en",
            "descriptionLanguage": "de"
        },
        {
            "programID": "EP018809220039",
            "titleLanguage": "en",
            "descriptionLanguage": "it"
        },
        {
            "programID": "EP019817400001",
            "titleLanguage": "en",
            "descriptionLanguage": "fi"
        },
        {
            "programID": "EP020127870069",
            "titleLanguage": "en",
            "descriptionLanguage": "no"
        }
    ]
}


The array sent to the not-yet-published code was:

"EP000000060013", "EP006883590001", "EP016178050088"

The last entry in the array ("0088") was one of the elements of the "0001" entry; this is an artificial example to show that the cross-reference works both ways.

Because this is not a feature that will necessarily have wide adoption, it will be a separate REST call as opposed to having the cross-reference within the program objects themselves.

Because this would be an entirely new call it will not necessitate an API bump.

Comment period closes 2016-05-29 at which time I will make the call available and publish the REST endpoint.

[gtb]

I know this is beyond the comment cut-off date, but without validity hashes for the returned program entries, you are asking for (potentially) a large number of requests to get the current accurate data. Applications will not be able to cache the results.

[rkulagow]

Implemented with MD5, detailed at

viewtopic.php?f=17&t=2887