knowgo.api.JourneysApi

Load the API package

import 'package:knowgo/api.dart';

All URIs are relative to https://api.adaptant.io/v1

Method	HTTP request	Description
addClassificationToJourney	POST /journeys/{journeyId}/classifications/{classificationId}	Add a new Journey classification for a specific Journey
addJourney	POST /journeys	Add a new Journey
createJourneyClassification	POST /journeys/classifications	Create a Journey classification
deleteJourney	DELETE /journeys/{journeyId}	Delete Journey by ID
deleteJourneyClassification	DELETE /journeys/classifications/{classificationId}	Delete specified Journey classification
getJourneyById	GET /journeys/{journeyId}	Find journey by ID
getJourneyClassificationById	GET /journeys/classifications/{classificationId}	Get Journey classification by classification id
listJourneyClassifications	GET /journeys/classifications	Return a list of Journey classifications available for a specific user
listJourneyClassificationsByJourneyId	GET /journeys/{journeyId}/classifications	Return a list of Journey classifications for a specific Journey
listJourneys	GET /journeys	Return a list of journeys available for a specific user
listJourneysByUserId	GET /users/{userId}/journeys	Return a list of journeys available for a specific user
removeClassificationFromJourney	DELETE /journeys/{journeyId}/classifications/{classificationId}	Remove a specific classification from a Journey
updateJourneyClassificationById	PUT /journeys/classifications/{classificationId}	Update a specified Journey classification
updateJourneyWithForm	POST /journeys/{journeyId}	Updates a Journey with form data

addClassificationToJourney

addClassificationToJourney(journeyId, classificationId)

Add a new Journey classification for a specific Journey

Example

import 'package:knowgo/api.dart';
// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = JourneysApi();
var journeyId = journeyId_example; // String | ID of Journey that needs to be fetched
var classificationId = 56; // int | ID of classification that needs to be added

try { 
    api_instance.addClassificationToJourney(journeyId, classificationId);
} catch (e) {
    print("Exception when calling JourneysApi->addClassificationToJourney: $e\n");
}

Parameters

Name	Type	Description	Notes
journeyId	String	ID of Journey that needs to be fetched	[default to null]
classificationId	int	ID of classification that needs to be added	[default to null]

Return type

void (empty response body)

Authorization

app_id, bearerAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

addJourney

Journey addJourney(journey)

Add a new Journey

Adds a new Journey to the system. The JourneyID as input is ignored, as it is dynamically allocated at insertion time. Journey details may be as complete or as incomplete as needed, with later updates possible via the PUT method. The complete new Journey record with allocated JourneyID are returned upon successful record creation.

Example

import 'package:knowgo/api.dart';
// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = JourneysApi();
var journey = Journey(); // Journey | Journey object to operate on

try { 
    var result = api_instance.addJourney(journey);
    print(result);
} catch (e) {
    print("Exception when calling JourneysApi->addJourney: $e\n");
}

Parameters

Name	Type	Description	Notes
journey	Journey	Journey object to operate on

Return type

Journey

Authorization

app_id, bearerAuth, cookieAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

createJourneyClassification

JourneyClassifications createJourneyClassification(journeyClassifications)

Create a Journey classification

Example

import 'package:knowgo/api.dart';
// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = JourneysApi();
var journeyClassifications = JourneyClassifications(); // JourneyClassifications | 

try { 
    var result = api_instance.createJourneyClassification(journeyClassifications);
    print(result);
} catch (e) {
    print("Exception when calling JourneysApi->createJourneyClassification: $e\n");
}

Parameters

Name	Type	Description	Notes
journeyClassifications	JourneyClassifications

Return type

JourneyClassifications

Authorization

app_id, bearerAuth, cookieAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

deleteJourney

deleteJourney(journeyId)

Delete Journey by ID

Manual deletion of a defined Journey based on its journeyId.

Example

import 'package:knowgo/api.dart';
// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = JourneysApi();
var journeyId = journeyId_example; // String | ID of the journey to delete

try { 
    api_instance.deleteJourney(journeyId);
} catch (e) {
    print("Exception when calling JourneysApi->deleteJourney: $e\n");
}

Parameters

Name	Type	Description	Notes
journeyId	String	ID of the journey to delete	[default to null]

Return type

void (empty response body)

Authorization

app_id, bearerAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

deleteJourneyClassification

deleteJourneyClassification(classificationId)

Delete specified Journey classification

Example

import 'package:knowgo/api.dart';
// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = JourneysApi();
var classificationId = 789; // int | ID of Journey Classification that needs to be fetched

try { 
    api_instance.deleteJourneyClassification(classificationId);
} catch (e) {
    print("Exception when calling JourneysApi->deleteJourneyClassification: $e\n");
}

Parameters

Name	Type	Description	Notes
classificationId	int	ID of Journey Classification that needs to be fetched	[default to null]

Return type

void (empty response body)

Authorization

app_id, bearerAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

getJourneyById

Journey getJourneyById(journeyId)

Find journey by ID

Example

import 'package:knowgo/api.dart';
// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = JourneysApi();
var journeyId = journeyId_example; // String | ID of journey that needs to be fetched

try { 
    var result = api_instance.getJourneyById(journeyId);
    print(result);
} catch (e) {
    print("Exception when calling JourneysApi->getJourneyById: $e\n");
}

Parameters

Name	Type	Description	Notes
journeyId	String	ID of journey that needs to be fetched	[default to null]

Return type

Journey

Authorization

app_id, bearerAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getJourneyClassificationById

JourneyClassifications getJourneyClassificationById(classificationId)

Get Journey classification by classification id

Example

import 'package:knowgo/api.dart';
// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = JourneysApi();
var classificationId = 789; // int | ID of Journey Classification that needs to be fetched

try { 
    var result = api_instance.getJourneyClassificationById(classificationId);
    print(result);
} catch (e) {
    print("Exception when calling JourneysApi->getJourneyClassificationById: $e\n");
}

Parameters

Name	Type	Description	Notes
classificationId	int	ID of Journey Classification that needs to be fetched	[default to null]

Return type

JourneyClassifications

Authorization

app_id, bearerAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

listJourneyClassifications

List listJourneyClassifications()

Return a list of Journey classifications available for a specific user

Given an authenticated user, return a list of Journey classifications that are available to them.

Example

import 'package:knowgo/api.dart';
// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = JourneysApi();

try { 
    var result = api_instance.listJourneyClassifications();
    print(result);
} catch (e) {
    print("Exception when calling JourneysApi->listJourneyClassifications: $e\n");
}

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

app_id, bearerAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

listJourneyClassificationsByJourneyId

List listJourneyClassificationsByJourneyId(journeyId)

Return a list of Journey classifications for a specific Journey

Given an authenticated user, return a list of Journey classificiations that are available to them within the context of a specific Journey.

Example

import 'package:knowgo/api.dart';
// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = JourneysApi();
var journeyId = journeyId_example; // String | ID of Journey that needs to be fetched

try { 
    var result = api_instance.listJourneyClassificationsByJourneyId(journeyId);
    print(result);
} catch (e) {
    print("Exception when calling JourneysApi->listJourneyClassificationsByJourneyId: $e\n");
}

Parameters

Name	Type	Description	Notes
journeyId	String	ID of Journey that needs to be fetched	[default to null]

Return type

List

Authorization

app_id, bearerAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

listJourneys

List listJourneys()

Return a list of journeys available for a specific user

Given an authenticated user, return a list of journeys that are available to them.

Example

import 'package:knowgo/api.dart';
// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = JourneysApi();

try { 
    var result = api_instance.listJourneys();
    print(result);
} catch (e) {
    print("Exception when calling JourneysApi->listJourneys: $e\n");
}

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

app_id, bearerAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

listJourneysByUserId

List listJourneysByUserId(userId)

Return a list of journeys available for a specific user

Given an authenticated user, return a list of journeys that are available to them.

Example

import 'package:knowgo/api.dart';
// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = JourneysApi();
var userId = 789; // int | ID of user that needs to be fetched

try { 
    var result = api_instance.listJourneysByUserId(userId);
    print(result);
} catch (e) {
    print("Exception when calling JourneysApi->listJourneysByUserId: $e\n");
}

Parameters

Name	Type	Description	Notes
userId	int	ID of user that needs to be fetched	[default to null]

Return type

List

Authorization

app_id, bearerAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

removeClassificationFromJourney

removeClassificationFromJourney(journeyId, classificationId)

Remove a specific classification from a Journey

Example

import 'package:knowgo/api.dart';
// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = JourneysApi();
var journeyId = journeyId_example; // String | ID of Journey that needs to be fetched
var classificationId = 56; // int | ID of classification that needs to be removed

try { 
    api_instance.removeClassificationFromJourney(journeyId, classificationId);
} catch (e) {
    print("Exception when calling JourneysApi->removeClassificationFromJourney: $e\n");
}

Parameters

Name	Type	Description	Notes
journeyId	String	ID of Journey that needs to be fetched	[default to null]
classificationId	int	ID of classification that needs to be removed	[default to null]

Return type

void (empty response body)

Authorization

app_id, bearerAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

updateJourneyClassificationById

updateJourneyClassificationById(classificationId, journeyClassifications)

Update a specified Journey classification

Example

import 'package:knowgo/api.dart';
// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = JourneysApi();
var classificationId = 789; // int | ID of Journey Classification that needs to be fetched
var journeyClassifications = JourneyClassifications(); // JourneyClassifications | Updated Journey classification object

try { 
    api_instance.updateJourneyClassificationById(classificationId, journeyClassifications);
} catch (e) {
    print("Exception when calling JourneysApi->updateJourneyClassificationById: $e\n");
}

Parameters

Name	Type	Description	Notes
classificationId	int	ID of Journey Classification that needs to be fetched	[default to null]
journeyClassifications	JourneyClassifications	Updated Journey classification object

Return type

void (empty response body)

Authorization

app_id, bearerAuth, cookieAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

updateJourneyWithForm

updateJourneyWithForm(journeyId, journey)

Updates a Journey with form data

Example

import 'package:knowgo/api.dart';
// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = JourneysApi();
var journeyId = journeyId_example; // String | ID of journey that needs to be updated
var journey = Journey(); // Journey | Journey object to operate on

try { 
    api_instance.updateJourneyWithForm(journeyId, journey);
} catch (e) {
    print("Exception when calling JourneysApi->updateJourneyWithForm: $e\n");
}

Parameters

Name	Type	Description	Notes
journeyId	String	ID of journey that needs to be updated	[default to null]
journey	Journey	Journey object to operate on

Return type

void (empty response body)

Authorization

app_id, bearerAuth, cookieAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

Files

JourneysApi.md

Latest commit

History

JourneysApi.md

File metadata and controls

knowgo.api.JourneysApi

Load the API package

addClassificationToJourney

Example

Parameters

Return type

Authorization

HTTP request headers

addJourney

Example

Parameters

Return type

Authorization

HTTP request headers

createJourneyClassification

Example

Parameters

Return type

Authorization

HTTP request headers

deleteJourney

Example

Parameters

Return type

Authorization

HTTP request headers

deleteJourneyClassification

Example

Parameters

Return type

Authorization

HTTP request headers

getJourneyById

Example

Parameters

Return type

Authorization

HTTP request headers

getJourneyClassificationById

Example

Parameters

Return type

Authorization

HTTP request headers

listJourneyClassifications

Example

Parameters

Return type

Authorization

HTTP request headers

listJourneyClassificationsByJourneyId

Example

Parameters

Return type

Authorization

HTTP request headers

listJourneys

Example

Parameters

Return type

Authorization

HTTP request headers

listJourneysByUserId

Example

Parameters

Return type

Authorization

HTTP request headers

removeClassificationFromJourney

Example

Parameters

Return type

Authorization

HTTP request headers