Section

Column

This section describes the basic protocol used to interact with Data APIs including examples of what Atom requests may look like, what kind of responses to expect, and so on. It is intended for anyone wanting an understanding the general idea of the format and protocol used by the Data API and it assumes that you understand the basics of XML, namespaces, Atom feeds, and the main HTTP requests GET, POST, PUT and DELETE, as well as the RESTful concept of a resource. Using the API at this level your client application can interact with the Server using any programming language that lets you issue HTTP requests and consume XML-based responses.

There are various different types of resources that can be viewed and manipulated by the Data API. Most of these resources are things that a designer sees when creating new forms and navigating the application using the UI, for instance users, applications, form, themes, schemas, etc. So before delving into the API specifics it is a good idea to understand these different types of resources and how they relate to each other. The following diagram shows these different resources currently being exposed by the Data API and the ownership relationships among them:

Image Added

Column

width	240px

On this page:

Table of Contents

maxLevel	1

Basically, for each resource type

...

in (User, Application, FormType, Theme, Schema)

...

an Atom Feed representation is provided. The following table shows the different URI to access the different resource feeds:

Column

width	240px

On this page:

Table of Contents

maxLevel	1

...

Data API URLs

Resource Description	Resource URI
Users Feed	/frevvo/web/t/{tenantId}/api/users
User Entry	/frevvo/web/t/{tenantId}/api/user/{id}
ApplicationFeed	/frevvo/web/t/{tenantId}/api/apps?ownerId={userId}
ApplicationEntry	/frevvo/web/t/{tenantId}/api/app/{id}
ThemeFeed	/frevvo/web/t/{tenantId}/api/themes?ownerId={userId}
ThemeEntry	/frevvo/web/t/{tenantId}/api/theme/{id}
FormTypeFeed	/frevvo/web/t/{tenantId}/api/formtypes?ownerId={appId}
FormTypeEntry	/frevvo/web/t/{tenantId}/api/formtype/{id}
SchemaFeed	/frevvo/web/t/{tenantId}/api/schemas?ownerId={appId}
SchemaEntry	/frevvo/web/t/{tenantId}/api/schema/{id}
ControlTypeFeed	/frevvo/web/t/{tenantId}/api/controltypes?ownerId={formTypeId}
ControlTypeEntry	/frevvo/web/t/{tenantId}/api/controltype/{id}
SubmissionFeed	/frevvo/web/t/{tenantId}/api/submissions
SubmissionEntry	/frevvo/web/t/{tenantId}/api/submission/{id}

...

The user feed represents each user that is visible to the currently logged in user. For all non-administrator users, this feed will always show one user: the current user; for the administrator users it will show all the users in frevvo allowing allowing them to manage user settings.

...

In order to get a list of all visible users, send the following request to the frevvo Server Server:

Code Block
GET /frevvo/web/tn/{tenantId}/api/users

...

In order to get a list of all themes, send the following request to the frevvo server server:

Code Block
GET /frevvo/web/tn/{tenantId}/api/themes

...

The returned feed above shows two theme entries named Clear and Blue Professional that happen to be the two global themes provided by default by the frevvo installationthe installation.

Getting a ThemeEntry

It is also possible to directly get a specific Theme entry as long as you know the theme id. In order to do that send the following request to the server:

...

In order to get a list of all applications, send the following request to the frevvo server server:

Code Block
GET /frevvo/web/tn/{tenantId}/api/apps

...

And the server will respond with:

Code Block
200 OK

FormTypeFeed

The formtype feed contains a list of all forms across all applications owned by the currently logged-in user.

...

In order to get a list of all forms owned by the current user, send the following request to the frevvo server server:

Code Block
GET /frevvo/web/tn/{tenantId}/api/formtypes

...

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):

...

In order to get a list of all schemas, send the following request to the frevvo server server:

Code Block
GET /frevvo/web/tn/{tenantId}/api/schemas

...

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 server:<pre>

Code Block
GET /frevvo/web/tn/{tenantId}/api/controltypes?ownerId={formTypeId}

</pre>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

</pre>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 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 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}

...

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.

Versions Compared

Old Version 20

New Version Current

Key

Getting a ThemeEntry

FormTypeFeed

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 server:<pre>
Code Block
GET /frevvo/web/tn/{tenantId}/api/controltypes?ownerId={formTypeId}
</pre>The server will respond with:<pre>
Code Block
200 OK
...
TODO
...

Getting a ControlTypeEntry

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

Getting the DocumentTypeFeed

Getting a DocumentTypeEntry

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.

Page Comparison

Versions Compared

Old Version 20

New Version Current

Key

Getting a ThemeEntry

FormTypeFeed

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 server:<pre> Code BlockGET /frevvo/web/tn/{tenantId}/api/controltypes?ownerId={formTypeId}</pre>The server will respond with:<pre> Code Block200 OK... TODO...

Getting a ControlTypeEntry

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

Getting the DocumentTypeFeed

Getting a DocumentTypeEntry

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.

In order to get a list of all ControlType's owned by a given FormType, send the following request to the frevvo server server:<pre>
Code Block
GET /frevvo/web/tn/{tenantId}/api/controltypes?ownerId={formTypeId}
</pre>The server will respond with:<pre>
Code Block
200 OK
...
TODO
...

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=====