library qualtrics

morphatic/qualtrics

Provides access to the Qualtrics API in Laravel 4

Qualtrics API wrapper for Laravel 4

, _(*1)

The Qualtrics REST API allows you to query the Qualtrics system using a simple URL syntax. All requests are simple GET or POST requests that return XML or JSON. The REST API allows you to interact with any part of the Qualtrics system allowing for full integration with client systems., _(*2)

This Qualtrics API wrapper for Laravel 4 provides access to the API via a PHP wrapper., _(*3)

Installation

To install the Qualtrics API wrapper for Laravel 4, add the following to the "require" element of your composer.json file:, _(*4)

    "morphatic/qualtrics": "1.1.*@dev"

Then run composer update from the command line., _(*5)

In config.app under providers add:, _(*6)

    'Morphatic\Qualtrics\QualtricsServiceProvider',

Finally, from the command line run:, _(*7)

    php artisan config:publish morphatic/qualtrics

And in the app/config/packages/morphatic/qualtrics/config.php file update your username and API token. Optionally you may also add a library ID to the config file., _(*8)

Basic usage

You can create a basic instance of the class with just a username and API token. Here's an example:, _(*9)

// Qualtrics login email 
$user  = 'someuser@test.com';

// Qualtrics API Token
$token = 'RmvGK6vjF3Izx8Ea2pCisDDSpqE4dELw9AzheBDc';

// create the instance
$qtrx  = new Qualtrics( $user, $token );

// get the user info (no additional parameters necessary)
$info  = $qtrx->getUserInfo();

// accessible libraries
$libraries = $info->Libraries;

// get a particular survey (requires ID of desired survey)
$mysurvey = $qtrx->getSurvey( [ 'SurveyID' => 'SV_9EQYOts8KmOle04' ] );                       

Any additional parameters required by the call (see the official API documentation) should be passed as an associative array of key/value pairs. The keys are case sensitive and follow the naming convention of the official docs., _(*10)

Disclaimer

I am in no way, shape, or form affiliated with Qualtrics. In order to gain access to the Qualtrics REST API, your organization or institution must subscribe to this service. In my case, it meant contacting an IT administrator at my university and asking them to do so., _(*11)

License

Qualtrics API wrapper for Laravel 4 is open-sourced software licensed under the MIT license, _(*12)