Log in to create and rate content, and to follow, bookmark, and share content with other members. Not a member? Join Now!

Using LTI Parameters to access BB REST API

Discussion created by uf0047403 on Jan 29, 2018
Latest reply on Jul 10, 2018 by coop

Like • Show 0 Likes0
Comment • 8

We are building a application and we are planning on using the BB REST API to to create grade columns and and do user grade sync.The launch of the application will happen as a LTI launch and we are using the LTI parameters context_id,user_id as the course id and user id fields for the API.

Currently we have noted to access the API the below mentioned way is possible (PATCH route),

https://<BB instnace Domain>/learn/api/public/v1/courses/<uuid:course_uuid>/gradebook/columns/<column_id>/users/<uuid:us…

Can we use the LTI parameters context_id,user_id in a similar way? If so could you please let us know how this can be done.

Outcomes

8 Replies

Peter Love Jan 29, 2018 11:00 PM
I'm not sure I quite follow the question, but for the courseId and userId in any of the routes, I think you should be able to use uuid:context_id and uuid:user_id, where context_id and user_id are from the LTI launch parameters.
Like • Show 0 Likes0
Actions
- uf0047403 @ Peter Love on Feb 1, 2018 12:30 AM
  Thank you for your quick response.
  
  Course Related LTI parameters received in Launch
  "context_id" : "5633a7bae4b097a160d6c77a-d18f04460354406500295f91454ac322c60e990470e139ac"
  "custom_context_uuid" : "1e5f7c65713c4a02b98079014a549bf1"
  "custom_context_batch_uid" : "KSG_COURSE_01"
  
  User Related LTI parameters received in Launch
  "user_id" : "5a6a4c86e4b0772625967359"
  "custom_user_uuid" : "6d56915cda4a488482c787bf0e18d03d"
  "custom_person_username" : "ksg_stu_01"
  "custom_person_batch_uid" : "ksg_stu_01"
  
  User Grade GET with LTI "custom_context_uuid" as course id and LTI "custom_user_uuid" as user id.
  {DOMIAN}/learn/api/public/v1/courses/uuid:1e5f7c65713c4a02b98079014a549bf1/gradebook/columns/_30917_1/users/uuid:bfc2baa70e0d4ce49a0fa2517ac842e1
  {
      "userId": "_23916_1",
      "columnId": "_30917_1",
      "exempt": false
  }
  
  User Grade GET with LTI "context_id" as course id and LTI "user_id" as user id.
  {DOMAIN}/learn/api/public/v1/courses/uuid:5633a7bae4b097a160d6c77a-d18f04460354406500295f91454ac322c60e990470e139ac/gradebook/columns/_30917_1/users/uuid:5a6a4c86e4b0772625967359
  {
      "status": 404,
      "message": "Cannot find the resource requested"
  }
  
  Is there any possibility to use LTI "context_id" as course id and LTI "user_id" as user id in Blackboard REST APIs
  Like • Show 0 Likes0
  Actions
  - Peter Love @ uf0047403 on Feb 1, 2018 11:52 PM
    This looks a bit odd. The LTI context_id and user_id work fine as the uuids for the REST APIs calls I have used.
    
    For example, they work fine in a course or user call:
    .../learn/api/public/v1/courses/uuid:ebaf4bdec37e4de382b42523c93ee71d
    .../learn/api/public/v1/users/uuid:bcec236fc10742439f88066b678dc50e
    
    You course_id does not look to be the same format as I'm getting.
    
    What version of Learn are you using? How are you doing the LTI launches - is the built in Learn LTI, or via some other building block?
    
    How do you get the custom_context_uuid and custom_user_uuid values? These aren't listed at Dynamic Rendering with Template Variables
    Like • Show 1 Like1
    Actions
    - uf0047403 @ Peter Love on Feb 2, 2018 1:53 AM
      What version of Learn are you using?
      Blackboard Version : Release 3100.0.3-rel.51+917ccd3.
      
      How are you doing the LTI launches - is the built-in Learn LTI, or via some other building block?
      We are using Partner Cloud-Based LTI integration.
      
      How do you get the custom_context_uuid and custom_user_uuid values?
      We are receiving those parameters in LTI launch.
      Like • Show 0 Likes0
      Actions
      - Peter Love @ uf0047403 on Feb 6, 2018 4:44 PM
        I just checked on a 3100 installation and it all worked fine. And no custom_context_uuid and custom_user_uuid.
        
        So its something to do with the way your tool is being launched in its particular installation.
        
        I guess you need to talk to someone who knows about the "Partner Cloud-Based LTI integration".
        Like • Show 0 Likes0
        Actions
    - coop @ Peter Love on Jul 10, 2018 11:10 AM
      Thanks so much for this, works perfectly on 3400.5.0, and as you noted later the custom_user and custom_context launch parameters have been removed, which is what threw me off. Using your uuid: method worked for both user_id and context_id in API calls.
      
      Canvas includes custom ids for users/courses on launch and was confused to not find them in BB.
      Like • Show 0 Likes0
      Actions
  - mkauffman @ uf0047403 on Feb 5, 2018 7:48 PM
    First, thank you Peter for all of your troubleshooting. A context_id like uuid:5633a7bae4b097a160d6c77a-d18f04460354406500295f91454ac322c60e990470e139ac for a course may be specific to the Partner Cloud LTI integration. I'm looking into that. Umar - try this. GitHub - blackboard/BBDN-LTI-Tool-Provider-Node: A node.js LTI Tool Provider for testing LTI launches, Caliper, and Outc… You run this BBDN-LTI-Tool-Provider-Node on your local system. Register it using the Learn LTI tool registration process. See Learning Tools Interoperability (LTI) | Blackboard Help When you launch to that tool it shows you all of the parameters received in the Launch. Now you can place a link to that tool in the same course that you are launching to the Partner Cloud integration and see how the context_id parameter shown by the BBDN-LTI-Tool-Provider-Node relates to the context_id parameter you get from the Partner Cloud LTI integration. Same for the user's uuid.
    Like • Show 0 Likes0
    Actions
    - mkauffman @ mkauffman on Feb 28, 2018 1:36 PM
      I've discussed this with the Partner Cloud (PC) team. A PC LTI launch has a context_id and user_id that are unique across all Learn instances.
      
      The context_id you receive in partner cloud integrations are the encrypted batch uid with a consumer id to make it unique across the institutions. Similarly the user_id is a cloud profile id of that user, guaranteed to be unique across the schools.
      
      context_id - Combination of LMS instance (school) + encrypted batch uid
      custom_context_uuid - Course UUid
      custom_context_batch_uid - batch Uid
      
      Similarly, for user
      
      user_id - cloud profile id
      custom_user_uuid - User UUid
      custom_legacy_user_id - User batch uid
      
      You need to use the params accordingly for RestFul APIs.
      2 people found this helpful
      Like • Show 0 Likes0
      Actions

Using LTI Parameters to access BB REST API

Outcomes

Related Content

Recommended Content