Webservice: Form

---

Method #1: list

lists all the available froms in the tenant

Request

Name		Type		Required		Multiple		Description
sid		String		Y

Response

Name		Type		Required		Multiple		Description
forms		WSForm		Y		Y
id		Long		Y				unique identifier
templateId		Long		Y				identifier of the document template assigned to this form
name		String		Y				name of the form, it must be unique
content		String		Y				body of the form in HTML format
css		String		Y				optional CSS specification
webEnabled		Int		Y				it this form is enabled for the web
collectEmails		Int		Y				it the responder must leave it's email
backgroundColor		String		Y				the background color
formId		String		Y				an alternative unique identifier of the form, do not set it just read it
width		Int		Y				width of the form
webCss		String		Y				the CSS to use in the web form
columns		Int		Y				number of columns
targetFolderId		Long		Y				identifier of the target folder that will receive the submissions via web
confirmation		String		Y				the confirmation message
editAfterSubmit		Int		Y				if the responder can change his responses after sumbit
statChartWidth		Int		Y				width of the statistic chart
notifyResponses		Int		Y				flag to enable/disable the notification of the new responses
recipients		Long		Y		Y		IDs of the users that will be notified about new responses

---

Method #2: delete

deletes an existing form

Request

Name		Type		Required		Multiple		Description
sid		String		Y
formId		Long		Y

---

Method #3: store

creates/updates a form; returns the newly created/updated form

Request

Name		Type		Required		Multiple		Description
sid		String		Y
form		WSForm		Y
id		Long		Y				unique identifier
templateId		Long		Y				identifier of the document template assigned to this form
name		String		Y				name of the form, it must be unique
content		String		Y				body of the form in HTML format
css		String		Y				optional CSS specification
webEnabled		Int		Y				it this form is enabled for the web
collectEmails		Int		Y				it the responder must leave it's email
backgroundColor		String		Y				the background color
formId		String		Y				an alternative unique identifier of the form, do not set it just read it
width		Int		Y				width of the form
webCss		String		Y				the CSS to use in the web form
columns		Int		Y				number of columns
targetFolderId		Long		Y				identifier of the target folder that will receive the submissions via web
confirmation		String		Y				the confirmation message
editAfterSubmit		Int		Y				if the responder can change his responses after sumbit
statChartWidth		Int		Y				width of the statistic chart
notifyResponses		Int		Y				flag to enable/disable the notification of the new responses
recipients		Long		Y		Y		IDs of the users that will be notified about new responses

Response

Name		Type		Required		Multiple		Description
form		WSForm		Y
id		Long		Y				unique identifier
templateId		Long		Y				identifier of the document template assigned to this form
name		String		Y				name of the form, it must be unique
content		String		Y				body of the form in HTML format
css		String		Y				optional CSS specification
webEnabled		Int		Y				it this form is enabled for the web
collectEmails		Int		Y				it the responder must leave it's email
backgroundColor		String		Y				the background color
formId		String		Y				an alternative unique identifier of the form, do not set it just read it
width		Int		Y				width of the form
webCss		String		Y				the CSS to use in the web form
columns		Int		Y				number of columns
targetFolderId		Long		Y				identifier of the target folder that will receive the submissions via web
confirmation		String		Y				the confirmation message
editAfterSubmit		Int		Y				if the responder can change his responses after sumbit
statChartWidth		Int		Y				width of the statistic chart
notifyResponses		Int		Y				flag to enable/disable the notification of the new responses
recipients		Long		Y		Y		IDs of the users that will be notified about new responses

---

Method #4: getForm

gets an existing form

Request

Name		Type		Required		Multiple		Description
sid		String		Y
formId		Long		Y

Response

Name		Type		Required		Multiple		Description
form		WSForm		Y
id		Long		Y				unique identifier
templateId		Long		Y				identifier of the document template assigned to this form
name		String		Y				name of the form, it must be unique
content		String		Y				body of the form in HTML format
css		String		Y				optional CSS specification
webEnabled		Int		Y				it this form is enabled for the web
collectEmails		Int		Y				it the responder must leave it's email
backgroundColor		String		Y				the background color
formId		String		Y				an alternative unique identifier of the form, do not set it just read it
width		Int		Y				width of the form
webCss		String		Y				the CSS to use in the web form
columns		Int		Y				number of columns
targetFolderId		Long		Y				identifier of the target folder that will receive the submissions via web
confirmation		String		Y				the confirmation message
editAfterSubmit		Int		Y				if the responder can change his responses after sumbit
statChartWidth		Int		Y				width of the statistic chart
notifyResponses		Int		Y				flag to enable/disable the notification of the new responses
recipients		Long		Y		Y		IDs of the users that will be notified about new responses

---

Method #5: getFormByName

gets an existing form

Request

Name		Type		Required		Multiple		Description
sid		String		Y
name		String		Y

Response

Name		Type		Required		Multiple		Description
form		WSForm		Y
id		Long		Y				unique identifier
templateId		Long		Y				identifier of the document template assigned to this form
name		String		Y				name of the form, it must be unique
content		String		Y				body of the form in HTML format
css		String		Y				optional CSS specification
webEnabled		Int		Y				it this form is enabled for the web
collectEmails		Int		Y				it the responder must leave it's email
backgroundColor		String		Y				the background color
formId		String		Y				an alternative unique identifier of the form, do not set it just read it
width		Int		Y				width of the form
webCss		String		Y				the CSS to use in the web form
columns		Int		Y				number of columns
targetFolderId		Long		Y				identifier of the target folder that will receive the submissions via web
confirmation		String		Y				the confirmation message
editAfterSubmit		Int		Y				if the responder can change his responses after sumbit
statChartWidth		Int		Y				width of the statistic chart
notifyResponses		Int		Y				flag to enable/disable the notification of the new responses
recipients		Long		Y		Y		IDs of the users that will be notified about new responses

---

Method #6: createDocument

creates a new document rendered with the given form; returns the newly created document

Request

Name		Type		Required		Multiple		Description
sid		String		Y
formId		Long		Y
doc		WSDocument		Y				the matadata for the creation, please populate the title, the folderId and all the needed attributes specified in the form
id		Long		Y				unique identifier
fileSize		Long		Y
status		Int						0 = unlocked, 1 = checked out, 2 = locked
exportStatus		Int
version		String
fileVersion		String
date		String		Y				last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
publisher		String
publisherId		Long
creator		String
creatorId		Long
type		String		Y
lockUserId		Long
creation		String						the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
fileName		String		Y
indexed		Int						0 = to index, 1 = indexed, 2 = skip indexing
signed		Int
stamped		Int						1 if the document contains at least one stamp
tags		String				Y		tags applied to the document
folderId		Long		Y				parent folder
templateId		Long						id of the template assigned to the document
customId		String						unique custom identifier
immutable		Int						0 = not immutable, 1 = immutable
digest		String
exportName		String
exportId		Long
docRef		Long						used for aliases, refers to another document
docRefType		String						if used, defines the reference type (use pdf for the PDF Conversion)
deleteUserId		Long						user that has deleted the document
attributes		WSAttribute				Y		array of attributes
name		String		Y				name of the attribute
stringValue		String
intValue		Long
doubleValue		Double
dateValue		String						the date value; format must be 'yyyy-MM-dd'
type		Int		Y				0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
mandatory		Int		Y
hidden		Int		Y
readonly		Int		Y
position		Int
label		String
editor		Int		Y				0 = free, 1 = preset
setId		Long						Id of the attribute set
multiple		Int		Y				0 = single value, 1 = one or more values
parent		String						The reference attribute name, used for multi value attributes
dependsOn		String						Name of another attribute on which the value of this attribute also depends, used for managing linked presets
stringValues		String						Read only. In case of multiple string values, contains the values separated by a comma
validation		String						Optional validation script
initialization		String						Optional initialization script
language		String						language of the document; See specification
summary		String						contains the snippet search text
score		Integer						full text search score
icon		String
comment		String
lastModified		String
rating		Integer
workflowStatus		String						current workflow's status where the document is in
workflowStatusDisplay		String						current workflow's status display informations
color		String						optional color assigned to the document
published		Int						if it is not set to 1, the document is marked as not published
startPublishing		String
stopPublishing		String
pages		Int						number of pages (default 1)
nature		Int						0 = document, 1 = form
formId		Long						the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
passwordProtected		Integer						indicates whether the document is protected by a password
ocrTemplateId		Long						identifier of the Zonal OCR template to use to process this document
ocrd		Int						indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
barcodeTemplateId		Long						identifier of the barcode template to use to process this document
barcoded		Int						indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Response

Name		Type		Required		Multiple		Description
document		WSDocument		Y
id		Long		Y				unique identifier
fileSize		Long		Y
status		Int						0 = unlocked, 1 = checked out, 2 = locked
exportStatus		Int
version		String
fileVersion		String
date		String		Y				last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
publisher		String
publisherId		Long
creator		String
creatorId		Long
type		String		Y
lockUserId		Long
creation		String						the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
fileName		String		Y
indexed		Int						0 = to index, 1 = indexed, 2 = skip indexing
signed		Int
stamped		Int						1 if the document contains at least one stamp
tags		String				Y		tags applied to the document
folderId		Long		Y				parent folder
templateId		Long						id of the template assigned to the document
customId		String						unique custom identifier
immutable		Int						0 = not immutable, 1 = immutable
digest		String
exportName		String
exportId		Long
docRef		Long						used for aliases, refers to another document
docRefType		String						if used, defines the reference type (use pdf for the PDF Conversion)
deleteUserId		Long						user that has deleted the document
attributes		WSAttribute				Y		array of attributes
name		String		Y				name of the attribute
stringValue		String
intValue		Long
doubleValue		Double
dateValue		String						the date value; format must be 'yyyy-MM-dd'
type		Int		Y				0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
mandatory		Int		Y
hidden		Int		Y
readonly		Int		Y
position		Int
label		String
editor		Int		Y				0 = free, 1 = preset
setId		Long						Id of the attribute set
multiple		Int		Y				0 = single value, 1 = one or more values
parent		String						The reference attribute name, used for multi value attributes
dependsOn		String						Name of another attribute on which the value of this attribute also depends, used for managing linked presets
stringValues		String						Read only. In case of multiple string values, contains the values separated by a comma
validation		String						Optional validation script
initialization		String						Optional initialization script
language		String						language of the document; See specification
summary		String						contains the snippet search text
score		Integer						full text search score
icon		String
comment		String
lastModified		String
rating		Integer
workflowStatus		String						current workflow's status where the document is in
workflowStatusDisplay		String						current workflow's status display informations
color		String						optional color assigned to the document
published		Int						if it is not set to 1, the document is marked as not published
startPublishing		String
stopPublishing		String
pages		Int						number of pages (default 1)
nature		Int						0 = document, 1 = form
formId		Long						the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
passwordProtected		Integer						indicates whether the document is protected by a password
ocrTemplateId		Long						identifier of the Zonal OCR template to use to process this document
ocrd		Int						indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
barcodeTemplateId		Long						identifier of the barcode template to use to process this document
barcoded		Int						indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed