THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
GET {wookie}/widgetinstances
Not supported.
POST {wookie}/widgetinstances {params:instance_params}
Either creates a new instance for the given parameters, or retrieves an already-created instance. If a new instance is successfully created, the response has a HTTP status code of 201; if an instance if successfully retrieved, a status code of 200 is returned.
| Wiki Markup |
|---|
PUT \{wookie\}/widgetinstances \{params:_instance |
...
_params |
...
_, |
...
action |
...
, \[cloneshareddatakey\ |
...
]\} |
...
Either stop, resume, or clone an instance, depending on the content of the action parameter. If the action is "clone", a shared data key for the clone must be provided using the "cloneshareddatakey" parameter.
...
GET {wookie}/services
Returns an XML document containing all services and their default widgets. NOT YET IMPLEMENTED.any widgets associated with the service category.
GET {wookie}/services/{service_name}
Returns an XML representation of the service specified by service_name and all the widgets associated with it. NOT YET IMPLEMENTED.
POST {wookie}/services/ {param:name}
Creates a new service with the name provided using the name parameter. If there is already a service with this name, a http 409 (conflict) error is returned. This method requires authentication using a widgetadmin role, e.g. using HTTP Basic authentication.
PUT {wookie}/services/{service_name} {param:name}
Renames the service specified by service_name with the new name given by the name parameter. This method requires authentication using a widgetadmin role, e.g. using HTTP Basic authentication.
DELETE {wookie}/services/{service_name}
Deletes the service specified by service_name. This method requires authentication using a widgetadmin role, e.g. using HTTP Basic authentication.
Participants
A Participant consists of a participant_display_name, participant_id, and participant_thumbnail_url. Participants are always defined in relation to a specific Widget Instance; requests affecting one Participant have no effect on Participants associated with other Widget Instances.
...
GET {wookie}/participants
Not supported.
GET {wookie}/participants {params: instance_params}
Returns an XML representation of the Participants associated with the Widget instance specified by {instance params}.
GET {wookie}/participants {params:id_key
...
, api_key}
Returns an XML representation of the Participants associated with the Widget instance specified by {id_key}.
POST {wookie}participants {params: instance
...
_params, participant_id, participant_display_name, participant_thumbnail_url}
Adds a participant to the specified Widget Instance. If successful, a HTTP status code of 201 is returned. If there is already a participant that matches {participant params} for the instance, a HTTP status code of 200 is returned.
DELETE {wookie}/participants {params: instance_params
...
, participant
...
_id}
Deletes the specified Participant from the specified Widget Instance.
...
GET {wookie}/properties
Not supported.
GET {wookie}/properties {params: instance_params
...
, propertyname}
Returns the value of the specified property for the specified instance.
| Wiki Markup |
|---|
POST \{wookie\}/properties \{params: _instance_params |
...
_, propertyname, propertyvalue, \[is_public=true\]\} |
Sets a property for the specified instance. If is_public=true is set, the property set is a Shared Data entry; otherwise it is a Preference.
PUT {wookie}/properties {params: instance_params
...
, propertyname
...
, propertyvalue}
Updates the value of the specified property of the specified Widget Instance. NOT YET IMPLEMENTED.
DELETE {wookie}/properties {params: instance_params
...
, propertyname}
Deletes a property. NOT YET IMPLEMENTED