Skip to content

Latest commit

 

History

History
69 lines (42 loc) · 2.13 KB

CurriculumApi.md

File metadata and controls

69 lines (42 loc) · 2.13 KB

\CurriculumApi

All URIs are relative to https://api.bombbomb.com/v2

Method HTTP request Description
GetCurricula Get /curricula/ Get Curricula
GetUserCurriculumWithProgress Get /curriculum/getForUserWithProgress Get Detailed For User

GetCurricula

[]Curriculum GetCurricula(ctx, optional) Get Curricula

Get Curricula, optionally with progress included.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
includeProgress bool Whether to return progress with the curriculum.

Return type

[]Curriculum

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUserCurriculumWithProgress

[]CurriculumWithProgress GetUserCurriculumWithProgress(ctx, ) Get Detailed For User

Get all curricula for user including progress for each curriculum.

Required Parameters

This endpoint does not need any parameter.

Return type

[]CurriculumWithProgress

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]