Issue with paging in CanvasApiResult

[brianmullinsbsd]

This may be a recent API change, but I'm not sure. Calls to CanvasApiResult are returning errors if there is only one page of data coming back. I think the issue is on line 78 of the CanvasApiMain.ps1:

if ($Results.Headers.link -ne $null) {

If I change the above to

if ($Results.Headers.link -ne $null -and $Results.Headers.link.contains("rel="next"") ) {

It seems to fix it, but I've only tested on one call.

BTW, this is freaking awesome. Until I found this I was building my own interfaces by hand. What a pain. Thanks man!

[squid808]

I'll see if I can take a look at it tomorrow, but I'm getting ready to head out for a business trip for a little while - if I don't get back to it soon I'm not ignoring you but please don't hesitate to ping me for an update. :)

[brianmullinsbsd]

Hey man, no worries. I’ve tweaked it on my end and it seems to be working well. One other thing…not an issue with the generated code, I don’t think, but the calls to update notification preferences (PUT /v1/users/self/communication_channels/{communication_channel_id}/notification_preferences) all update SELF, as do several other endpoints. I reached out to Instructure support yesterday and they said I can get around that (so I can update other users) by adding "?as_user_id=". I can duplicate the generated code, add another parameter and get it to work, but wanted to let you know and see if there was some way the generator could detect the ‘self’ reference and add another version with the above included. However, it would assume all of those endpoint support the extra filter. Thanks again for building this! Brian

[squid808]

Edited your response to remove your email information - you may want to reply on the web next time. I'll be looking in to this a little more today I hope to at least provide more insight, and to followup on your second point.

[brianmullinsbsd]

Thanks for the edit. Appreciate that. On that second point, I've been testing it and have not had success yet, so hold on it.

Brian

[squid808]

I cannot reproduce the issue. I did a fresh pull, regenerated the APIs and tried this without issue:
$Users = Get-CanvasAccountsUsersByAccountId -AccountId 1

What exactly are you testing to get the error for paging?

[squid808]

ffs closed the tab before commenting. I couldn't reproduce using this:
$Users = Get-CanvasAccountsUsersByAccountId -AccountId 1

What are you using to get the paging error?

[brianmullinsbsd]

Sorry for the delayed response.

$results = Get-CanvasCommunicationChannel -UserId $user_id
You cannot call a method on a null-valued expression.
At C:\Source\PS Code Play\PoshCanvas_BSD.ps1:93 char:9
+         $PerPage = $NextUriLine.Substring($NextUriLine.IndexOf("per_p ...
+         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [], RuntimeException
    + FullyQualifiedErrorId : InvokeMethodOnNull

This user has only a single communication channel, and the results that function Get-CanvasApiResult() is getting back from the call has no 'next' link, so this line is failing:

 $NextUriLine = $Results.Headers.link.Split(",") | where {$_.Contains("rel=`"next`"")}

When I update the previous If to this, it works:

if ($Results.Headers.link -ne $null -and $Results.Headers.link.contains("rel=`"next`"") )
```

[pasteiner]

Hey Spencer,
Loving the script. I do notice an exception when call Get-CanvasAccountsCoursesByAccountId

You cannot call a method on a null-valued expression.
At E:\scripts\canvas\canvas-posh.psm1:83 char:9

It does continue, but thought you might want to know.

[brianmullinsbsd]

Hey Spencer,
Loving the script. I do notice an exception when call Get-CanvasAccountsCoursesByAccountId

You cannot call a method on a null-valued expression.
At E:\scripts\canvas\canvas-posh.psm1:83 char:9

It does continue, but thought you might want to know.

Hey steinhenge, I think you probably need to create a new issue for this rather than posting it as a reply on an older issue.