ParticipantApi: Participant operations

In BIDMCDigitalPsychiatry/LAMP-r: API Client for LAMP Platform

Description

LAMP.Participant

Format

An R6Class generator object

Methods

all Get the set of all participants. Get the set of all participants.

• @param transform character

• status code : 200 | 200 Success

• return type : array[object]

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

allByResearcher Get the set of all participants under a single researcher. Get the set of all participants under a single researcher.

• @param researcher.id character

• @param transform character

• status code : 200 | 200 Success

• return type : array[object]

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

allByStudy Get the set of all participants in a single study. Get the set of all participants in a single study.

• @param study.id character

• @param transform character

• status code : 200 | 200 Success

• return type : array[object]

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

create Create a new Participant for the given Study. Create a new Participant for the given Study.

• @param study.id character

• @param participant Participant

• status code : 200 | 200 Success

• return type : character

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

delete Delete a participant AND all owned data or event streams. Delete a participant AND all owned data or event streams.

• @param participant.id character

• status code : 200 | 200 Success

• return type : character

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

update Update a Participant's settings. Update a Participant's settings.

• @param participant.id character

• @param participant Participant

• status code : 200 | 200 Success

• return type : character

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

view Get a single participant, by identifier. Get a single participant, by identifier.

• @param participant.id character

• @param transform character

• status code : 200 | 200 Success

• return type : array[object]

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• ParticipantApi$new()

• ParticipantApi$all()

• ParticipantApi$allWithHttpInfo()

• ParticipantApi$allByResearcher()

• ParticipantApi$allByResearcherWithHttpInfo()

• ParticipantApi$allByStudy()

• ParticipantApi$allByStudyWithHttpInfo()

• ParticipantApi$create()

• ParticipantApi$createWithHttpInfo()

• ParticipantApi$delete()

• ParticipantApi$deleteWithHttpInfo()

• ParticipantApi$update()

• ParticipantApi$updateWithHttpInfo()

• ParticipantApi$view()

• ParticipantApi$viewWithHttpInfo()

• ParticipantApi$clone()

---

Method new()

Usage

ParticipantApi$new(apiClient)

---

Method all()

Usage

ParticipantApi$all(transform = NULL, ...)

---

Method allWithHttpInfo()

Usage

ParticipantApi$allWithHttpInfo(transform = NULL, ...)

---

Method allByResearcher()

Usage

ParticipantApi$allByResearcher(researcher.id, transform = NULL, ...)

---

Method allByResearcherWithHttpInfo()

Usage

ParticipantApi$allByResearcherWithHttpInfo(
  researcher.id,
  transform = NULL,
  ...
)

---

Method allByStudy()

Usage

ParticipantApi$allByStudy(study.id, transform = NULL, ...)

---

Method allByStudyWithHttpInfo()

Usage

ParticipantApi$allByStudyWithHttpInfo(study.id, transform = NULL, ...)

---

Method create()

Usage

ParticipantApi$create(study.id, participant, ...)

---

Method createWithHttpInfo()

Usage

ParticipantApi$createWithHttpInfo(study.id, participant, ...)

---

Method delete()

Usage

ParticipantApi$delete(participant.id, ...)

---

Method deleteWithHttpInfo()

Usage

ParticipantApi$deleteWithHttpInfo(participant.id, ...)

---

Method update()

Usage

ParticipantApi$update(participant.id, participant, ...)

---

Method updateWithHttpInfo()

Usage

ParticipantApi$updateWithHttpInfo(participant.id, participant, ...)

---

Method view()

Usage

ParticipantApi$view(participant.id, transform = NULL, ...)

---

Method viewWithHttpInfo()

Usage

ParticipantApi$viewWithHttpInfo(participant.id, transform = NULL, ...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ParticipantApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
####################  all  ####################

library(LAMP)

#Get the set of all participants.
result <- LAMP.Participant$all()


####################  allByResearcher  ####################

library(LAMP)
var.researcher.id <- 'researcher.id_example' # character | 

#Get the set of all participants under a single researcher.
result <- LAMP.Participant$allByResearcher(var.researcher.id)


####################  allByStudy  ####################

library(LAMP)
var.study.id <- 'study.id_example' # character | 

#Get the set of all participants in a single study.
result <- LAMP.Participant$allByStudy(var.study.id)


####################  create  ####################

library(LAMP)
var.study.id <- 'study.id_example' # character | 
var.participant <- Participant$new() # Participant | 

#Create a new Participant for the given Study.
result <- LAMP.Participant$create(var.study.id, var.participant)


####################  delete  ####################

library(LAMP)
var.participant.id <- 'participant.id_example' # character | 

#Delete a participant AND all owned data or event streams.
result <- LAMP.Participant$delete(var.participant.id)


####################  update  ####################

library(LAMP)
var.participant.id <- 'participant.id_example' # character | 
var.participant <- Participant$new() # Participant | 

#Update a Participant's settings.
result <- LAMP.Participant$update(var.participant.id, var.participant)


####################  view  ####################

library(LAMP)
var.participant.id <- 'participant.id_example' # character | 

#Get a single participant, by identifier.
result <- LAMP.Participant$view(var.participant.id)



## End(Not run)

BIDMCDigitalPsychiatry/LAMP-r documentation built on April 29, 2020, 9:51 a.m.