From KnowledgeTree Document Management Made Simple

Contents 1 Introduction 2 Structures 2.1 kt_response 2.2 kt_folder_detail 2.3 kt_folder_item 2.4 kt_folder_items 2.5 kt_folder_contents 2.6 kt_document_detail 3 Functions 3.1 Authentication 3.2 Folder 3.3 Document 3.4 Workflow 3.5 General

Introduction

To access the SOAP WSDL for the web services, the URL http:://<kt.domain>/ktwebservice/webservice.php?wsdl or http:://<kt.domain>/ktwebservice/?wsdl

Structures

The following structures are defined by the web services:

kt_response

Field	Type	Description
status_code	int
message	string

kt_folder_detail

Field	Type	Description
status_code	int
message	string
id	int
folder_name	string
parent_id	int
full_path	string

kt_folder_item

Field	Type	Description
id	int
item_type	string
title	string
creator	string
checked_out_by	string
modified_by	string
filename	string
size	string
major_version	string
minor_version	string
storage_path	string
mime_type	string
mime_icon_path	string
mime_display	string
items	kt_folder_items

kt_folder_items

An array of kt_folder_item.

kt_folder_contents

Field	Type	Description
status_code	Int
message	String
folder_id	Int
folder_name	String
full_path	String
items	kt_folder_items

kt_document_detail

Field	Type	Description
status_code	Int
message	String
title	String
document_type	String
version	String
filename	String
created_date	String
created_by	String
updated_date	String
document_id	Int
folder_id	Int	The folder the document belongs to.
workflow	String
workflow_state	String
checkout_by	String
full_path	String

Functions

Authentication

Method	Parameters	Return	Description
login	username : string password : string ip : string	kt_response
logout	session_id : string	kt_response

Folder

Method	Parameters	Return	Description
get_folder_detail	session_id : string folder_id : integer	kt_folder_detail
get_folder_detail_by_name	session_id : string folder_name : string	kt_folder_detail
get_folder_contents	session_id : string folder_id : integer depth : integer what : string	kt_folder_contents
create_folder	session_id : string folder_id : integer folder_name : string	kt_folder_detail
delete_folder	session_id : string folder_id : integer reason : string	kt_response
rename_folder	session_id : string folder_id : integer newname : string	kt_response
copy_folder	session_id : string source_id : integer target_id : integer reason : string	kt_response
move_folder	session_id : string source_id : integer target_id : integer reason : string	kt_response
add_document	session_id : string folder_id : integer title : string filename : string documentype : string tempfilename : string	kt_document_detail

Document

Method	Parameters	Return	Description
get_document_detail	session_id : string document_id : integer	kt_document_detail
checkin_document	session_id : string document_id : integer filename : string reason : string tempfilename  : string major_update : boolean	kt_response
get_document_detail_by_name	session_id : string document_name : string what : string	kt_response
checkout_document	session_id : string document_id : integer reason : string	kt_response
undo_document_checkout	session_id : string document_id : integer reason : string	kt_response
download_document	session_id : string document_id : integer	kt_response
delete_document	session_id : string document_id : integer reason : string	kt_response
change_document_owner	session_id : string document_id : integer username : string reason : string	kt_response
copy_document	session_id : string document_id : integer folder_id : integer reason : string newtitle : string newfilename : string	kt_response
move_document	session_id : string document_id : integer folder_id : integer reason : string newtitle : string newfilename : string	kt_response
rename_document_title	session_id : string document_id : integer newtitle : string	kt_response
rename_document_filename	session_id : string document_id : integer newfilename : string	kt_response
rename_document_filename	session_id : string document_id : integer documenttype : string	kt_response
get_document_metadata	session_id : string document_id : integer	kt_metadata_response
update_document_metadata	session_id : string document_id : integer metadata : kt_metadata_fieldsets	kt_response
get_document_transaction_history	session_id : string document_id : integer	kt_document_transaction_history_response
get_document_version_history	session_id : string document_id : integer	kt_document_version_history_response

Workflow

Method	Parameters	Return	Description
start_document_workflow	session_id : string document_id : integer workflow : string	kt_response
delete_document_workflow	session_id : string document_id : integer	kt_response
perform_document_workflow_transition	session_id : string document_id : integer transition : string reason : string	kt_response
get_document_workflow_transitions	session_id : string document_id : integer	kt_response
get_document_workflow_state	session_id : string document_id : integer	kt_document_transitions_response

General

Method	Parameters	Return	Description
get_document_types	session_id : string	kt_document_types_response