Skip to content

Latest commit

 

History

History
269 lines (185 loc) · 7.35 KB

ResearcherAPI.md

File metadata and controls

269 lines (185 loc) · 7.35 KB

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

    open class func researcherAll(transform: String? = nil, completion: @escaping (_ data: [Any]?, _ error: Error?) -> Void)

Get the set of all researchers.

Get the set of all researchers.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import LAMP

let transform = "transform_example" // String |  (optional)

// Get the set of all researchers.
ResearcherAPI.researcherAll(transform: transform) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
transform String [optional]

Return type

[Any]

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

researcherCreate

    open class func researcherCreate(researcher: Researcher, completion: @escaping (_ data: String?, _ error: Error?) -> Void)

Create a new Researcher.

Create a new Researcher.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import LAMP

let researcher = Researcher(_id: "_id_example", name: "name_example", email: "email_example", address: "address_example", studies: [123]) // Researcher | 

// Create a new Researcher.
ResearcherAPI.researcherCreate(researcher: researcher) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
researcher Researcher

Return type

String

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

researcherDelete

    open class func researcherDelete(researcherId: String, completion: @escaping (_ data: String?, _ error: Error?) -> Void)

Delete a researcher.

Delete a researcher.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import LAMP

let researcherId = "researcherId_example" // String | 

// Delete a researcher.
ResearcherAPI.researcherDelete(researcherId: researcherId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
researcherId String

Return type

String

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

researcherUpdate

    open class func researcherUpdate(researcherId: String, researcher: Researcher, transform: String? = nil, completion: @escaping (_ data: String?, _ error: Error?) -> Void)

Update a Researcher's settings.

Update a Researcher's settings.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import LAMP

let researcherId = "researcherId_example" // String | 
let researcher = Researcher(_id: "_id_example", name: "name_example", email: "email_example", address: "address_example", studies: [123]) // Researcher | 
let transform = "transform_example" // String |  (optional)

// Update a Researcher's settings.
ResearcherAPI.researcherUpdate(researcherId: researcherId, researcher: researcher, transform: transform) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

String

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

researcherView

    open class func researcherView(researcherId: String, transform: String? = nil, completion: @escaping (_ data: [Any]?, _ error: Error?) -> Void)

Get a single researcher, by identifier.

Get a single researcher, by identifier.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import LAMP

let researcherId = "researcherId_example" // String | 
let transform = "transform_example" // String |  (optional)

// Get a single researcher, by identifier.
ResearcherAPI.researcherView(researcherId: researcherId, transform: transform) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
researcherId String
transform String [optional]

Return type

[Any]

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]