Web Method definition
Web Method. CreateUser Summary: Create a new user CreateUser Request Parameters fk_cog_style_id s:int Integer, the primary key id of the cognitive style associated with the user Usr s:string Username foaf_nick s:string Nickname/display name Pwd s:string Password Email s:string E-mail address Opened s:Boolean Whether or not the user account is an OpenID account (Boolean, true/false) s:string (JSON) Returns OperationCompletedSuccessfully (code=2) and the user data for the created user ▇▇▇▇://▇▇▇▇▇▇▇▇▇▇▇.▇▇▇▇▇- ▇▇▇▇▇▇▇.▇▇/▇▇▇.▇▇▇▇/▇▇▇▇▇▇▇▇▇▇?▇▇_▇▇▇_▇▇▇▇▇_▇▇=▇:▇▇▇&▇▇▇=▇:▇▇▇▇▇▇&▇▇▇▇_▇▇▇▇=▇:▇▇▇▇▇▇&▇▇▇ =s:string&email=s:string&openid=s:boolean {
Web Method. GetWorkspaceItem Summary: Get a workspace item by its ID GetWorkspaceItem Request Parameters workspace_id s:string Unique database identifier of workspace item to be retrieved. s:string (JSON) JSON String: Single workspace item information ▇▇▇▇://▇▇▇▇▇▇▇▇▇▇▇.▇▇▇▇▇- ▇▇▇▇▇▇▇.▇▇/▇▇▇▇▇▇▇▇▇.▇▇▇▇/▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇?▇▇▇▇▇▇▇▇▇_▇▇=▇:▇▇▇▇▇▇ s:string (JSON) JSON String: List of workspace items information ▇▇▇▇://▇▇▇▇▇▇▇▇▇▇▇.▇▇▇▇▇-▇▇▇▇▇▇▇.▇▇/Workspace.asmx/GetWorkspaceItems? a path and to ▇▇▇▇ paths and nodes. Paths and nodes are the core dynamic objects in the PATHS Web Service API. A path consist of one or more nodes, a node references an item (or another object) via a URI.
Web Method. GetItemByID Summary: Get a single item by its ID GetItemByID Request Parameters ItemID s:string ID of item s:string (JSON) JSON String: Single item information ▇▇▇▇://▇▇▇▇▇▇▇▇▇▇▇.▇▇▇▇▇-▇▇▇▇▇▇▇.▇▇/Item.asmx/GetItemByID?ItemID=s:string topic_id s:string Unique database identifier of topic s:string (JSON) JSON String: Topic hierarchy ▇▇▇▇://▇▇▇▇▇▇▇▇▇▇▇.▇▇▇▇▇-▇▇▇▇▇▇▇.▇▇/Topic.asmx/GetTopicHierarchy?topic_id=s:string topic_uri s:string URI of topic s:string (JSON) JSON String: Topic hierarchy ▇▇▇▇://▇▇▇▇▇▇▇▇▇▇▇.▇▇▇▇▇-▇▇▇▇▇▇▇.▇▇/Topic.asmx/GetTopicByUri?topic_uri=s:string Web Method: GetTopicById Summary: Get a topic by its ID GetTopicById Request Parameters topic_id s:int Unique database identifier of topic s:string (JSON) JSON String: Single topic information ▇▇▇▇://▇▇▇▇▇▇▇▇▇▇▇.▇▇▇▇▇-▇▇▇▇▇▇▇.▇▇/Topic.asmx/GetTopicById?topic_id=s:int fk_rel_uri s:string Any URI, but commonly a reference to the URI of a PATHS Item dc_title s:string Title of workspace item dc_description s:string Description of workspace item (optional) type s:string Type of workspace item (optional, used?) s:string (JSON) JSON String: Workspace item ▇▇▇▇://▇▇▇▇▇▇▇▇▇▇▇.▇▇▇▇▇- ▇▇▇▇▇▇▇.▇▇/▇▇▇▇▇▇▇▇▇.▇▇▇▇/▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇?▇▇_▇▇▇_▇▇▇=▇:▇▇▇▇▇▇&▇▇_▇▇▇▇▇=▇:▇▇▇▇▇▇&▇▇_▇▇ scription=s:string&type=s:string
More Definitions of Web Method
Web Method. DeletePathNode Summary: Delete a node identified by its URI Remark: Method requires authentication DeletePathNode Request Parameters node_uri s:string URI of node to be deleted s:string (JSON) JSON String: Single node information ▇▇▇▇://▇▇▇▇▇▇▇▇▇▇▇.▇▇▇▇▇-▇▇▇▇▇▇▇.▇▇/Path.asmx/DeletePathNode?node_uri=s:string Summary: Delete a node identified by its URI Remark: Method requires authentication DeletePath Request Parameters path_uri s:string URI of path to be deleted s:string (JSON) JSON String: Single node information ▇▇▇▇://▇▇▇▇▇▇▇▇▇▇▇.▇▇▇▇▇-▇▇▇▇▇▇▇.▇▇/Path.asmx/DeletePath?path_uri=s:string node_uri s:string URI of node to be updated fk_path_id s:string Unique database identifier of path node should be assigned to (Integer, optional) fk_rel_uri s:string URI of object referenced by node. Often an item but can be any object identifiable by a URI (URI, optional) dc_title s:string Title of node (optional) dc_description s:string Description of node (optional) type s:string Type of node (optional, used?) node_order s:string Number indicating the position of the node within a path (Double, optional) s:string (JSON) JSON String: OperationCompletedSuccessfully (code=2) on success ▇▇▇▇://▇▇▇▇▇▇▇▇▇▇▇.▇▇▇▇▇- ▇▇▇▇▇▇▇.▇▇/▇▇▇▇.▇▇▇▇/▇▇▇▇▇▇▇▇▇▇▇▇▇▇?▇▇▇▇_▇▇▇=▇:▇▇▇▇▇▇&▇▇_▇▇▇▇_▇▇=▇:▇▇▇▇▇▇&▇▇_▇▇▇_▇▇▇=▇: string&dc_title=s:string&dc_description=s:string&type=s:string&node_order=s:string
Web Method. DeleteWorkspaceItem Summary: Deletes an item from the workspace. DeleteWorkspaceItem Request Parameters workspace_id s:string Unique datbase identifier of workspace item to be deleted s:string (JSON) JSON String: OperationCompletedSuccessfully (code=2) on success, DatabaseSQLError (code=7) on error. ▇▇▇▇://▇▇▇▇▇▇▇▇▇▇▇.▇▇▇▇▇- ▇▇▇▇▇▇▇.▇▇/▇▇▇▇▇▇▇▇▇.▇▇▇▇/▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇?▇▇▇▇▇▇▇▇▇_▇▇=▇:▇▇▇▇▇▇ workspace_id s:int Unique database identifier of the workspace item to be updated. fk_rel_uri s:string URI of referenced object dc_title s:string Title of workspace item dc_description s:string Description of workspace item (optional) type s:string Type of workspace item (optional) s:string (JSON) JSON String: Single workspace item information ▇▇▇▇://▇▇▇▇▇▇▇▇▇▇▇.▇▇▇▇▇- ▇▇▇▇▇▇▇.▇▇/▇▇▇▇▇▇▇▇▇.▇▇▇▇/▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇?▇▇▇▇▇▇▇▇▇_▇▇=▇:▇▇▇&▇▇_▇▇▇_▇▇▇=▇:▇▇▇▇▇▇& dc_title=s:string&dc_description=s:string&type=s:string
Web Method. GetItemsForTopic Summary: Get all items associated with a specific topic. GetItemsForTopic Request Parameters Parameter Data type Description GetItemsForTopic Response Data type Description Example of GetItemsForTopic HttpGet Request Request: Response:
Web Method. ModifyUser
Web Method. GetItemByUri Summary: Get a single item by its URI GetItemByUri Request Parameters item_uri s:string URI of item s:string (JSON) JSON String: Single item information ▇▇▇▇://▇▇▇▇▇▇▇▇▇▇▇.▇▇▇▇▇-▇▇▇▇▇▇▇.▇▇/Item.asmx/GetItemByUri?item_uri=s:string {
Web Method. DeleteUser Summary: Deletes a user from PATHS Remark: Method requires authentication DeleteUser Request Parameters usr_uri s:string URI of the user to be deleted