ApplicationTemplate

The ApplicationTemplate object

The ApplicationTemplate object looks like this in JSON:

{
    "object": "application_template",
    "id": 3,
    "current_version_id": 2,
    "name": "Test v3",
    "type": "application",
    "published": true,
    "custom_css": null,
    "show_online": true,
    "require_address": false,
    "fee_id": null,
    "fee_amount": 75,
    "fee_payment": "before_start",
    "allow_undecided": true,
    "enable_sms_verification": true,
    "redirect_url": null,
    "thank_you_message": null,
    "initial_email_template_id": null,
    "enable_initial_email": true,
    "retired_by_id": null,
    "retired_at": null,
    "default_localization_id": null,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
current_version_id	No	int
name	Yes	text (300)
type	Yes	enum (application, online_reference)
published	Yes	bool
custom_css	No	text
show_online	Yes	bool
require_address	Yes	bool
fee_id	No	int
fee_amount	No	decimal
fee_payment	Yes	enum (before_start, before_submit)
allow_undecided	Yes	bool
enable_sms_verification	Yes	bool
redirect_url	No	text (2000)
thank_you_message	No	text
initial_email_template_id	No	int
enable_initial_email	Yes	bool
retired_by_id	No	int
retired_at	No	datetime
default_localization_id	No	int
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/applicationtemplates" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/applicationtemplates',
 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/applicationtemplates"), 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/applicationtemplates');
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": 3,
    "results": 3,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "application_template",
            "id": 3,
            "current_version_id": 2,
            "name": "Test v3",
            "type": "application",
            "published": true,
            "custom_css": null,
            "show_online": true,
            "require_address": false,
            "fee_id": null,
            "fee_amount": 75,
            "fee_payment": "before_start",
            "allow_undecided": true,
            "enable_sms_verification": true,
            "redirect_url": null,
            "thank_you_message": null,
            "initial_email_template_id": null,
            "enable_initial_email": true,
            "retired_by_id": null,
            "retired_at": null,
            "default_localization_id": null,
            "added_at": null,
            "added_by_id": null
        }
    ],
    "sandbox": true
}

Retrieves all ApplicationTemplate objects.

HTTP Request

GET /applicationtemplates

Parameters

None

Permissions

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

Admissions Admin

show

Example code to call this method:

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

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/applicationtemplates/(applicationtemplate)',
 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/applicationtemplates/(applicationtemplate)"), 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/applicationtemplates/(applicationtemplate)');
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": "application_template",
    "id": 3,
    "current_version_id": 2,
    "name": "Test v3",
    "type": "application",
    "published": true,
    "custom_css": null,
    "show_online": true,
    "require_address": false,
    "fee_id": null,
    "fee_amount": 75,
    "fee_payment": "before_start",
    "allow_undecided": true,
    "enable_sms_verification": true,
    "redirect_url": null,
    "thank_you_message": null,
    "initial_email_template_id": null,
    "enable_initial_email": true,
    "retired_by_id": null,
    "retired_at": null,
    "default_localization_id": null,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}

Retrieves a specific ApplicationTemplate object.

HTTP Request

GET /applicationtemplates/(applicationtemplate)

Parameters

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

Expandable Properties

current_version
academic_terms
programs
enrollment_options
initial_email_template

Permissions

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

Admissions Admin