Skip to content

Latest commit

 

History

History
269 lines (195 loc) · 7 KB

ResearcherAPI.md

File metadata and controls

269 lines (195 loc) · 7 KB
Raw

ResearcherAPI

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

Method HTTP request Description
researcherAll GET /researcher Get the set of all researchers.
researcherCreate POST /researcher Create a new Researcher.
researcherDelete DELETE /researcher/{researcher_id} Delete a researcher.
researcherUpdate PUT /researcher/{researcher_id} Update a Researcher's settings.
researcherView GET /researcher/{researcher_id} Get a single researcher, by identifier.

researcherAll

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

Get the set of all researchers.

Get the set of all researchers.

Example

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

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

researcherCreate

kotlin.String researcherCreate(researcher)

Create a new Researcher.

Create a new Researcher.

Example

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

val apiInstance = ResearcherAPI()
val researcher : Researcher =  // Researcher | 
try {
    val result : kotlin.String = apiInstance.researcherCreate(researcher)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ResearcherAPI#researcherCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ResearcherAPI#researcherCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
researcher Researcher

Return type

kotlin.String

Authorization

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

HTTP request headers

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

researcherDelete

kotlin.String researcherDelete(researcherId)

Delete a researcher.

Delete a researcher.

Example

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

val apiInstance = ResearcherAPI()
val researcherId : kotlin.String = researcherId_example // kotlin.String | 
try {
    val result : kotlin.String = apiInstance.researcherDelete(researcherId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ResearcherAPI#researcherDelete")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ResearcherAPI#researcherDelete")
    e.printStackTrace()
}

Parameters

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

researcherUpdate

kotlin.String researcherUpdate(researcherId, researcher, transform)

Update a Researcher's settings.

Update a Researcher's settings.

Example

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

val apiInstance = ResearcherAPI()
val researcherId : kotlin.String = researcherId_example // kotlin.String | 
val researcher : Researcher =  // Researcher | 
val transform : kotlin.String = transform_example // kotlin.String | 
try {
    val result : kotlin.String = apiInstance.researcherUpdate(researcherId, researcher, transform)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ResearcherAPI#researcherUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ResearcherAPI#researcherUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.String

Authorization

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

HTTP request headers

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

researcherView

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

Get a single researcher, by identifier.

Get a single researcher, by identifier.

Example

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

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