Skip to content

Latest commit

 

History

History
428 lines (312 loc) · 11.3 KB

SensorAPI.md

File metadata and controls

428 lines (312 loc) · 11.3 KB

SensorAPI

All URIs are relative to https://api.lamp.digital

Method HTTP request Description
sensorAll GET /sensor Get the set of all sensors.
sensorAllByParticipant GET /participant/{participant_id}/sensor Get all sensors for a participant.
sensorAllByResearcher GET /researcher/{researcher_id}/sensor Get all sensors for a researcher.
sensorAllByStudy GET /study/{study_id}/sensor View all sensors in a study.
sensorCreate POST /study/{study_id}/sensor Create a new Sensor under the given Study.
sensorDelete DELETE /sensor/{sensor_id} Delete a Sensor.
sensorUpdate PUT /sensor/{sensor_id} Update an Sensor's settings.
sensorView GET /sensor/{sensor_id} Get a single sensor, by identifier.

sensorAll

kotlin.Array<kotlin.Any> sensorAll(transform)

Get the set of all sensors.

Get the set of all sensors.

Example

// Import classes:
//import digital.lamp.lamp-core.infrastructure.*
//import digital.lamp.lamp-core.models.*

val apiInstance = SensorAPI()
val transform : kotlin.String = transform_example // kotlin.String | 
try {
    val result : kotlin.Array<kotlin.Any> = apiInstance.sensorAll(transform)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SensorAPI#sensorAll")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SensorAPI#sensorAll")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
transform kotlin.String [optional]

Return type

kotlin.Array<kotlin.Any>

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

sensorAllByParticipant

kotlin.Array<kotlin.Any> sensorAllByParticipant(participantId, transform)

Get all sensors for a participant.

Get the set of all sensors available to a participant, by participant identifier.

Example

// Import classes:
//import digital.lamp.lamp-core.infrastructure.*
//import digital.lamp.lamp-core.models.*

val apiInstance = SensorAPI()
val participantId : kotlin.String = participantId_example // kotlin.String | 
val transform : kotlin.String = transform_example // kotlin.String | 
try {
    val result : kotlin.Array<kotlin.Any> = apiInstance.sensorAllByParticipant(participantId, transform)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SensorAPI#sensorAllByParticipant")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SensorAPI#sensorAllByParticipant")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
participantId kotlin.String
transform kotlin.String [optional]

Return type

kotlin.Array<kotlin.Any>

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

sensorAllByResearcher

kotlin.Array<kotlin.Any> sensorAllByResearcher(researcherId, transform)

Get all sensors for a researcher.

Get the set of all sensors available to participants of any study conducted by a researcher, by researcher identifier.

Example

// Import classes:
//import digital.lamp.lamp-core.infrastructure.*
//import digital.lamp.lamp-core.models.*

val apiInstance = SensorAPI()
val researcherId : kotlin.String = researcherId_example // kotlin.String | 
val transform : kotlin.String = transform_example // kotlin.String | 
try {
    val result : kotlin.Array<kotlin.Any> = apiInstance.sensorAllByResearcher(researcherId, transform)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SensorAPI#sensorAllByResearcher")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SensorAPI#sensorAllByResearcher")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
researcherId kotlin.String
transform kotlin.String [optional]

Return type

kotlin.Array<kotlin.Any>

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

sensorAllByStudy

kotlin.Array<kotlin.Any> sensorAllByStudy(studyId, transform)

View all sensors in a study.

Get the set of all sensors available to participants of a single study, by study identifier.

Example

// Import classes:
//import digital.lamp.lamp-core.infrastructure.*
//import digital.lamp.lamp-core.models.*

val apiInstance = SensorAPI()
val studyId : kotlin.String = studyId_example // kotlin.String | 
val transform : kotlin.String = transform_example // kotlin.String | 
try {
    val result : kotlin.Array<kotlin.Any> = apiInstance.sensorAllByStudy(studyId, transform)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SensorAPI#sensorAllByStudy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SensorAPI#sensorAllByStudy")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
studyId kotlin.String
transform kotlin.String [optional]

Return type

kotlin.Array<kotlin.Any>

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

sensorCreate

kotlin.String sensorCreate(studyId, sensor)

Create a new Sensor under the given Study.

Create a new Sensor under the given Study.

Example

// Import classes:
//import digital.lamp.lamp-core.infrastructure.*
//import digital.lamp.lamp-core.models.*

val apiInstance = SensorAPI()
val studyId : kotlin.String = studyId_example // kotlin.String | 
val sensor : Sensor =  // Sensor | 
try {
    val result : kotlin.String = apiInstance.sensorCreate(studyId, sensor)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SensorAPI#sensorCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SensorAPI#sensorCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
studyId kotlin.String
sensor Sensor

Return type

kotlin.String

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

sensorDelete

kotlin.String sensorDelete(sensorId)

Delete a Sensor.

Delete a Sensor.

Example

// Import classes:
//import digital.lamp.lamp-core.infrastructure.*
//import digital.lamp.lamp-core.models.*

val apiInstance = SensorAPI()
val sensorId : kotlin.String = sensorId_example // kotlin.String | 
try {
    val result : kotlin.String = apiInstance.sensorDelete(sensorId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SensorAPI#sensorDelete")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SensorAPI#sensorDelete")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
sensorId kotlin.String

Return type

kotlin.String

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

sensorUpdate

kotlin.String sensorUpdate(sensorId, sensor)

Update an Sensor's settings.

Update an Sensor's settings.

Example

// Import classes:
//import digital.lamp.lamp-core.infrastructure.*
//import digital.lamp.lamp-core.models.*

val apiInstance = SensorAPI()
val sensorId : kotlin.String = sensorId_example // kotlin.String | 
val sensor : Sensor =  // Sensor | 
try {
    val result : kotlin.String = apiInstance.sensorUpdate(sensorId, sensor)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SensorAPI#sensorUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SensorAPI#sensorUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
sensorId kotlin.String
sensor Sensor

Return type

kotlin.String

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

sensorView

kotlin.Array<kotlin.Any> sensorView(sensorId, transform)

Get a single sensor, by identifier.

Get a single sensor, by identifier.

Example

// Import classes:
//import digital.lamp.lamp-core.infrastructure.*
//import digital.lamp.lamp-core.models.*

val apiInstance = SensorAPI()
val sensorId : kotlin.String = sensorId_example // kotlin.String | 
val transform : kotlin.String = transform_example // kotlin.String | 
try {
    val result : kotlin.Array<kotlin.Any> = apiInstance.sensorView(sensorId, transform)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SensorAPI#sensorView")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SensorAPI#sensorView")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
sensorId kotlin.String
transform kotlin.String [optional]

Return type

kotlin.Array<kotlin.Any>

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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