SOAP Webservice Type Definitions

The following core types are defined by the webservice. Please note, this only covers the commonly used types and is not a comprehesive list.

Permissions

The permissions assigned to a document or folder are represented by a string of letters: RWASDNE.

R: READ
W: WRITE
A: Add Folder (folder specific)
S: Manage Security (folder specific)
D: Delete
N: Rename Folder (folder specific)
E: Edit (document specific) - available if the document has been checked out by the current (webservice) user.

kt_response

Field	Type	Description
status_code	int	Determines if the request has been successful. 0 for success.
message	string	Contains an error message if the request is not successful. If successful, contents depend on the request.

kt_folder_detail

Field	Type	Description
status_code	int	Determines if the request has been successful. 0 for success.
message	string	Contains an error message if the request is not successful.
id	int	ID of the requested folder.
folder_name	string	Name of the requested folder.
parent_id	int	ID of the parent folder.
full_path	string	Folder path to the folder.
permissions	string	Permissions string
created_by	string	Name of the user who created the folder.
linked_folder_id	int	If this is a shortcut, the ID of the target folder.
clean_uri	string	URL to the folder.
parent_folder_ids	string	Comma separated list of the parent folder IDs
creator_id	int	ID of the user who created the folder
created_date	string	Date the folder was created.
modified_by	string	Name of the user who last updated the folder.
modified_user_id	int	ID of the user who last updated the folder.
modified_date	string	Date the folder was last updated.
owned_by	string	Name of the owner.
owner_id	int	ID of the owner of the folder.

kt_folder_item

The folder item describes both folders and documents and some of the fields will only be relevant to one or the other. In these cases a “n/a” will be sent if the field is not applicable to the item.

Field	Type	Description
id	int	ID of the requested folder.
item_type	string	Indicates a folder: F, document: D or shortcut: S.
title	string	Name of the item (folder name or document title)
filename	string	The document filename.
filesize	string	The size of the document file in bytes.
document_type	string	The assigned Document Type.
created_by	string	The person who created the document or folder.
created_date	string	Date the item was created.
checked_out_by	string	If checked out, the person who checked out the document.
checked_out_date	string	If checked out, the date the document was checked out.
modified_by	string	The person who last modified the item.
modified_date	string	The date the item was last modified.
owned_by	string	The owner of the document.
version	string	The version of the document.
is_immutable	string	Indicates if the document has been finalized.
permissions	string	Permissions string
workflow	string	If in a workflow, the name of the workflow.
workflow_state	string	If in a workflow, the current state of the workflow.
mime_type	string	The mime type. For a folder this will be “folder”.
mime_icon_path	string
mime_display	string	The display name for the mime type.
full_path	string	The folder path to the item.
storage_path	string	The path under which the file has been stored. For internal use only.
folder_name	string	The name of the folder
parent_id	int	The ID of the containing or parent folder.
linked_folder_id	int	If folder is a shortcut, the ID of the target folder
clean_uri	string	The URI of the item.
creator_id	int	The ID of the user who created the item.
created_by_user_name	string	The username (usually an email address) of the creator.
modified_user_id	int	The ID of the user who last updated the item.
modified_by_user_name	string	The username of the user who last updated the item.
checked_out_by_user_name	string	If checked out, the username of the user who checked out the document.
owner_id	int	The ID of the owner of the document.
owned_by_user_name	string	The username of the owner of the document.
has_rendition	string	Indicates whether the document has an associated PDF rendition.
object_type	string	Indicates the type of document: normal, remote, webpage, web document
custom_document_no	string	Deprecated
oem_document_no	string	Deprecated
items	kt_folder_items	If a folder, the list of contained items.

kt_folder_items

An array of kt_folder_item.

kt_folder_contents

Field	Type	Description
status_code	Int	Determines if the request has been successful. 0 for success.
message	String	Contains an error message if the request is not successful.
folder_id	Int	ID of the folder.
folder_name	String	Name of the folder.
full_path	String	The folder path of the folder.
items	kt_folder_items	The list of contained items

kt_document_detail

Field	Type	Description
status_code	int	Determines if the request has been successful. 0 for success.
message	string	Contains an error message if the request is not successful.
document_id	int	The ID of the document.
title	string	The title of the document
document_type	string	The assigned Document Type.
full_path	string
filename	string	The document filename.
filesize	int	The size of the document file in bytes.
folder_id	int	The ID of the folder the document is contained within.
created_by	string	The person who created the document
created_date	string	Date the item was created.
checked_out_by	string	If checked out, the person who checked out the document.
checked_out_date	string	If checked out, the date the document was checked out.
modified_by	string	The person who last modified the item.
modified_date	string	The date the item was last modified.
owned_by	string	The owner of the document.
version	float	The version of the document.
is_immutable	boolean	Indicates if the document has been finalized.
permissions	string	Permissions string
workflow	string	If in a workflow, the name of the workflow.
workflow_state	string	If in a workflow, the current state of the workflow.
mime_type	string	The mime type.
mime_icon_path	string
mime_display	string	The display name for the mime type.
storage_path	string	The path under which the file has been stored. For internal use only.
metadata	kt_metadata_fieldsets
links	kt_linked_documents
transitions	kt_workflow_transitions
version_history	kt_document_version_history
transaction_history	kt_document_transaction_history
document_type_id	int	The ID of the Document Type.
linked_document_id	int	If document is a shortcut, the ID of the target document
clean_uri	string	The URI of the item.
checked_in_date	string
document_status	string
created_by_user_name	string	The username (usually an email address) of the creator.
modified_by_user_name	string	The username of the user who last updated the item.
checked_out_by_user_name	string	If checked out, the username of the user who checked out the document.
owned_by_user_name	string	The username of the owner of the document.
created_by_user_id	int	The ID of the user who created the item.
modified_by_user_id	int	The ID of the user who last updated the item.
owned_by_user_id	int	The ID of the owner of the document.
content_id	int
extension	string
hash	string
custom_document_no	string	Deprecated.
oem_document_no	string	Deprecated

Table of Contents