Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column

The frevvo Data API provides a simple protocol for viewing and managing frevvo resources such as forms, applications, themes, schemas, etc. The API extends the Google Data API framework, is HTTP and XML-based, and uses the Atom [http://www.ietf.org/rfc/rfc4287.txt Syndication format] Syndication Format  with a few extensions following Atom's standard extension model. Java and .Net are the language-specific wrappers around the API.

Atom also provides the Atom [http://www.rfc-editor.org/rfc/rfc5023.txt Publishing Protocol] Publishing Protocol  (APP), an HTTP-based application protocol for publishing and editing resources on the web. The APP specification is an emerging standard being developed by the IETF that allows you to send an HTTP GET request to ask for a particular resource such as a form or schema; a representation of that resource is returned in the Atom [http://www.ietf.org/rfc/rfc4287.txt Syndication format] Syndication format. You can also create, edit and delete resources using standard HTTP POST, PUT and DELETE methods, respectively. Atom provides a protocol in line with the REST approach to web service interfaces.

Column
width240px

On this page:

Table of Contents
maxLevel1

 

 ===

The Data API Feeds

...

There are various different types of frevvo 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 frevvo 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.

Here is a diagram showing all the available Data API feeds

[[Image:DataAPI-Feeds.png]]Image Added

Here is a quick run-down of each one of them:* '''UserFeed'''

  • UserFeed  - There is not much that can be done with this collection at this point except for being an optional entry point for applications, tasks and themes.

...

  • FormTypeTemplateFeed - The collection used to list and manage published forms or flows.

...

  • SubmissionFeed - The collection used to query form or flow submissions and get associated XML documents, PDF snapshots, attachments, etc.

...

  • ThemeFeed - The collection used list and manage themes in

...

  • .

...

  • ApplicationFeed - The collection used to list and manage applications in

...

  • .

...

  • TaskFeed - The collection used to manage the tasks for the current logged-in user.

...

  • SchemaFeed - The collection used to manage the XSDs uploaded to an application.

...

  • DocumentType - The collection used to manage top-level XSD elements in frevvo, called DocumentTypes. An XSD has a feed containing all the DocumentTypes (top level elements) that can be added to forms and flows and a form or flow has a feed containing all the DocumentTypes added (in the designer's Data Sources pane).

...

  • FormTypeFeed - The collection used to manage forms AND flows. This is the core collection in the API that is used to use, design, manage, instantiate, etc forms and flows.

...

  • ControlTypeFeed - The collection used to list the controls, and their metadata, contained in a form or flow.

It is important to understand this diagram since the source code for the client application maps almost one-to-one to this structure.===

Tutorials

...

==== Tutorial: Getting Started with the Java Client Library ====

...