ResearcherApi: Researcher operations

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

Description

LAMP.Researcher

Format

An R6Class generator object

Methods

all Get the set of all researchers. Get the set of all researchers.

• @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 Researcher. Create a new Researcher.

• @param researcher Researcher

• 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 researcher. Delete a researcher.

• @param researcher.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 Researcher's settings. Update a Researcher's settings.

• @param researcher.id character

• @param researcher Researcher

• @param transform 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 :

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

• @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 :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• ResearcherApi$new()

• ResearcherApi$all()

• ResearcherApi$allWithHttpInfo()

• ResearcherApi$create()

• ResearcherApi$createWithHttpInfo()

• ResearcherApi$delete()

• ResearcherApi$deleteWithHttpInfo()

• ResearcherApi$update()

• ResearcherApi$updateWithHttpInfo()

• ResearcherApi$view()

• ResearcherApi$viewWithHttpInfo()

• ResearcherApi$clone()

---

Method new()

Usage

ResearcherApi$new(apiClient)

---

Method all()

Usage

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

---

Method allWithHttpInfo()

Usage

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

---

Method create()

Usage

ResearcherApi$create(researcher, ...)

---

Method createWithHttpInfo()

Usage

ResearcherApi$createWithHttpInfo(researcher, ...)

---

Method delete()

Usage

ResearcherApi$delete(researcher.id, ...)

---

Method deleteWithHttpInfo()

Usage

ResearcherApi$deleteWithHttpInfo(researcher.id, ...)

---

Method update()

Usage

ResearcherApi$update(researcher.id, researcher, transform = NULL, ...)

---

Method updateWithHttpInfo()

Usage

ResearcherApi$updateWithHttpInfo(
  researcher.id,
  researcher,
  transform = NULL,
  ...
)

---

Method view()

Usage

ResearcherApi$view(researcher.id, transform = NULL, ...)

---

Method viewWithHttpInfo()

Usage

ResearcherApi$viewWithHttpInfo(researcher.id, transform = NULL, ...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ResearcherApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

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

library(LAMP)

#Get the set of all researchers.
result <- LAMP.Researcher$all()


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

library(LAMP)
var.researcher <- Researcher$new() # Researcher | 

#Create a new Researcher.
result <- LAMP.Researcher$create(var.researcher)


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

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

#Delete a researcher.
result <- LAMP.Researcher$delete(var.researcher.id)


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

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

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


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

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

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



## End(Not run)

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