8 RFP Resource API and Bid Resource API

The ClearTrial Web Service RFP Resource API returns information about RFPs stored in the ClearTrial application. The ClearTrial Web Service Bid Resource API returns information about bids stored in the ClearTrial application.

Get RFPs

Gets the first 25 complete RFPs accessible to the current user for a given customer ID, ordered by plan and study name. Using the pagination options, the user can get subsequent pages.

Method: GET

URL: /cleartrial-ws/rfps

Sample output in JSON:

{
    "rfps": {
        "rfp": [
            {
                "id": 10129,
                "study": "24660",
                "currency": "USD",
                "shortDescription": "dsafgfdsg",
                "createdBy": "France, Michelle",
                "createdDate": "13-Apr-2015",
                "lastModifiedBy": "France, Michelle",
                "lastModifiedDate": "13-Apr-2015",
                "laborUrl": "/cleartrial-ws/rfps/10129/labor",
                "costUrl": "/cleartrial-ws/rfps/10129/cost",
                "bidsUrl": "/cleartrial-ws/rfps/10129/bids",
                "planUrl": "/cleartrial-ws/plans/32610",
                "serviceProviderUrl": "/cleartrial-ws/plans/32610/serviceProvider/12401"
            },
            {
                "id": 10123,
                "study": "!! 10181-1",
                "currency": "USD",
                "shortDescription": "sfdddddddddddddd",
                "bidGridTitle": "sdfsdfsdfsdfsdfsdfsdfsdfsdfsdfsdf",
                "comments": "sdfffffffffffffffff",
                "createdBy": "Administrator, QA",
                "createdDate": "13-Apr-2015",
                "lastModifiedBy": "Administrator, QA",
                "lastModifiedDate": "13-Apr-2015",
                "laborUrl": "/cleartrial-ws/rfps/10123/labor",
                "costUrl": "/cleartrial-ws/rfps/10123/cost",
                "bidsUrl": "/cleartrial-ws/rfps/10123/bids",
                "planUrl": "/cleartrial-ws/plans/54173",
                "serviceProviderUrl": "/cleartrial-ws/plans/54173/serviceProvider/19003"
            }, . . .
     ...  ]  
        }
     }

Sample output in XML:

<rfps>
<rfp>
<id>10000</id>
<study>Simple Study</study>
<currency>USD</currency>
<shortDescription>short description</shortDescription>
<bidGridTitle>Sample RFP</bidGridTitle>
<comments>This is a Sample RFP</comments>
<createdBy>administrator</createdBy>
<createdDate>04-Mar-2015</createdDate>
<lastModifiedBy>administrator</lastModifiedBy>
<lastModifiedDate>04-Mar-2015</lastModifiedDate>
<laborUrl>/cleartrial-ws/rfps/10000/labor</laborUrl>
<costUrl>/cleartrial-ws/rfps/10000/cost</costUrl>
<bidsUrl>/cleartrial-ws/rfps/10000/bids</bidsUrl>
<planUrl>/cleartrial-ws/plans/12345</planUrl>
<serviceProviderUrl>/cleartrial-ws/plans/12345/serviceProvider/6789</serviceProviderUrl>
</rfp>
<rfp>
...
</rfp>
...
</rfps>

Sub-Resources: None

Note: In Phase I Healthy Volunteers studies, the Subject Enrollment Schedule sub-resource URL does not appear in the values returned by the Get RFPs API.

Get RFP

Obtains the representation for a specific RFP. This provides an overview of an RFP that was created.

Method: GET

URL: /cleartrial-ws/rfps/<rfpId>

Sample output in JSON:

{
    "rfp": {
        "id": 10129,
        "study": "24660",
        "currency": "USD",
        "shortDescription": "dsafgfdsg",
        "createdBy": "France, Michelle",
        "createdDate": "13-Apr-2015",
        "lastModifiedBy": "France, Michelle",
        "lastModifiedDate": "13-Apr-2015",
        "laborUrl": "/cleartrial-ws/rfps/10129/labor",
        "costUrl": "/cleartrial-ws/rfps/10129/cost",
        "bidsUrl": "/cleartrial-ws/rfps/10129/bids",
        "planUrl": "/cleartrial-ws/plans/32610",
        "serviceProviderUrl": "/cleartrial-ws/plans/32610/serviceProvider/12401"
    }

 }

Sample output in XML:

<rfp>
 <id>10000</id>
 <study>Simple Study</study>
 <currency>USD</currency>
 <shortDescription>short description</shortDescription>
 <bidGridTitle>Sample RFP</bidGridTitle>
 <comments>This is a Sample RFP</comments>
 <createdBy>administrator</createdBy>
 <createdDate>04-Mar-2015</createdDate>
 <lastModifiedBy>administrator</lastModifiedBy>
 <lastModifiedDate>04-Mar-2015</lastModifiedDate>
 <laborUrl>/cleartrial-ws/rfps/10000/labor</laborUrl>
 <costUrl>/cleartrial-ws/rfps/10000/cost</costUrl>
 <bidsUrl>/cleartrial-ws/rfps/10000/bids</bidsUrl>
 <planUrl>/cleartrial-ws/plans/12345</planUrl>
 <serviceProviderUrl>/cleartrial-ws/plans/12345/serviceProvider/6789</serviceProviderUrl>
 </rfp>

Sub-Resources:

• Labor

• Cost

Note: In Phase I Healthy Volunteers studies, the following field does not appear in the Get Plan API: Subject Enrollment Schedule.

Get Labor

Shows the breakdown of labor by major task, task, location, and resources.

Method: GET

URL: /cleartrial-ws/rfps/{rfpID}/labor

Sample output in XML:

<rfp>
 <id>10000</id>
 <currency>USD</currency>
 <location>
 <locationId>100</locationId>
 <locationName>USA</locationName>
 <majorTask>
 <id>2</id>
 <name>Project Initiated</name>
 <unitOfMeasure>Study</unitOfMeasure>
 <task>
 <id>2</id>
 <name>Develop scope of work, timeline, work assignments</name>
 <resource>
 <name>Senior Clinical Researcher Associate</name>
 <code>CR02</code>
<mappingKey>000-002-002</mappingKey>
 <billingRate>143.13</billingRate>
 <inflatedBillingRate>143.13</inflatedBillingRate>>
 <numUnits>1.0</numUnits>
 <unitCost>286.26</unitCost>
 <unitHours>2.0</unitHours>
 <totalCost>286.26</cost>
 <totalHours>2.0</hours>
 </resource>
 <resource>
 ....
 </resource>
 ....
 </task>
 <task>
 
 ....
 </task>
 .... 
 </majorTask>
 <majorTask>
 ...
 </majorTask>
 ... 
 </location>
 <location>
 ....
 </location>
 <url>/cleartrial-ws/rfps/10000/labor</url>
</rfp>

Get Cost

Shows the breakdown of labor by major task, task, location, and resources.

Method: GET

URL: /cleartrial-ws/rfps/{rfpID}/cost

Sample output in XML:

<rfp>
<rfpId>1</rfpId>
<currency>INR</currency>
<location>
<locationId>3</locationId>
<locationName>India</locationName>
<cost>
<id>2</id>
<name>TestMiscCost</name> 
<mappingKey>TR-01010-01010</mappingKey>
                      <wbsModelId>1</wbsModelId>
                      <workUnitId>1</workUnitId>
                      <locationScoped>true</locationScoped>
                      <credit>false</credit>
                      <includeInflation>true</includeInflation>
                      <numUnits>3</numUnits>
                      <totalCost>4500.0</totalCost>
                      <inflatedTotalCost>4500.0</inflatedTotalCost>
             </cost>
              <cost>
                …
              </cost>
              …
      </location>
        <location>
        …
        </location>
        …
      <url>/cleartrial-ws/rfps/1/cost</url>
</rfp>