Skip to main content

Person API

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

MethodHTTP requestDescription
personAssociateWorkstreamSummaryPOST /person/{person}/workstream_summaries/associate/{workstream_summary}/person/{person}/workstream_summaries/associate/{workstream_summary} [POST]
personDisassociateWorkstreamSummaryPOST /person/{person}/workstream_summaries/disassociate/{workstream_summary}/person/{person}/workstream_summaries/disassociate/{workstream_summary} [POST]
personScoresIncrementPOST /person/{person}/scores/increment'/person/{person}/scores/increment' [POST]
personSnapshotGET /person/{person}/person/{person} [GET]
updatePersonPOST /person/update/person/update [POST]

personAssociateWorkstreamSummary

personAssociateWorkstreamSummary(person, workstreamSummary)

/person/{person}/workstream_summaries/associate/{workstream_summary} [POST]

This will associate a person with a workstream summary. This will do the same thing as the workstreamSummary equivalent.

Example

import 'package:core_openapi/api.dart';

final api_instance = PersonApi();
final person = person_example; // String | This is a uuid that represents a person.
final workstreamSummary = workstreamSummary_example; // String | This is a identifier that is used to identify a specific workstream_summary.

try {
api_instance.personAssociateWorkstreamSummary(person, workstreamSummary);
} catch (e) {
print('Exception when calling PersonApi->personAssociateWorkstreamSummary: $e\n');
}

Parameters

NameTypeDescriptionNotes
personStringThis is a uuid that represents a person.
workstreamSummaryStringThis is a identifier that is used to identify a specific workstream_summary.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

personDisassociateWorkstreamSummary

personDisassociateWorkstreamSummary(person, workstreamSummary)

/person/{person}/workstream_summaries/disassociate/{workstream_summary} [POST]

This will enable us to disassociate an person from a workstream summary. This will do the same thing as the workstreamSummary equivalent.

Example

import 'package:core_openapi/api.dart';

final api_instance = PersonApi();
final person = person_example; // String | This is a uuid that represents a person.
final workstreamSummary = workstreamSummary_example; // String | This is a identifier that is used to identify a specific workstream_summary.

try {
api_instance.personDisassociateWorkstreamSummary(person, workstreamSummary);
} catch (e) {
print('Exception when calling PersonApi->personDisassociateWorkstreamSummary: $e\n');
}

Parameters

NameTypeDescriptionNotes
personStringThis is a uuid that represents a person.
workstreamSummaryStringThis is a identifier that is used to identify a specific workstream_summary.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

personScoresIncrement

personScoresIncrement(person, seededScoreIncrement)

'/person/{person}/scores/increment' [POST]

This will take in a SeededScoreIncrement and will increment the material relative to the incoming body.

Example

import 'package:core_openapi/api.dart';

final api_instance = PersonApi();
final person = person_example; // String | This is a uuid that represents a person.
final seededScoreIncrement = SeededScoreIncrement(); // SeededScoreIncrement |

try {
api_instance.personScoresIncrement(person, seededScoreIncrement);
} catch (e) {
print('Exception when calling PersonApi->personScoresIncrement: $e\n');
}

Parameters

NameTypeDescriptionNotes
personStringThis is a uuid that represents a person.
seededScoreIncrementSeededScoreIncrement[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

personSnapshot

Person personSnapshot(person, transferables)

/person/{person} [GET]

This will get a snapshot of a specific person

Example

import 'package:core_openapi/api.dart';

final api_instance = PersonApi();
final person = person_example; // String | This is a uuid that represents a person.
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)

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

Parameters

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

Return type

Person

Authorization

No authorization required

HTTP request headers

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

updatePerson

Person updatePerson(transferables, person)

/person/update [POST]

This will update a specific person

Example

import 'package:core_openapi/api.dart';

final api_instance = PersonApi();
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 person = Person(); // Person |

try {
final result = api_instance.updatePerson(transferables, person);
print(result);
} catch (e) {
print('Exception when calling PersonApi->updatePerson: $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]
personPerson[optional]

Return type

Person

Authorization

No authorization required

HTTP request headers

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