Site:API:PCR

From Metrixstream
(Difference between revisions)
Jump to: navigation, search
(Created page with "= Property Change Requests = Property Change Requests are a mechanism that allows you to approve updates to metadata that your users do on their own profile or their content. =...")
 
 
Line 1: Line 1:
 
= Property Change Requests =
 
= Property Change Requests =
  
Property Change Requests are a mechanism that allows you to approve updates to metadata that your users do on their own profile or their content.
+
Property Change Requests are a mechanism that allows you to approve updates to metadata that your users do on their own profile or their content. PCRs get created as a user updates metadata on their own profile or their content. PCRs can be enabled per property on a per site level.
 
+
== Add Property Change Request ==
+
 
+
This API call is responsible for adding a property change request.
+
 
+
=== Authentication Restrictions ===
+
 
+
Adminstrator or any authenticated user as long as objtype and objid correspond to their own authentication or they own the content.
+
 
+
=== Required Parameters ===
+
 
+
;action=pcr
+
;verb=add
+
;objtype
+
:content, owner, user
+
;objid
+
:the id of the objtype.
+
;name
+
:the property name; depending on objtype this can be title, description, banner_blob_id, banner_blob2_id, banner_blob3_id, etc
+
;value
+
:the value of the property.
+
 
+
=== Successful Response ===
+
 
+
;status=ok
+
;item
+
 
+
:;pcr
+
 
+
::;id
+
::: the id of the newly created property change request.
+
  
 
== Edit Property Change Request ==
 
== Edit Property Change Request ==

Latest revision as of 16:42, 23 May 2012

Contents

[edit] Property Change Requests

Property Change Requests are a mechanism that allows you to approve updates to metadata that your users do on their own profile or their content. PCRs get created as a user updates metadata on their own profile or their content. PCRs can be enabled per property on a per site level.

[edit] Edit Property Change Request

This API call is responsible for editing a property change request.

[edit] Authentication Restrictions

Adminstrators only.

[edit] Required Parameters

action=pcr
verb=edit
pcrId
The id of the pcr.
state
pending, approved, rejected, delete

[edit] Successful Response

status=ok
Personal tools