Skip to content

start_account_report parameters param should be a dict rather than string #67

@cmurtaugh

Description

@cmurtaugh

The inline doc for the start_account_report method indicates that the parameters argument should be a string, but it needs to be a dict. Also, it's not obvious what the keys of that dict need to be. After some experimentation, I found that the dict needs to look like:

{
    'parameters[enrollments]': '1',
    'parameters[include_deleted]': '1',
}

This is a little clunky looking to me and non-obvious; we could improve the situation by providing more details in the documentation, or we could translate the dict keys to the format expected by the Canvas API (parameters[<k>]).

What does everyone think about automatically translating the paramaters dict keys vs. just providing better docs?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions