Tagging Service

This service provides the ability to add and remove tags from learners and courses.

getCourseTags

  • Semantics: This method will fetch the tags currently associated with the specified course

  • Required Arguments:

    • appid– Your application id
    • courseid– The id of the course for which the tags will be retrieved
  • Optional Arguments: none

  • Example Call:

    http://cloud.scorm.com/api?method=rustici.tagging.getCourseTags&appid=myappid&courseid=course003
    
  • Example response:

    <tags>
        <tag>compliance2009</tag>
        <tag>advanced</tag>
    </tags>
    

setCourseTags

  • Semantics: This method will set all the tags for the specified course

  • Required Arguments:

    • appid– Your application id
    • courseid– The id of the course for which the tags will be set
    • tags– A comma separated list of tags to set for the course
  • Optional Arguments: none

  • Example Call:

    http://cloud.scorm.com/api?method=rustici.tagging.setCourseTags&appid=myappid&courseid=course003&tags=compliance2009,advanced
    
  • Example response:

    <success />
    

addCourseTag

  • Semantics: This method will associate the given tag with the specified course.

  • Required Arguments:

    • appid– Your application id
    • courseid– The id of the course which the given tag will be associated with
    • tag– The tag to associate with the course
  • Optional Arguments: none

  • Example Call:

    http://cloud.scorm.com/api?method=rustici.tagging.addCourseTag&appid=myappid&courseid=course003&tag=compliance2009
    
  • Example response:

    <success />
    

removeCourseTag

  • Semantics: This method will remove the given tag with the specified course.

  • Required Arguments:

    • appid– Your application id
    • courseid– The id of the course which the given tag is associated with
    • tag– The tag to remove from the course
  • Optional Arguments: none

  • Example Call:

    http://cloud.scorm.com/api?method=rustici.tagging.removeCourseTag&appid=myappid&courseid=course003&tag=compliance2009
    
  • Example response:

    <success />
    

getLearnerTags

  • Semantics: This method will fetch the tags currently associated with the specified learner

  • Required Arguments:

    • appid– Your application id
    • learnerid– The id of the learner for which the tags will be retrieved
  • Optional Arguments: none

  • Example Call:

    http://cloud.scorm.com/api?method=rustici.tagging.getLearnerTags&appid=myappid&learnerid=jstudent
    
  • Example response:

    <tags>
        <tag>humanresources</tag>
        <tag>division_a</tag>
    </tags>
    

setLearnerTags

  • Semantics: This method will set all the tags for the specified learner

  • Required Arguments:

    • appid– Your application id
    • learnerid– The id of the learner for which the tags will be set
    • tags– A comma separated list of tags to set for the learner
  • Optional Arguments: none

  • Example Call:

    http://cloud.scorm.com/api?method=rustici.tagging.setLearnerTags&appid=myappid&learnerid=jstudent&tags=humanresources,division\_a
    
  • Example response:

    <success />
    

addLearnerTag

  • Semantics: This method will associate the given tag with the specified learner.

  • Required Arguments:

    • appid– Your application id
    • learnerid– The id of the learner which the given tag will be associated with
    • tag– The tag to associate with the learner
  • Optional Arguments: none

  • Example Call:

    http://cloud.scorm.com/api?method=rustici.tagging.addLearnerTag&appid=myappid&learnerid=jstudent&tag=humanresources
    
  • Example response:

    <success />
    

removeLearnerTag

  • Semantics: This method will remove the given tag with the specified learner.

  • Required Arguments:

    • appid– Your application id
    • learnerid– The id of the learner which the given tag is associated with
    • tag– The tag to remove from the learner
  • Optional Arguments: none

  • Example Call:

    http://cloud.scorm.com/api?method=rustici.tagging.removeLearnerTag&appid=myappid&learnerid=jstudent&tag=humanresources
    
  • Example response:

    <success />
    

getRegistrationTags

  • Semantics: This method will fetch the tags currently associated with the specified registration

  • Required Arguments:

    • appid– Your application id
    • regid– The id of the registration for which the tags will be retrieved
  • Optional Arguments: none

  • Example Call:

    http://cloud.scorm.com/api?method=rustici.tagging.getRegistrationTags&appid=myappid&regid=reg001
    
  • Example response:

    <tags>
        <tag>Invitation100</tag>
        <tag>JulyPromotion</tag>
    </tags>
    

setRegistrationTags

  • Semantics: This method will set all the tags for the specified registration

  • Required Arguments:

    • appid– Your application id
    • regid– The id of the registration for which the tags will be set
    • tags– A comma separated list of tags to set for the registration
  • Optional Arguments:

    • refreshUpdateTime– Denotes whether this method call will refresh the update time on a registration. A registration’s updated time is useful for the “after” filter of getRegistrationList. Default behavior is that tagging a registration will not refresh its updated time.
  • Example Call:

    http://cloud.scorm.com/api?method=rustici.tagging.setRegistrationTags&appid=myappid&regid=reg001&tags=Invitation100,JulyPromotion
    
  • Example response:

    <success />
    

addRegistrationTag

  • Semantics: This method will associate the given tag with the specified registration.

  • Required Arguments:

    • appid– Your application id
    • regid– The id of the registration which the given tag will be associated with
    • tag– The tag to associate with the registration
  • Optional Arguments: none

  • Example Call:

    http://cloud.scorm.com/api?method=rustici.tagging.addRegistrationTag&appid=myappid&regid=reg001&tag=Invitation100
    
  • Example response:

    <success />
    

removeRegistrationTag

  • Semantics: This method will remove the given tag with the specified registration.

  • Required Arguments:

    • appid– Your application id
    • regid– The id of the registration which the given tag is associated with
    • tag– The tag to remove from the registration
  • Optional Arguments: none

  • Example Call:

    http://cloud.scorm.com/api?method=rustici.tagging.removeRegistrationTag&appid=myappid&regid=reg001&tag=Invitation100
    
  • Example response:

    <success />