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"
    }
}

In the example 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