Retrieves the groups for a specific course.
curl -X GET \
-H "X-WP-Nonce: [[apiKey]]" \
\
-H "Accept: application/json" \
"https://localhost/wp-json/learndash/v1/ldlms/v2/sfwd-courses/{id}/groups?context=view&page=1&per_page=10&search=search_example&after=after_example&modified_after=modifiedAfter_example&author=[]&author_exclude=[]&before=before_example&modified_before=modifiedBefore_example&exclude=[]&include=[]&search_semantics=searchSemantics_example&offset=56&order=asc&orderby=title&parent=[]&parent_exclude=[]&search_columns=[]&slug=&status=["publish"]&tax_relation=taxRelation_example&categories=Object&categories_exclude=Object&tags=Object&tags_exclude=Object&ld_group_category=Object&ld_group_category_exclude=Object&ld_group_tag=Object&ld_group_tag_exclude=Object"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CourseGroupsApi;
import java.io.File;
import java.util.*;
public class CourseGroupsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: nonceAuth
ApiKeyAuth nonceAuth = (ApiKeyAuth) defaultClient.getAuthentication("nonceAuth");
nonceAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//nonceAuth.setApiKeyPrefix("Token");
// Configure API key authorization: cookieAuth
ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
cookieAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.setApiKeyPrefix("Token");
// Create an instance of the API class
CourseGroupsApi apiInstance = new CourseGroupsApi();
Integer id = 56; // Integer | Course ID
String context = view; // String | Scope under which the request is made; determines fields present in response.
Integer page = 1; // Integer | Current page of the collection.
Integer perPage = 10; // Integer | Maximum number of items to be returned in result set.
String search = search_example; // String | Limit results to those matching a string.
String after = after_example; // String | Limit response to posts published after a given ISO8601 compliant date.
String modifiedAfter = modifiedAfter_example; // String | Limit response to posts modified after a given ISO8601 compliant date.
array[Integer] author = []; // array[Integer] | Limit result set to posts assigned to specific authors.
array[Integer] authorExclude = []; // array[Integer] | Ensure result set excludes posts assigned to specific authors.
String before = before_example; // String | Limit response to posts published before a given ISO8601 compliant date.
String modifiedBefore = modifiedBefore_example; // String | Limit response to posts modified before a given ISO8601 compliant date.
array[Integer] exclude = []; // array[Integer] | Ensure result set excludes specific IDs.
array[Integer] include = []; // array[Integer] | Limit result set to specific IDs.
String searchSemantics = searchSemantics_example; // String | How to interpret the search input.
Integer offset = 56; // Integer | Offset the result set by a specific number of items.
String order = asc; // String | Order sort attribute ascending or descending.
String orderby = title; // String | Sort collection by post attribute.
array[Integer] parent = []; // array[Integer] | Limit result set to items with particular parent IDs.
array[Integer] parentExclude = []; // array[Integer] | Limit result set to all items except those of a particular parent ID.
array[String] searchColumns = []; // array[String] | Array of column names to be searched.
array[String] slug = ; // array[String] | Limit result set to posts with one or more specific slugs.
array[String] status = ["publish"]; // array[String] | Limit result set to posts assigned one or more statuses.
String taxRelation = taxRelation_example; // String | Limit result set based on relationship between multiple taxonomies.
Object categories = Object; // Object | Limit result set to items with specific terms assigned in the categories taxonomy.
Object categoriesExclude = Object; // Object | Limit result set to items except those with specific terms assigned in the categories taxonomy.
Object tags = Object; // Object | Limit result set to items with specific terms assigned in the tags taxonomy.
Object tagsExclude = Object; // Object | Limit result set to items except those with specific terms assigned in the tags taxonomy.
Object ldGroupCategory = Object; // Object | Limit result set to items with specific terms assigned in the ld_group_category taxonomy.
Object ldGroupCategoryExclude = Object; // Object | Limit result set to items except those with specific terms assigned in the ld_group_category taxonomy.
Object ldGroupTag = Object; // Object | Limit result set to items with specific terms assigned in the ld_group_tag taxonomy.
Object ldGroupTagExclude = Object; // Object | Limit result set to items except those with specific terms assigned in the ld_group_tag taxonomy.
try {
array[LDLMS_v2_Group] result = apiInstance.getLdlmsV2CoursesGroupsById(id, context, page, perPage, search, after, modifiedAfter, author, authorExclude, before, modifiedBefore, exclude, include, searchSemantics, offset, order, orderby, parent, parentExclude, searchColumns, slug, status, taxRelation, categories, categoriesExclude, tags, tagsExclude, ldGroupCategory, ldGroupCategoryExclude, ldGroupTag, ldGroupTagExclude);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CourseGroupsApi#getLdlmsV2CoursesGroupsById");
e.printStackTrace();
}
}
}
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final Integer id = new Integer(); // Integer | Course ID
final String context = new String(); // String | Scope under which the request is made; determines fields present in response.
final Integer page = new Integer(); // Integer | Current page of the collection.
final Integer perPage = new Integer(); // Integer | Maximum number of items to be returned in result set.
final String search = new String(); // String | Limit results to those matching a string.
final String after = new String(); // String | Limit response to posts published after a given ISO8601 compliant date.
final String modifiedAfter = new String(); // String | Limit response to posts modified after a given ISO8601 compliant date.
final array[Integer] author = new array[Integer](); // array[Integer] | Limit result set to posts assigned to specific authors.
final array[Integer] authorExclude = new array[Integer](); // array[Integer] | Ensure result set excludes posts assigned to specific authors.
final String before = new String(); // String | Limit response to posts published before a given ISO8601 compliant date.
final String modifiedBefore = new String(); // String | Limit response to posts modified before a given ISO8601 compliant date.
final array[Integer] exclude = new array[Integer](); // array[Integer] | Ensure result set excludes specific IDs.
final array[Integer] include = new array[Integer](); // array[Integer] | Limit result set to specific IDs.
final String searchSemantics = new String(); // String | How to interpret the search input.
final Integer offset = new Integer(); // Integer | Offset the result set by a specific number of items.
final String order = new String(); // String | Order sort attribute ascending or descending.
final String orderby = new String(); // String | Sort collection by post attribute.
final array[Integer] parent = new array[Integer](); // array[Integer] | Limit result set to items with particular parent IDs.
final array[Integer] parentExclude = new array[Integer](); // array[Integer] | Limit result set to all items except those of a particular parent ID.
final array[String] searchColumns = new array[String](); // array[String] | Array of column names to be searched.
final array[String] slug = new array[String](); // array[String] | Limit result set to posts with one or more specific slugs.
final array[String] status = new array[String](); // array[String] | Limit result set to posts assigned one or more statuses.
final String taxRelation = new String(); // String | Limit result set based on relationship between multiple taxonomies.
final Object categories = new Object(); // Object | Limit result set to items with specific terms assigned in the categories taxonomy.
final Object categoriesExclude = new Object(); // Object | Limit result set to items except those with specific terms assigned in the categories taxonomy.
final Object tags = new Object(); // Object | Limit result set to items with specific terms assigned in the tags taxonomy.
final Object tagsExclude = new Object(); // Object | Limit result set to items except those with specific terms assigned in the tags taxonomy.
final Object ldGroupCategory = new Object(); // Object | Limit result set to items with specific terms assigned in the ld_group_category taxonomy.
final Object ldGroupCategoryExclude = new Object(); // Object | Limit result set to items except those with specific terms assigned in the ld_group_category taxonomy.
final Object ldGroupTag = new Object(); // Object | Limit result set to items with specific terms assigned in the ld_group_tag taxonomy.
final Object ldGroupTagExclude = new Object(); // Object | Limit result set to items except those with specific terms assigned in the ld_group_tag taxonomy.
try {
final result = await api_instance.getLdlmsV2CoursesGroupsById(id, context, page, perPage, search, after, modifiedAfter, author, authorExclude, before, modifiedBefore, exclude, include, searchSemantics, offset, order, orderby, parent, parentExclude, searchColumns, slug, status, taxRelation, categories, categoriesExclude, tags, tagsExclude, ldGroupCategory, ldGroupCategoryExclude, ldGroupTag, ldGroupTagExclude);
print(result);
} catch (e) {
print('Exception when calling DefaultApi->getLdlmsV2CoursesGroupsById: $e\n');
}
import org.openapitools.client.api.CourseGroupsApi;
public class CourseGroupsApiExample {
public static void main(String[] args) {
CourseGroupsApi apiInstance = new CourseGroupsApi();
Integer id = 56; // Integer | Course ID
String context = view; // String | Scope under which the request is made; determines fields present in response.
Integer page = 1; // Integer | Current page of the collection.
Integer perPage = 10; // Integer | Maximum number of items to be returned in result set.
String search = search_example; // String | Limit results to those matching a string.
String after = after_example; // String | Limit response to posts published after a given ISO8601 compliant date.
String modifiedAfter = modifiedAfter_example; // String | Limit response to posts modified after a given ISO8601 compliant date.
array[Integer] author = []; // array[Integer] | Limit result set to posts assigned to specific authors.
array[Integer] authorExclude = []; // array[Integer] | Ensure result set excludes posts assigned to specific authors.
String before = before_example; // String | Limit response to posts published before a given ISO8601 compliant date.
String modifiedBefore = modifiedBefore_example; // String | Limit response to posts modified before a given ISO8601 compliant date.
array[Integer] exclude = []; // array[Integer] | Ensure result set excludes specific IDs.
array[Integer] include = []; // array[Integer] | Limit result set to specific IDs.
String searchSemantics = searchSemantics_example; // String | How to interpret the search input.
Integer offset = 56; // Integer | Offset the result set by a specific number of items.
String order = asc; // String | Order sort attribute ascending or descending.
String orderby = title; // String | Sort collection by post attribute.
array[Integer] parent = []; // array[Integer] | Limit result set to items with particular parent IDs.
array[Integer] parentExclude = []; // array[Integer] | Limit result set to all items except those of a particular parent ID.
array[String] searchColumns = []; // array[String] | Array of column names to be searched.
array[String] slug = ; // array[String] | Limit result set to posts with one or more specific slugs.
array[String] status = ["publish"]; // array[String] | Limit result set to posts assigned one or more statuses.
String taxRelation = taxRelation_example; // String | Limit result set based on relationship between multiple taxonomies.
Object categories = Object; // Object | Limit result set to items with specific terms assigned in the categories taxonomy.
Object categoriesExclude = Object; // Object | Limit result set to items except those with specific terms assigned in the categories taxonomy.
Object tags = Object; // Object | Limit result set to items with specific terms assigned in the tags taxonomy.
Object tagsExclude = Object; // Object | Limit result set to items except those with specific terms assigned in the tags taxonomy.
Object ldGroupCategory = Object; // Object | Limit result set to items with specific terms assigned in the ld_group_category taxonomy.
Object ldGroupCategoryExclude = Object; // Object | Limit result set to items except those with specific terms assigned in the ld_group_category taxonomy.
Object ldGroupTag = Object; // Object | Limit result set to items with specific terms assigned in the ld_group_tag taxonomy.
Object ldGroupTagExclude = Object; // Object | Limit result set to items except those with specific terms assigned in the ld_group_tag taxonomy.
try {
array[LDLMS_v2_Group] result = apiInstance.getLdlmsV2CoursesGroupsById(id, context, page, perPage, search, after, modifiedAfter, author, authorExclude, before, modifiedBefore, exclude, include, searchSemantics, offset, order, orderby, parent, parentExclude, searchColumns, slug, status, taxRelation, categories, categoriesExclude, tags, tagsExclude, ldGroupCategory, ldGroupCategoryExclude, ldGroupTag, ldGroupTagExclude);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CourseGroupsApi#getLdlmsV2CoursesGroupsById");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: nonceAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-WP-Nonce"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-WP-Nonce"];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"wordpress_logged_in"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"wordpress_logged_in"];
// Create an instance of the API class
CourseGroupsApi *apiInstance = [[CourseGroupsApi alloc] init];
Integer *id = 56; // Course ID (default to null)
String *context = view; // Scope under which the request is made; determines fields present in response. (optional) (default to view)
Integer *page = 1; // Current page of the collection. (optional) (default to 1)
Integer *perPage = 10; // Maximum number of items to be returned in result set. (optional) (default to 10)
String *search = search_example; // Limit results to those matching a string. (optional) (default to null)
String *after = after_example; // Limit response to posts published after a given ISO8601 compliant date. (optional) (default to null)
String *modifiedAfter = modifiedAfter_example; // Limit response to posts modified after a given ISO8601 compliant date. (optional) (default to null)
array[Integer] *author = []; // Limit result set to posts assigned to specific authors. (optional) (default to [])
array[Integer] *authorExclude = []; // Ensure result set excludes posts assigned to specific authors. (optional) (default to [])
String *before = before_example; // Limit response to posts published before a given ISO8601 compliant date. (optional) (default to null)
String *modifiedBefore = modifiedBefore_example; // Limit response to posts modified before a given ISO8601 compliant date. (optional) (default to null)
array[Integer] *exclude = []; // Ensure result set excludes specific IDs. (optional) (default to [])
array[Integer] *include = []; // Limit result set to specific IDs. (optional) (default to [])
String *searchSemantics = searchSemantics_example; // How to interpret the search input. (optional) (default to null)
Integer *offset = 56; // Offset the result set by a specific number of items. (optional) (default to null)
String *order = asc; // Order sort attribute ascending or descending. (optional) (default to asc)
String *orderby = title; // Sort collection by post attribute. (optional) (default to title)
array[Integer] *parent = []; // Limit result set to items with particular parent IDs. (optional) (default to [])
array[Integer] *parentExclude = []; // Limit result set to all items except those of a particular parent ID. (optional) (default to [])
array[String] *searchColumns = []; // Array of column names to be searched. (optional) (default to [])
array[String] *slug = ; // Limit result set to posts with one or more specific slugs. (optional) (default to null)
array[String] *status = ["publish"]; // Limit result set to posts assigned one or more statuses. (optional) (default to ["publish"])
String *taxRelation = taxRelation_example; // Limit result set based on relationship between multiple taxonomies. (optional) (default to null)
Object *categories = Object; // Limit result set to items with specific terms assigned in the categories taxonomy. (optional) (default to null)
Object *categoriesExclude = Object; // Limit result set to items except those with specific terms assigned in the categories taxonomy. (optional) (default to null)
Object *tags = Object; // Limit result set to items with specific terms assigned in the tags taxonomy. (optional) (default to null)
Object *tagsExclude = Object; // Limit result set to items except those with specific terms assigned in the tags taxonomy. (optional) (default to null)
Object *ldGroupCategory = Object; // Limit result set to items with specific terms assigned in the ld_group_category taxonomy. (optional) (default to null)
Object *ldGroupCategoryExclude = Object; // Limit result set to items except those with specific terms assigned in the ld_group_category taxonomy. (optional) (default to null)
Object *ldGroupTag = Object; // Limit result set to items with specific terms assigned in the ld_group_tag taxonomy. (optional) (default to null)
Object *ldGroupTagExclude = Object; // Limit result set to items except those with specific terms assigned in the ld_group_tag taxonomy. (optional) (default to null)
// Get associated groups for a course
[apiInstance getLdlmsV2CoursesGroupsByIdWith:id
context:context
page:page
perPage:perPage
search:search
after:after
modifiedAfter:modifiedAfter
author:author
authorExclude:authorExclude
before:before
modifiedBefore:modifiedBefore
exclude:exclude
include:include
searchSemantics:searchSemantics
offset:offset
order:order
orderby:orderby
parent:parent
parentExclude:parentExclude
searchColumns:searchColumns
slug:slug
status:status
taxRelation:taxRelation
categories:categories
categoriesExclude:categoriesExclude
tags:tags
tagsExclude:tagsExclude
ldGroupCategory:ldGroupCategory
ldGroupCategoryExclude:ldGroupCategoryExclude
ldGroupTag:ldGroupTag
ldGroupTagExclude:ldGroupTagExclude
completionHandler: ^(array[LDLMS_v2_Group] output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var LearnDashRestApi = require('learn_dash_rest_api');
var defaultClient = LearnDashRestApi.ApiClient.instance;
// Configure API key authorization: nonceAuth
var nonceAuth = defaultClient.authentications['nonceAuth'];
nonceAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//nonceAuth.apiKeyPrefix['X-WP-Nonce'] = "Token";
// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['wordpress_logged_in'] = "Token";
// Create an instance of the API class
var api = new LearnDashRestApi.CourseGroupsApi()
var id = 56; // {Integer} Course ID
var opts = {
'context': view, // {String} Scope under which the request is made; determines fields present in response.
'page': 1, // {Integer} Current page of the collection.
'perPage': 10, // {Integer} Maximum number of items to be returned in result set.
'search': search_example, // {String} Limit results to those matching a string.
'after': after_example, // {String} Limit response to posts published after a given ISO8601 compliant date.
'modifiedAfter': modifiedAfter_example, // {String} Limit response to posts modified after a given ISO8601 compliant date.
'author': [], // {array[Integer]} Limit result set to posts assigned to specific authors.
'authorExclude': [], // {array[Integer]} Ensure result set excludes posts assigned to specific authors.
'before': before_example, // {String} Limit response to posts published before a given ISO8601 compliant date.
'modifiedBefore': modifiedBefore_example, // {String} Limit response to posts modified before a given ISO8601 compliant date.
'exclude': [], // {array[Integer]} Ensure result set excludes specific IDs.
'include': [], // {array[Integer]} Limit result set to specific IDs.
'searchSemantics': searchSemantics_example, // {String} How to interpret the search input.
'offset': 56, // {Integer} Offset the result set by a specific number of items.
'order': asc, // {String} Order sort attribute ascending or descending.
'orderby': title, // {String} Sort collection by post attribute.
'parent': [], // {array[Integer]} Limit result set to items with particular parent IDs.
'parentExclude': [], // {array[Integer]} Limit result set to all items except those of a particular parent ID.
'searchColumns': [], // {array[String]} Array of column names to be searched.
'slug': , // {array[String]} Limit result set to posts with one or more specific slugs.
'status': ["publish"], // {array[String]} Limit result set to posts assigned one or more statuses.
'taxRelation': taxRelation_example, // {String} Limit result set based on relationship between multiple taxonomies.
'categories': Object, // {Object} Limit result set to items with specific terms assigned in the categories taxonomy.
'categoriesExclude': Object, // {Object} Limit result set to items except those with specific terms assigned in the categories taxonomy.
'tags': Object, // {Object} Limit result set to items with specific terms assigned in the tags taxonomy.
'tagsExclude': Object, // {Object} Limit result set to items except those with specific terms assigned in the tags taxonomy.
'ldGroupCategory': Object, // {Object} Limit result set to items with specific terms assigned in the ld_group_category taxonomy.
'ldGroupCategoryExclude': Object, // {Object} Limit result set to items except those with specific terms assigned in the ld_group_category taxonomy.
'ldGroupTag': Object, // {Object} Limit result set to items with specific terms assigned in the ld_group_tag taxonomy.
'ldGroupTagExclude': Object // {Object} Limit result set to items except those with specific terms assigned in the ld_group_tag taxonomy.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getLdlmsV2CoursesGroupsById(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;
namespace Example
{
public class getLdlmsV2CoursesGroupsByIdExample
{
public void main()
{
// Configure API key authorization: nonceAuth
Configuration.Default.ApiKey.Add("X-WP-Nonce", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("X-WP-Nonce", "Bearer");
// Configure API key authorization: cookieAuth
Configuration.Default.ApiKey.Add("wordpress_logged_in", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("wordpress_logged_in", "Bearer");
// Create an instance of the API class
var apiInstance = new CourseGroupsApi();
var id = 56; // Integer | Course ID (default to null)
var context = view; // String | Scope under which the request is made; determines fields present in response. (optional) (default to view)
var page = 1; // Integer | Current page of the collection. (optional) (default to 1)
var perPage = 10; // Integer | Maximum number of items to be returned in result set. (optional) (default to 10)
var search = search_example; // String | Limit results to those matching a string. (optional) (default to null)
var after = after_example; // String | Limit response to posts published after a given ISO8601 compliant date. (optional) (default to null)
var modifiedAfter = modifiedAfter_example; // String | Limit response to posts modified after a given ISO8601 compliant date. (optional) (default to null)
var author = new array[Integer](); // array[Integer] | Limit result set to posts assigned to specific authors. (optional) (default to [])
var authorExclude = new array[Integer](); // array[Integer] | Ensure result set excludes posts assigned to specific authors. (optional) (default to [])
var before = before_example; // String | Limit response to posts published before a given ISO8601 compliant date. (optional) (default to null)
var modifiedBefore = modifiedBefore_example; // String | Limit response to posts modified before a given ISO8601 compliant date. (optional) (default to null)
var exclude = new array[Integer](); // array[Integer] | Ensure result set excludes specific IDs. (optional) (default to [])
var include = new array[Integer](); // array[Integer] | Limit result set to specific IDs. (optional) (default to [])
var searchSemantics = searchSemantics_example; // String | How to interpret the search input. (optional) (default to null)
var offset = 56; // Integer | Offset the result set by a specific number of items. (optional) (default to null)
var order = asc; // String | Order sort attribute ascending or descending. (optional) (default to asc)
var orderby = title; // String | Sort collection by post attribute. (optional) (default to title)
var parent = new array[Integer](); // array[Integer] | Limit result set to items with particular parent IDs. (optional) (default to [])
var parentExclude = new array[Integer](); // array[Integer] | Limit result set to all items except those of a particular parent ID. (optional) (default to [])
var searchColumns = new array[String](); // array[String] | Array of column names to be searched. (optional) (default to [])
var slug = new array[String](); // array[String] | Limit result set to posts with one or more specific slugs. (optional) (default to null)
var status = new array[String](); // array[String] | Limit result set to posts assigned one or more statuses. (optional) (default to ["publish"])
var taxRelation = taxRelation_example; // String | Limit result set based on relationship between multiple taxonomies. (optional) (default to null)
var categories = new Object(); // Object | Limit result set to items with specific terms assigned in the categories taxonomy. (optional) (default to null)
var categoriesExclude = new Object(); // Object | Limit result set to items except those with specific terms assigned in the categories taxonomy. (optional) (default to null)
var tags = new Object(); // Object | Limit result set to items with specific terms assigned in the tags taxonomy. (optional) (default to null)
var tagsExclude = new Object(); // Object | Limit result set to items except those with specific terms assigned in the tags taxonomy. (optional) (default to null)
var ldGroupCategory = new Object(); // Object | Limit result set to items with specific terms assigned in the ld_group_category taxonomy. (optional) (default to null)
var ldGroupCategoryExclude = new Object(); // Object | Limit result set to items except those with specific terms assigned in the ld_group_category taxonomy. (optional) (default to null)
var ldGroupTag = new Object(); // Object | Limit result set to items with specific terms assigned in the ld_group_tag taxonomy. (optional) (default to null)
var ldGroupTagExclude = new Object(); // Object | Limit result set to items except those with specific terms assigned in the ld_group_tag taxonomy. (optional) (default to null)
try {
// Get associated groups for a course
array[LDLMS_v2_Group] result = apiInstance.getLdlmsV2CoursesGroupsById(id, context, page, perPage, search, after, modifiedAfter, author, authorExclude, before, modifiedBefore, exclude, include, searchSemantics, offset, order, orderby, parent, parentExclude, searchColumns, slug, status, taxRelation, categories, categoriesExclude, tags, tagsExclude, ldGroupCategory, ldGroupCategoryExclude, ldGroupTag, ldGroupTagExclude);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling CourseGroupsApi.getLdlmsV2CoursesGroupsById: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: nonceAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-WP-Nonce', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-WP-Nonce', 'Bearer');
// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('wordpress_logged_in', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('wordpress_logged_in', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CourseGroupsApi();
$id = 56; // Integer | Course ID
$context = view; // String | Scope under which the request is made; determines fields present in response.
$page = 1; // Integer | Current page of the collection.
$perPage = 10; // Integer | Maximum number of items to be returned in result set.
$search = search_example; // String | Limit results to those matching a string.
$after = after_example; // String | Limit response to posts published after a given ISO8601 compliant date.
$modifiedAfter = modifiedAfter_example; // String | Limit response to posts modified after a given ISO8601 compliant date.
$author = []; // array[Integer] | Limit result set to posts assigned to specific authors.
$authorExclude = []; // array[Integer] | Ensure result set excludes posts assigned to specific authors.
$before = before_example; // String | Limit response to posts published before a given ISO8601 compliant date.
$modifiedBefore = modifiedBefore_example; // String | Limit response to posts modified before a given ISO8601 compliant date.
$exclude = []; // array[Integer] | Ensure result set excludes specific IDs.
$include = []; // array[Integer] | Limit result set to specific IDs.
$searchSemantics = searchSemantics_example; // String | How to interpret the search input.
$offset = 56; // Integer | Offset the result set by a specific number of items.
$order = asc; // String | Order sort attribute ascending or descending.
$orderby = title; // String | Sort collection by post attribute.
$parent = []; // array[Integer] | Limit result set to items with particular parent IDs.
$parentExclude = []; // array[Integer] | Limit result set to all items except those of a particular parent ID.
$searchColumns = []; // array[String] | Array of column names to be searched.
$slug = ; // array[String] | Limit result set to posts with one or more specific slugs.
$status = ["publish"]; // array[String] | Limit result set to posts assigned one or more statuses.
$taxRelation = taxRelation_example; // String | Limit result set based on relationship between multiple taxonomies.
$categories = Object; // Object | Limit result set to items with specific terms assigned in the categories taxonomy.
$categoriesExclude = Object; // Object | Limit result set to items except those with specific terms assigned in the categories taxonomy.
$tags = Object; // Object | Limit result set to items with specific terms assigned in the tags taxonomy.
$tagsExclude = Object; // Object | Limit result set to items except those with specific terms assigned in the tags taxonomy.
$ldGroupCategory = Object; // Object | Limit result set to items with specific terms assigned in the ld_group_category taxonomy.
$ldGroupCategoryExclude = Object; // Object | Limit result set to items except those with specific terms assigned in the ld_group_category taxonomy.
$ldGroupTag = Object; // Object | Limit result set to items with specific terms assigned in the ld_group_tag taxonomy.
$ldGroupTagExclude = Object; // Object | Limit result set to items except those with specific terms assigned in the ld_group_tag taxonomy.
try {
$result = $api_instance->getLdlmsV2CoursesGroupsById($id, $context, $page, $perPage, $search, $after, $modifiedAfter, $author, $authorExclude, $before, $modifiedBefore, $exclude, $include, $searchSemantics, $offset, $order, $orderby, $parent, $parentExclude, $searchColumns, $slug, $status, $taxRelation, $categories, $categoriesExclude, $tags, $tagsExclude, $ldGroupCategory, $ldGroupCategoryExclude, $ldGroupTag, $ldGroupTagExclude);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CourseGroupsApi->getLdlmsV2CoursesGroupsById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CourseGroupsApi;
# Configure API key authorization: nonceAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-WP-Nonce'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-WP-Nonce'} = "Bearer";
# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'wordpress_logged_in'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'wordpress_logged_in'} = "Bearer";
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CourseGroupsApi->new();
my $id = 56; # Integer | Course ID
my $context = view; # String | Scope under which the request is made; determines fields present in response.
my $page = 1; # Integer | Current page of the collection.
my $perPage = 10; # Integer | Maximum number of items to be returned in result set.
my $search = search_example; # String | Limit results to those matching a string.
my $after = after_example; # String | Limit response to posts published after a given ISO8601 compliant date.
my $modifiedAfter = modifiedAfter_example; # String | Limit response to posts modified after a given ISO8601 compliant date.
my $author = [[]]; # array[Integer] | Limit result set to posts assigned to specific authors.
my $authorExclude = [[]]; # array[Integer] | Ensure result set excludes posts assigned to specific authors.
my $before = before_example; # String | Limit response to posts published before a given ISO8601 compliant date.
my $modifiedBefore = modifiedBefore_example; # String | Limit response to posts modified before a given ISO8601 compliant date.
my $exclude = [[]]; # array[Integer] | Ensure result set excludes specific IDs.
my $include = [[]]; # array[Integer] | Limit result set to specific IDs.
my $searchSemantics = searchSemantics_example; # String | How to interpret the search input.
my $offset = 56; # Integer | Offset the result set by a specific number of items.
my $order = asc; # String | Order sort attribute ascending or descending.
my $orderby = title; # String | Sort collection by post attribute.
my $parent = [[]]; # array[Integer] | Limit result set to items with particular parent IDs.
my $parentExclude = [[]]; # array[Integer] | Limit result set to all items except those of a particular parent ID.
my $searchColumns = [[]]; # array[String] | Array of column names to be searched.
my $slug = []; # array[String] | Limit result set to posts with one or more specific slugs.
my $status = [["publish"]]; # array[String] | Limit result set to posts assigned one or more statuses.
my $taxRelation = taxRelation_example; # String | Limit result set based on relationship between multiple taxonomies.
my $categories = Object; # Object | Limit result set to items with specific terms assigned in the categories taxonomy.
my $categoriesExclude = Object; # Object | Limit result set to items except those with specific terms assigned in the categories taxonomy.
my $tags = Object; # Object | Limit result set to items with specific terms assigned in the tags taxonomy.
my $tagsExclude = Object; # Object | Limit result set to items except those with specific terms assigned in the tags taxonomy.
my $ldGroupCategory = Object; # Object | Limit result set to items with specific terms assigned in the ld_group_category taxonomy.
my $ldGroupCategoryExclude = Object; # Object | Limit result set to items except those with specific terms assigned in the ld_group_category taxonomy.
my $ldGroupTag = Object; # Object | Limit result set to items with specific terms assigned in the ld_group_tag taxonomy.
my $ldGroupTagExclude = Object; # Object | Limit result set to items except those with specific terms assigned in the ld_group_tag taxonomy.
eval {
my $result = $api_instance->getLdlmsV2CoursesGroupsById(id => $id, context => $context, page => $page, perPage => $perPage, search => $search, after => $after, modifiedAfter => $modifiedAfter, author => $author, authorExclude => $authorExclude, before => $before, modifiedBefore => $modifiedBefore, exclude => $exclude, include => $include, searchSemantics => $searchSemantics, offset => $offset, order => $order, orderby => $orderby, parent => $parent, parentExclude => $parentExclude, searchColumns => $searchColumns, slug => $slug, status => $status, taxRelation => $taxRelation, categories => $categories, categoriesExclude => $categoriesExclude, tags => $tags, tagsExclude => $tagsExclude, ldGroupCategory => $ldGroupCategory, ldGroupCategoryExclude => $ldGroupCategoryExclude, ldGroupTag => $ldGroupTag, ldGroupTagExclude => $ldGroupTagExclude);
print Dumper($result);
};
if ($@) {
warn "Exception when calling CourseGroupsApi->getLdlmsV2CoursesGroupsById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: nonceAuth
openapi_client.configuration.api_key['X-WP-Nonce'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-WP-Nonce'] = 'Bearer'
# Configure API key authorization: cookieAuth
openapi_client.configuration.api_key['wordpress_logged_in'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['wordpress_logged_in'] = 'Bearer'
# Create an instance of the API class
api_instance = openapi_client.CourseGroupsApi()
id = 56 # Integer | Course ID (default to null)
context = view # String | Scope under which the request is made; determines fields present in response. (optional) (default to view)
page = 1 # Integer | Current page of the collection. (optional) (default to 1)
perPage = 10 # Integer | Maximum number of items to be returned in result set. (optional) (default to 10)
search = search_example # String | Limit results to those matching a string. (optional) (default to null)
after = after_example # String | Limit response to posts published after a given ISO8601 compliant date. (optional) (default to null)
modifiedAfter = modifiedAfter_example # String | Limit response to posts modified after a given ISO8601 compliant date. (optional) (default to null)
author = [] # array[Integer] | Limit result set to posts assigned to specific authors. (optional) (default to [])
authorExclude = [] # array[Integer] | Ensure result set excludes posts assigned to specific authors. (optional) (default to [])
before = before_example # String | Limit response to posts published before a given ISO8601 compliant date. (optional) (default to null)
modifiedBefore = modifiedBefore_example # String | Limit response to posts modified before a given ISO8601 compliant date. (optional) (default to null)
exclude = [] # array[Integer] | Ensure result set excludes specific IDs. (optional) (default to [])
include = [] # array[Integer] | Limit result set to specific IDs. (optional) (default to [])
searchSemantics = searchSemantics_example # String | How to interpret the search input. (optional) (default to null)
offset = 56 # Integer | Offset the result set by a specific number of items. (optional) (default to null)
order = asc # String | Order sort attribute ascending or descending. (optional) (default to asc)
orderby = title # String | Sort collection by post attribute. (optional) (default to title)
parent = [] # array[Integer] | Limit result set to items with particular parent IDs. (optional) (default to [])
parentExclude = [] # array[Integer] | Limit result set to all items except those of a particular parent ID. (optional) (default to [])
searchColumns = [] # array[String] | Array of column names to be searched. (optional) (default to [])
slug = # array[String] | Limit result set to posts with one or more specific slugs. (optional) (default to null)
status = ["publish"] # array[String] | Limit result set to posts assigned one or more statuses. (optional) (default to ["publish"])
taxRelation = taxRelation_example # String | Limit result set based on relationship between multiple taxonomies. (optional) (default to null)
categories = Object # Object | Limit result set to items with specific terms assigned in the categories taxonomy. (optional) (default to null)
categoriesExclude = Object # Object | Limit result set to items except those with specific terms assigned in the categories taxonomy. (optional) (default to null)
tags = Object # Object | Limit result set to items with specific terms assigned in the tags taxonomy. (optional) (default to null)
tagsExclude = Object # Object | Limit result set to items except those with specific terms assigned in the tags taxonomy. (optional) (default to null)
ldGroupCategory = Object # Object | Limit result set to items with specific terms assigned in the ld_group_category taxonomy. (optional) (default to null)
ldGroupCategoryExclude = Object # Object | Limit result set to items except those with specific terms assigned in the ld_group_category taxonomy. (optional) (default to null)
ldGroupTag = Object # Object | Limit result set to items with specific terms assigned in the ld_group_tag taxonomy. (optional) (default to null)
ldGroupTagExclude = Object # Object | Limit result set to items except those with specific terms assigned in the ld_group_tag taxonomy. (optional) (default to null)
try:
# Get associated groups for a course
api_response = api_instance.get_ldlms_v2_courses_groups_by_id(id, context=context, page=page, perPage=perPage, search=search, after=after, modifiedAfter=modifiedAfter, author=author, authorExclude=authorExclude, before=before, modifiedBefore=modifiedBefore, exclude=exclude, include=include, searchSemantics=searchSemantics, offset=offset, order=order, orderby=orderby, parent=parent, parentExclude=parentExclude, searchColumns=searchColumns, slug=slug, status=status, taxRelation=taxRelation, categories=categories, categoriesExclude=categoriesExclude, tags=tags, tagsExclude=tagsExclude, ldGroupCategory=ldGroupCategory, ldGroupCategoryExclude=ldGroupCategoryExclude, ldGroupTag=ldGroupTag, ldGroupTagExclude=ldGroupTagExclude)
pprint(api_response)
except ApiException as e:
print("Exception when calling CourseGroupsApi->getLdlmsV2CoursesGroupsById: %s\n" % e)
extern crate CourseGroupsApi;
pub fn main() {
let id = 56; // Integer
let context = view; // String
let page = 1; // Integer
let perPage = 10; // Integer
let search = search_example; // String
let after = after_example; // String
let modifiedAfter = modifiedAfter_example; // String
let author = []; // array[Integer]
let authorExclude = []; // array[Integer]
let before = before_example; // String
let modifiedBefore = modifiedBefore_example; // String
let exclude = []; // array[Integer]
let include = []; // array[Integer]
let searchSemantics = searchSemantics_example; // String
let offset = 56; // Integer
let order = asc; // String
let orderby = title; // String
let parent = []; // array[Integer]
let parentExclude = []; // array[Integer]
let searchColumns = []; // array[String]
let slug = ; // array[String]
let status = ["publish"]; // array[String]
let taxRelation = taxRelation_example; // String
let categories = Object; // Object
let categoriesExclude = Object; // Object
let tags = Object; // Object
let tagsExclude = Object; // Object
let ldGroupCategory = Object; // Object
let ldGroupCategoryExclude = Object; // Object
let ldGroupTag = Object; // Object
let ldGroupTagExclude = Object; // Object
let mut context = CourseGroupsApi::Context::default();
let result = client.getLdlmsV2CoursesGroupsById(id, context, page, perPage, search, after, modifiedAfter, author, authorExclude, before, modifiedBefore, exclude, include, searchSemantics, offset, order, orderby, parent, parentExclude, searchColumns, slug, status, taxRelation, categories, categoriesExclude, tags, tagsExclude, ldGroupCategory, ldGroupCategoryExclude, ldGroupTag, ldGroupTagExclude, &context).wait();
println!("{:?}", result);
}
| Name |
Description |
| context |
String
Scope under which the request is made; determines fields present in response.
|
| page |
Integer
Current page of the collection.
|
| per_page |
Integer
Maximum number of items to be returned in result set.
|
| search |
String
Limit results to those matching a string.
|
| after |
String
Limit response to posts published after a given ISO8601 compliant date.
|
| modified_after |
String
Limit response to posts modified after a given ISO8601 compliant date.
|
| author |
array[Integer]
Limit result set to posts assigned to specific authors.
|
| author_exclude |
array[Integer]
Ensure result set excludes posts assigned to specific authors.
|
| before |
String
Limit response to posts published before a given ISO8601 compliant date.
|
| modified_before |
String
Limit response to posts modified before a given ISO8601 compliant date.
|
| exclude |
array[Integer]
Ensure result set excludes specific IDs.
|
| include |
array[Integer]
Limit result set to specific IDs.
|
| search_semantics |
String
How to interpret the search input.
|
| offset |
Integer
Offset the result set by a specific number of items.
|
| order |
String
Order sort attribute ascending or descending.
|
| orderby |
String
Sort collection by post attribute.
|
| parent |
array[Integer]
Limit result set to items with particular parent IDs.
|
| parent_exclude |
array[Integer]
Limit result set to all items except those of a particular parent ID.
|
| search_columns |
array[String]
Array of column names to be searched.
|
| slug |
array[String]
Limit result set to posts with one or more specific slugs.
|
| status |
array[String]
Limit result set to posts assigned one or more statuses.
|
| tax_relation |
String
Limit result set based on relationship between multiple taxonomies.
|
| categories |
Object
Limit result set to items with specific terms assigned in the categories taxonomy.
|
| categories_exclude |
Object
Limit result set to items except those with specific terms assigned in the categories taxonomy.
|
| tags |
|
| tags_exclude |
|
| ld_group_category |
Object
Limit result set to items with specific terms assigned in the ld_group_category taxonomy.
|
| ld_group_category_exclude |
Object
Limit result set to items except those with specific terms assigned in the ld_group_category taxonomy.
|
| ld_group_tag |
Object
Limit result set to items with specific terms assigned in the ld_group_tag taxonomy.
|
| ld_group_tag_exclude |
Object
Limit result set to items except those with specific terms assigned in the ld_group_tag taxonomy.
|
