fAudApi

Base URL: /faudapi, Version: alpha

Make and respond to forms without touching a thing. Good for busy hands or natural interaction.

Default response content-types: application/json
Schemes: http

Summary

Tag: forms

Operation Description
GET /get/forms

A form by ID

GET /forms/new

Create a new Form

Tag: responses

Operation Description
GET /get/responses

A form response by ID

GET /responses/new

Create a new Form response

Tag: users

Operation Description
GET /user/new

Create a new user

Paths

Create a new Form

GET /forms/new

Tags: forms

Create a new Form

username

username with sufficient permission

query string
authkey

auth key for the given user

query string
viewers

a list of viewers by username

query string
content

the questions

query object[]

Uses default content-types: application/json

200 OK

An array containing the desired form, or empty

400 Bad Request

Missing Necessary Key

401 Unauthorized

Missing Necessary Authentication Information

A form by ID

GET /get/forms

Tags: forms

Get a form object by ID

username

username with sufficient permission

query string
authkey

auth key for the given user

query string
id

the desired object id.

query string

Uses default content-types: application/json

200 OK

An array containing the desired form, or empty

400 Bad Request

Missing Necessary Key

401 Unauthorized

Missing Necessary Authentication Information

A form response by ID

GET /get/responses

Tags: responses

Get a form response object by ID

username

username with sufficient permission

query string
authkey

auth key for the given user

query string
id

the desired object id.

query string

Uses default content-types: application/json

200 OK

An array containing the desired form, or empty

400 Bad Request

Missing Necessary Key

401 Unauthorized

Missing Necessary Authentication Information

Create a new Form response

GET /responses/new

Tags: responses

Create a new Form response

username

username with sufficient permission

query string
authkey

auth key for the given user

query string
viewers

a list of viewers by username

query string
content

the questions and answers

query object[]

Uses default content-types: application/json

200 OK

An array containing the desired form, or empty

400 Bad Request

Missing Necessary Key

401 Unauthorized

Missing Necessary Authentication Information

Create a new user

GET /user/new

Tags: users

Create a new user and get an authkey for that user.

username

username with sufficient permission

query string

Uses default content-types: application/json

200 OK

An array containing the desired form, or empty

400 Bad Request

Missing Necessary Key

Schema definitions

Error: object

code: integer (int32)
message: string
fields: string

Form: object

username: string

username with sufficient permission

viewers: object[]

a list of viewers by username

content: object[]

the questions

Question: object

title: string

The question's title (the question)

datatype: string

The expected data type of the result

validation: string

Additional validation requested

QuestionResponse: object

title: string

The question's title (the question)

response: string

The question's response (the answer)

datatype: string

The expected data type of the result

validation: string

Additional validation requested

Response: object

username: string

username with sufficient permission

viewers: object[]

a list of viewers by username

content: object[]

the questions and answers

User: object

username: string

Username name of the user.