Documentation

/document/edit/{contentId}

ThoughtFarmer REST API Method: /document/edit/{contentId}

Gets a document from ThoughtFarmer and locks it for editing.

URL:
http://yourserver.com/api/document/edit/{contentId}
http://yourserver.com/api/2.0/document/edit/{contentId}

Response Formats:
xml,json

HTTP Method(s):
GET

Requires Authentication:
true, user making call must pass a valid token parameter and must have edit permissions

Parameters:

Parameter Type Description
contentId int Required. The content id of the the document page to retrieve
token string Required. A valid token authentication parameter
Response Status Codes:
200 - Update successful
401 - Token parameter is invalid
403 - No permissions to make update
404 - Requested document not found
409 - If a content id is not a document page
412 - If the document is locked by another user

Example request
GET http://yourserver.com/api/document/edit/{contentId}
{
   "AbbreviatedTitle":[
      {
         "Key":"en",
         "Value":""
      }
   ],
   "Body":[
      {
         "Key":"en",
         "Value":""
      }
   ],
   "ContentId":64,
   "CreatorId":5,
   "Data":[
      ...
   ],
   "DateModified":"/Date(1188448372010-0700)/",
   "DatePosted":"/Date(1188448372010-0700)/",
   "DatePublished":"/Date(1188448372010-0700)/",
   "DocumentContentType":"application/download",
   "FileName":"06_06_07.pdf",
   "FileSize":9908,
   "GrandParentId":247,
   "LastModifiedBy":"Updated Aug 29, 2007 by Sandra Fipke",
   "ModifiedId":13,
   "OwnerId":5,
   "ParentId":58,
   "Summary":[
      {
         "Key":"en",
         "Value":""
      }
   ],
   "Title":[
      {
         "Key":"en",
         "Value":"Pricelist"
      }
   ],
   "TreePath":"",
   "ViewTypes":[
      15,
      18
   ]
}