Settings Syncing API: Digiguide.tv API Documentation

Settings Syncing API

Digiguide.tv can manage the syncing of personal settings, but you need to handle things in your app to allow items to be synced properly.

You need to store the date/time with any like/dislike change that occurs
If someone removes a like or dislike, you must store this and the date/time the like/dislike was removed

This allows the API to remove items from the server as appropriate based on the most recent changes.

The dateUTC is a JavaScript-like Julian date, i.e. milliseconds since epoch.

When you upload your changes, the server will merge these changes into the database and respond with a new full authoritative set; at which point you should discard all your internal structures and use this new returned set.

It is recommended you sync regularly to ensure that any other applications and products get any changes made in your app and vice-versa.

Getting Programme Preferences

Use this API to return back a complete authoritative set of programmes that are liked or disliked, in separate arrays, for the authorised user account.

End Point	http://api.digiguide.tv/1.2/tv/programmepreferences/
Supported Responses	JSON
Supported Methods	GET
URI Scheme	Either HTTP or HTTPS requests are supported.
User Authentication	Required

Required Parameters

appid=<yourappid>

Your unique and secret Application ID

{
  "success" : true,
  "programmePreferences" : {
    "dislike" : [
      { "category" : "Childrens",
        "categoryID" : 21,
        "id" : 779796,
        "imageMain" : { "height" : 262,
          "url" : "http://i.digiguide.tv/up/1104/779796-PrankPatr-13020208610.5.jpg",
          "width" : 350
        },
        "imageThumb" : { "height" : 150,
          "url" : "http://i.digiguide.tv/up/1104/tn-779796-PrankPatr-13020208610.5.jpg",
          "width" : 150
        },
        "imageTinyThumb" : { "height" : 75,
          "url" : "http://i.digiguide.tv/up/1104/ttn-779796-PrankPatr-13020208610.5.jpg",
          "width" : 75
        },
        "name" : "Prank Patrol Down Under"
      }
    ],
    "like" : [
      { "category" : "Drama",
        "categoryID" : 6,
        "id" : 238308,
        "imageMain" : { "height" : 262,
          "url" : "http://i.digiguide.tv/up/1103/238308-House-12990991122.92.jpg",
          "width" : 350
        },
        "imageThumb" : { "height" : 150,
          "url" : "http://i.digiguide.tv/up/1103/tn-238308-House-12990991122.92.jpg",
          "width" : 150
        },
        "imageTinyThumb" : { "height" : 75,
          "url" : "http://i.digiguide.tv/up/1103/ttn-238308-House-12990991122.92.jpg",
          "width" : 75
        },
        "name" : "House"
      },
      { "category" : "Nature",
        "categoryID" : 13,
        "id" : 703064,
        "imageCredit" : "BBC",
        "imageMain" : { "height" : 210,
          "url" : "http://i.digiguide.tv/up/0906/703064-Deadly60-12460367930.jpg",
          "width" : 350
        },
        "imageThumb" : { "height" : 150,
          "url" : "http://i.digiguide.tv/up/0906/tn-703064-Deadly60-12460367930.jpg",
          "width" : 150
        },
        "imageTinyThumb" : { "height" : 75,
          "url" : "http://i.digiguide.tv/up/0906/ttn-703064-Deadly60-12460367930.jpg",
          "width" : 75
        },
        "name" : "Deadly 60"
      }
    ]
  }
}

Setting Programme Preferences

Use this API to push your current preferences changeset back to the server for merging into the authorised user account. You should only post the items that have changed since the last time you synced/received data as described above.

Returns back a new authoratative set of preferences; you should discard any cached preferences structures and use the returned set as it will contain the latest set of preferences pushed by other apps.

End Point	http://api.digiguide.tv/1.2/tv/programmepreferences/
Supported Responses	JSON
Supported Methods	POST
URI Scheme	Either HTTP or HTTPS requests are supported.
User Authentication	Required

Required Parameters

appid=<yourappid> Your unique and secret Application ID

JSON Structure You should post a structure as defined in Fig.1 below. { preferencesUpdates: [ { "progID": 31350, "action": "delete", "dateUTC": 121002010000 }, { "progID": 85020, "action": "delete", "dateUTC": 121002010000 }, { "progID": 1, "action": "like", "dateUTC": 121002010000 }, { "progID": 2, "action": "like", "dateUTC": 121002010000 }, { "progID": 8102, "action": "dislike", "dateUTC": 121002010000 }, { "progID": 16014, "action": "delete", "dateUTC": 121002010000 } ] }

Successful Response

{
  "success" : true,
  "programmePreferences" : {
    "dislike" : [
      { "category" : "Childrens",
        "categoryID" : 21,
        "id" : 779796,
        "imageMain" : { "height" : 262,
          "url" : "http://i.digiguide.tv/up/1104/779796-PrankPatr-13020208610.5.jpg",
          "width" : 350
        },
        "imageThumb" : { "height" : 150,
          "url" : "http://i.digiguide.tv/up/1104/tn-779796-PrankPatr-13020208610.5.jpg",
          "width" : 150
        },
        "imageTinyThumb" : { "height" : 75,
          "url" : "http://i.digiguide.tv/up/1104/ttn-779796-PrankPatr-13020208610.5.jpg",
          "width" : 75
        },
        "name" : "Prank Patrol Down Under"
      }
    ],
    "like" : [
      { "category" : "Drama",
        "categoryID" : 6,
        "id" : 238308,
        "imageMain" : { "height" : 262,
          "url" : "http://i.digiguide.tv/up/1103/238308-House-12990991122.92.jpg",
          "width" : 350
        },
        "imageThumb" : { "height" : 150,
          "url" : "http://i.digiguide.tv/up/1103/tn-238308-House-12990991122.92.jpg",
          "width" : 150
        },
        "imageTinyThumb" : { "height" : 75,
          "url" : "http://i.digiguide.tv/up/1103/ttn-238308-House-12990991122.92.jpg",
          "width" : 75
        },
        "name" : "House"
      },
      { "category" : "Nature",
        "categoryID" : 13,
        "id" : 703064,
        "imageCredit" : "BBC",
        "imageMain" : { "height" : 210,
          "url" : "http://i.digiguide.tv/up/0906/703064-Deadly60-12460367930.jpg",
          "width" : 350
        },
        "imageThumb" : { "height" : 150,
          "url" : "http://i.digiguide.tv/up/0906/tn-703064-Deadly60-12460367930.jpg",
          "width" : 150
        },
        "imageTinyThumb" : { "height" : 75,
          "url" : "http://i.digiguide.tv/up/0906/ttn-703064-Deadly60-12460367930.jpg",
          "width" : 75
        },
        "name" : "Deadly 60"
      }
    ]
  }
}