6 Study Resource API

This ClearTrial Web Services API returns information about study resources from ClearTrial applications.

Get Studies

Lists all the studies accessible to the current user for a given customer ID.

Method: GET

URL: /cleartrial-ws/studies

Table 6-1 Get Studies Query Parameters

Query Parameters	Description	Accepted Values	Examples
fetchDeleted	Filter to include deleted studies or not. Default is true.	true false	?fetchDeleted=true ?fetchDeleted=false
page	For Pagination. What page of results you are on. Default is 1.	Integer	?page=1 ?page=5
dateSinceModified	Filter to list compounds modified after a specific date and time.	DD-MMM-YYYY HH:MM:SS (in 24 hr format) DD-MMM-YYYY	?dateSinceModified= 14-Mar-2016 14:00:00

Example: /cleartrial-ws/studies?fetchDeleted=false&page=2&dateSinceModified=14-Mar-2016

Sample output in JSON:

{
    "studies": {
        "pageNumber": 1,
        "pageSize": 4,
        "totalPages": 1,
        "isLastPage": true,
        "study": [
            {
                "id": 22339,
                "name": "!! 10181",
                "description": "Testf",
                "createdBy": "1, VL",
                "createdDate": "08-Nov-2011 00:40:41 CST",
                "lastModifiedBy": "Scan, Web",
                "lastModifiedDate": "12-Apr-2016 12:13:50 CDT",
                "sponsorId": 10104,
                "sponsorName": "ClearTrial Operations",
                "protocol": "Test",
                "studyPhaseId": 3,
                "studyPhaseName": "II",
                "therapeuticAreaId": 3,
                "therapeuticAreaName": "CNS",
                "therapeuticAreaAlias": "CNS",
                "indicationId": 11,
                "indicationName": "Aneurysms",
                "indicationAlias": "Aneurysms",
                "compoundId": 13317,
                "compoundUrl": "/cleartrial-ws/compounds/13317",
                "actualsPlanId": 56544,
                "actualsPlanUrl": "/cleartrial-ws/actuals/56544",
                "url": "/cleartrial-ws/studies/22339"
            },
            {
                ........
            },
            ........
        ],
        "url": "/cleartrial-ws/studies?dateSinceModified=14-Mar-2016"
    }
}

Sample output in XML:

<studies>
    <pageNumber>1</pageNumber>
    <pageSize>4</pageSize>
    <totalPages>1</totalPages>
    <isLastPage>true</isLastPage>
    <study>
        <id>22339</id>
        <name>!! 10181</name>
        <description>Testf</description>
        <createdBy>1, VL</createdBy>
        <createdDate>08-Nov-2011 00:40:41 CST</createdDate>
        <lastModifiedBy>Scan, Web</lastModifiedBy>
        <lastModifiedDate>12-Apr-2016 12:13:50 CDT</lastModifiedDate>
        <sponsorId>10104</sponsorId>
        <sponsorName>ClearTrial Operations</sponsorName>
        <protocol>Test</protocol>
        <studyPhaseId>3</studyPhaseId>
        <studyPhaseName>II</studyPhaseName>
        <therapeuticAreaId>3</therapeuticAreaId>
        <therapeuticAreaName>CNS</therapeuticAreaName>
        <therapeuticAreaAlias>CNS</therapeuticAreaAlias>
        <indicationId>11</indicationId>
        <indicationName>Aneurysms</indicationName>
        <indicationAlias>Aneurysms</indicationAlias>
        <compoundId>13317</compoundId>
        <compoundUrl>/cleartrial-ws/compounds/13317</compoundUrl>
        <actualsPlanId>56544</actualsPlanId>
        <actualsPlanUrl>/cleartrial-ws/actuals/56544</actualsPlanUrl>
        <url>/cleartrial-ws/studies/22339</url>
    </study>
    <study>
        ........
     </study>
     ........
    <url>/cleartrial-ws/studies?dateSinceModified=14-Mar-2016</url>
</studies>

In the examples above:

• 'pageNumber': 1, specifies that the current contents belong to page 1.

• 'pageSize': 4, defines the current page size. In this case, the page has 4 plans.

• 'totalPages': 1, indicates that there is 1 page available.

• 'isLastPage': true, indicates that the current page is the last page.

Sub-Resources: None

Get Study

Obtains the representation for a specified study.

Method: GET

URL: /cleartrial-ws/studies/{studyID}

Sample output in JSON:

{
  "study":{
     "id":10201,
     "name":"Simple Study 1",
     "createdBy":"administrator",
     "createdDate":"15-Apr-2010",
     "lastModifiedBy":"administrator",
     "lastModifiedDate":"15-Apr-2010",
     "sponsorId":10201,
     "sponsorName":"QA",
     "protocol":"ABC-123",
     "studyPhaseId":3,
     "studyPhaseName":"II",
     'therapeuticAreaId':6,
     'therapeuticAreaName':'Endocrine',
     "therapeuticAreaAlias':'Endocrine',
     'indicationId>':232,
     'indicationName':'Acromegaly',
     'indicationAlias':'Acromegaly',
     "compoundId":10201,
     "compoundUrl":"/cleartrial-ws/compounds/10201",
     "url":"/cleartrial-ws/studies/10201"
   }
}

Sample output in XML:

<study>
    <id>10201</id>
    <name>Simple Study 1</name>
    <createdBy>administrator</createdBy>
    <createdDate>15-Apr-2010</createdDate>
    <lastModifiedBy>administrator</lastModifiedBy>
    <lastModifiedDate>15-Apr-2010</lastModifiedDate>
    <sponsorId>10201</sponsorId>
    <sponsorName>QA</sponsorName>
    <protocol>ABC-123</protocol>
    <studyPhaseId>3</studyPhaseId>
    <studyPhaseName>II</studyPhaseName>
    <therapeuticAreaId>21</therapeuticAreaId>
    <therapeuticAreaName>(Non-Routine)</therapeuticAreaName>
    <therapeuticAreaAlias>Alias of (Non-Routine)</therapeuticAreaAlias>
    <indicationId>105</indicationId>
    <indicationName>Other (Routine)</indicationName>
    <indicationAlias>Alias of Other (Routine)</indicationAlias>
    <compoundId>10201</compoundId>
    <compoundUrl>/cleartrial-ws/compounds/10201</compoundUrl>
    <url>/cleartrial-ws/studies/10201</url>
</study>

Sub-Resources: Compound