Skip Headers

Oracle® Health Sciences ClearTrial Cloud Service Web Services API User Guide Release 5.0 Part Number E39879-01 |
Home | Book List | Contents | Contact Us

Previous | Next
| View PDF

# 6 Study Resource API

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

## 6.1 Get Studies

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

Method: GET

URL: /cleartrial-ws/studies

Sample output in JSON:

    {
      "study":[
          {
            "id":10201,
            "name":"Simple Study 1",
            "createdBy":"joeuser",
            "createdDate":"15-Apr-2010",
            "lastModifiedBy":"joeuser",
            "lastModifiedDate":"15-Apr-2010",
            "sponsorId":10201,
            "sponsorName":"sponsor",
            "protocol":"ABC-123",
            "studyPhaseId":3,
            "studyPhaseName":"II",
            "indicationId":105,
            "indicationName":"Other (Routine)",
            "compoundId":10201,
            "compoundUrl":"/cleartrial-ws/compounds/10201",
            "url":"/cleartrial-ws/studies/10201"
          },
         {
           ...
           ...
         },
         ...
         ...
       ]
    }

Sample output in XML:

    <studyRepresentations>
      <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>
             <indicationId>105</indicationId>
             <indicationName>Other (Routine)</indicationName>
             <compoundId>10201</compoundId>
             <compoundUrl>/cleartrial-ws/compounds/10201</compoundUrl>
             <url>/cleartrial-ws/studies/10201</url>
       </study>
       <study>
       ...
       </study>
       ...
    </studyRepresentations>

Sub-Resources: Compound

## 6.2 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": 21,
         "therapeuticAreaName":"Other (Non-Routine)",
         "indicationId":105,
         "indicationName":"Other (Routine)",
         "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>
        <indicationId>105</indicationId>
        <indicationName>Other (Routine)</indicationName>
        <compoundId>10201</compoundId>
        <compoundUrl>/cleartrial-ws/compounds/10201</compoundUrl>
        <url>/cleartrial-ws/studies/10201</url>
    </study>

Sub-Resources: Compound