API related questions

sadiga

We are looking at the following APIs and wanted to check if it is available and in what form (REST/SOAP).

1. Get metadata of all CRFs for a given study

2. Get list of participants added/edited/deleted for a given time range

3. Get list of visits added/edited/deleted for a given time range

4. Get data for CRFs added/edited/deleted for a given time range

If not available, what is the best way to get the data?

~Sri

sdibona

Hello,

I did a quick review of the existing APIs to find ones that would meet your criteria.

For reference, documentation on OpenClinica RESTful APIs can be found here:
* https://dev.openclinica.com/apidoc/
And documentation on the SOAP APIs can be found here:
* https://docs.openclinica.com/3.1/technical-documents/openclinica-web-services-guide

1. Get metadata of all CRFs for a given study
* Depending on the format of the output you want, the following APIs should retrieve the necessary data.
* REST/XML: https://dev.openclinica.com/apidoc/#api-Study-GetODM
* REST/JSON: https://dev.openclinica.com/apidoc/#api-Study-GetODMJSON

2. Get list of participants added/edited/deleted for a given time range
* The following SOAP call will return all study subjects for a given study/site. It does not, however, support date/time range filters
* https://docs.openclinica.com/3.1/technical-documents/openclinica-web-services-guide/studysubject-web-service#content-title-3005

3. Get list of visits added/edited/deleted for a given time range
* I did not see an API that would retrieve this information.

4. Get data for CRFs added/edited/deleted for a given time range
* Assuming you mean populated/submitted CRFs, I did not see an API that would retrieve this information.
* There are, however, REST APIs to retrieve CRF data for a specific study subject:
* REST/HTML: https://dev.openclinica.com/apidoc/#api-Subject-getPrintCRFController
* REST/XML: https://dev.openclinica.com/apidoc/#api-Subject-getODMMetadata
* REST/JSON: https://dev.openclinica.com/apidoc/#api-Subject-getODMClinicaldataJSON

If not available, what is the best way to get the data?
Extracts are another way to retrieve metadata & clinical data from the study. Any needed data can be retrieved from extracts. They can also be filtered by subject enrollment date.
They would include the data for #3 (list of visits), but it would be arranged by subject in the Clinical Data section and as mentioned before, the date range would apply to the subject enrollment date.

Please let me know if you have any questions.

-Steve DiBona

sadiga

The main question is: does the Audit data have APIs?

~Sri

sdibona

Hello,

There are not APIs just for audit data, but the subject casebook APIs do contain the audit data:

* (REST/HTML) https://dev.openclinica.com/apidoc/#api-Subject-getPrintCRFController
* (REST/JSON) https://dev.openclinica.com/apidoc/#api-Subject-getODMClinicaldataJSON
* (REST/XML) https://dev.openclinica.com/apidoc/#api-Subject-getODMMetadata

-Steve DiBona

sadiga

Thanks Steve. We are getting started on this in the next next or so, will
report any issues we face.

~Sri