Versions Compared

Key

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


Section


Column

This section describes the basic protocol used to interact with frevvo 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 frevvo 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 frevvo Server using any programming language that lets you issue HTTP requests and consume XML-based responses.

Note

In v9.1 and later frevvo's "Applications" are known as "Projects," and "Themes" are known as "Styles." The API objects and methods still use the words application, 'app', and theme.

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 frevvo UI, for instance users, projects, forms, 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.


Column
width240px

On this page:

Table of Contents
maxLevel1



...

Resource Description  Resource URI
UserFeed/frevvo/web/tn/{tenantId}/api/users
UserEntry/frevvo/web/tn/{tenantId}/api/user/{id}
ProjectFeed/frevvo/web/tn/{tenantId}/api/apps?ownerId={userId}
ProjectEntry/frevvo/web/tn/{tenantId}/api/app/{id}
FormTypeFeed/frevvo/web/tn/{tenantId}/api/formtypes?ownerId={appId}
FormTypeEntry/frevvo/web/tn/{tenantId}/api/formtype/{id}
SchemaFeed/frevvo/web/tn/{tenantId}/api/schemas?ownerId={appId}
SchemaEntry/frevvo/web/tn/{tenantId}/api/schema/{id}
ControlTypeFeed/frevvo/web/tn/{tenantId}/api/controltypes?ownerId={formTypeId}
ControlTypeEntry/frevvo/web/tn/{tenantId}/api/controltype/{id}
SubmissionFeed/frevvo/web/tn/{tenantId}/api/submissions?ownerId={formTypeId}appId}&filter=$formTypeId eq 'formTypeId'
SubmissionEntry/frevvo/web/tn/{tenantId}/api/submission/{id}

...