NAV
shell ruby python csharp php

EnrollmentAgreement

The EnrollmentAgreement object

The EnrollmentAgreement object looks like this in JSON:

{
    "object": "enrollment_agreement",
    "id": 1,
    "student_id": 1,
    "academic_term_id": 1,
    "print_layout_id": 6,
    "signed": null,
    "file_id": null,
    "source": "uploaded_manually",
    "amount": 1456.5,
    "user_ip": null,
    "status": "signed",
    "status_at": "2020-05-06T23:45:33+00:00",
    "notify_student": true,
    "added_at": "2020-05-06T23:45:33+00:00",
    "added_by_id": 1,
    "sandbox": true
}
Attribute Required Data Type
id Yes int
student_id Yes int
academic_term_id Yes int
print_layout_id No int
signed Yes int
file_id No int
source Yes enum (uploaded_manually, generated_manually, generated_in_bulk, generated_automatically, signed_during_registration, signed_manually, temporary)
amount No decimal
user_ip No text (75)
status Yes enum (pending, generating, generated, signing, signed, error, deleted)
status_at No datetime
notify_student Yes bool
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/enrollmentagreements" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": {"0":{"logic":"ALL","fields":[{"name":"academic_term","value":1,"positive":1}]}}
}' \ 

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/enrollmentagreements',
 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/enrollmentagreements"), 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/enrollmentagreements');
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": 0,
    "results": 0,
    "results_per_page": 200,
    "pages": 0,
    "page": 0,
    "offset": 0,
    "has_more": false,
    "data": [],
    "sandbox": true
}

Retrieves all EnrollmentAgreement objects that match given filter conditions.

HTTP Request

GET /enrollmentagreements

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.

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name Type
student text
student_role_status choice
academic_term object_id
added_on datetime
layout object id
source choice
amount decimal
signed bool
tag tag
custom_field custom

Permissions

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

show

Example code to call this method:

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

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/enrollmentagreements/(enrollmentagreement)',
 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/enrollmentagreements/(enrollmentagreement)"), 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/enrollmentagreements/(enrollmentagreement)');
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": "enrollment_agreement",
    "id": 1,
    "student_id": 1,
    "academic_term_id": 1,
    "print_layout_id": 6,
    "signed": null,
    "file_id": null,
    "source": "uploaded_manually",
    "amount": 1456.5,
    "user_ip": null,
    "status": "signed",
    "status_at": "2020-05-06T23:45:33+00:00",
    "notify_student": true,
    "added_at": "2020-05-06T23:45:33+00:00",
    "added_by_id": 1,
    "sandbox": true
}

Retrieves a specific EnrollmentAgreement object.

HTTP Request

GET /enrollmentagreements/(enrollmentagreement)

Parameters

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

Permissions

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

shell ruby python csharp php