|
| |
Call |
Function Description |
| 1 |
moodleconnect |
Connects a personal Moodle dictionary word to a concept in BrainBank as a ressource. This function is deprecated as of version 3.5, and is replaced by urlconnect |
| 2 |
createbbuser |
Create a new Brainbank user based on an external system id. |
| 3 |
urlconnect |
Submit a URL to BrainBank and have it added as a resource to a BrainBank concept. |
| 4 |
returntopicsbyurlresource |
Returns all concepts by a given resource URL |
| 5 |
returnresourcesbytopic |
Returns all resources by a given conceptname. |
All services will return a status message upon errors such as wrong authentication credentials for either BrainBank Learning users or external users
The status messages are appended to the end of the return url in the form of URL encoded value of URL variable ?status.
An example would be something like http://your.reurn.url/?status=Error:%20User%20with%20id%20+%20nonexistinguser%20not%20found
For the returntopicsbyresource and returnresourcesbytopic services, th resulting xml is also returned as the URL encoded URL value of the variable ?returntopics
moodleconnect
http://<Server Adress>/brainbank/bb?username=<user name>&passwd=<password>&returnurl=<the URL to return to>&brainbankurl=http://<server address2>/brainbank/app/&topicname=<topic>&action=moodleconnect
| Element |
Description |
| <Server Address> |
The address of the server to receive the call. For Cerpus' BrainBank Learning installation, the server address will usually be brainbank.no |
| <User Name> |
User's user name in BrainBank Learning on the server receiving the call. |
| <Password> |
User's password in BrainBank Learning on the server receiving the call. |
| <URL to return to> |
URL for the resource to be assosciated to the concept in BrainBank (for instance a word in Moodle's dictionary of themes) The user will be taken to this URL when the operation has completed. |
| <Concept Name> |
The concept name of the concept the resource is to be associated to. If it already exists in BrainBank the resource will be associated to it. If the concept does not exist, it will be created before association. |
| <Server Address2> |
The address of the server running the BrainBank installation. This address is part of the URL being returned to the external system together making it possible to navigate to the BrainBank concept form the external system. |
To the top
createbbuser
http://<Server Address>/brainbank/bb?systemid=<System Id>&systempwd=<System Password>&extusername=<External Username>&extpasswd=<External Password>&username=<brukernavn>&firstname=<fornavn>&lastname=<etternavn>&returnurl=<URL to return to>&action=createbbuser
| Element |
Description |
| <Server Address> |
The address of the server to receive the call. For Cerpus' BrainBank Learning installation, the server address will usually be brainbank.no |
| <System Id> |
The system ID the external system has been given as authentication credentials for web service connection against BrainBank Learning |
| <System Password> |
The password the external system has been given as authentication credentials for web service connection against BrainBank Learning |
| <User Name> |
User's username on the external system (will be added to the users keychain in BrainBank Learning) |
| <External User Name> |
User's password on the external system (will be added to the users keychain in BrainBank Learning) |
| <External Password> |
Desired user name in BrainBank Learning |
| <First name> |
User's first name |
| <Surname> |
User's last name |
| <URL to return to> |
URL to be returned to. This URL will also contain information indicating whether the operation was a success or not. |
To the top
urlconnect
http://<Server Address>/brainbank/bb?systemid=<System Id>&systempwd=<System Password>&username=<User Name>&passwd=<Password>&resourceurl=<Resource URL>&returnurl=<URL to return to>&topicname=<Concept name>&action=urlconnect&resourcename=<Name of resource>&returnformat=<Indication of return format>[&jsoncallback=RenderHTML]
| Element |
Description |
| <Server Address> |
The address of the server to receive the call. For Cerpus' BrainBank Learning installation, the server address will usually be brainbank.no |
| <System Id> |
The system ID the external system has been given as authentication credentials for web service connection against BrainBank Learning |
| <System Password> |
The password the external system has been given as authentication credentials for web service connection against BrainBank Learning |
| <User Name> |
Username in BrainBank Learning |
| <Password> |
Password in BrainBank Learning |
| <URL to return to> |
URL to be returned to. This URL will also contain information indicating if the operation was a success or not. |
| <Concept Name> |
The concept name of the concept the resource is to be associated to. If it already exists in BrainBank the resource will be associated to it. If the concept does not exist, it will be created before association. |
| <Resource URL> |
URL of the resource which is to be associated to the concept in BrainBank Learning, for instance a word in Moodle or a tag in Elgg. |
| <Name of Resource> |
A title for the resource to be used within BrainBank learning |
| <Indication of return value> |
Indication of whether one wants the return data returned in the form of a URL-encoded string containing XML data as value, or in the form of an XML document. |
Example XML fragment returned by urlconnect:
<response><topicname>topic name</topicname><topicid>T2647804</topicid><resourcename>resource name</resourcename><returnurl>http://brainbank.no/brainbank/app/edit-topic.jsp?id=</returnurl></response>
To the top
returntopicsbyurlresource
http://<Server Address>/brainbank/bb?systemid=<System Id>&systempwd=<System Password>&username=<User name>&passwd=<Password>&returnurl=<URL to return to>&resourceurl=<Resource URL>&radius=<Radius>&action=returntopicsbyurlresource
| Element |
Description |
| <Server Address> |
The address of the server to receive the call. For Cerpus' BrainBank Learning installation, the server address will usually be brainbank.no |
| <System Id> |
The system ID the external system has been given as authentication credentials for web service connection against BrainBank Learning |
| <System Password> |
The password the external system has been given as authentication credentials for web service connection against BrainBank Learning |
| <User Name> |
Username in BrainBank Learning |
| <Password> |
Password in BrainBank Learning |
| <URL to return to> |
URL to be returned to. This URL will also contain information indicating if the operation was a success or not. |
| <Resource URL> |
URL of resource to be searched for in BrainBank Learning. |
| <Radius> |
By giving 0 or 1 as value to this argument, one indicates whether one wants to return concepts related to the concept connected to the resource. 0 is default. |
Example XML fragment returned by returntopicsbyurlresource:
<topic id="T123456" name="emnenavn"> <releatedtopics> <topic id="T234567" name="emnenavn"/> <topic id="T345678" name="emnenavn"/> <topic id="T231567" name="emnenavn"/> </relatedtopics> </topic> <topic id="T223456" name="emnenavn">
<relatedtopics>
<topic id="T334567" name="emnenavn"/>
<topic id="T245678" name="emnenavn"/>
</relatedtopics>
</topic>
To the top
returnresourcesbytopic
http://<Server Address>/brainbank/bb?systemid=<System Id>&systempwd=<System Password>&username=<User name>&passwd=<Password>&returnurl=<URL to return to>&topicname=<Concept Name>&action=returnresourcesbytopic
| Element |
Description |
| <Server Address> |
The address of the server to receive the call. For Cerpus' BrainBank Learning installation, the server address will usually be brainbank.no |
| <System Id> |
The system ID the external system has been given as authentication credentials for web service connection against BrainBank Learning |
| <System Password> |
The password the external system has been given as authentication credentials for web service connection against BrainBank Learning |
| <User Name> |
Username in BrainBank Learning |
| <Password> |
Password in BrainBank Learning |
| <URL to return to> |
URL to be returned to. This URL will also contain information indicating if the operation was a success or not. |
| <Concept Name> |
The name of the concept to search for in BrainBank Learning. |
Example XML fragment returned by returnresourcesbytopic:
<topic id="T123456" name="emnenavn">
<resources>
<resource url="http://brainbank.no/brainbank/content?uri=x-ontopia:cms:10915&filename=figur.gif&tmid=bb-init.xtm" name="ressursnavn"/>
<resource url="http://sv.wikipedia.org/wiki/Geometrisk_figur" name="ressursnavn"/>
<resource url="http://no.wikipedia.org/wiki/Geometri" name="ressursnavn"/>
</resources>
</topic>
To the top
|
