CurriculumApi.md

IO.Swagger.Api.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

List GetCurricula (bool? includeProgress = null)

Get Curricula

Get Curricula, optionally with progress included.

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class GetCurriculaExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: BBOAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CurriculumApi();
            var includeProgress = true;  // bool? | Whether to return progress with the curriculum. (optional) 

            try
            {
                // Get Curricula
                List<Curriculum> result = apiInstance.GetCurricula(includeProgress);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CurriculumApi.GetCurricula: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
includeProgress	bool?	Whether to return progress with the curriculum.	[optional]

Return type

List

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

List GetUserCurriculumWithProgress ()

Get Detailed For User

Get all curricula for user including progress for each curriculum.

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class GetUserCurriculumWithProgressExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: BBOAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CurriculumApi();

            try
            {
                // Get Detailed For User
                List<CurriculumWithProgress> result = apiInstance.GetUserCurriculumWithProgress();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CurriculumApi.GetUserCurriculumWithProgress: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List

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]