2 Compound Resource API

This ClearTrial Web Services API enables you to view compounds accessible to the current user for a given customer ID. Compounds are products and include drugs and medical devices.

Get Compounds

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

Method: GET

URL: /cleartrial-ws/compounds

Table 2-1 Get Compounds Query Parameters

Query Parameters	Description	Accepted Values	Examples
fetchDeleted	Filter to include deleted compounds 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/compounds?fetchDeleted=false&page=2&dateSinceModified=14-Mar-2016

Sample output in JSON:

{
    "compounds": {
        "pageNumber": 2,
        "pageSize": 25,
        "totalPages": 15,
        "isLastPage": false,
        "compound": [
            {
                "id": 19903,
                "name": "hello 124",
                "code": "ABC-1233",
                "description": "test3",
                "createdBy": "administrator, clinical",
                "createdDate": "13-Feb-2013 03:30:18 CST",
                "lastModifiedBy": "administrator, clinical",
                "lastModifiedDate": "13-Feb-2013 03:30:18 CST",
                "url": "/cleartrial-ws/compounds/19903"
            },
            {
                ........
            },
            ........
        ],
        "url": "//cleartrial-ws/compounds?fetchDeleted=false&page=2&dateSinceModified=14-Mar-2012+12:00:00"
    }
}

Sample output in XML:

<compounds>
    <pageNumber>2</pageNumber>
    <pageSize>25</pageSize>
    <totalPages>15</totalPages>
    <isLastPage>false</isLastPage>
    <compound>
        <id>19903</id>
        <name>hello 124</name>
        <code>ABC-1233</code>
        <description>test3</description>
        <createdBy>administrator, clinical</createdBy>
        <createdDate>13-Feb-2013 03:30:18 CST</createdDate>
        <lastModifiedBy>administrator, clinical</lastModifiedBy>
        <lastModifiedDate>13-Feb-2013 03:30:18 CST</lastModifiedDate>
        <url>/cleartrial-ws/compounds/19903</url>
    </compound>
    <compound>
        ........
    </compound>
    ........
    <url>/cleartrial-ws/compounds?fetchDeleted=false&page=2&dateSinceModified=14-Mar-2012+12:00:00</url>
</compounds>

In the examples above:

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

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

• 'totalPages': 15, indicates that there are 15 pages available.

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

Sub-Resources: None

Get Compound

Obtains the representation for a specified compound.

Method: GET

URL: /cleartrial-ws/compounds/{compoundId}

Sample output in JSON:

{
"compound": [
    "id": 10201,
    "name":"Test Compound",
    "code":"ABC-123",
    "description":"test",
    "createdBy":"administrator", 
    "createdDate":"15-Apr-2010", 
    "lastModifiedBy":"administrator", 
    "lastModifiedDate":"15-Apr-2010",
    "url":"/cleartrial-ws/compounds/10201"
  }                                    
}

Sample output in XML:

<compound>
<id>10201</id>
<name>Test Compound</name>
<code>ABC-123</code>
<description>test</description>
<createdBy>administrator</createdBy>
<createdDate>15-Apr-2010</createdDate>
<lastModifiedBy>administrator</lastModifiedBy>
<lastModifiedDate>15-Apr-2010</lastModifiedDate>
<url>/cleartrial-ws/compounds/10201</url>
</compound>

Sub-Resources: None

Add Compound

This ClearTrial Web Services API adds a new product by issuing an HTTP PUT command. The server expects a name, code, and description. An attempt to create a compound with the same name or code as an existing compound causes the server to return an error message.

Method: PUT

URL: /cleartrial-ws/compounds

Sample input in JSON:

{
  "compound": [
    "name":"Test Compound",
    "code":"ABC-123",
    "description":"test",
  }                                    
}

Corresponding response by server in JSON:

{
  "compound": [
    "id": 10502,
    "name":"Test Compound", 
    "code":"ABC-123",
    "description":"test", 
    "createdBy":"joeuser", 
    "createdDate":"03-May-2011", 
    "lastModifiedBy":"joeuser", 
    "lastModifiedDate":"03-May-2011", 
    "url":"/cleartrial-ws/compounds/10502"
  }                                    
}

Sample input in XML:

<compound>
<name>Test Compound</name>
<code>ABC-123</code>
<description>test</description>
</compound>

Corresponding response by server in XML:

<compound>
<id>10501</id>
<name>Test Compound</name>
<code>ABC-123</code>
<description>test</description>
<createdBy>joeuser</createdBy>
<createdDate>03-May-2011</createdDate>
<lastModifiedBy>joeuser</lastModifiedBy>
<lastModifiedDate>03-May-2011</lastModifiedDate>
<url>/cleartrial-ws/compounds/10501</url>
</compound>

Sub-Resources: None