Form

The Form object

The Form object looks like this in JSON:

{
    "object": "form",
    "id": 1,
    "current_version_id": 1,
    "type": "form",
    "name": "Form",
    "description": null,
    "image_file_id": null,
    "published": true,
    "accept_responses": true,
    "available_from": null,
    "available_until": null,
    "self_service": false,
    "require_user": false,
    "require_request": false,
    "anonymous_responses": false,
    "can_choose_linked_model": false,
    "user_response_limit": null,
    "total_response_limit": null,
    "response_review": "review",
    "enable_sms_verification": false,
    "redirect_url": null,
    "thank_you_message": null,
    "custom_css": null,
    "fee_id": null,
    "fee_amount": null,
    "can_charge_to_account": false,
    "default_localization_id": null,
    "retired_by_id": null,
    "retired_at": null,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
current_version_id	No	int
type	Yes	enum (form, inquiry)
name	Yes	text (300)
description	No	text (5000)
image_file_id	No	int
published	Yes	bool
accept_responses	Yes	bool
available_from	No	datetime
available_until	No	datetime
self_service	Yes	bool
require_user	Yes	bool
require_request	Yes	bool
anonymous_responses	Yes	bool
can_choose_linked_model	Yes	bool
user_response_limit	No	int
total_response_limit	No	int
response_review	Yes	enum (none, review, decision)
enable_sms_verification	Yes	bool
redirect_url	No	text (2000)
thank_you_message	No	text
custom_css	No	text
fee_id	No	int
fee_amount	No	decimal
can_charge_to_account	Yes	bool
default_localization_id	No	int
retired_by_id	No	int
retired_at	No	datetime
added_at	No	datetime
added_by_id	No	int
sandbox	No	bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/forms" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": []
}' \

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/forms',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/forms',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/forms"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/forms');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": 200,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "form",
            "id": 1,
            "current_version_id": 1,
            "type": "form",
            "name": "Form",
            "description": null,
            "image_file_id": null,
            "published": true,
            "accept_responses": true,
            "available_from": null,
            "available_until": null,
            "self_service": false,
            "require_user": false,
            "require_request": false,
            "anonymous_responses": false,
            "can_choose_linked_model": false,
            "user_response_limit": null,
            "total_response_limit": null,
            "response_review": "review",
            "enable_sms_verification": false,
            "redirect_url": null,
            "thank_you_message": null,
            "custom_css": null,
            "fee_id": null,
            "fee_amount": null,
            "can_charge_to_account": false,
            "default_localization_id": null,
            "retired_by_id": null,
            "retired_at": null,
            "added_at": null,
            "added_by_id": null,
            "report_data": {
                "num_responses_to_review": 2,
                "category_names": null
            }
        }
    ],
    "sandbox": true
}

Retrieves all Form objects that match given filter conditions.

HTTP Request

GET /forms

Parameters

Name	Required	Data Type	Description
filter	No	mixed	See available filter conditions
page	No	int	The page of results to return if more than 200 records are found.

Expandable Properties

current_version
roles
people
fee
form_categories

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name	Type
accepting_responses	bool
category	object_id
custom_css	bool
custom_thank_you_message	bool
fee	bool
login_required	bool
name	text
notification	object id
published	bool
response_limit_per_user	integer
response_limit	integer
responses_to_review	bool
retired	bool

Permissions

One of the following roles is required to call this method:

Staff
Faculty
Advisor

show

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/forms/(form)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/forms/(form)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/forms/(form)',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/forms/(form)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/forms/(form)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "form",
    "id": 1,
    "current_version_id": 1,
    "type": "form",
    "name": "Form",
    "description": null,
    "image_file_id": null,
    "published": true,
    "accept_responses": true,
    "available_from": null,
    "available_until": null,
    "self_service": false,
    "require_user": false,
    "require_request": false,
    "anonymous_responses": false,
    "can_choose_linked_model": false,
    "user_response_limit": null,
    "total_response_limit": null,
    "response_review": "review",
    "enable_sms_verification": false,
    "redirect_url": null,
    "thank_you_message": null,
    "custom_css": null,
    "fee_id": null,
    "fee_amount": null,
    "can_charge_to_account": false,
    "default_localization_id": null,
    "retired_by_id": null,
    "retired_at": null,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}

Retrieves a specific Form object.

HTTP Request

GET /forms/(form)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Expandable Properties

current_version
roles
people
fee
form_categories