Profile Data API

API Overview

The 'Profile Data API' allows a 3rd party application to perform basic operations on profile data. It would typically be used to update all or part of a profile with new data.

API Operations

API Operation: create

http://livedirectory.org/api/profile-data/1.0/create/jquery/latest_version?api_key=[api_key]&data_value=[data value]

API Operation: retrieve

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

API Operation: update

http://livedirectory.org/api/profile-data/1.0/update/jquery/latest_version?api_key=[api_key]&data_value=[data value]

API Operation: delete

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

API Operation: retrieve-subscriptions (not implemented yet)

http://livedirectory.org/api/profile-data/1.0/retrieve-subscriptions/jquery/latest_version?api_key=[api_key]

API Parameters

api_key

The value used for the parameter 'api_key' should be exactly the same value displayed in the 'My Account' page. The API Key unique identifies your account and allows you to perform API operations on your profile data. For this reason, your API Key should not be shared or made public because anybody could update, delete or create data against your profile.

data_value

Any text can be supplied as a value for the 'data_value' paramenter. However, if the supplied data is a valid JSON formatted string, then the value will be interpreted and treated as a JSON object. This is a powerful feature and allows the creation and management of complex data structures via a single url parameter.

Please read the JSON Guide for more information on JSON formatted strings.