Put Study

Creates a new study in ClearTrial for the given sponsor and compound. The compound and sponsor should already exist in ClearTrial. This operation requires the following information about the new study:

• Unique name (Required)

• Protocol

• Code

• Description

• Compound ID (Required)

• Sponsor ID (Required)

• Study Phase ID (Required)

• Study Status ID

• Therapeutic Area ID (Required, except for Phase I (Healthy Volunteers) studies)

• Indication ID (Required, except for Phase I (Healthy Volunteers) studies)

• Use Alias (Required if you want to use aliases for therapeutic area and/or indication)

• Therapeutic Area Alias

• Indication Alias

Method: PUT

URL: /cleartrial-ws/studies

Sample input in JSON:

{
    "study": {
        "name":"Simple Study Weeeeee 8",
        "protocol": "Sample protocol Weeeeee 8",
        "compoundId":10201,
        "studyPhaseId":3,
        "sponsorId":10201,
        "studyStatusId":4,
        "therapeuticAreaId":6,
        "indicationId":232,
        "indicationAlias":"Indication Alias Sample Weee",
        "description": "Weeee Notes 8",
        "useAlias": true,
        "code": "Weeee Code 8"
    }
}

Upon successful execution of the request, the server returns an HTTP 200 code and information about the newly created study as shown below.

{
    "study": {
        "id": 39201,
        "name": "Create New Sample Study",
        "code": "SampleCode",
        "description": "Sample description",
        "createdBy": "User, Test",
        "createdDate": "19-Jun-2017 11:47:20 CDT",
        "lastModifiedBy": "User, Test",
        "lastModifiedDate": "19-Jun-2017 11:47:20 CDT",
        "sponsorId": 10104,
        "sponsorName": "ClearTrial Operations",
        "protocol": "Proto123",
        "studyPhaseId": 3,
        "studyPhaseName": "II",
        "studyStatus": {
            "id": 1,
            "name": "Planning",
            "code": "PLAN",
            "description": "Planning",
            "url": "/cleartrial-ws/studyStatus/1"
        },
        "therapeuticAreaId": 2,
        "therapeuticAreaName": "Circulatory System",
        "therapeuticAreaAlias": "Therapeutic Area Alias",
        "indicationId": 12,
        "indicationName": "Angina",
        "indicationAlias": "Indication Alias",
        "compoundId": 19507,
        "compoundUrl": "/cleartrial-ws/compounds/19507",
        "url": "/cleartrial-ws/studies/39201"
    }
}

If an error occurs during the request, the server returns an appropriate HTTP code and some information about the error.

For example, if there are validation errors in the data provided via the PUT request, the HTTP response code 400 is returned along with the following message:

{
    "error": {
        "errorCode": "Bad Request",
        "message": "The following validation errors occurred:  [ compoundId may not be null ]  [ name is either missing or not a legal name ]  [ sponsorId may not be null ]  [ studyPhaseId may not be null ] "
    }
}

Sub-Resources: none