Skip to main content

Hint API

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

MethodHTTP requestDescription
hint_scores_incrementPOST /hint/{hint}/scores/increment'/hint/{hint}/scores/increment' [POST]
hint_specific_hint_snapshotGET /hint/{hint}/hint/{hint} [POST]
hint_updatePOST /hint/update/hint/update [POST]

hint_scores_increment

hint_scores_increment(hint, seeded_score_increment=seeded_score_increment)

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

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

Example

import pieces_os_client
from pieces_os_client.models.seeded_score_increment import SeededScoreIncrement
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host="http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.HintApi(api_client)
hint = 'hint_example' # str | This is a specific hint uuid
seeded_score_increment = pieces_os_client.SeededScoreIncrement() # SeededScoreIncrement | (optional)

try:
# '/hint/\{hint\}/scores/increment' [POST]
api_instance.hint_scores_increment(hint, seeded_score_increment=seeded_score_increment)
except Exception as e:
print("Exception when calling HintApi->hint_scores_increment: %s\n" % e)

Parameters

NameTypeDescriptionNotes
hintstrThis is a specific hint uuid
seeded_score_incrementSeededScoreIncrement[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
204No Content-
500Internal Server Error-

hint_specific_hint_snapshot

Hint hint_specific_hint_snapshot(hint)

/hint/{hint} [POST]

This will get a snapshot of a specific hint.

Example

import pieces_os_client
from pieces_os_client.models.hint import Hint
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host="http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.HintApi(api_client)
hint = 'hint_example' # str | This is a specific hint uuid

try:
# /hint/\{hint\} [POST]
api_response = api_instance.hint_specific_hint_snapshot(hint)
print("The response of HintApi->hint_specific_hint_snapshot:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling HintApi->hint_specific_hint_snapshot: %s\n" % e)

Parameters

NameTypeDescriptionNotes
hintstrThis is a specific hint uuid

Return type

Hint

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

hint_update

Hint hint_update(hint=hint)

/hint/update [POST]

This will update a specific hint.

Example

import pieces_os_client
from pieces_os_client.models.hint import Hint
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host="http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.HintApi(api_client)
hint = pieces_os_client.Hint() # Hint | (optional)

try:
# /hint/update [POST]
api_response = api_instance.hint_update(hint=hint)
print("The response of HintApi->hint_update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling HintApi->hint_update: %s\n" % e)

Parameters

NameTypeDescriptionNotes
hintHint[optional]

Return type

Hint

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-