Child pages
  • Additional web services for Sakai
Skip to end of metadata
Go to start of metadata

Additional web services for Sakai

I have written a number of additional web services for Sakai and they are included below. If you find these useful, please let me know!

Additional web services
These are web services I have written but are not yet in any official Sakai release
#getResourcesForSite - Gets an XML doc of the resources in a site, with URL, type etc.
#archiveSite - Archives a site

Available in 2.7
These services will be part of the future 2.7 release
#getGroupsInSite - Gets XML doc of all groups in a site, incl id, title and description.
#getUserEmail - Get's the email address for a given user (the original was session based, this is more flexible)
#getAllUsers - Gets a list of all user accounts. You can restrict what is returned, see the doc.
#addNewToolToAllWorkspaces - Adds a tool to all My Workspace sites
#copyRole - Copies a role from one authzgroup (or site) to another. Useful for mass population/synchronisation of roles across sites.
#getUserType - Gets the type of a user's account
#getSessionForUser - Creates a session for a given user without knowing their password. Only admin can access this one (for security reasons)

Available since 2.6
These services are now part of the main Sakai web service set as of 2.6 and onwards
#getUsersInAuthzGroup - Gets XML doc of all users in an authzgroup (or site)
#getUsersInAuthzGroupWithRole - Gets XML doc of all users in an authzgroup (or site) with the given role(s), incl username, displayname, role.
#removeMemberFromSite - Remove an individual member from a site (similar to removeMemberFromAuthzGroup in the original SakaiScript, but acts on Site rather than AuthzGroup)
#getSiteTitle - Returns title of a site.
#getSiteDescription - Returns description of a site.
#getSiteSkin - Returns the skin of a site.
#isSiteJoinable - Returns if site is joinable or not
#checkForUserInAuthzGroup - Checks if a user exists in an authzgroup (or site)
#changeSiteTitle - Modifies a site's title
#changeSiteSkin - Modifies a site's skin
#changeSiteJoinable - Modifies a site's joinable status
#changeSiteIconUrl - Modifies a site's iconurl
#changeSiteDescription - Modifies a site's description
#getSiteProperty - Get a custom property of a site
#setSiteProperty - Set a custom property for a site
#removeSiteProperty - Remove a custom property for a site
#checkForAuthzGroup - Check if a given authzgroup exists
#checkForRoleInAuthzGroup - Check if a role exists in a given authzgroup
#getUserDisplayName - Gets the displayname of a given user (the original was session based, this is more flexible)
#searchForUsers - Search for users that meet the given criteria, returns xml

Gradebook services
#SakaiGradebook the beginning of a Gradebook web service set for 2.4.x and beyond. The existing set of services used deprecated API calls so this has been rewritten.

Deprecated web services
These are some service I have written which I no longer use or maintain, but kept here for reference
#addMembersToSiteFromXML - Processes an XML fragment (see method for schema) and adds the users to a site
#removeMembersFromSiteFromXML - Processes an XML fragment (see method for schema) and removes users from a site

Additional web services

getResourcesForSite()

archiveSite()

Available in 2.7

getGroupsInSite()

getUserEmail()

getAllUsers()

addNewToolToAllWorkspaces()

copyRole()

getUserType()

getSessionForUser()

Available since 2.6

getUsersInAuthzGroup()

getUsersInAuthzGroupWithRole()

removeMemberFromSite()

getSiteTitle()

getSiteDescription()

getSiteSkin()

isSiteJoinable()

checkForUserInAuthzGroup()

changeSiteTitle()

changeSiteSkin()

changeSiteJoinable()

changeSiteIconUrl()

changeSiteDescription()

getSiteProperty()

setSiteProperty()

removeSiteProperty()

checkForAuthzGroup()

checkForRoleInAuthzGroup()

getUserDisplayName()

searchForUsers()

SakaiGradebook.jws

Much of the code here is based on the original by Rutgers, however I have updated it for Sakai 2.4. This is the whole file.
It's not finished though!

SakaiGradebook.jws

Deprecated

addMembersToSiteFromXML()

removeMembersFromSiteFromXML()

Keywords: WSGradebook.jws SakaiGradebook.jws SakaiScript.jws jws wsdl