Assign a kit type to a dispensation visit

Make a POST request to assign a kit type to a visit.

Note:

To run these Oracle Clinical One Platform API calls, you need to include an authentication token. For instructions on how to generate your authentication token, see Get a token for authentication and Use the token to make an API request.
For every API call make sure you construct the URL using the correct server URL and path parameters values.

For the following API calls, you need the studyID and version, as well as the visitId. These values are retrieved as part of a prerequisite, see Get study information and Get visit information.

Step 1: Create the request payload file

Create a new JSON file called AssignKitType.json and copy the following code.

Note:

Make sure you replace the armId, kitId and visitId with the correct values. Treatment arm and kit type IDs are generated and saved as part of a previous task. To create a visit using Rest APIS, see Create a visit.

[
{
    "armId": "E322F08E38124329BD185847AFD971E8",
    "dispenseoutsidewindow": true,
    "dnd": 74,
    "dosingId": null,
    "kitId": "355EB26793D64E748A0114C162D19232",
    "quantity": 1,
    "visitId": "80047A332DE8404587189A3E75FA206A"
}
]

Step 2: Update list of dispensation visits using payload file

Run the following cURL call to assign the created kit type to treatment arm A and to a dispensation visit:

curl -X PUT "https://tenant.clinicalone.oraclecloud.com/ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/dispensings" -d "@AssignKitType.json"

For more information on how to build the payload and other parameters, see Update list of dispensation visits.

Tip:

Browse for these and other related APIs under the Tasks section of this guide. If you see any deprecated endpoint, look for its newest version.