4 IRB APIs

calexh-sar edited this page 2021-03-30 10:12:56 -04:00

Table of Contents

• Info

IRB APIs

JSON to Excel or CSV

name: "StudyInfo", description: StudyInfo [TYPE], where TYPE is one of 'info', 'investigators', 'details', 'approvals' or 'documents'.

Adds details about the current study to the Task Data. The type of information required should be provided as an argument. The following arguments are available:

Info

Returns the basic information such as the id and title

- id: 12
- title: test
- primary_investigator_id: 21
- user_uid: dif84\",\n  \"sponsor\": \"sponsor\",\n  \"ind_number\": \"1234\",\n  \"inactive\": false\n}\n```

### Investigators
Returns detailed information about related personnel.\nThe order returned is guaranteed to match the order provided in the investigators.xslx reference file.\nDetailed information is added in from LDAP about each personnel based on their user_id. \n```\n{\n  \"PI\": {\n    \"label\": \"Primary Investigator\",\n    \"display\": \"Always\",\n    \"unique\": \"Yes\",\n    \"user_id\": \"dhf8r\",\n    \"display_name\": \"Dan Funk\",\n    \"given_name\": \"Dan\",\n    \"email\": \"dhf8r@virginia.edu\",\n    \"telephone_number\": \"+1 (434) 924-1723\",\n    \"title\": \"E42:He's a hoopy frood\",\n    \"department\": \"E0:EN-Eng Study of Parallel Universes\",\n    \"affiliation\": \"faculty\",\n    \"sponsor_type\": \"Staff\"\n  },\n  \"SC_I\": {\n    \"label\": \"Study Coordinator I\",\n    \"display\": \"Always\",\n    \"unique\": \"Yes\",\n    \"user_id\": null\n  },\n  \"DC\": {\n    \"label\": \"Department Contact\",\n    \"display\": \"Optional\",\n    \"unique\": \"Yes\",\n    \"user_id\": \"asd3v\",\n    \"error\": \"Unable to locate a user with id asd3v in LDAP\"\n  }\n}\n```

### Investigator Roles 
Returns a list of all investigator roles, populating any roles with additional information available from\nthe Protocol Builder and LDAP.  Its basically just like Investigators, but it includes all the roles, rather\nthat just those that were set in Protocol Builder.\n```\n{\n  \"PI\": {\n    \"label\": \"Primary Investigator\",\n    \"display\": \"Always\",\n    \"unique\": \"Yes\",\n    \"user_id\": \"dhf8r\",\n    \"display_name\": \"Dan Funk\",\n    \"given_name\": \"Dan\",\n    \"email\": \"dhf8r@virginia.edu\",\n    \"telephone_number\": \"+1 (434) 924-1723\",\n    \"title\": \"E42:He's a hoopy frood\",\n    \"department\": \"E0:EN-Eng Study of Parallel Universes\",\n    \"affiliation\": \"faculty\",\n    \"sponsor_type\": \"Staff\"\n  },\n  \"SC_I\": {\n    \"label\": \"Study Coordinator I\",\n    \"display\": \"Always\",\n    \"unique\": \"Yes\",\n    \"user_id\": null\n  },\n  \"DC\": {\n    \"label\": \"Department Contact\",\n    \"display\": \"Optional\",\n    \"unique\": \"Yes\",\n    \"user_id\": \"asd3v\",\n    \"error\": \"Unable to locate a user with id asd3v in LDAP\"\n  }\n}\n```\n\n\n### Details ###\nReturns detailed information about variable keys read in from the Protocol Builder.\n\n### Approvals ###\nReturns data about the status of approvals related to a study.\n```\n{\n  \"study_id\": 12,\n  \"workflow_id\": 321,\n  \"display_name\": \"IRB API Details\",\n  \"name\": \"irb_api_details\",\n  \"status\": \"not_started\",\n  \"workflow_spec_id\": \"irb_api_details\"\n}\n```

### Documents
Returns a list of all documents that might be related to a study, reading all columns from the irb_documents.xsl \nfile. Including information about any files that were uploaded or generated that relate to a given document. \nPlease note this is just a few examples, ALL known document types are returned in an actual call.\n```\n{\n  \"AD_CoCApp\": {\n    \"category1\": \"Ancillary Document\",\n    \"category2\": \"CoC Application\",\n    \"category3\": \"\",\n    \"Who Uploads?\": \"CRC\",\n    \"id\": \"12\",\n    \"description\": \"Certificate of Confidentiality Application\",\n    \"required\": false,\n    \"study_id\": 1,\n    \"code\": \"AD_CoCApp\",\n    \"display_name\": \"Ancillary Document / CoC Application\",\n    \"count\": 0,\n    \"files\": []\n  },\n  \"UVACompl_PRCAppr\": {\n    \"category1\": \"UVA Compliance\",\n    \"category2\": \"PRC Approval\",\n    \"category3\": \"\",\n    \"Who Uploads?\": \"CRC\",\n    \"id\": \"6\",\n    \"description\": \"Cancer Center's PRC Approval Form\",\n    \"required\": true,\n    \"study_id\": 1,\n    \"code\": \"UVACompl_PRCAppr\",\n    \"display_name\": \"UVA Compliance / PRC Approval\",\n    \"count\": 1,\n    \"files\": [\n      {\n        \"file_id\": 10,\n        \"task_id\": \"fakingthisout\",\n        \"workflow_id\": 2,\n        \"workflow_spec_id\": \"docx\"\n      }\n    ],\n    \"status\": \"complete\"\n  }\n}\n```