ISIR
The Isir object
The Isir object looks like this in JSON:
{
"object": "isir",
"id": 6,
"batch_id": 1,
"cps_transaction_number": 1,
"cps_processed_date": "2011-03-20",
"status": "pending",
"content": "2200100405ED01EDIT QUESTION BORN BEFORE ASSUME NO EDIT 1004 VA2078419880102 1 1 VA 2 1 2 3 100000{000000000000{00000{000000000000000000 1222222211111 1 391091111FATHERLASTNAME A19540101000000000 VA 03 121 00500{0000000300500{00999I000000000000000000 011 001002 20110101B I1A20110320 TG53275 200100405 1A20110320 001 Y20110320 Y Y 4 2 0000000000 5200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000{0008550000000{00000000008550000855}000427N 000000{000000{0008550000000{00000000008550000855}000427N00000000{000000000000000000 000000{000000{ 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 000000000000010000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 1 8 8 F 4 149001146124219220221222115116118053117006000000000000000000 10 N 011 N04 N04 NY NY N05 NM YY N\/A 002405N\/A N\/A N\/A N\/A N\/A 777777008888999999 005309 NNNNNNNNNNNNNNYYY NNNNNN01Y 00280000003732 20090315 ",
"aid_year_id": 2,
"aid_application_id": null,
"imported_by_id": null,
"imported_at": null,
"sandbox": true
}
| Attribute | Required | Data Type |
|---|---|---|
| id | Yes | int |
| batch_id | Yes | int |
| cps_transaction_number | Yes | int |
| cps_processed_date | No | date |
| status | Yes | enum (pending, imported, skipped) |
| content | Yes | text (10000) |
| aid_year_id | No | int |
| aid_application_id | No | int |
| imported_by_id | No | int |
| imported_at | No | datetime |
| sandbox | No | bool |
show
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/isirs/(isir)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/isirs/(isir)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/isirs/(isir)',
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/isirs/(isir)"), 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/isirs/(isir)');
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": "isir",
"id": 6,
"batch_id": 1,
"cps_transaction_number": 1,
"cps_processed_date": "2011-03-20",
"status": "pending",
"content": "2200100405ED01EDIT QUESTION BORN BEFORE ASSUME NO EDIT 1004 VA2078419880102 1 1 VA 2 1 2 3 100000{000000000000{00000{000000000000000000 1222222211111 1 391091111FATHERLASTNAME A19540101000000000 VA 03 121 00500{0000000300500{00999I000000000000000000 011 001002 20110101B I1A20110320 TG53275 200100405 1A20110320 001 Y20110320 Y Y 4 2 0000000000 5200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000{0008550000000{00000000008550000855}000427N 000000{000000{0008550000000{00000000008550000855}000427N00000000{000000000000000000 000000{000000{ 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 000000000000010000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 1 8 8 F 4 149001146124219220221222115116118053117006000000000000000000 10 N 011 N04 N04 NY NY N05 NM YY N\/A 002405N\/A N\/A N\/A N\/A N\/A 777777008888999999 005309 NNNNNNNNNNNNNNYYY NNNNNN01Y 00280000003732 20090315 ",
"aid_year_id": 2,
"aid_application_id": null,
"imported_by_id": null,
"imported_at": null,
"sandbox": true
}
Retrieves a specific Isir object.
HTTP Request
GET /isirs/(isir)
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:
- Financial Aid
- Financial Admin
- Student Billing