PlagiarismService

class PlagiarismService

Methods

get	Get a .models.PlagiarismRun.
delete	Delete a given plagiarism run and all its cases.
get_cases	Get all the .models.PlagiarismCase`s for the given `.models.PlagiarismRun.

get(*, plagiarism_id, extra_parameters=None)

Get a .models.PlagiarismRun.

Parameters:

• plagiarism_id (int) – The of the plagiarism run.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (PlagiarismService[AuthenticatedClient]) –

Returns:

An single plagiarism run.

Return type:

PlagiarismRun

delete(*, plagiarism_id, extra_parameters=None)

Delete a given plagiarism run and all its cases.

This is irreversible, so make sure the user really wants this!

Parameters:

• plagiarism_id (int) – The id of the run to delete.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (PlagiarismService[AuthenticatedClient]) –

Returns:

Nothing.

Return type:

None

get_cases(*, plagiarism_id, offset=Nothing, limit=25, extra_parameters=None)

Get all the .models.PlagiarismCase`s for the given `.models.PlagiarismRun.

Parameters:

• plagiarism_id (int) – The of the plagiarism run.

• offset (Union[Just[int], _Nothing[int]]) – The amount of cases that should be skipped, only used when limit is given. Defaults to 0.

• limit (int) – The amount of cases to get. Defaults to infinity.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (PlagiarismService[AuthenticatedClient]) –

Returns:

An array of JSON serialized plagiarism cases.

Return type:

Sequence[PlagiarismCase]