Skip to main content
Answer

API - List Values

  • October 20, 2023
  • 4 replies
  • 146 views

hwolfehall
Helper I
Forum|alt.badge.img+2

I’m struggling a bit with the API documentation.  There are many API calls that leverage the numeric value for field options that are only text-based in the platform, documentation, and help.  

For example, “Level” for a course.  I know the options are student (don’t get me started about why it’s “Learner” in the frontend dropdown lists but “student” if you’re using CSV), tutor, instructor.  BUT...which is which numeric value?  I can’t find it ANYWHERE in the resources.  Same thing for “status” I know the options are subscribed, enrolled, in progress, completed, etc.  but what number goes with each status?  

If someone can please point me to the place where these lookup values are hidden, I would greatly appreciate it.  

 

Best answer by alekwo

@hwolfehall Indeed, the documentation is not very well structured.

So far, I could find most of what I needed by checking the Body Schema of POST/PUT endpoints for creating/updating the relevant object.

 

 

 

4 replies

alekwo
Guide III
Forum|alt.badge.img+1
  • Guide III
  • Answer
  • October 20, 2023

@hwolfehall Indeed, the documentation is not very well structured.

So far, I could find most of what I needed by checking the Body Schema of POST/PUT endpoints for creating/updating the relevant object.

 

 

 


Bfarkas
Hero III
Forum|alt.badge.img+6
  • Hero III
  • October 21, 2023

I wish that tab was open by default, so many people never know it is even there!


hwolfehall
Helper I
Forum|alt.badge.img+2
  • Author
  • Helper I
  • November 29, 2023

I wish that tab was open by default, so many people never know it is even there!

Add me to the list of people.  🤣   As always, thanks for the awesome help!! 


Ian
Guide I
  • Guide I
  • November 30, 2023

Not sure if it’s inappropriate to use other threads to plug ideas we’ve submitted, but I just submitted this one: 

Please feel free to add other improvement ideas to the thread!