API specification for Ngiyaqonda NLG Worker

Continuations

continuationsGet

Get a selection of correct and incorrect continuations for a (possibly empty) sentence.

This endpoint supplies a mapping from tokens to status values, which are 'final', 'nonfinal' and 'incorrect'. final: These tokens are acceptable given the current sentence, and will therefore be droppable into the authoring area. In addition, they lead to a final, acceptable sentence. In the case of a 'write' task, this means that the selection of such a token will cause the Write button to be enabled, while in a 'game' task, it will cause the sentence to be written automatically to the right-hand panel. nonfinal: These tokens are acceptable given the current sentence, and will therefore be droppable into the authoring area. incorrect: These tokens are not acceptable given the current sentence, and will not be droppable into the authoring area.

/continuations

Usage and SDK Samples

curl -X GET "https://localhost/continuations?user_id=&lesson_index=&task_index=&sentence=&prompt="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContinuationsApi;

import java.io.File;
import java.util.*;

public class ContinuationsApiExample {

    public static void main(String[] args) {
        
        ContinuationsApi apiInstance = new ContinuationsApi();
        String userId = userId_example; // String | Unique user identifier.
        String lessonIndex = lessonIndex_example; // String | Index of lesson.
        Integer taskIndex = 56; // Integer | Index of task in lesson.
        String sentence = sentence_example; // String | Sentence authored so far.
        String prompt = prompt_example; // String | Prompt, if applicable.
        try {
            inline_response_200_4 result = apiInstance.continuationsGet(userId, lessonIndex, taskIndex, sentence, prompt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContinuationsApi#continuationsGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContinuationsApi;

public class ContinuationsApiExample {

    public static void main(String[] args) {
        ContinuationsApi apiInstance = new ContinuationsApi();
        String userId = userId_example; // String | Unique user identifier.
        String lessonIndex = lessonIndex_example; // String | Index of lesson.
        Integer taskIndex = 56; // Integer | Index of task in lesson.
        String sentence = sentence_example; // String | Sentence authored so far.
        String prompt = prompt_example; // String | Prompt, if applicable.
        try {
            inline_response_200_4 result = apiInstance.continuationsGet(userId, lessonIndex, taskIndex, sentence, prompt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContinuationsApi#continuationsGet");
            e.printStackTrace();
        }
    }
}

String *userId = userId_example; // Unique user identifier.
String *lessonIndex = lessonIndex_example; // Index of lesson.
Integer *taskIndex = 56; // Index of task in lesson.
String *sentence = sentence_example; // Sentence authored so far.
String *prompt = prompt_example; // Prompt, if applicable. (optional)

ContinuationsApi *apiInstance = [[ContinuationsApi alloc] init];

// Get a selection of correct and incorrect continuations for a (possibly empty) sentence.
[apiInstance continuationsGetWith:userId
    lessonIndex:lessonIndex
    taskIndex:taskIndex
    sentence:sentence
    prompt:prompt
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var ApiSpecificationForNgiyaqondaNlgWorker = require('api_specification_for_ngiyaqonda_nlg_worker');

var api = new ApiSpecificationForNgiyaqondaNlgWorker.ContinuationsApi()

var userId = userId_example; // {String} Unique user identifier.

var lessonIndex = lessonIndex_example; // {String} Index of lesson.

var taskIndex = 56; // {Integer} Index of task in lesson.

var sentence = sentence_example; // {String} Sentence authored so far.

var opts = { 
  'prompt': prompt_example // {String} Prompt, if applicable.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.continuationsGet(userId, lessonIndex, taskIndex, sentence, opts, callback);

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

namespace Example
{
    public class continuationsGetExample
    {
        public void main()
        {
            
            var apiInstance = new ContinuationsApi();
            var userId = userId_example;  // String | Unique user identifier.
            var lessonIndex = lessonIndex_example;  // String | Index of lesson.
            var taskIndex = 56;  // Integer | Index of task in lesson.
            var sentence = sentence_example;  // String | Sentence authored so far.
            var prompt = prompt_example;  // String | Prompt, if applicable. (optional) 

            try
            {
                // Get a selection of correct and incorrect continuations for a (possibly empty) sentence.
                inline_response_200_4 result = apiInstance.continuationsGet(userId, lessonIndex, taskIndex, sentence, prompt);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContinuationsApi.continuationsGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ContinuationsApi();
$userId = userId_example; // String | Unique user identifier.
$lessonIndex = lessonIndex_example; // String | Index of lesson.
$taskIndex = 56; // Integer | Index of task in lesson.
$sentence = sentence_example; // String | Sentence authored so far.
$prompt = prompt_example; // String | Prompt, if applicable.

try {
    $result = $api_instance->continuationsGet($userId, $lessonIndex, $taskIndex, $sentence, $prompt);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContinuationsApi->continuationsGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContinuationsApi;

my $api_instance = WWW::SwaggerClient::ContinuationsApi->new();
my $userId = userId_example; # String | Unique user identifier.
my $lessonIndex = lessonIndex_example; # String | Index of lesson.
my $taskIndex = 56; # Integer | Index of task in lesson.
my $sentence = sentence_example; # String | Sentence authored so far.
my $prompt = prompt_example; # String | Prompt, if applicable.

eval { 
    my $result = $api_instance->continuationsGet(userId => $userId, lessonIndex => $lessonIndex, taskIndex => $taskIndex, sentence => $sentence, prompt => $prompt);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContinuationsApi->continuationsGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ContinuationsApi()
userId = userId_example # String | Unique user identifier.
lessonIndex = lessonIndex_example # String | Index of lesson.
taskIndex = 56 # Integer | Index of task in lesson.
sentence = sentence_example # String | Sentence authored so far.
prompt = prompt_example # String | Prompt, if applicable. (optional)

try: 
    # Get a selection of correct and incorrect continuations for a (possibly empty) sentence.
    api_response = api_instance.continuations_get(userId, lessonIndex, taskIndex, sentence, prompt=prompt)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContinuationsApi->continuationsGet: %s\n" % e)

Parameters

Query parameters

Name	Description
user_id*	String Unique user identifier. Required
lesson_index*	String Index of lesson. Required
task_index*	Integer Index of task in lesson. Required
sentence*	String Sentence authored so far. Required
prompt	String Prompt, if applicable.

Responses

Status: 200 - The request succeeded. Returns a JSON object containing continuations.

Schema

LessonProgress

lessonProgressGet

Get available lessons with user progress data.

This endpoint is to be used to populate the screen showing all available lessons and tasks on a high level, and which tasks should be active given the user's progress.

/lesson_progress

Usage and SDK Samples

curl -X GET "https://localhost/lesson_progress?user_id="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LessonProgressApi;

import java.io.File;
import java.util.*;

public class LessonProgressApiExample {

    public static void main(String[] args) {
        
        LessonProgressApi apiInstance = new LessonProgressApi();
        Integer userId = 56; // Integer | Unique user id
        try {
            inline_response_200_2 result = apiInstance.lessonProgressGet(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LessonProgressApi#lessonProgressGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.LessonProgressApi;

public class LessonProgressApiExample {

    public static void main(String[] args) {
        LessonProgressApi apiInstance = new LessonProgressApi();
        Integer userId = 56; // Integer | Unique user id
        try {
            inline_response_200_2 result = apiInstance.lessonProgressGet(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LessonProgressApi#lessonProgressGet");
            e.printStackTrace();
        }
    }
}

Integer *userId = 56; // Unique user id

LessonProgressApi *apiInstance = [[LessonProgressApi alloc] init];

// Get available lessons with user progress data.
[apiInstance lessonProgressGetWith:userId
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var ApiSpecificationForNgiyaqondaNlgWorker = require('api_specification_for_ngiyaqonda_nlg_worker');

var api = new ApiSpecificationForNgiyaqondaNlgWorker.LessonProgressApi()

var userId = 56; // {Integer} Unique user id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.lessonProgressGet(userId, callback);

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

namespace Example
{
    public class lessonProgressGetExample
    {
        public void main()
        {
            
            var apiInstance = new LessonProgressApi();
            var userId = 56;  // Integer | Unique user id

            try
            {
                // Get available lessons with user progress data.
                inline_response_200_2 result = apiInstance.lessonProgressGet(userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LessonProgressApi.lessonProgressGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LessonProgressApi();
$userId = 56; // Integer | Unique user id

try {
    $result = $api_instance->lessonProgressGet($userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LessonProgressApi->lessonProgressGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LessonProgressApi;

my $api_instance = WWW::SwaggerClient::LessonProgressApi->new();
my $userId = 56; # Integer | Unique user id

eval { 
    my $result = $api_instance->lessonProgressGet(userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LessonProgressApi->lessonProgressGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LessonProgressApi()
userId = 56 # Integer | Unique user id

try: 
    # Get available lessons with user progress data.
    api_response = api_instance.lesson_progress_get(userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LessonProgressApi->lessonProgressGet: %s\n" % e)

Parameters

Query parameters

Name	Description
user_id*	Integer Unique user id Required

Responses

Status: 200 - List of available lessons.

Schema

Schools

schoolsGet

Get a list of schools.

This endpoint supplies a list of schools that have participating students.

/schools

Usage and SDK Samples

curl -X GET "https://localhost/schools"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchoolsApi;

import java.io.File;
import java.util.*;

public class SchoolsApiExample {

    public static void main(String[] args) {
        
        SchoolsApi apiInstance = new SchoolsApi();
        try {
            inline_response_200 result = apiInstance.schoolsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchoolsApi#schoolsGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.SchoolsApi;

public class SchoolsApiExample {

    public static void main(String[] args) {
        SchoolsApi apiInstance = new SchoolsApi();
        try {
            inline_response_200 result = apiInstance.schoolsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchoolsApi#schoolsGet");
            e.printStackTrace();
        }
    }
}


SchoolsApi *apiInstance = [[SchoolsApi alloc] init];

// Get a list of schools.
[apiInstance schoolsGetWithCompletionHandler: 
              ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var ApiSpecificationForNgiyaqondaNlgWorker = require('api_specification_for_ngiyaqonda_nlg_worker');

var api = new ApiSpecificationForNgiyaqondaNlgWorker.SchoolsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.schoolsGet(callback);

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

namespace Example
{
    public class schoolsGetExample
    {
        public void main()
        {
            
            var apiInstance = new SchoolsApi();

            try
            {
                // Get a list of schools.
                inline_response_200 result = apiInstance.schoolsGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchoolsApi.schoolsGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SchoolsApi();

try {
    $result = $api_instance->schoolsGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchoolsApi->schoolsGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchoolsApi;

my $api_instance = WWW::SwaggerClient::SchoolsApi->new();

eval { 
    my $result = $api_instance->schoolsGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchoolsApi->schoolsGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchoolsApi()

try: 
    # Get a list of schools.
    api_response = api_instance.schools_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchoolsApi->schoolsGet: %s\n" % e)

Parameters

Responses

Status: 200 - New prompt text for task.

Schema

TaskSetup

taskSetupGet

Get content for task setup.

This endpoint supplies all the initial strings for static components of the task screens as well as information about the type of task and its associated components. The task is uniquely identified by combining the user's id, the lesson's unique identifier and the task index.

/task_setup

Usage and SDK Samples

curl -X GET "https://localhost/task_setup?user_id=&lesson_id=&task_index="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskSetupApi;

import java.io.File;
import java.util.*;

public class TaskSetupApiExample {

    public static void main(String[] args) {
        
        TaskSetupApi apiInstance = new TaskSetupApi();
        String userId = userId_example; // String | Unique user id
        String lessonId = lessonId_example; // String | Unique identifier of lesson.
        Integer taskIndex = 56; // Integer | Index of task in lesson.
        try {
            inline_response_200_3 result = apiInstance.taskSetupGet(userId, lessonId, taskIndex);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskSetupApi#taskSetupGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.TaskSetupApi;

public class TaskSetupApiExample {

    public static void main(String[] args) {
        TaskSetupApi apiInstance = new TaskSetupApi();
        String userId = userId_example; // String | Unique user id
        String lessonId = lessonId_example; // String | Unique identifier of lesson.
        Integer taskIndex = 56; // Integer | Index of task in lesson.
        try {
            inline_response_200_3 result = apiInstance.taskSetupGet(userId, lessonId, taskIndex);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskSetupApi#taskSetupGet");
            e.printStackTrace();
        }
    }
}

String *userId = userId_example; // Unique user id
String *lessonId = lessonId_example; // Unique identifier of lesson.
Integer *taskIndex = 56; // Index of task in lesson.

TaskSetupApi *apiInstance = [[TaskSetupApi alloc] init];

// Get content for task setup.
[apiInstance taskSetupGetWith:userId
    lessonId:lessonId
    taskIndex:taskIndex
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var ApiSpecificationForNgiyaqondaNlgWorker = require('api_specification_for_ngiyaqonda_nlg_worker');

var api = new ApiSpecificationForNgiyaqondaNlgWorker.TaskSetupApi()

var userId = userId_example; // {String} Unique user id

var lessonId = lessonId_example; // {String} Unique identifier of lesson.

var taskIndex = 56; // {Integer} Index of task in lesson.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.taskSetupGet(userId, lessonId, taskIndex, callback);

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

namespace Example
{
    public class taskSetupGetExample
    {
        public void main()
        {
            
            var apiInstance = new TaskSetupApi();
            var userId = userId_example;  // String | Unique user id
            var lessonId = lessonId_example;  // String | Unique identifier of lesson.
            var taskIndex = 56;  // Integer | Index of task in lesson.

            try
            {
                // Get content for task setup.
                inline_response_200_3 result = apiInstance.taskSetupGet(userId, lessonId, taskIndex);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskSetupApi.taskSetupGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaskSetupApi();
$userId = userId_example; // String | Unique user id
$lessonId = lessonId_example; // String | Unique identifier of lesson.
$taskIndex = 56; // Integer | Index of task in lesson.

try {
    $result = $api_instance->taskSetupGet($userId, $lessonId, $taskIndex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaskSetupApi->taskSetupGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaskSetupApi;

my $api_instance = WWW::SwaggerClient::TaskSetupApi->new();
my $userId = userId_example; # String | Unique user id
my $lessonId = lessonId_example; # String | Unique identifier of lesson.
my $taskIndex = 56; # Integer | Index of task in lesson.

eval { 
    my $result = $api_instance->taskSetupGet(userId => $userId, lessonId => $lessonId, taskIndex => $taskIndex);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaskSetupApi->taskSetupGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TaskSetupApi()
userId = userId_example # String | Unique user id
lessonId = lessonId_example # String | Unique identifier of lesson.
taskIndex = 56 # Integer | Index of task in lesson.

try: 
    # Get content for task setup.
    api_response = api_instance.task_setup_get(userId, lessonId, taskIndex)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaskSetupApi->taskSetupGet: %s\n" % e)

Parameters

Query parameters

Name	Description
user_id*	String Unique user id Required
lesson_id*	String Unique identifier of lesson. Required
task_index*	Integer Index of task in lesson. Required

Responses

Status: 200 - Content for task setup.

Schema

Users

usersGet

Get a list of users of the school.

This endpoint supplies a list of users from a participating school.

/users

Usage and SDK Samples

curl -X GET "https://localhost/users?school_id="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        Integer schoolId = 56; // Integer | Unique school id
        try {
            inline_response_200_1 result = apiInstance.usersGet(schoolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer schoolId = 56; // Integer | Unique school id
        try {
            inline_response_200_1 result = apiInstance.usersGet(schoolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersGet");
            e.printStackTrace();
        }
    }
}

Integer *schoolId = 56; // Unique school id

UsersApi *apiInstance = [[UsersApi alloc] init];

// Get a list of users of the school.
[apiInstance usersGetWith:schoolId
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var ApiSpecificationForNgiyaqondaNlgWorker = require('api_specification_for_ngiyaqonda_nlg_worker');

var api = new ApiSpecificationForNgiyaqondaNlgWorker.UsersApi()

var schoolId = 56; // {Integer} Unique school id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.usersGet(schoolId, callback);

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

namespace Example
{
    public class usersGetExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var schoolId = 56;  // Integer | Unique school id

            try
            {
                // Get a list of users of the school.
                inline_response_200_1 result = apiInstance.usersGet(schoolId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.usersGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$schoolId = 56; // Integer | Unique school id

try {
    $result = $api_instance->usersGet($schoolId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->usersGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $schoolId = 56; # Integer | Unique school id

eval { 
    my $result = $api_instance->usersGet(schoolId => $schoolId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->usersGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UsersApi()
schoolId = 56 # Integer | Unique school id

try: 
    # Get a list of users of the school.
    api_response = api_instance.users_get(schoolId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->usersGet: %s\n" % e)

Parameters

Query parameters

Name	Description
school_id*	Integer Unique school id Required

Responses

Status: 200 - New prompt text for task.

Schema

API specification for Ngiyaqonda NLG Worker

API and SDK Documentation

Continuations

continuationsGet

Usage and SDK Samples

Parameters

Responses

Status: 200 - The request succeeded. Returns a JSON object containing continuations.

LessonProgress

lessonProgressGet

Usage and SDK Samples

Parameters

Responses

Status: 200 - List of available lessons.

Schools

schoolsGet

Usage and SDK Samples

Parameters

Responses

Status: 200 - New prompt text for task.

TaskSetup

taskSetupGet

Usage and SDK Samples

Parameters

Responses

Status: 200 - Content for task setup.

Users

usersGet

Usage and SDK Samples

Parameters

Responses

Status: 200 - New prompt text for task.