Skill Level:
Advanced
This API endpoint allows you to get lists of events from a specific calendar.
Available Endpoints
Read (By ID)
GET
http://events.unl.edu/api/v2/location/{location_id}/
This endpoint is for getting a specific location based on its ID.
HTTP Method
GET
Authentication Requirements
None
Request Data
Response Data
Example Code
Javascript
async function eventsAPI() {
const response = await fetch('https://events.unl.edu/api/v2/location/27161/');
if (response.ok) {
const response_json = await response.json();
console.log(response_json.data);
}
}
CURL
curl -X GET 'https://events.unl.edu/api/v2/location/27161/'
PHP
function eventsAPI() {
$url = 'https://events.unl.edu/api/v2/location/27161/';
// Make an HTTP GET request using file_get_contents
$response = file_get_contents($url);
if ($response !== false) {
// Decode the JSON response
$responseData = json_decode($response, true);
// Check if JSON decoding was successful
if ($responseData !== null) {
// Access the 'data' field in the response JSON
var_dump($responseData);
} else {
echo 'JSON decoding error';
}
} else {
echo 'Error fetching data';
}
}
Read (Standard)
GET
http://events.unl.edu/api/v2/location/standard/
This endpoint is for getting a list of all the standard UNL campus locations and extension locations.
HTTP Method
GET
Authentication Requirements
None
Request Data
None
Response Data
Example Code
Javascript
async function eventsAPI() {
const response = await fetch('https://events.unl.edu/api/v2/location/standard/');
if (response.ok) {
const response_json = await response.json();
console.log(response_json.data);
}
}
CURL
curl -X GET 'https://events.unl.edu/api/v2/location/standard/'
PHP
function eventsAPI() {
$url = 'https://events.unl.edu/api/v2/location/standard/';
// Make an HTTP GET request using file_get_contents
$response = file_get_contents($url);
if ($response !== false) {
// Decode the JSON response
$responseData = json_decode($response, true);
// Check if JSON decoding was successful
if ($responseData !== null) {
// Access the 'data' field in the response JSON
var_dump($responseData);
} else {
echo 'JSON decoding error';
}
} else {
echo 'Error fetching data';
}
}
Create
POST
http://events.unl.edu/api/v2/location/
This endpoint is for creating a new custom location.
HTTP Method
POST
Authentication Requirements
You must add a header to the request with the header key being Authentication and the value being your API Token.
Request Data
Response Data
Example Code
Javascript
async function eventsAPI() {
// Sets up data
const data = {
'name': 'Meeting room 1 at 1217',
'address-1': '1217 Q St',
'address-2': null,
'city': 'Lincoln',
'state': 'NE',
'zip': '68508',
'map-url': 'https://maps.unl.edu/L055',
'webpage': null,
'hours': null,
'phone': null,
'default-room': null,
'default-directions': 'Head upstairs and make a right: it should be right there.',
'default-additional-public-info': 'L055',
'save-user': true,
'save-calendar': true,
'calendar-id': '3809',
}
// Sends request with method, headers, and data
const response = await fetch(
'https://events.unl.edu/api/v2/location/',
{
method: 'POST',
headers: {
'content-type': 'application/json',
'Authentication': MY_API_TOKEN,
},
body: JSON.stringify(data),
}
);
// Checks response and throws error on error
if (response.ok) {
const response_json = await response.json();
console.log(response_json.data);
} else {
response.text().then(text => {throw new Error(text)})
}
}
CURL
curl -X POST https://events.unl.edu/api/v2/location/ \
-H "Content-Type: application/json" \
-H "Authentication: MY_API_TOKEN" \
-d '{
"name": "Meeting room 1 at 1217",
"address-1": "1217 Q St",
"address-2": null,
"city": "Lincoln",
"state": "NE",
"zip": "68508",
"map-url": "https://maps.unl.edu/L055",
"webpage": null,
"hours": null,
"phone": null,
"default-room": null,
"default-directions": "Head upstairs and make a right: it should be right there.",
"default-additional-public-info": "L055",
"save-user": true,
"save-calendar": true,
"calendar-id": "3809",
}'
PHP
function eventsAPI() {
$data = array(
'name' => 'Meeting room 1 at 1217',
'address-1' => '1217 Q St',
'address-2' => null,
'city' => 'Lincoln',
'state' => 'NE',
'zip' => '68508',
'map-url' => 'https://maps.unl.edu/L055',
'webpage' => null,
'hours' => null,
'phone' => null,
'default-room' => null,
'default-directions' => 'Head upstairs and make a right: it should be right there.',
'default-additional-public-info' => 'L055',
'save-user' => true,
'save-calendar' => true,
'calendar-id' => '3809',
);
$jsonData = json_encode($data);
$apiToken = 'MY_API_TOKEN';
$url = 'https://events.unl.edu/api/v2/location/';
$headers = array(
'Content-Type: application/json',
'Authentication: ' . $apiToken,
);
// Initialize cURL session
$ch = curl_init();
// Set cURL options
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
// Execute cURL session and get the response
$response = curl_exec($ch);
// Check if cURL request was successful
if ($response === false) {
// Handle cURL error
echo 'cURL Error: ' . curl_error($ch);
} else {
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($httpCode === 200) {
// Successful response
$responseData = json_decode($response, true);
var_dump($responseData);
} else {
// Error response
echo 'API Error: ' . $response;
}
}
// Close cURL session
curl_close($ch);
}
Update
PUT
http://events.unl.edu/api/v2/location/{location_id}/
This endpoint is for updating a specific location based on its ID.
HTTP Method
PUT
Authentication Requirements
You must add a header to the request with the header key being Authentication and the value being your API Token.
Request Data
Even if the data hasn't changed, please re-enter any previously existing data to avoid unintentional null values.
Response Data
Example Code
Javascript
async function eventsAPI() {
// Sets up data
const data = {
'name': 'Meeting room 1 at 1217',
'address-1': '1217 Q St',
'address-2': null,
'city': 'Lincoln',
'state': 'NE',
'zip': '68508',
'map-url': 'https://maps.unl.edu/L055',
'webpage': null,
'hours': null,
'phone': null,
'default-room': null,
'default-directions': 'Head upstairs and make a right: it should be right there.',
'default-additional-public-info': 'L055',
'save-user': true,
'save-calendar': true,
'calendar-id': '3809',
}
// Sends request with method, headers, and data
const response = await fetch(
'https://events.unl.edu/api/v2/location/27217/',
{
method: 'PUT',
headers: {
'content-type': 'application/json',
'Authentication': MY_API_TOKEN,
},
body: JSON.stringify(data),
}
);
// Checks response and throws error on error
if (response.ok) {
const response_json = await response.json();
console.log(response_json.data);
} else {
response.text().then(text => {throw new Error(text)})
}
}
CURL
curl -X PUT https://events.unl.edu/api/v2/location/ \
-H "Content-Type: application/json" \
-H "Authentication: MY_API_TOKEN" \
-d '{
"name": "Meeting room 1 at 1217",
"address-1": "1217 Q St",
"address-2": null,
"city": "Lincoln",
"state": "NE",
"zip": "68508",
"map-url": "https://maps.unl.edu/L055",
"webpage": null,
"hours": null,
"phone": null,
"default-room": null,
"default-directions": "Head upstairs and make a right: it should be right there.",
"default-additional-public-info": "L055",
"save-user": true,
"save-calendar": true,
"calendar-id": "3809",
}'
PHP
function eventsAPI() {
$data = array(
'name' => 'Meeting room 1 at 1217',
'address-1' => '1217 Q St',
'address-2' => null,
'city' => 'Lincoln',
'state' => 'NE',
'zip' => '68508',
'map-url' => 'https://maps.unl.edu/L055',
'webpage' => null,
'hours' => null,
'phone' => null,
'default-room' => null,
'default-directions' => 'Head upstairs and make a right: it should be right there.',
'default-additional-public-info' => 'L055',
'save-user' => true,
'save-calendar' => false,
'calendar-id' => '3809',
);
$jsonData = json_encode($data);
$apiToken = 'MY_API_TOKEN';
$url = 'https://events.unl.edu/api/v2/location/27217/';
$headers = array(
'Content-Type: application/json',
'Authentication: ' . $apiToken,
);
// Initialize cURL session
$ch = curl_init();
// Set cURL options
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
// Execute cURL session and get the response
$response = curl_exec($ch);
// Check if cURL request was successful
if ($response === false) {
// Handle cURL error
echo 'cURL Error: ' . curl_error($ch);
} else {
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($httpCode === 200) {
// Successful response
$responseData = json_decode($response, true);
var_dump($responseData);
} else {
// Error response
echo 'API Error: ' . $response;
}
}
// Close cURL session
curl_close($ch);
}
Contributed By:
DXG
- Printer-friendly version
- Log in to post comments