Skip to main content

Activities API

All URIs are relative to http://localhost:1000

MethodHTTP requestDescription
activitiesCreateNewActivityPOST /activities/create/activities/create [POST]
activitiesDeleteSpecificActivityPOST /activities/{activity}/delete/activities/{activity}/delete [POST]
activitiesSnapshotGET /activities/activities [GET]

activitiesCreateNewActivity

Activity activitiesCreateNewActivity(transferables, seededActivity)

/activities/create [POST]

This will create a new Activity.

Example

import 'package:core_openapi/api.dart';

final api_instance = ActivitiesApi();
final transferables = true; // bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)
final seededActivity = SeededActivity(); // SeededActivity |

try {
final result = api_instance.activitiesCreateNewActivity(transferables, seededActivity);
print(result);
} catch (e) {
print('Exception when calling ActivitiesApi->activitiesCreateNewActivity: $e\n');
}

Parameters

NameTypeDescriptionNotes
transferablesboolThis is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)[optional]
seededActivitySeededActivity[optional]

Return type

Activity

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/plain

activitiesDeleteSpecificActivity

activitiesDeleteSpecificActivity(activity)

/activities/{activity}/delete [POST]

This will delete a specific activity. important note: if we delete an activity: that is going to be a generic or a specific/ we will also delete its counter part i.e the specific. and vise versa, this ensures that the references are always cleaned.

Example

import 'package:core_openapi/api.dart';

final api_instance = ActivitiesApi();
final activity = activity_example; // String | This is a specific activity uuid.

try {
api_instance.activitiesDeleteSpecificActivity(activity);
} catch (e) {
print('Exception when calling ActivitiesApi->activitiesDeleteSpecificActivity: $e\n');
}

Parameters

NameTypeDescriptionNotes
activityStringThis is a specific activity uuid.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

activitiesSnapshot

Activities activitiesSnapshot(transferables, pseudo)

/activities [GET]

This will get a snapshot of all of the activities

Example

import 'package:core_openapi/api.dart';

final api_instance = ActivitiesApi();
final transferables = true; // bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)
final pseudo = true; // bool | This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false.

try {
final result = api_instance.activitiesSnapshot(transferables, pseudo);
print(result);
} catch (e) {
print('Exception when calling ActivitiesApi->activitiesSnapshot: $e\n');
}

Parameters

NameTypeDescriptionNotes
transferablesboolThis is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)[optional]
pseudoboolThis is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false.[optional]

Return type

Activities

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain