TranscriptRequest

The TranscriptRequest object

The TranscriptRequest object looks like this in JSON:

{
    "object": "transcript_request",
    "id": 1,
    "status": "active",
    "person_id": 8,
    "student_firstname": null,
    "student_lastname": null,
    "student_ssn": null,
    "student_birthdate": null,
    "student_last_enrolled_year": null,
    "program_id": 1,
    "delivery_method_id": 3,
    "recipient_name": "Bob's University",
    "email": null,
    "street": "123 Street",
    "city": "Moscow",
    "state": "ID",
    "postal": "83843",
    "country": "US",
    "notes": "blah",
    "fee_id": 1,
    "fee_amount": 22,
    "charge_method": "credit_card",
    "online_payment_id": 1,
    "sales_receipt_id": 1,
    "pending_charge_id": null,
    "requester_name": "Wally Wanderer",
    "requester_electronic_signature": "Wally W",
    "requester_email": "wally@populi.co",
    "requester_phone": "123-123-1234",
    "secret": "72b5c7ee3d15f15932ea3a1813251b29",
    "completed_at": "2022-07-13T18:32:47+00:00",
    "completed_by_id": 10,
    "refunded_at": null,
    "refunded_by_id": null,
    "added_at": "2022-07-13T18:31:48+00:00",
    "added_by_id": 10,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
status	Yes	enum (construction, active, deleted, closed)
person_id	No	int
student_firstname	No	text (50)
student_lastname	No	text (50)
student_ssn	No	text (15)
student_birthdate	No	date
student_last_enrolled_year	No	text (10)
program_id	No	int
delivery_method_id	Yes	int
recipient_name	No	text (200)
email	No	text (200)
street	No	text (300)
city	No	text (100)
state	No	text (50)
postal	No	text (50)
country	No	text (50)
notes	No	text (1000)
fee_id	No	int
fee_amount	Yes	decimal
charge_method	No	enum (account, credit_card, paypal)
online_payment_id	No	int
sales_receipt_id	No	int
pending_charge_id	No	int
requester_name	No	text (200)
requester_electronic_signature	No	text (200)
requester_email	No	text (200)
requester_phone	No	text (200)
secret	No	text (200)
completed_at	No	datetime
completed_by_id	No	int
refunded_at	No	datetime
refunded_by_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/transcriptrequests" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": {"0":{"logic":"ALL","fields":[{"name":"delivery_method","value":"BLAH","positive":1}]}}
}' \

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/transcriptrequests',
 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/transcriptrequests"), 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/transcriptrequests');
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 TranscriptRequest objects that match given filter conditions.

HTTP Request

GET /transcriptrequests

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

student
delivery_method
program
fee
requester
completer
refunder
sales_receipt
online_payment

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name	Type
student_name	text
program	object id
delivery_method	choice
requested_at	date
is_complete	bool
completed_at	date
linked_to_populi_record	bool

Permissions

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

Academic Auditor
Academic Admin
Registrar

show