Skip to main content

Hint API

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

MethodHTTP requestDescription
hintScoresIncrementPOST /hint/{hint}/scores/increment'/hint/{hint}/scores/increment' [POST]
hintSpecificHintSnapshotGET /hint/{hint}/hint/{hint} [POST]
hintUpdatePOST /hint/update/hint/update [POST]

hintScoresIncrement

hintScoresIncrement(hint, seededScoreIncrement)

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

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

Example

// Import classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = HintApi()
val hint : kotlin.String = hint_example // kotlin.String | This is a specific hint uuid
val seededScoreIncrement : SeededScoreIncrement = // SeededScoreIncrement |
try {
apiInstance.hintScoresIncrement(hint, seededScoreIncrement)
} catch (e: ClientException) {
println("4xx response calling HintApi#hintScoresIncrement")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HintApi#hintScoresIncrement")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
hintkotlin.StringThis is a specific hint uuid
seededScoreIncrementSeededScoreIncrement[optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

hintSpecificHintSnapshot

Hint hintSpecificHintSnapshot(hint)

/hint/{hint} [POST]

This will get a snapshot of a specific hint.

Example

// Import classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = HintApi()
val hint : kotlin.String = hint_example // kotlin.String | This is a specific hint uuid
try {
val result : Hint = apiInstance.hintSpecificHintSnapshot(hint)
println(result)
} catch (e: ClientException) {
println("4xx response calling HintApi#hintSpecificHintSnapshot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HintApi#hintSpecificHintSnapshot")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
hintkotlin.StringThis is a specific hint uuid

Return type

Hint

Authorization

No authorization required

HTTP request headers

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

hintUpdate

Hint hintUpdate(hint)

/hint/update [POST]

This will update a specific hint.

Example

// Import classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = HintApi()
val hint : Hint = // Hint |
try {
val result : Hint = apiInstance.hintUpdate(hint)
println(result)
} catch (e: ClientException) {
println("4xx response calling HintApi#hintUpdate")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HintApi#hintUpdate")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
hintHint[optional]

Return type

Hint

Authorization

No authorization required

HTTP request headers

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