See request body using the Canvas Live API

[brian_mullins]

I'm trying to build out some code to manage notifications, and am hitting a wall. Using the Live API, I can do the Notification PUT to update a notification preference, supplying he correct parameters, and when I hit "Try it out", it actually works. That's great, but all it is showing for the request is the request URL, and I know that there are parameters not included in the URL, and therefore must be included in the Body. Could we get the live API page updated to show not only the URL used for the call, but also what the body contains?

[bneporadny]

Brian,

The parameters that you are setting in the live api‌ is the body that is being sent up. 

What programming language are you using?

You may want to try using postman‌ as well. As it can provide you with code you can use for just about any coding language. 

API Testing: Postman 

[brian_mullins]

 @bneporadny ‌,

Thanks for the feedback. I'm using Powershell, and have just started playing with Postman. I'm an API noob, so anything that makes seeing what is actually happening is helpful.

Here's some background on this request, which I'd actually started writing a few weeks back.

I'm working on code to set notification preferences. A few weeks back I was able to use the Live API site to successfully get a channel ID for a user, then make a change to the notification preferences using the same Live API site, under the PUT /v1/users/self/communication_channels/{communication_channel_id}/notification_preferences/{notification} call. That call is a 'self' call, and as I understand it requires masquerading using the as_user_id parameter. However, the as_user_id parameter is not listed in the "Request URL" box after sending the request. The request was working, so my assumption is that the parameter was in the body, not the URL. So, this was a case where not everything that appeared to be happening was evident just by looking at the Request URL. I wanted to see the body, to see what really is encoded there, too.

Today, when I try the same steps (getting the channel id and attempting to set the notification preference) it does not work via the Live API site. I'm getting "The specified resource does not exist". So, I can't reproduce a successful attempt.

Thanks,

Brian

[bneporadny]

Hi Brian,

I haven't used that particular api‌ before, but when I have a few moments I will take a look at it and see if I can get it to work for me. 

In the mean time below are some great references you can review to help you become more familiar with the Canvas API's.

Canvas APIs: Getting started, the practical ins and outs, gotchas, tips, and tricks 

Notification Preferences API 

https://community.canvaslms.com/groups/canvas-developers/blog/2018/04/23/getting-started-with-ruby-t... 

You can also check out this great post in the community about using Postman: API Testing: Postman

Happy coding!

Brian

[bneporadny]

Brian,

I took a few minutes to try this out for you and I was able to get it to work without having to user the as_user_id parameter.

First thing I did was user the communication channels‌ api‌ to get the communication channel ID's associated with the particular user account I was testing with. 

I then went to the notification preferences api and plugged in one of the ID's I had gotten from above, entered in the notification I wanted to change and then the frequency and was able to successfully change the notification preference of that particular user without any issues.

Hope this helps. If not let me know what you're seeing and I'll be glad to continue to assist. 

Brian

[ColinMurtaugh]

Hi Brian --

If it's helpful, here's what my Postman settings look like for this request (which works for me, using an account administrator's token):

...and the Headers tab looks like:

 

Getting comfortable with Postman might take a little time, but it's a very useful tool! Good luck!

--Colin

[stuart_ryan]

Hi  @brian_mullins ,

I wanted to check in with you as there have been a number of really good comments and suggestions to hopefully point you on the right track.

Have these helped you out, or do you still need some additional assistance?

Please let us know!

Cheers,
Stuart