...
| Code Block |
|---|
* Form UI url ('''formtype''' link) * Form Designer UI ('''formtype-editor''' link) * Submissions UI ('''submissions''' link) * The list of controls/fields contained in this form ('''controltypes''' link) * XML Schema for this form ('''schema''' link) |
Note that for some of the links above there are two links for the same rel attribute (e.g. the '''formtype''' link):
...
And the server will respond with:
| Code Block |
|---|
200 OK |
...
ControlTypeFeed
...
The controltype feed contains a flat list of all controltypes contained in a given FormType.=====
Getting the ControlTypeFeed
...
In order to get a list of all ControlType's owned by a given FormType, send the following request to the frevvo server:<pre>
| Code Block |
|---|
GET /frevvo/web/tn/{tenantId}/api/controltypes?ownerId={formTypeId} |
...
The server will respond with:<pre>
| Code Block |
|---|
200 OK |
...
TODO |
...
...
Getting a ControlTypeEntry
...
It is also possible to get a specific controltype entry as long as you know its id. In order to do that send the following request to the server:<pre>
| Code Block |
|---|
GET /frevvo/web/tn/{tenantId}/api/controltype/{id} |
...
And the server will respond with:<pre>
| Code Block |
|---|
200 OK |
...
TODO |
Once you have a ControlTypeEntry Url you can get the:
| Code Block |
|---|
* Type of control (in a category with a |
...
http://schemas.frevvo.com/fdata/2008#controltype |
...
scheme) |
...
* Display type of the control (in a category with |
...
http://schemas.frevvo.com/fdata/2008#displaytype |
...
scheme) |
...
* Link to the parent control (in a |
...
parent link) |
...
Inserting a new ControlTypeEntry
...
Not supported at this point. The ControlTypeFeed is read-only and changes can only be made through the designer.=====
Updating a ControlTypeEntry
...
Not supported at this point. The ControlTypeFeed is read-only and changes can only be made through the designer.=====
Deleting a ControlTypeEntry
...
Not supported at this point. The ControlTypeFeed is read-only and changes can only be made through the designer.====
DocumentTypeFeed
...
A DocumentType represents a schema for a single Document (contrast this with a Schema that is namespace aggregating a set of top-level elements or DocumentType's). You will find DocumentType's in uploaded XML Schemas, one DocumentType for each root element in the schema, and in FormType's, one default DocumentType and zero or more DocumentType's from an XML Schema.
The reason you may want to add a DocumentType from a Schema to a FormType is so that you can auto-generate controls bound to elements in that DocumentType. Schema DocumentType's added to a FormType will show up in the Data Source pane in the designer.=====
Getting the DocumentTypeFeed
...
In order to get a list of DocumentType's owned by a given FormType or Schema, send the following request to the frevvo server:<pre>
| Code Block |
|---|
GET /frevvo/web/tn/{tenantId}/api/doctypes?ownerId={formTypeId} |
...
or |
...
GET /frevvo/web/tn/{tenantId}/api/doctypes?ownerId={SchemaId} |
</pre>The server will respond with:<pre>
| Code Block |
|---|
200 OK |
...
TODO |
...
Getting a DocumentTypeEntry
...
DocumentType's cannot be created from scratch using the API. They are either created automatically by frevvo when you design your forms or by uploading an XML Schema. They can, however, be added/removed to/from a FormType.<pre>
| Code Block |
|---|
GET /frevvo/web/tn/{tenantId}/api/doctype/{id} |
</pre>And the server will respond with:<pre>
| Code Block |
|---|
200 OK |
...
TODO
</pre>
...
TODO |
Inserting a new DocumentTypeEntry
...
It is only possible to insert a DocumentType's into a FormTypes from an existing one (i.e. you wont be able to create a DocumentType from scratch, but you will be able to add a DocumentType found in a Schema into a FormType). The DocumentTypeFeed found in a SchemaEntry is read-only.
TODO=====
Updating a DocumentTypeEntry
...
Not supported at this point.=====
Deleting a DocumentTypeEntry
...
It is only possible to delete DocumentType's from a FormType as long as it was added from a Schema. This means that you can add and remove a Schema DocumentType's from a FormType but you wont be able to remove the its default DocumentType.