Retrieve a list of study timeline periods.
GET {{baseUrl}}/StudyTimelinePeriods?$top=<integer>&$skip=<integer>&$search=<string>&$filter=<string>&$count=<boolean>&$orderby=isDispensationPeriod,overage desc&$select=colorCode,description&$expand=*,treatments
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
$top | string | Show only the first n items, see Paging - Top | |
$skip | string | Skip the first n items, see Paging - Skip | |
$search | string | Search items by search phrases, see Searching | |
$filter | string | Filter items by property values, see Filtering | |
$count | string | Include count of items, see Count | |
$orderby | string | Order items by property values, see Sorting | |
$select | string | Select properties to be returned, see Select | |
$expand | string | Expand related entities, see Expand |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"@odata.count":"\u003cnumber\u003e","value":[{"ID":"\u003cuuid\u003e","treatmentGroup_ID":"\u003cuuid\u003e","treatmentSchedule_ID":"\u003cuuid\u003e","treatmentPeriodID":"\u003cstring\u003e","description":"\u003cstring\u003e","durationInDays":"\u003cinteger\u003e","position":"\u003cinteger\u003e","startDay":"\u003cinteger\u003e","isDispensationPeriod":"\u003cboolean\u003e","colorCode":"\u003cstring\u003e","overage":"\u003cnumber\u003e","dropout":"\u003cnumber\u003e","treatmentDispensationEvent_ID":"\u003cuuid\u003e","switchFromRate":"\u003cnumber\u003e","switchToRate":"\u003cnumber\u003e","treatments":[{"dispensationEvent_ID":"\u003cuuid\u003e","treatment_ID":"\u003cuuid\u003e","period_ID":"\u003cuuid\u003e","treatmentID":"\u003cstring\u003e","treatment_num":"\u003cinteger\u003e","description":"\u003cstring\u003e","kitTypes":[{"dispensationEvent_ID":"\u003cuuid\u003e","treatment_ID":"\u003cuuid\u003e","kitTypeAssignment_ID":"\u003cuuid\u003e","kitType_ID":"\u003cuuid\u003e","quantity":"\u003cinteger\u003e","validFrom":"\u003cdate\u003e","validTo":"\u003cdate\u003e","kitTypeID":"\u003cstring\u003e","description":"\u003cstring\u003e"},{"dispensationEvent_ID":"\u003cuuid\u003e","treatment_ID":"\u003cuuid\u003e","kitTypeAssignment_ID":"\u003cuuid\u003e","kitType_ID":"\u003cuuid\u003e","quantity":"\u003cinteger\u003e","validFrom":"\u003cdate\u003e","validTo":"\u003cdate\u003e","kitTypeID":"\u003cstring\u003e","description":"\u003cstring\u003e"}],"kitTypes@odata.count":"\u003cnumber\u003e"},{"dispensationEvent_ID":"\u003cuuid\u003e","treatment_ID":"\u003cuuid\u003e","period_ID":"\u003cuuid\u003e","treatmentID":"\u003cstring\u003e","treatment_num":"\u003cinteger\u003e","description":"\u003cstring\u003e","kitTypes":[{"dispensationEvent_ID":"\u003cuuid\u003e","treatment_ID":"\u003cuuid\u003e","kitTypeAssignment_ID":"\u003cuuid\u003e","kitType_ID":"\u003cuuid\u003e","quantity":"\u003cinteger\u003e","validFrom":"\u003cdate\u003e","validTo":"\u003cdate\u003e","kitTypeID":"\u003cstring\u003e","description":"\u003cstring\u003e"},{"dispensationEvent_ID":"\u003cuuid\u003e","treatment_ID":"\u003cuuid\u003e","kitTypeAssignment_ID":"\u003cuuid\u003e","kitType_ID":"\u003cuuid\u003e","quantity":"\u003cinteger\u003e","validFrom":"\u003cdate\u003e","validTo":"\u003cdate\u003e","kitTypeID":"\u003cstring\u003e","description":"\u003cstring\u003e"}],"kitTypes@odata.count":"\u003cnumber\u003e"}],"treatments@odata.count":"\u003cnumber\u003e"},{"ID":"\u003cuuid\u003e","treatmentGroup_ID":"\u003cuuid\u003e","treatmentSchedule_ID":"\u003cuuid\u003e","treatmentPeriodID":"\u003cstring\u003e","description":"\u003cstring\u003e","durationInDays":"\u003cinteger\u003e","position":"\u003cinteger\u003e","startDay":"\u003cinteger\u003e","isDispensationPeriod":"\u003cboolean\u003e","colorCode":"\u003cstring\u003e","overage":"\u003cnumber\u003e","dropout":"\u003cnumber\u003e","treatmentDispensationEvent_ID":"\u003cuuid\u003e","switchFromRate":"\u003cnumber\u003e","switchToRate":"\u003cnumber\u003e","treatments":[{"dispensationEvent_ID":"\u003cuuid\u003e","treatment_ID":"\u003cuuid\u003e","period_ID":"\u003cuuid\u003e","treatmentID":"\u003cstring\u003e","treatment_num":"\u003cinteger\u003e","description":"\u003cstring\u003e","kitTypes":[{"dispensationEvent_ID":"\u003cuuid\u003e","treatment_ID":"\u003cuuid\u003e","kitTypeAssignment_ID":"\u003cuuid\u003e","kitType_ID":"\u003cuuid\u003e","quantity":"\u003cinteger\u003e","validFrom":"\u003cdate\u003e","validTo":"\u003cdate\u003e","kitTypeID":"\u003cstring\u003e","description":"\u003cstring\u003e"},{"dispensationEvent_ID":"\u003cuuid\u003e","treatment_ID":"\u003cuuid\u003e","kitTypeAssignment_ID":"\u003cuuid\u003e","kitType_ID":"\u003cuuid\u003e","quantity":"\u003cinteger\u003e","validFrom":"\u003cdate\u003e","validTo":"\u003cdate\u003e","kitTypeID":"\u003cstring\u003e","description":"\u003cstring\u003e"}],"kitTypes@odata.count":"\u003cnumber\u003e"},{"dispensationEvent_ID":"\u003cuuid\u003e","treatment_ID":"\u003cuuid\u003e","period_ID":"\u003cuuid\u003e","treatmentID":"\u003cstring\u003e","treatment_num":"\u003cinteger\u003e","description":"\u003cstring\u003e","kitTypes":[{"dispensationEvent_ID":"\u003cuuid\u003e","treatment_ID":"\u003cuuid\u003e","kitTypeAssignment_ID":"\u003cuuid\u003e","kitType_ID":"\u003cuuid\u003e","quantity":"\u003cinteger\u003e","validFrom":"\u003cdate\u003e","validTo":"\u003cdate\u003e","kitTypeID":"\u003cstring\u003e","description":"\u003cstring\u003e"},{"dispensationEvent_ID":"\u003cuuid\u003e","treatment_ID":"\u003cuuid\u003e","kitTypeAssignment_ID":"\u003cuuid\u003e","kitType_ID":"\u003cuuid\u003e","quantity":"\u003cinteger\u003e","validFrom":"\u003cdate\u003e","validTo":"\u003cdate\u003e","kitTypeID":"\u003cstring\u003e","description":"\u003cstring\u003e"}],"kitTypes@odata.count":"\u003cnumber\u003e"}],"treatments@odata.count":"\u003cnumber\u003e"}]}