Agendize forms API

Results


Resource representation

{ "id": {string}, "result": {string}, "form": {string}, "ipAddress": {string}, "client": {string}, "date": {string} }
Parameter name Value Description
id string Identifier of the result.
result string Results of the result.
form string Id of the result's form.
ipAddress string IP address of the client.
client string Id of the client (if exist in database, otherwise 0).
date string Date of the result.

Delete

Deletes an entry on the form's result list.

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

Request

HTTP Request

DELETE https://api.agendize.com/api/2.0/forms/{formId}/results/{resultId}

Parameters

Parameter name Value Description
Path parameters
formId string Form identifier.
resultId string Result 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's result list.

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

Request

HTTP Request

GET https://api.agendize.com/api/2.0/forms/{formId}/results/{resultId}

Parameters

Parameter name Value Description
Path parameters
formId string Form identifier.
resultId string Result identifier.

Request body

Do not supply a request body with this method.

Response

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


List

Returns entries on the form's result list.

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

Request

HTTP Request

GET https://api.agendize.com/api/2.0/forms/{formId}/results

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 response body with the following structure:

{ items: [Result Resource] }

Insert

Adds an entry to the form's result list.

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

Request

HTTP Request

POST https://api.agendize.com/api/2.0/forms/{formId}/results

Parameters

Parameter name Value Description
Path parameters
formId string Form identifier.

Request body

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

Parameter name Value Description
Required Properties
form string Id of the result's form.
Optional Properties
id string Identifier of the result.
author string Author of the result's form.
result string Results of the result.
form string Id of the result's form.
ipAddress string IP address of the client.
client string Id of the client (if exist in database, otherwise 0).
date string Date of the result.

Response

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


Update

Updates an entry on the form's result list.

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

Request

HTTP Request

PUT https://api.agendize.com/api/2.0/forms/{formId}/results/{resultId}

Parameters

Parameter name Value Description
Path parameters
formId string Form identifier.
resultId string Result identifier.

Request body

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

Parameter name Value Description
Optional Properties
form string Id of the result's form.

Response

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


Watch

Watch for form filled.

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

The watch send an Result resource in the request body

Request

HTTP Request

POST https://api.agendize.com/api/2.0/forms/{formId}/results/watch

Parameters

Request body

{ "id": {string}, "address": {string} }
Parameter name Value Description
id string Identifier of the watch. Read-only.
address string The address where notifications are delivered for this watch.

Response

If successful, this method returns an of Watch resource in the response body.