Modulus Form API

Limits:

Your calls are limited based on your plan.
Please consult your plans throttling, to see how many parallel calls per second are allowed for your module.
If you abuse the limitations, first your calls will be delayed to match the limit, but if you continue, your IP will be blacklisted for 10 minutes!
If you integrate with our API and you need the data to be shown for your customers, please use a caching mechanism on your servers, instead of forwarding those request to us.

Available Functions:


info

Returns information about a module, share, user, module rights or module setup

mngField

Manages custom fields.

load

Returns neccesary form data needed to manage fills, more specific the list of form definitions and other essential items. Pay attention that this is a composite function made from info, mngField, mngDerivRule, mngBulk and mngTemplate. In case of an error, the errors returned can come from the functions listed before!

show

Returns neccesary form data needed to manage fills, this function is focused on the fills, and filtering a list of fills. Pay attention that this is a composite function made from mngFill and it acts like mngFill with action 0, in case of an error, the errors returned can come from those 3 functions said before!

loadShow

Returns necessary form data including everything like the list of form definitions, fills, derivations, etc. Pay attention that this is a composite function made from load and show wich in turn are composite also, at core they call basic api functions. In case of an error, the errors returned can come from those basic functions! In order to understand more in detail please also read the functions show and load!

mngModuleItem

A composite function over mngFill, that can add new fills, and accepts field values in normal or human encoded format!

search

Searches for form items.

export

Returns data formatted for export.

mngForm

List, Add, Update, Delete, Suspend or Resume a form definition.

checkDeletion

Check section / field deletion from a form definition.

mngFill

List, Add, Update or Delete a fill.

mngBulkUpdate

Applies a bulk update of fields on form fills.

mngDerivRule

List, Add, Update, Delete a derivation rule.

applyDerivRule

Apply a derivation rule.

revertDerivRule

Revert the repeatable sections from the destination fill created as a result of applying the derivation rule.


Possible errors and codes returned

Code 1: Acces denied for private function call!

Code 2: Internal Database Error, can not connect to Database!

Code 3: Function is not available!

Code 4: Invalid JSON parameter!

Code 5: Internal Error caused by invalid JSON!

Code 6: Too many requests, you can send 1 request in every LIMIT s!

Code 7: Your IP was banned for 10 minutes, because of abusive requests, you can send 1 request/limit period!

Code 8: Invalid API key!

Code 9: Unknown action!

Code 10: Call is not allowed from your IP: %IP%

Code 100: Composed keys from different modules or apps!

Code 102: You do not have the right for this operation!

Code 115: Module does not exists!

Code 116: Share does not exist!

Code 152: Option values are mandatory for select or multiple select!

Code 157: Duplicate option name `%FIELD%`!