GET Api/Resource/Schedule?startDate={startDate}&endDate={endDate}
returns the schedule data for the resource (user in this case)
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
startDate | date |
Required |
|
endDate | date |
Required |
Body Parameters
None.
Response Information
Resource Description
ResourceScheduledDataName | Description | Type | Additional information |
---|---|---|---|
Tasks | Collection of TaskSlim |
None. |
|
ExtraCodes | Collection of ExtraCode |
None. |
|
ExtraSegments | Collection of ExtraSegmentSlim |
None. |
|
Availabilities | Collection of Availability |
None. |
|
StandardAvailabilities | Collection of StandardAvailability |
None. |
|
Customers | Collection of CustomerModel |
None. |
|
Locations | Collection of Location |
None. |
|
TaskSchedulings | Collection of TaskScheduling |
None. |
|
ExtraSegmentSchedulings | Collection of ExtraSegmentScheduling |
None. |
|
ExtraCodeSchedulings | Collection of ExtraCodeScheduling |
None. |
|
MemoSchedulings | Collection of MemoScheduling |
None. |
|
AvailabilitySchedulings | Collection of AvailabilityScheduling |
None. |
|
DayAvailabilityForDays | Collection of DayAvailability |
None. |
|
LeaveSchedulings | Collection of LeaveScheduling |
None. |
|
BeginDate | date |
None. |
|
EndDate | date |
None. |
Response Formats
application/json, text/json
Sample:
{ "Tasks": [ { "ID": 1, "Name": "sample string 2", "CustomerID": 3, "LocationID": 4, "Color": 5, "BeginTime": "sample string 6", "EndTime": "sample string 7", "Details1": "sample string 8", "Details2": "sample string 9" }, { "ID": 1, "Name": "sample string 2", "CustomerID": 3, "LocationID": 4, "Color": 5, "BeginTime": "sample string 6", "EndTime": "sample string 7", "Details1": "sample string 8", "Details2": "sample string 9" } ], "ExtraCodes": null, "ExtraSegments": [ { "ID": 1, "Name": "sample string 2", "CustomerID": 3, "LocationID": 4, "Color": 5, "Details1": "sample string 6", "Details2": "sample string 7" }, { "ID": 1, "Name": "sample string 2", "CustomerID": 3, "LocationID": 4, "Color": 5, "Details1": "sample string 6", "Details2": "sample string 7" } ], "Availabilities": [ { "Id": 1, "Available": true, "AvailabilityName": "sample string 3", "IsWeb": true }, { "Id": 1, "Available": true, "AvailabilityName": "sample string 3", "IsWeb": true } ], "StandardAvailabilities": [ { "ID": 1, "Name": "sample string 2", "Symbol": "sample string 3", "Weight": 4 }, { "ID": 1, "Name": "sample string 2", "Symbol": "sample string 3", "Weight": 4 } ], "Customers": [ { "Details1": "sample string 1", "UserID": 3, "ID": 5, "Details2": "sample string 2", "Email": "sample string 4", "Name": "sample string 6", "BeginDates": [ "2024-12-22T07:55:31.0598698+01:00", "2024-12-22T07:55:31.0598698+01:00" ], "EndDates": [ "2024-12-22T07:55:31.0598698+01:00", "2024-12-22T07:55:31.0598698+01:00" ] }, { "Details1": "sample string 1", "UserID": 3, "ID": 5, "Details2": "sample string 2", "Email": "sample string 4", "Name": "sample string 6", "BeginDates": [ "2024-12-22T07:55:31.0598698+01:00", "2024-12-22T07:55:31.0598698+01:00" ], "EndDates": [ "2024-12-22T07:55:31.0598698+01:00", "2024-12-22T07:55:31.0598698+01:00" ] } ], "Locations": [ { "Details1": "sample string 1", "ID": 3, "Details2": "sample string 2", "Name": "sample string 4" }, { "Details1": "sample string 1", "ID": 3, "Details2": "sample string 2", "Name": "sample string 4" } ], "TaskSchedulings": [ { "TaskID": 1, "SchedulingID": 4, "PlannerComment": "sample string 2", "Date": "2024-12-22T07:55:31.0598698+01:00", "TaskColor": 3, "BeginTime": "2024-12-22T07:55:31.0598698+01:00", "EndTime": "2024-12-22T07:55:31.0598698+01:00", "AcknowledgedID": 8 }, { "TaskID": 1, "SchedulingID": 4, "PlannerComment": "sample string 2", "Date": "2024-12-22T07:55:31.0598698+01:00", "TaskColor": 3, "BeginTime": "2024-12-22T07:55:31.0598698+01:00", "EndTime": "2024-12-22T07:55:31.0598698+01:00", "AcknowledgedID": 8 } ], "ExtraSegmentSchedulings": [ { "ExtraSegmentID": 1, "SchedulingID": 2, "Date": "2024-12-22T07:55:31.0598698+01:00", "BeginTime": "2024-12-22T07:55:31.0598698+01:00", "EndTime": "2024-12-22T07:55:31.0598698+01:00", "AcknowledgedID": 6 }, { "ExtraSegmentID": 1, "SchedulingID": 2, "Date": "2024-12-22T07:55:31.0598698+01:00", "BeginTime": "2024-12-22T07:55:31.0598698+01:00", "EndTime": "2024-12-22T07:55:31.0598698+01:00", "AcknowledgedID": 6 } ], "ExtraCodeSchedulings": [ { "ExtraCodeID": 1, "SchedulingID": 4, "RequestID": 2, "Date": "2024-12-22T07:55:31.0598698+01:00", "PlannerComment": "sample string 3", "BeginTime": "2024-12-22T07:55:31.0598698+01:00", "EndTime": "2024-12-22T07:55:31.0598698+01:00", "AcknowledgedID": 8 }, { "ExtraCodeID": 1, "SchedulingID": 4, "RequestID": 2, "Date": "2024-12-22T07:55:31.0598698+01:00", "PlannerComment": "sample string 3", "BeginTime": "2024-12-22T07:55:31.0598698+01:00", "EndTime": "2024-12-22T07:55:31.0598698+01:00", "AcknowledgedID": 8 } ], "MemoSchedulings": [ { "PlannerComment": "sample string 1", "SchedulingID": 2, "Date": "2024-12-22T07:55:31.0598698+01:00", "BeginTime": "2024-12-22T07:55:31.0598698+01:00", "EndTime": "2024-12-22T07:55:31.0598698+01:00", "AcknowledgedID": 6 }, { "PlannerComment": "sample string 1", "SchedulingID": 2, "Date": "2024-12-22T07:55:31.0598698+01:00", "BeginTime": "2024-12-22T07:55:31.0598698+01:00", "EndTime": "2024-12-22T07:55:31.0598698+01:00", "AcknowledgedID": 6 } ], "AvailabilitySchedulings": [ { "AvailabilityID": 1, "SchedulingID": 3, "RequestID": 2, "Date": "2024-12-22T07:55:31.0598698+01:00", "BeginTime": "2024-12-22T07:55:31.0598698+01:00", "EndTime": "2024-12-22T07:55:31.0598698+01:00", "AcknowledgedID": 7 }, { "AvailabilityID": 1, "SchedulingID": 3, "RequestID": 2, "Date": "2024-12-22T07:55:31.0598698+01:00", "BeginTime": "2024-12-22T07:55:31.0598698+01:00", "EndTime": "2024-12-22T07:55:31.0598698+01:00", "AcknowledgedID": 7 } ], "DayAvailabilityForDays": [ { "Date": "2024-12-22T07:55:31.0598698+01:00", "StandardAvailabilityID": 2, "RequestID": 3, "AvailabilityBlockSchedulings": [ { "AvailabilityBlock": { "StandardAvailabilityID": 1, "BeginTime": "sample string 2", "EndTime": "sample string 3" }, "BeginTime": "sample string 1", "EndTime": "sample string 2" }, { "AvailabilityBlock": { "StandardAvailabilityID": 1, "BeginTime": "sample string 2", "EndTime": "sample string 3" }, "BeginTime": "sample string 1", "EndTime": "sample string 2" } ], "StandardAvailabilitySchedulings": [ { "StandardAvailabilityID": 1, "BeginTime": "sample string 2", "EndTime": "sample string 3" }, { "StandardAvailabilityID": 1, "BeginTime": "sample string 2", "EndTime": "sample string 3" } ] }, { "Date": "2024-12-22T07:55:31.0598698+01:00", "StandardAvailabilityID": 2, "RequestID": 3, "AvailabilityBlockSchedulings": [ { "AvailabilityBlock": { "StandardAvailabilityID": 1, "BeginTime": "sample string 2", "EndTime": "sample string 3" }, "BeginTime": "sample string 1", "EndTime": "sample string 2" }, { "AvailabilityBlock": { "StandardAvailabilityID": 1, "BeginTime": "sample string 2", "EndTime": "sample string 3" }, "BeginTime": "sample string 1", "EndTime": "sample string 2" } ], "StandardAvailabilitySchedulings": [ { "StandardAvailabilityID": 1, "BeginTime": "sample string 2", "EndTime": "sample string 3" }, { "StandardAvailabilityID": 1, "BeginTime": "sample string 2", "EndTime": "sample string 3" } ] } ], "LeaveSchedulings": [ { "ExtraCodeID": 1, "SchedulingID": 4, "LeavePeriodID": 2, "Date": "2024-12-22T07:55:31.0598698+01:00", "OpenRequestID": 3, "BeginTime": "2024-12-22T07:55:31.0598698+01:00", "EndTime": "2024-12-22T07:55:31.0598698+01:00", "AcknowledgedID": 8 }, { "ExtraCodeID": 1, "SchedulingID": 4, "LeavePeriodID": 2, "Date": "2024-12-22T07:55:31.0598698+01:00", "OpenRequestID": 3, "BeginTime": "2024-12-22T07:55:31.0598698+01:00", "EndTime": "2024-12-22T07:55:31.0598698+01:00", "AcknowledgedID": 8 } ], "BeginDate": "2024-12-22T07:55:31.0598698+01:00", "EndDate": "2024-12-22T07:55:31.0598698+01:00" }
application/xml, text/xml
Sample:
<ResourceScheduledData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Paralax.Cas.Web.WebServices.Models"> <Tasks> <TaskSlim> <ID>1</ID> <Name>sample string 2</Name> <CustomerID>3</CustomerID> <LocationID>4</LocationID> <Color>5</Color> <BeginTime>sample string 6</BeginTime> <EndTime>sample string 7</EndTime> <Details1>sample string 8</Details1> <Details2>sample string 9</Details2> </TaskSlim> <TaskSlim> <ID>1</ID> <Name>sample string 2</Name> <CustomerID>3</CustomerID> <LocationID>4</LocationID> <Color>5</Color> <BeginTime>sample string 6</BeginTime> <EndTime>sample string 7</EndTime> <Details1>sample string 8</Details1> <Details2>sample string 9</Details2> </TaskSlim> </Tasks> <ExtraCodes i:nil="true" /> <ExtraSegments> <ExtraSegmentSlim> <ID>1</ID> <Name>sample string 2</Name> <CustomerID>3</CustomerID> <LocationID>4</LocationID> <Color>5</Color> <Details1>sample string 6</Details1> <Details2>sample string 7</Details2> </ExtraSegmentSlim> <ExtraSegmentSlim> <ID>1</ID> <Name>sample string 2</Name> <CustomerID>3</CustomerID> <LocationID>4</LocationID> <Color>5</Color> <Details1>sample string 6</Details1> <Details2>sample string 7</Details2> </ExtraSegmentSlim> </ExtraSegments> <Availabilities> <Availability> <Id>1</Id> <Available>true</Available> <AvailabilityName>sample string 3</AvailabilityName> <IsWeb>true</IsWeb> </Availability> <Availability> <Id>1</Id> <Available>true</Available> <AvailabilityName>sample string 3</AvailabilityName> <IsWeb>true</IsWeb> </Availability> </Availabilities> <StandardAvailabilities> <StandardAvailability> <ID>1</ID> <Name>sample string 2</Name> <Symbol>sample string 3</Symbol> <Weight>4</Weight> </StandardAvailability> <StandardAvailability> <ID>1</ID> <Name>sample string 2</Name> <Symbol>sample string 3</Symbol> <Weight>4</Weight> </StandardAvailability> </StandardAvailabilities> <Customers> <CustomerModel> <ID>5</ID> <Name>sample string 6</Name> <UserID>3</UserID> <Email>sample string 4</Email> <BeginDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:dateTime>2024-12-22T07:55:31.0598698+01:00</d4p1:dateTime> <d4p1:dateTime>2024-12-22T07:55:31.0598698+01:00</d4p1:dateTime> </BeginDates> <EndDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:dateTime>2024-12-22T07:55:31.0598698+01:00</d4p1:dateTime> <d4p1:dateTime>2024-12-22T07:55:31.0598698+01:00</d4p1:dateTime> </EndDates> <Details1>sample string 1</Details1> <Details2>sample string 2</Details2> </CustomerModel> <CustomerModel> <ID>5</ID> <Name>sample string 6</Name> <UserID>3</UserID> <Email>sample string 4</Email> <BeginDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:dateTime>2024-12-22T07:55:31.0598698+01:00</d4p1:dateTime> <d4p1:dateTime>2024-12-22T07:55:31.0598698+01:00</d4p1:dateTime> </BeginDates> <EndDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:dateTime>2024-12-22T07:55:31.0598698+01:00</d4p1:dateTime> <d4p1:dateTime>2024-12-22T07:55:31.0598698+01:00</d4p1:dateTime> </EndDates> <Details1>sample string 1</Details1> <Details2>sample string 2</Details2> </CustomerModel> </Customers> <Locations> <Location> <ID>3</ID> <Name>sample string 4</Name> <Details1>sample string 1</Details1> <Details2>sample string 2</Details2> </Location> <Location> <ID>3</ID> <Name>sample string 4</Name> <Details1>sample string 1</Details1> <Details2>sample string 2</Details2> </Location> </Locations> <TaskSchedulings> <TaskScheduling> <SchedulingID>4</SchedulingID> <Date>2024-12-22T07:55:31.0598698+01:00</Date> <BeginTime>2024-12-22T07:55:31.0598698+01:00</BeginTime> <EndTime>2024-12-22T07:55:31.0598698+01:00</EndTime> <AcknowledgedID>8</AcknowledgedID> <TaskID>1</TaskID> <PlannerComment>sample string 2</PlannerComment> <TaskColor>3</TaskColor> </TaskScheduling> <TaskScheduling> <SchedulingID>4</SchedulingID> <Date>2024-12-22T07:55:31.0598698+01:00</Date> <BeginTime>2024-12-22T07:55:31.0598698+01:00</BeginTime> <EndTime>2024-12-22T07:55:31.0598698+01:00</EndTime> <AcknowledgedID>8</AcknowledgedID> <TaskID>1</TaskID> <PlannerComment>sample string 2</PlannerComment> <TaskColor>3</TaskColor> </TaskScheduling> </TaskSchedulings> <ExtraSegmentSchedulings> <ExtraSegmentScheduling> <SchedulingID>2</SchedulingID> <Date>2024-12-22T07:55:31.0598698+01:00</Date> <BeginTime>2024-12-22T07:55:31.0598698+01:00</BeginTime> <EndTime>2024-12-22T07:55:31.0598698+01:00</EndTime> <AcknowledgedID>6</AcknowledgedID> <ExtraSegmentID>1</ExtraSegmentID> </ExtraSegmentScheduling> <ExtraSegmentScheduling> <SchedulingID>2</SchedulingID> <Date>2024-12-22T07:55:31.0598698+01:00</Date> <BeginTime>2024-12-22T07:55:31.0598698+01:00</BeginTime> <EndTime>2024-12-22T07:55:31.0598698+01:00</EndTime> <AcknowledgedID>6</AcknowledgedID> <ExtraSegmentID>1</ExtraSegmentID> </ExtraSegmentScheduling> </ExtraSegmentSchedulings> <ExtraCodeSchedulings> <ExtraCodeScheduling> <SchedulingID>4</SchedulingID> <Date>2024-12-22T07:55:31.0598698+01:00</Date> <BeginTime>2024-12-22T07:55:31.0598698+01:00</BeginTime> <EndTime>2024-12-22T07:55:31.0598698+01:00</EndTime> <AcknowledgedID>8</AcknowledgedID> <ExtraCodeID>1</ExtraCodeID> <RequestID>2</RequestID> <PlannerComment>sample string 3</PlannerComment> </ExtraCodeScheduling> <ExtraCodeScheduling> <SchedulingID>4</SchedulingID> <Date>2024-12-22T07:55:31.0598698+01:00</Date> <BeginTime>2024-12-22T07:55:31.0598698+01:00</BeginTime> <EndTime>2024-12-22T07:55:31.0598698+01:00</EndTime> <AcknowledgedID>8</AcknowledgedID> <ExtraCodeID>1</ExtraCodeID> <RequestID>2</RequestID> <PlannerComment>sample string 3</PlannerComment> </ExtraCodeScheduling> </ExtraCodeSchedulings> <MemoSchedulings> <MemoScheduling> <SchedulingID>2</SchedulingID> <Date>2024-12-22T07:55:31.0598698+01:00</Date> <BeginTime>2024-12-22T07:55:31.0598698+01:00</BeginTime> <EndTime>2024-12-22T07:55:31.0598698+01:00</EndTime> <AcknowledgedID>6</AcknowledgedID> <PlannerComment>sample string 1</PlannerComment> </MemoScheduling> <MemoScheduling> <SchedulingID>2</SchedulingID> <Date>2024-12-22T07:55:31.0598698+01:00</Date> <BeginTime>2024-12-22T07:55:31.0598698+01:00</BeginTime> <EndTime>2024-12-22T07:55:31.0598698+01:00</EndTime> <AcknowledgedID>6</AcknowledgedID> <PlannerComment>sample string 1</PlannerComment> </MemoScheduling> </MemoSchedulings> <AvailabilitySchedulings> <AvailabilityScheduling> <SchedulingID>3</SchedulingID> <Date>2024-12-22T07:55:31.0598698+01:00</Date> <BeginTime>2024-12-22T07:55:31.0598698+01:00</BeginTime> <EndTime>2024-12-22T07:55:31.0598698+01:00</EndTime> <AcknowledgedID>7</AcknowledgedID> <AvailabilityID>1</AvailabilityID> <RequestID>2</RequestID> </AvailabilityScheduling> <AvailabilityScheduling> <SchedulingID>3</SchedulingID> <Date>2024-12-22T07:55:31.0598698+01:00</Date> <BeginTime>2024-12-22T07:55:31.0598698+01:00</BeginTime> <EndTime>2024-12-22T07:55:31.0598698+01:00</EndTime> <AcknowledgedID>7</AcknowledgedID> <AvailabilityID>1</AvailabilityID> <RequestID>2</RequestID> </AvailabilityScheduling> </AvailabilitySchedulings> <DayAvailabilityForDays> <DayAvailability> <Date>2024-12-22T07:55:31.0598698+01:00</Date> <StandardAvailabilityID>2</StandardAvailabilityID> <RequestID>3</RequestID> <AvailabilityBlockSchedulings> <AvailabilityBlockScheduling> <AvailabilityBlock> <StandardAvailabilityID>1</StandardAvailabilityID> <BeginTime>sample string 2</BeginTime> <EndTime>sample string 3</EndTime> </AvailabilityBlock> <BeginTime>sample string 1</BeginTime> <EndTime>sample string 2</EndTime> </AvailabilityBlockScheduling> <AvailabilityBlockScheduling> <AvailabilityBlock> <StandardAvailabilityID>1</StandardAvailabilityID> <BeginTime>sample string 2</BeginTime> <EndTime>sample string 3</EndTime> </AvailabilityBlock> <BeginTime>sample string 1</BeginTime> <EndTime>sample string 2</EndTime> </AvailabilityBlockScheduling> </AvailabilityBlockSchedulings> <StandardAvailabilitySchedulings> <StandardAvailabilityScheduling> <StandardAvailabilityID>1</StandardAvailabilityID> <BeginTime>sample string 2</BeginTime> <EndTime>sample string 3</EndTime> </StandardAvailabilityScheduling> <StandardAvailabilityScheduling> <StandardAvailabilityID>1</StandardAvailabilityID> <BeginTime>sample string 2</BeginTime> <EndTime>sample string 3</EndTime> </StandardAvailabilityScheduling> </StandardAvailabilitySchedulings> </DayAvailability> <DayAvailability> <Date>2024-12-22T07:55:31.0598698+01:00</Date> <StandardAvailabilityID>2</StandardAvailabilityID> <RequestID>3</RequestID> <AvailabilityBlockSchedulings> <AvailabilityBlockScheduling> <AvailabilityBlock> <StandardAvailabilityID>1</StandardAvailabilityID> <BeginTime>sample string 2</BeginTime> <EndTime>sample string 3</EndTime> </AvailabilityBlock> <BeginTime>sample string 1</BeginTime> <EndTime>sample string 2</EndTime> </AvailabilityBlockScheduling> <AvailabilityBlockScheduling> <AvailabilityBlock> <StandardAvailabilityID>1</StandardAvailabilityID> <BeginTime>sample string 2</BeginTime> <EndTime>sample string 3</EndTime> </AvailabilityBlock> <BeginTime>sample string 1</BeginTime> <EndTime>sample string 2</EndTime> </AvailabilityBlockScheduling> </AvailabilityBlockSchedulings> <StandardAvailabilitySchedulings> <StandardAvailabilityScheduling> <StandardAvailabilityID>1</StandardAvailabilityID> <BeginTime>sample string 2</BeginTime> <EndTime>sample string 3</EndTime> </StandardAvailabilityScheduling> <StandardAvailabilityScheduling> <StandardAvailabilityID>1</StandardAvailabilityID> <BeginTime>sample string 2</BeginTime> <EndTime>sample string 3</EndTime> </StandardAvailabilityScheduling> </StandardAvailabilitySchedulings> </DayAvailability> </DayAvailabilityForDays> <BeginDate>2024-12-22T07:55:31.0598698+01:00</BeginDate> <LeaveSchedulings> <LeaveScheduling> <SchedulingID>4</SchedulingID> <Date>2024-12-22T07:55:31.0598698+01:00</Date> <BeginTime>2024-12-22T07:55:31.0598698+01:00</BeginTime> <EndTime>2024-12-22T07:55:31.0598698+01:00</EndTime> <AcknowledgedID>8</AcknowledgedID> <ExtraCodeID>1</ExtraCodeID> <LeavePeriodID>2</LeavePeriodID> <OpenRequestID>3</OpenRequestID> </LeaveScheduling> <LeaveScheduling> <SchedulingID>4</SchedulingID> <Date>2024-12-22T07:55:31.0598698+01:00</Date> <BeginTime>2024-12-22T07:55:31.0598698+01:00</BeginTime> <EndTime>2024-12-22T07:55:31.0598698+01:00</EndTime> <AcknowledgedID>8</AcknowledgedID> <ExtraCodeID>1</ExtraCodeID> <LeavePeriodID>2</LeavePeriodID> <OpenRequestID>3</OpenRequestID> </LeaveScheduling> </LeaveSchedulings> <EndDate>2024-12-22T07:55:31.0598698+01:00</EndDate> </ResourceScheduledData>