NAV
shell ruby python csharp php

LockArea

The LockArea object

The LockArea object looks like this in JSON:

{
    "object": "lock_area",
    "id": 1,
    "lock_type_id": 1,
    "lock_area": "grades",
    "sandbox": true
}
Attribute Required Data Type
id Yes int
lock_type_id Yes int
lock_area Yes enum (charge_to_account, courses, grades, registration, transcript)
sandbox No bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/lockareas" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/lockareas',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body
import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/lockareas',
 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/lockareas"), 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/lockareas');
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": 7,
    "results": 7,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "lock_area",
            "id": 1,
            "lock_type_id": 1,
            "lock_area": "grades"
        }
    ],
    "sandbox": true
}

Retrieves all LockArea objects.

HTTP Request

GET /lockareas

Parameters

None

Permissions

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