InstitutionsApi

All URIs are relative to https://api.molecularmatch.com/v4

Method	HTTP request	Description
deleteInstitution	DELETE /institution/{id}	Delete an institution
deletePrivateTrial	DELETE /institution/{id}/trial/{trialId}	Delete a private trial
getInstitution	GET /institution/{id}	Get an institution
getInstitutionStatus	GET /institution/{id}/status	Get an institution record's status
getInstitutions	GET /institutions	Get a paginated list of institutions
getPrivateTrial	GET /institution/{id}/trial/{trialId}	Get a private trial
getPrivateTrialStatus	GET /institution/{id}/trial/{trialId}/status	Get a private trial record's status
getPrivateTrials	GET /institution/{id}/trials	Get a paginated list of private
postInstitution	POST /institution	Create an institution
postPrivateTrial	POST /institution/{id}/trial	Create a private trial
putInstitution	PUT /institution/{id}	Put/Update an institution
putPrivateTrial	PUT /institution/{id}/trial/{trialId}	Put/Update a private trial

deleteInstitution

Institution deleteInstitution(id)

Delete an institution

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.InstitutionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


InstitutionsApi apiInstance = new InstitutionsApi();
String id = "id_example"; // String | ID of the Institution to delete
try {
    Institution result = apiInstance.deleteInstitution(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InstitutionsApi#deleteInstitution");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	ID of the Institution to delete

Return type

Institution

HTTP request headers

Content-Type: Not defined
Accept: application/json

deletePrivateTrial

PrivateTrial deletePrivateTrial(id, trialId)

Delete a private trial

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.InstitutionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


InstitutionsApi apiInstance = new InstitutionsApi();
String id = "id_example"; // String | ID of the Institution governing the private trial
String trialId = "trialId_example"; // String | ID of the private trial to delete
try {
    PrivateTrial result = apiInstance.deletePrivateTrial(id, trialId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InstitutionsApi#deletePrivateTrial");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	ID of the Institution governing the private trial
trialId	String	ID of the private trial to delete

Return type

PrivateTrial

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstitution

Institution getInstitution(id)

Get an institution

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.InstitutionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


InstitutionsApi apiInstance = new InstitutionsApi();
String id = "id_example"; // String | ID of the Institution to return
try {
    Institution result = apiInstance.getInstitution(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InstitutionsApi#getInstitution");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	ID of the Institution to return

Return type

Institution

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstitutionStatus

Institution getInstitutionStatus(id)

Get an institution record's status

Get an institution status

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.InstitutionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


InstitutionsApi apiInstance = new InstitutionsApi();
String id = "id_example"; // String | ID of the Institution to return status for
try {
    Institution result = apiInstance.getInstitutionStatus(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InstitutionsApi#getInstitutionStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	ID of the Institution to return status for

Return type

Institution

HTTP request headers

Content-Type: Not defined
Accept: application/json

getInstitutions

Institution getInstitutions()

Get a paginated list of institutions

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.InstitutionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


InstitutionsApi apiInstance = new InstitutionsApi();
try {
    Institution result = apiInstance.getInstitutions();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InstitutionsApi#getInstitutions");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

Institution

HTTP request headers

Content-Type: Not defined
Accept: application/json

getPrivateTrial

PrivateTrial getPrivateTrial(id, trialId)

Get a private trial

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.InstitutionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


InstitutionsApi apiInstance = new InstitutionsApi();
String id = "id_example"; // String | ID of the Institution governing the private trial
String trialId = "trialId_example"; // String | ID of the private trial to return
try {
    PrivateTrial result = apiInstance.getPrivateTrial(id, trialId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InstitutionsApi#getPrivateTrial");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	ID of the Institution governing the private trial
trialId	String	ID of the private trial to return

Return type

PrivateTrial

HTTP request headers

Content-Type: Not defined
Accept: application/json

getPrivateTrialStatus

PrivateTrial getPrivateTrialStatus(id, trialId)

Get a private trial record's status

Get a private trial's status

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.InstitutionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


InstitutionsApi apiInstance = new InstitutionsApi();
String id = "id_example"; // String | ID of the Institution governing the private trial
String trialId = "trialId_example"; // String | ID of the private trial to return status for
try {
    PrivateTrial result = apiInstance.getPrivateTrialStatus(id, trialId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InstitutionsApi#getPrivateTrialStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	ID of the Institution governing the private trial
trialId	String	ID of the private trial to return status for

Return type

PrivateTrial

HTTP request headers

Content-Type: Not defined
Accept: application/json

getPrivateTrials

PrivateTrial getPrivateTrials(id)

Get a paginated list of private

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.InstitutionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


InstitutionsApi apiInstance = new InstitutionsApi();
String id = "id_example"; // String | ID of the Institution governing the private trial
try {
    PrivateTrial result = apiInstance.getPrivateTrials(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InstitutionsApi#getPrivateTrials");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	ID of the Institution governing the private trial

Return type

PrivateTrial

HTTP request headers

Content-Type: Not defined
Accept: application/json

postInstitution

Institution postInstitution(body)

Create an institution

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.InstitutionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


InstitutionsApi apiInstance = new InstitutionsApi();
Institution body = new Institution(); // Institution | Institution object to send to MolecularMatch for processing
try {
    Institution result = apiInstance.postInstitution(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InstitutionsApi#postInstitution");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	Institution	Institution object to send to MolecularMatch for processing

Return type

Institution

HTTP request headers

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

postPrivateTrial

PrivateTrial postPrivateTrial(body)

Create a private trial

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.InstitutionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


InstitutionsApi apiInstance = new InstitutionsApi();
PrivateTrial body = new PrivateTrial(); // PrivateTrial | Private Trial object to send to MolecularMatch for processing
try {
    PrivateTrial result = apiInstance.postPrivateTrial(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InstitutionsApi#postPrivateTrial");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	PrivateTrial	Private Trial object to send to MolecularMatch for processing

Return type

PrivateTrial

HTTP request headers

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

putInstitution

Institution putInstitution(id)

Put/Update an institution

Put an institution

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.InstitutionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


InstitutionsApi apiInstance = new InstitutionsApi();
String id = "id_example"; // String | ID of the Institution to return
try {
    Institution result = apiInstance.putInstitution(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InstitutionsApi#putInstitution");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	ID of the Institution to return

Return type

Institution

HTTP request headers

Content-Type: Not defined
Accept: application/json

putPrivateTrial

PrivateTrial putPrivateTrial(id, trialId)

Put/Update a private trial

Put a private trial

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.InstitutionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


InstitutionsApi apiInstance = new InstitutionsApi();
String id = "id_example"; // String | ID of the Institution governing the private trial
String trialId = "trialId_example"; // String | ID of the private trial
try {
    PrivateTrial result = apiInstance.putPrivateTrial(id, trialId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InstitutionsApi#putPrivateTrial");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	ID of the Institution governing the private trial
trialId	String	ID of the private trial

Return type

PrivateTrial

HTTP request headers

Content-Type: Not defined
Accept: application/json