LibraryResource

The LibraryResource object

The LibraryResource object looks like this in JSON:

{
    "object": "library_resource",
    "id": 6,
    "resource_type_id": 11,
    "title": "Purgatorio",
    "authors": "Dante",
    "replacement_price": null,
    "lccn": null,
    "total_loans": null,
    "total_recommendations": null,
    "image_file_id": null,
    "import_id": null,
    "added_at": null,
    "added_by_id": null,
    "updated_at": "2011-02-01T19:06:08+00:00",
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
resource_type_id	No	int
title	No	text (500)
authors	No	text (500)
replacement_price	No	decimal
lccn	No	text (50)
total_loans	Yes	int
total_recommendations	Yes	int
image_file_id	No	int
import_id	No	int
added_at	No	datetime
added_by_id	No	int
updated_at	No	datetime
sandbox	No	bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/libraryresources" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": []
}' \

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

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

HTTP Request

GET /libraryresources

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

resource_copies
resource_fields

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name	Type
title	text
authors	text
type	object id
num_copies	integer
status	choice
added_at	datetime
deleted_at	datetime
resource_field	resourcefield

Permissions

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

Library Admin
Library Staff

library_fields

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/libraryresources/fields" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/libraryresources/fields',
 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/libraryresources/fields"), 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/libraryresources/fields');
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": 62,
    "results": 62,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "library_field",
            "id": 15,
            "name": "Abstract",
            "qualified_name": "dcterms:abstract",
            "description": "A summary of the resource.",
            "data_type": "TEXT"
        }
    ],
    "sandbox": true
}

HTTP Request

GET /libraryresources/fields

Parameters

None

Permissions

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

Library Admin
Library Staff

show

Example code to call this method:

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

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/libraryresources/(libraryresource)',
 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/libraryresources/(libraryresource)"), 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/libraryresources/(libraryresource)');
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": "library_resource",
    "id": 6,
    "resource_type_id": 11,
    "title": "Purgatorio",
    "authors": "Dante",
    "replacement_price": null,
    "lccn": null,
    "total_loans": null,
    "total_recommendations": null,
    "image_file_id": null,
    "import_id": null,
    "added_at": null,
    "added_by_id": null,
    "updated_at": "2011-02-01T19:06:08+00:00",
    "sandbox": true
}

Retrieves a specific LibraryResource object.

HTTP Request

GET /libraryresources/(libraryresource)

Parameters

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

Expandable Properties

resource_copies
resource_fields