Agendize forms API

Forms


Resource representation

{ "id": {string}, "name": {string}, "title": {string}, "submitMessage": {string}, "fields": [ { "id": {string}, "type": {string}, "label": {string}, "mandatory": {boolean}, "order": {integer}, "key": {string}, "values" : [{string}] } ], "followUp": {boolean}, "emailNotifications": {boolean}, "emailNotificationsAddresses": [ {string} ], "clientEmailNotifications": {boolean}, "finalizeLater": {boolean}, "finalizeLaterEmailMessage": {string} }
Parameter name Value Description
id string Identifier of the form. Read-only
name string Name of the form.
title string Title of the form.
submitMessage string Message of the form after validation.
fields[] list Fields of the form.
fields[].id string Id of the fields. Read only.
fields[].type string Type of the field. Values: "address", "checkbox", "date", "email", "input", "name", "number", "phone", "price", "radio", "scalerating", "select", "start", "textarea", "website".
fields[].label string Label of the field.
fields.mandatory boolean If the field is mandatory.
fields[].order integer Order number of the fields. First field of the form has order number 0
fields[].key string Key of the field.
fields[].values string Values list of the field. Only used for "checkbox", "select" and "radio" field types.
followUp boolean Enable or disable follow up feature.
emailNotifications boolean Enable or disable account email notification.
emailNotifications array[string] List of email adresses to notify for each form filled.
clientEmailNotifications boolean Allow end user to receive an email when he fill a new form.
finalizeLater boolean Allow end user to finalized the form later.
finalizeLaterEmailMessage boolean Text message displayed when the end user come back to the form.

Delete

Deletes an entry on the form list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

DELETE http://az2.agendize.com/api/2.0/forms/{formId}

Parameters

Parameter name Value Description
Path parameters
formId string Form identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.


Get

Returns an entry of the form list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/forms/{formId}

Parameters

Parameter name Value Description
Path parameters
formId string Form identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Form resource in the response body.


List

Returns entries on the form list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/forms

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Form Resource] }

Insert

Adds an entry to the form list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

POST http://az2.agendize.com/api/2.0/forms

Request body

In the request body, supply a Form Resource with the following properties:

Parameter name Value Description
Required Properties
name string Name of the form.
Optional Properties
id string Identifier of the form.
author string Author of the form.
description string Description of the form.
content string Content of the form in XML.
submitMessage string Message of the form after validation.
fields[] string Fields of the form.
fields[].id string Id of the fields.
fields[].type string Type of the field.
fields[].label string Label of the field.
fields[].mandatory boolean If the field is mandatory.
fields[].order integer Order number of the fields.
fields[].key string Key of the field.
fields[].values string Values list of the field.

Response

If successful, this method returns a Form resource in the response body.


Update

Updates an entry on the form list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

PUT http://az2.agendize.com/api/2.0/forms/{formId}

Parameters

Parameter name Value Description
Path parameters
formId string Form identifier.

Request body

In the request body, supply a Form resource with the following properties:

Parameter name Value Description
Optional Properties
name string Name of the form.

Response

If successful, this method returns a Form resource in the response body.