Code Monkey home page Code Monkey logo

blackboard-soap-client's Introduction

blackboard-soap-client

A PHP client library for Blackboard 9's Soap API. Project goals include

  • Providing more transparency into WS-Security Header ...
  • ... without requiring users to generate their own headers or parameter XML
  • Use code generation to provide transparency into methods and their parameters
  • Enough documentation of Blackboard objects to use them (i.e. Filters)

If you're looking for instructions on how to make an API calls, the three step Register, Login, Call process is documented in the Wiki.

Add to Composer

You're just a simple require and repositoryaway

"repositories": [
{
    "type": "vcs",
    "url": "https://github.com/astorm/blackboard-soap-client"
}],	

"require": {
	"pulsestorm/blackboard-soap-client": "0.2.1"
}

Thanks To

The transport layer of this project is based on the library open sourced by St. Edwards, and kudos to Blackboard for getting more code online.

blackboard-soap-client's People

Contributors

astorm avatar jounisuo avatar

Stargazers

avatar avatar

Watchers

avatar

Forkers

universidadebrazcubas jounisuo charmeleon-char

blackboard-soap-client's Issues

A few bugs (with fixes)

In Soap/Parameters/Base.php:
$body .= '</ns1:filter>';
should be replaced with:
$body .= '</ns1:'.static::NAME.'>';
(We're assuming that we're always closing a filter tag, when in some cases we are closing an 'f' tag or something else. You need to reference static::NAME for this to be correct. Causes Blackboard to not respond properly)

In /Soap/Parameters/CourseMembership/MembershipFilter.php:
public $courseIds;
should be replaced with:
public $courseId;
AND
'courseIds'=>$this->courseIds,
should be replaced with:
'courseId'=>$this->courseId,
(The correct name is courseId without the 's'. Adding the 's' causes blackboard to not respond correctly)

This file: /Soap/Legacy/Coursemembership.php
needs to be renamed to:
/Soap/Legacy/CourseMembership.php
(The capitalization mistake throws errors)

Example Param Class to Generate 

<?php
namespace Pulsestorm\Blackboard\Soap\Parameters\Course;
class CourseFilter
{
    const NAMESPACE_XSD = 'http://course.ws.blackboard/xsd';
    const NAME          = 'filter';
    public function serializeForParam()
    {
        $body       = '<ns1:' . self::NAME . ' xmlns:ns2="' . self::NAMESPACE_XSD . '">';
        foreach ($this->getData() as $key => $arg) {
            $body .= '<ns2:' . $key . '>' . $arg . '</ns2:' . $key . '>';
        }
        $body .= '</ns1:filter>';               
        return $body;
    }

    public function getData()
    {
        return get_object_vars($this);    
    }
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.