API and SIS Export Report

[odavila]

Hello,

I have a question regarding the start of the account report "SIS Export" using the API. So far, I've been successful using the "List Available Reports" and the "Status of a Report".

From the API Documentation , I should be able to use "POST /api/v1/accounts/:account_id/reports/:report" to "Start a Report". I am using POSTMAN to test and when I start the report and check the status I get back this message:

"extra_text": "Failed, please report the following error code to your system administrator: ErrorReport:310,214,075;"

I am an administrator of the account so I am at a lost of what this error means.

BTW - The report runs fine if I manually run it. When I check the status of the report I noticed the parameters

"parameters": {

            "enrollment_term_id": "",

            "users": "1",

            "extra_text": "Term: All Terms; Reports: users "
}

which I've have also tried but I get the same error.

Any help would be appreciated.

[pklove]

What do you have for ":report"?

And what, if any, parameters are you passing?

[bneporadny]

Hi Oscar,

Here are some screen shots of using postman to start a report using postman‌. The first screen shot shows where I setup my Bearer Token and the second is how you can setup a parameter to pull for only a specific term. 

Hope this helps. 

[odavila]

Thanks Brian! That was it. I needed to put the parameters in the correct place. Once I saw your pic I was able to figure it out.

Using POSTMAN

I went to the body tab, selected “form-data”. For the key I entered “parameters[users]” and for value I entered “true”.

Thanks again!

[pklove]

It looks like you need to specify what to include.

If I POST $server/api/v1/accounts/1/reports/sis_export_csv with no parameters and get an error like yours.  But if I specify some thing(s) it runs okay.

For example:

    curl -X POST $server/api/v1/accounts/1/reports/sis_export_csv \
       -F "parameters[users]=true" \
       -F "parameters[enrollments]=true" \
       -H "Authorization: Bearer $token"

[odavila]

Hi Peter,

Thanks for your reply. My issue was that I was putting the parameters in the wrong place in POSTMAN.

Using POSTMAN

I went to the body tab, selected “form-data”. For the key I entered “parameters[users]” and for value I entered “true”.

Thanks again!