Campus

The Campus object

The Campus object looks like this in JSON:

{
    "object": "campus",
    "id": 8,
    "name": "Main Campus",
    "city": "Moscow",
    "state": "ID",
    "postal": "83843",
    "country": "US",
    "status": "active",
    "primary": true,
    "timezone": "America\/Los_Angeles",
    "cod_routing_id": null,
    "ope_id": null,
    "export_prefix": null,
    "ipeds_unit_id": null,
    "country_full": "United States",
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
name	Yes	text (255)
city	Yes	text (255)
state	Yes	text (50)
postal	Yes	text (50)
country	Yes	text (50)
status	Yes	enum (active, retired, deleted)
primary	Yes	bool
timezone	No	text (50)
cod_routing_id	No	text (50)
ope_id	No	text (50)
export_prefix	No	text (50)
ipeds_unit_id	No	int
country_full	No	text
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/campuses" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/campuses',
 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/campuses"), 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/campuses');
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": 2,
    "results": 2,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "campus",
            "id": 8,
            "name": "Main Campus",
            "city": "Moscow",
            "state": "ID",
            "postal": "83843",
            "country": "US",
            "status": "active",
            "primary": true,
            "timezone": "America\/Los_Angeles",
            "cod_routing_id": null,
            "ope_id": null,
            "export_prefix": null,
            "ipeds_unit_id": null,
            "country_full": "United States",
            "added_at": null,
            "added_by_id": null
        }
    ],
    "sandbox": true
}

Retrieves all Campus objects.

HTTP Request

GET /campuses

Parameters

None

Permissions

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

Staff

show

Example code to call this method:

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

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/campuses/(campus)',
 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/campuses/(campus)"), 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/campuses/(campus)');
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": "campus",
    "id": 8,
    "name": "Main Campus",
    "city": "Moscow",
    "state": "ID",
    "postal": "83843",
    "country": "US",
    "status": "active",
    "primary": true,
    "timezone": "America\/Los_Angeles",
    "cod_routing_id": null,
    "ope_id": null,
    "export_prefix": null,
    "ipeds_unit_id": null,
    "country_full": "United States",
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}

Retrieves a specific Campus object.

HTTP Request

GET /campuses/(campus)

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:

Staff