Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagephp
titleCreating a course
linenumberstrue
<?php
$domain = 'your-domain.com';
$userpass = 'restws_webservice:restws_webservice';
$curl = curl_init('http://' . $domain . '/restws/session/token');
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $userpass); // Your web service user credentials goes here.
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
$token = curl_exec($curl);
// The token looks like "q71OBx05wtECfjA0KmXf6wiktewrywNhkMZv-OcfyOA%"
print_r($token);
// Build a course to send, in JSON. The fields and allowed values are available on the full documentation site.
$course = array(
  'title' => 'My Course',   // A single line textbox
  'titletype' => 'My Coursecourse',
  'typefield_course_summary' => 'course',array(   // A multi-line text area field
  'field_course_summary' => array(
    'value' => 'A <b>summary</b> of the course',
    'format' => 'full_html'
  ),
  // It 'author' => 1,   // It is best practice is to assign the Web Service user id as author
  'authorstatus' => 1,   //  Status (published): A single select checkbox. Either 1 or 0
  'status' => 1,
  'field_course_date' => array(
    'value' => '2017-08-20T13:00:00',
    'value2' => '2018-08-20T21:00:00',
  ),
  'field_course_event_date' => array(
    'value' => '2018-08-20T13:00:00',
    'value2' => '2018-08-20T21:00:00',
  ),
  'sell_price' => 100.00,
  'model' => 'DLC_1234',
  'field_learning_objectives' => array(
    'value' => '<p>Objectives for learning.</p>',
    'format' => 'full_html'
  ),
  'field_hotel_travel' => array(
    'value' => '<p>Attendees will have a block of rooms available at <b>The Double Tree</b></p>',
    'format' => 'full_html'
  ),
  'field_hotel_information' => array(
    'value' => '<p>Please call the front desk for rates.</p>',
    'format' => 'full_html'
  ),
  "field_hotel_link" => array(
    "title" => "Venue Website",
    "url" => "doubletree3.hilton.com",
  ),
  'field_venue_phone' => array(
    'number' => '2158931600',
    'country_code' => 'us' // Link to list
  ),
  "field_course_location" => array(
    "name" => "Double Tree Philadelphia",
    "street" => "237 S Broad Street",
    "additional" => "",
    "city" => "Philadelphia",
    "province" => "PA",
    "postal_code" => "19107",
    "country" => "us",
  ),
  "field_course_live" => 1,   // The 'Live' checkbox, under Course settings must be checked for live events
  "field_course_livecategory" => 1,array(   // Course CagetoryCategory is field containing a list of taxonomy terms. The id values entered here are the integer term ids
  "field_course_category" => array(
    array(''id' => 50),
    array('id' => 60),
  ),
  "field_course_format" => array(
    array('id' => 10),
    array('id' => 20),
  ),
);
$json = json_encode($course);
$curl = curl_init('http://' . $domain . '/node.json');
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $userpass); //Your credentials go here
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
curl_setopt($curl, CURLOPT_HTTPHEADER, array("X-CSRF-Token: $token", "Content-Type: application/json"));
// Send the course creation request
$http_return = curl_exec($curl);
$response = json_decode($http_return);
print_r($response);
/*
 An example response, returned in JSON:
(
    [uri] => http://your-domain.com/node/408
    [id] => 408
    [resource] => node
    [uuid] => f88adca4-8332-459c-873f-1bad3724b13e
)
*/
// Get the nid to send credit information
$nid = $response->id;
// Add Credit
$curl = curl_init('http://' . $domain . '/course_credit.json');
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $userpass); //Your credentials go here
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($curl, CURLOPT_HTTPHEADER, array("X-CSRF-Token: $token", "Content-Type: application/json"));

// Enable Attendance
$credit_attendance = array(
  'nid' => $nid,
  'active' => 1,
  'type' => 'attendance',
  "increments" => 0,
  "min" => 0,
  "max" => 1,
  "enable_variable_credit" => 0,
);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($credit_attendance));
$http_return = curl_exec($curl);
$response = json_decode($http_return);
print_r($response);

// Enable AMA
$credit_ama = array(
  'nid' => $nid,
  'active' => 1,
  'type' => 'ama',
  "increments" => 0.25,
  "min" => 1.,
  "max" => 5.5,
  "enable_variable_credit" => 1,
);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($credit_ama));
$http_return = curl_exec($curl);
$response = json_decode($http_return);
print_r($response);

Updating a course's title

...

...

When updating any content, the payload sent is trimmed down to only the fields being updated. To update the course created in the previous section, we use the URI sent, http:///your-domain.com/node/408.

...

your-domain.com/node/408.

Info
Note the usage of "PUT" instead of "POST"


Code Block
languagephp
titleUpdating a course's title
<?php

$curl = curl_init('http://your-domain.com/restws/session/token');
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, "admin:webservicepw"); //Your credentials go here
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
$token = curl_exec($curl);
print "Received token: " . $token . "\n";

// Token looks like "q71OBx05wtECfjA0KmXf6wiktewrywNhkMZv-OcfyOA%"
// Build a course
// The fields and allowed values are available on the full documentation site.
$course = array(
  'title' => 'My Updated Course',
);
$json = json_encode($course);
$curl = curl_init('http://your-domain.com/node/408');
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, "admin:webservicepw"); //Your credentials go here
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
curl_setopt($curl, CURLOPT_HTTPHEADER, array("X-CSRF-Token: $token", "Content-Type: application/json"));
$response = curl_exec($curl);
print $response;

Updating a course's external ID

After creating a course via web service, clients may need to update the E field, with a value associated to the external system. This update call is different than the title, detailed above.  The title field is attached to the node entity, however the External course ID field is attached to the course entity, a separate collection of data. It is used for primarily for internal purposes, and is seldom changed manually. However, in this case of a course created externally via web service, there may be a need to associate the new course with an external system ID. 

To update the course created in the previous section, we take the nid returned, above example is 408, and send a PUT call, via the course endpoint, to updated the External course ID fieldThe internal name of the field is external_id.


Info
iconfalse
titleWarning
It is not recommended to update any other fields found in the course endpoint, except external_id, as they are automatically created/updated when editing a course via the UI. 


Code Block
languagephp
titleUpdating a course's titleexternal ID
<?php

$curl = curl_init('http://your-domain.com/restws/session/token');
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, "admin:webservicepw"); //Your credentials go here
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
$token = curl_exec($curl);
print "Received token: " . $token . "\n";

// Token looks like "q71OBx05wtECfjA0KmXf6wiktewrywNhkMZv-OcfyOA%"
// Build a course
// The fields and allowed values are available on the full documentation site.
$course = array(
  'titleexternal_id' => 'My Updated Courseethosce_ext_id_12345',
);
$json = json_encode($course);
$curl = curl_init('http://your-domain.com/nodecourse/408');
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, "admin:webservicepw"); //Your credentials go here
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
curl_setopt($curl, CURLOPT_HTTPHEADER, array("X-CSRF-Token: $token", "Content-Type: application/json"));
$response = curl_exec($curl);
print $response;

...