Skip to content

Latest commit

 

History

History
428 lines (312 loc) · 11.6 KB

ActivityAPI.md

File metadata and controls

428 lines (312 loc) · 11.6 KB

ActivityAPI

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

Method HTTP request Description
activityAll GET /activity Get the set of all activities.
activityAllByParticipant GET /participant/{participant_id}/activity Get all activities for a participant.
activityAllByResearcher GET /researcher/{researcher_id}/activity Get all activities for a researcher.
activityAllByStudy GET /study/{study_id}/activity Get all activities in a study.
activityCreate POST /study/{study_id}/activity Create a new Activity under the given Study.
activityDelete DELETE /activity/{activity_id} Delete an Activity.
activityUpdate PUT /activity/{activity_id} Update an Activity's settings.
activityView GET /activity/{activity_id} Get a single activity, by identifier.

activityAll

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

Get the set of all activities.

Get the set of all activities.

Example

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

val apiInstance = ActivityAPI()
val transform : kotlin.String = transform_example // kotlin.String | 
try {
    val result : kotlin.Array<kotlin.Any> = apiInstance.activityAll(transform)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ActivityAPI#activityAll")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ActivityAPI#activityAll")
    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

activityAllByParticipant

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

Get all activities for a participant.

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

Example

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

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

activityAllByResearcher

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

Get all activities for a researcher.

Get the set of all activities 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 = ActivityAPI()
val researcherId : kotlin.String = researcherId_example // kotlin.String | 
val transform : kotlin.String = transform_example // kotlin.String | 
try {
    val result : kotlin.Array<kotlin.Any> = apiInstance.activityAllByResearcher(researcherId, transform)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ActivityAPI#activityAllByResearcher")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ActivityAPI#activityAllByResearcher")
    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

activityAllByStudy

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

Get all activities in a study.

Get the set of all activities 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 = ActivityAPI()
val studyId : kotlin.String = studyId_example // kotlin.String | 
val transform : kotlin.String = transform_example // kotlin.String | 
try {
    val result : kotlin.Array<kotlin.Any> = apiInstance.activityAllByStudy(studyId, transform)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ActivityAPI#activityAllByStudy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ActivityAPI#activityAllByStudy")
    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

activityCreate

kotlin.String activityCreate(studyId, activity)

Create a new Activity under the given Study.

Create a new Activity under the given Study.

Example

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

val apiInstance = ActivityAPI()
val studyId : kotlin.String = studyId_example // kotlin.String | 
val activity : Activity =  // Activity | 
try {
    val result : kotlin.String = apiInstance.activityCreate(studyId, activity)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ActivityAPI#activityCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ActivityAPI#activityCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
studyId kotlin.String
activity Activity

Return type

kotlin.String

Authorization

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

HTTP request headers

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

activityDelete

kotlin.String activityDelete(activityId)

Delete an Activity.

Delete an Activity.

Example

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

val apiInstance = ActivityAPI()
val activityId : kotlin.String = activityId_example // kotlin.String | 
try {
    val result : kotlin.String = apiInstance.activityDelete(activityId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ActivityAPI#activityDelete")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ActivityAPI#activityDelete")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
activityId 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

activityUpdate

kotlin.String activityUpdate(activityId, activity)

Update an Activity's settings.

Update an Activity's settings.

Example

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

val apiInstance = ActivityAPI()
val activityId : kotlin.String = activityId_example // kotlin.String | 
val activity : Activity =  // Activity | 
try {
    val result : kotlin.String = apiInstance.activityUpdate(activityId, activity)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ActivityAPI#activityUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ActivityAPI#activityUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
activityId kotlin.String
activity Activity

Return type

kotlin.String

Authorization

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

HTTP request headers

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

activityView

kotlin.Array<kotlin.Any> activityView(activityId, transform)

Get a single activity, by identifier.

Get a single activity, by identifier.

Example

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

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

Parameters

Name Type Description Notes
activityId 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