GET api/v{version}/laboratory/{laboratoryId}/subject/{subjectId}/timeline

Gets a timeline for the specified subject.

Request Information

URI Parameters

Name	Description	Type	Additional information
laboratoryId		integer	Required
subjectId		integer	Required
StartDate	Gets or sets the start date.	date	None.
ShowingDays	Gets or sets the showing days.	integer	None.
Containing	Gets or sets the containing.	string	None.
RelatedID	Gets or sets the related identifier.	string	None.
Include	Gets or sets the data points to include in the query (defaults to timeline).	Collection of IncludesEnum	None.
version		string	None.

Body Parameters

None.

Response Information

Resource Description

ResponseOfIEnumerableOfTimelineListModel

Name	Description	Type	Additional information
Data		Collection of TimelineListModel	None.
StatusCode	Gets or sets the status code.	HttpStatusCode	None.
StatusDescription	Gets or sets the status description.	string	None.
Errors		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "data": [
    {
      "date": "2024-10-22T09:24:48.4408033-07:00",
      "description": "sample string 1",
      "detail": "sample string 2",
      "relatedID": "sample string 3",
      "createdByID": 4,
      "createdBy": "sample string 5",
      "activityID": 1,
      "activityTypeID": 1,
      "notes": "sample string 6",
      "equipmentID": 1,
      "medicationID": 1,
      "prescriptionID": 1,
      "measurementID": 1,
      "adherenceReasonSubtypeID": 1,
      "adherenceReasonSubtypeDescription": "sample string 7"
    },
    {
      "date": "2024-10-22T09:24:48.4408033-07:00",
      "description": "sample string 1",
      "detail": "sample string 2",
      "relatedID": "sample string 3",
      "createdByID": 4,
      "createdBy": "sample string 5",
      "activityID": 1,
      "activityTypeID": 1,
      "notes": "sample string 6",
      "equipmentID": 1,
      "medicationID": 1,
      "prescriptionID": 1,
      "measurementID": 1,
      "adherenceReasonSubtypeID": 1,
      "adherenceReasonSubtypeDescription": "sample string 7"
    }
  ],
  "statusCode": 100,
  "statusDescription": "sample string 1",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfTimelineListModeluskxzdf5 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Response">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <StatusCode>Continue</StatusCode>
  <StatusDescription>sample string 1</StatusDescription>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Models">
    <d2p1:TimelineListModel>
      <d2p1:ActivityID>1</d2p1:ActivityID>
      <d2p1:ActivityTypeID>1</d2p1:ActivityTypeID>
      <d2p1:AdherenceReasonSubtypeDescription>sample string 7</d2p1:AdherenceReasonSubtypeDescription>
      <d2p1:AdherenceReasonSubtypeID>1</d2p1:AdherenceReasonSubtypeID>
      <d2p1:CreatedBy>sample string 5</d2p1:CreatedBy>
      <d2p1:CreatedByID>4</d2p1:CreatedByID>
      <d2p1:Date>2024-10-22T09:24:48.4408033-07:00</d2p1:Date>
      <d2p1:Description>sample string 1</d2p1:Description>
      <d2p1:Detail>sample string 2</d2p1:Detail>
      <d2p1:EquipmentID>1</d2p1:EquipmentID>
      <d2p1:MeasurementID>1</d2p1:MeasurementID>
      <d2p1:MedicationID>1</d2p1:MedicationID>
      <d2p1:Notes>sample string 6</d2p1:Notes>
      <d2p1:PrescriptionID>1</d2p1:PrescriptionID>
      <d2p1:RelatedID>sample string 3</d2p1:RelatedID>
    </d2p1:TimelineListModel>
    <d2p1:TimelineListModel>
      <d2p1:ActivityID>1</d2p1:ActivityID>
      <d2p1:ActivityTypeID>1</d2p1:ActivityTypeID>
      <d2p1:AdherenceReasonSubtypeDescription>sample string 7</d2p1:AdherenceReasonSubtypeDescription>
      <d2p1:AdherenceReasonSubtypeID>1</d2p1:AdherenceReasonSubtypeID>
      <d2p1:CreatedBy>sample string 5</d2p1:CreatedBy>
      <d2p1:CreatedByID>4</d2p1:CreatedByID>
      <d2p1:Date>2024-10-22T09:24:48.4408033-07:00</d2p1:Date>
      <d2p1:Description>sample string 1</d2p1:Description>
      <d2p1:Detail>sample string 2</d2p1:Detail>
      <d2p1:EquipmentID>1</d2p1:EquipmentID>
      <d2p1:MeasurementID>1</d2p1:MeasurementID>
      <d2p1:MedicationID>1</d2p1:MedicationID>
      <d2p1:Notes>sample string 6</d2p1:Notes>
      <d2p1:PrescriptionID>1</d2p1:PrescriptionID>
      <d2p1:RelatedID>sample string 3</d2p1:RelatedID>
    </d2p1:TimelineListModel>
  </Data>
</ResponseOfArrayOfTimelineListModeluskxzdf5>