Subscription API

back to API Documentation (up a level)

API Overview

The 'Subscription API' allows a 3rd party application to perform basic operations on Subscriptions. A subscription is uniquely keyed with the 'api_key' and the 'profile data path'. This has two implications:

  1. Both the 'api key' and 'profile data path' must always be supplied for every operation on a Subscrition.
  2. For a given 'api key' (user account) only one subscription may exist for any single 'data profile path'.

API Operations

create

http://livedirectory.org/api/subscription/1.0/create/jquery/latest_version?api_key=[api_key]&notify_url=[url]

retrieve

http://livedirectory.org/api/subscription/1.0/retrieve/jquery/latest_version?api_key=[api_key]

update

http://livedirectory.org/api/subscription/1.0/update/jquery/latest_version?api_key=[api_key]&notify_url=[url]

(The 'profile data path' can not be updated - If this is required, a new subscription should be created and the previous one deleted. In the future the 'update' function may perform these operations automatically.)

delete

http://livedirectory.org/api/subscription/1.0/delete/jquery/latest_version?api_key=[api_key]