GET Api/Customer/Schedule?startDate={startDate}&endDate={endDate}
returns the customer schedulings
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
startDate | date |
Required |
|
endDate | date |
Required |
Body Parameters
None.
Response Information
Resource Description
CustomerRosterDataName | Description | Type | Additional information |
---|---|---|---|
BeginDate | date |
None. |
|
EndDate | date |
None. |
|
CustomerRosterByTasks | Collection of CustomerRosterByTask |
None. |
|
CustomerRosterByLocations | Collection of CustomerRosterByLocation |
None. |
|
ScheduledResourcesInPeriod | Collection of Resource |
None. |
Response Formats
application/json, text/json
Sample:
{ "BeginDate": "2024-12-22T07:54:56.9222203+01:00", "EndDate": "2024-12-22T07:54:56.9222203+01:00", "CustomerRosterByTasks": [ { "Task": { "Customer": { "Details1": "sample string 1", "UserID": 3, "ID": 5, "Details2": "sample string 2", "Email": "sample string 4", "Name": "sample string 6", "BeginDates": [ "2024-12-22T07:54:56.9222203+01:00", "2024-12-22T07:54:56.9222203+01:00" ], "EndDates": [ "2024-12-22T07:54:56.9222203+01:00", "2024-12-22T07:54:56.9222203+01:00" ] }, "ID": 6, "Location": { "Details1": "sample string 1", "ID": 3, "Details2": "sample string 2", "Name": "sample string 4" }, "Name": "sample string 7", "Color": 1, "BeginTime": "sample string 2", "EndTime": "sample string 3", "Details1": "sample string 4", "Details2": "sample string 5" }, "CustomerRosterByPeriods": [ { "SchedulingID": 1, "Date": "2024-12-22T07:54:56.9222203+01:00", "BeginTime": "2024-12-22T07:54:56.9222203+01:00", "EndTime": "2024-12-22T07:54:56.9222203+01:00", "ScheduledResources": null, "OccupationAmounts": { "RequiredAmount": 1, "ScheduledAmount": 2, "OpenAmount": 3 }, "Reason": { "ID": 1, "Message": "sample string 2", "IsDeleted": true } }, { "SchedulingID": 1, "Date": "2024-12-22T07:54:56.9222203+01:00", "BeginTime": "2024-12-22T07:54:56.9222203+01:00", "EndTime": "2024-12-22T07:54:56.9222203+01:00", "ScheduledResources": null, "OccupationAmounts": { "RequiredAmount": 1, "ScheduledAmount": 2, "OpenAmount": 3 }, "Reason": { "ID": 1, "Message": "sample string 2", "IsDeleted": true } } ] }, { "Task": { "Customer": { "Details1": "sample string 1", "UserID": 3, "ID": 5, "Details2": "sample string 2", "Email": "sample string 4", "Name": "sample string 6", "BeginDates": [ "2024-12-22T07:54:56.9222203+01:00", "2024-12-22T07:54:56.9222203+01:00" ], "EndDates": [ "2024-12-22T07:54:56.9222203+01:00", "2024-12-22T07:54:56.9222203+01:00" ] }, "ID": 6, "Location": { "Details1": "sample string 1", "ID": 3, "Details2": "sample string 2", "Name": "sample string 4" }, "Name": "sample string 7", "Color": 1, "BeginTime": "sample string 2", "EndTime": "sample string 3", "Details1": "sample string 4", "Details2": "sample string 5" }, "CustomerRosterByPeriods": [ { "SchedulingID": 1, "Date": "2024-12-22T07:54:56.9222203+01:00", "BeginTime": "2024-12-22T07:54:56.9222203+01:00", "EndTime": "2024-12-22T07:54:56.9222203+01:00", "ScheduledResources": null, "OccupationAmounts": { "RequiredAmount": 1, "ScheduledAmount": 2, "OpenAmount": 3 }, "Reason": { "ID": 1, "Message": "sample string 2", "IsDeleted": true } }, { "SchedulingID": 1, "Date": "2024-12-22T07:54:56.9222203+01:00", "BeginTime": "2024-12-22T07:54:56.9222203+01:00", "EndTime": "2024-12-22T07:54:56.9222203+01:00", "ScheduledResources": null, "OccupationAmounts": { "RequiredAmount": 1, "ScheduledAmount": 2, "OpenAmount": 3 }, "Reason": { "ID": 1, "Message": "sample string 2", "IsDeleted": true } } ] } ], "CustomerRosterByLocations": [ { "Location": "sample string 1", "CustomerRosterByDays": null }, { "Location": "sample string 1", "CustomerRosterByDays": null } ], "ScheduledResourcesInPeriod": [ { "DefaultAvailable": true, "UserID": 14, "ID": 16, "Name": "sample string 5", "Email": "sample string 15", "LastName": "sample string 2", "BeginDates": [ "2024-12-22T07:54:56.9222203+01:00", "2024-12-22T07:54:56.9222203+01:00" ], "MiddleName": "sample string 3", "EndDates": [ "2024-12-22T07:54:56.9222203+01:00", "2024-12-22T07:54:56.9222203+01:00" ], "FirstName": "sample string 4", "FullName": "sample string 5", "EmployeeNumber": "sample string 6", "UserGroup": "sample string 7", "GroupSchedule1": "sample string 8", "GroupSchedule2": "sample string 9", "GroupSchedule3": "sample string 10", "GroupSchedule4": "sample string 11", "GroupSchedule5": "sample string 12", "DefaultUserGroup": "sample string 13" }, { "DefaultAvailable": true, "UserID": 14, "ID": 16, "Name": "sample string 5", "Email": "sample string 15", "LastName": "sample string 2", "BeginDates": [ "2024-12-22T07:54:56.9222203+01:00", "2024-12-22T07:54:56.9222203+01:00" ], "MiddleName": "sample string 3", "EndDates": [ "2024-12-22T07:54:56.9222203+01:00", "2024-12-22T07:54:56.9222203+01:00" ], "FirstName": "sample string 4", "FullName": "sample string 5", "EmployeeNumber": "sample string 6", "UserGroup": "sample string 7", "GroupSchedule1": "sample string 8", "GroupSchedule2": "sample string 9", "GroupSchedule3": "sample string 10", "GroupSchedule4": "sample string 11", "GroupSchedule5": "sample string 12", "DefaultUserGroup": "sample string 13" } ] }
application/xml, text/xml
Sample:
<CustomerRosterData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Paralax.Cas.Web.WebServices.Models"> <BeginDate>2024-12-22T07:54:56.9222203+01:00</BeginDate> <EndDate>2024-12-22T07:54:56.9222203+01:00</EndDate> <CustomerRosterByTasks> <CustomerRosterByTask> <Task> <ID>6</ID> <Name>sample string 7</Name> <Customer> <ID>5</ID> <Name>sample string 6</Name> <UserID>3</UserID> <Email>sample string 4</Email> <BeginDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d6p1:dateTime> <d6p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d6p1:dateTime> </BeginDates> <EndDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d6p1:dateTime> <d6p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d6p1:dateTime> </EndDates> <Details1>sample string 1</Details1> <Details2>sample string 2</Details2> </Customer> <Location> <ID>3</ID> <Name>sample string 4</Name> <Details1>sample string 1</Details1> <Details2>sample string 2</Details2> </Location> <Color>1</Color> <BeginTime>sample string 2</BeginTime> <EndTime>sample string 3</EndTime> <Details1>sample string 4</Details1> <Details2>sample string 5</Details2> </Task> <CustomerRosterByPeriods> <CustomerRosterByPeriod> <SchedulingID>1</SchedulingID> <Date>2024-12-22T07:54:56.9222203+01:00</Date> <BeginTime>2024-12-22T07:54:56.9222203+01:00</BeginTime> <EndTime>2024-12-22T07:54:56.9222203+01:00</EndTime> <ScheduledResources i:nil="true" /> <OccupationAmounts> <RequiredAmount>1</RequiredAmount> <ScheduledAmount>2</ScheduledAmount> <OpenAmount>3</OpenAmount> </OccupationAmounts> <Reason> <ID>1</ID> <Message>sample string 2</Message> <IsDeleted>true</IsDeleted> </Reason> </CustomerRosterByPeriod> <CustomerRosterByPeriod> <SchedulingID>1</SchedulingID> <Date>2024-12-22T07:54:56.9222203+01:00</Date> <BeginTime>2024-12-22T07:54:56.9222203+01:00</BeginTime> <EndTime>2024-12-22T07:54:56.9222203+01:00</EndTime> <ScheduledResources i:nil="true" /> <OccupationAmounts> <RequiredAmount>1</RequiredAmount> <ScheduledAmount>2</ScheduledAmount> <OpenAmount>3</OpenAmount> </OccupationAmounts> <Reason> <ID>1</ID> <Message>sample string 2</Message> <IsDeleted>true</IsDeleted> </Reason> </CustomerRosterByPeriod> </CustomerRosterByPeriods> </CustomerRosterByTask> <CustomerRosterByTask> <Task> <ID>6</ID> <Name>sample string 7</Name> <Customer> <ID>5</ID> <Name>sample string 6</Name> <UserID>3</UserID> <Email>sample string 4</Email> <BeginDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d6p1:dateTime> <d6p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d6p1:dateTime> </BeginDates> <EndDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d6p1:dateTime> <d6p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d6p1:dateTime> </EndDates> <Details1>sample string 1</Details1> <Details2>sample string 2</Details2> </Customer> <Location> <ID>3</ID> <Name>sample string 4</Name> <Details1>sample string 1</Details1> <Details2>sample string 2</Details2> </Location> <Color>1</Color> <BeginTime>sample string 2</BeginTime> <EndTime>sample string 3</EndTime> <Details1>sample string 4</Details1> <Details2>sample string 5</Details2> </Task> <CustomerRosterByPeriods> <CustomerRosterByPeriod> <SchedulingID>1</SchedulingID> <Date>2024-12-22T07:54:56.9222203+01:00</Date> <BeginTime>2024-12-22T07:54:56.9222203+01:00</BeginTime> <EndTime>2024-12-22T07:54:56.9222203+01:00</EndTime> <ScheduledResources i:nil="true" /> <OccupationAmounts> <RequiredAmount>1</RequiredAmount> <ScheduledAmount>2</ScheduledAmount> <OpenAmount>3</OpenAmount> </OccupationAmounts> <Reason> <ID>1</ID> <Message>sample string 2</Message> <IsDeleted>true</IsDeleted> </Reason> </CustomerRosterByPeriod> <CustomerRosterByPeriod> <SchedulingID>1</SchedulingID> <Date>2024-12-22T07:54:56.9222203+01:00</Date> <BeginTime>2024-12-22T07:54:56.9222203+01:00</BeginTime> <EndTime>2024-12-22T07:54:56.9222203+01:00</EndTime> <ScheduledResources i:nil="true" /> <OccupationAmounts> <RequiredAmount>1</RequiredAmount> <ScheduledAmount>2</ScheduledAmount> <OpenAmount>3</OpenAmount> </OccupationAmounts> <Reason> <ID>1</ID> <Message>sample string 2</Message> <IsDeleted>true</IsDeleted> </Reason> </CustomerRosterByPeriod> </CustomerRosterByPeriods> </CustomerRosterByTask> </CustomerRosterByTasks> <CustomerRosterByLocations> <CustomerRosterByLocation> <Location>sample string 1</Location> <CustomerRosterByDays i:nil="true" /> </CustomerRosterByLocation> <CustomerRosterByLocation> <Location>sample string 1</Location> <CustomerRosterByDays i:nil="true" /> </CustomerRosterByLocation> </CustomerRosterByLocations> <ScheduledResourcesInPeriod> <Resource> <ID>16</ID> <Name>sample string 5</Name> <UserID>14</UserID> <Email>sample string 15</Email> <BeginDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d4p1:dateTime> <d4p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d4p1:dateTime> </BeginDates> <EndDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d4p1:dateTime> <d4p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d4p1:dateTime> </EndDates> <DefaultAvailable>true</DefaultAvailable> <LastName>sample string 2</LastName> <MiddleName>sample string 3</MiddleName> <FirstName>sample string 4</FirstName> <FullName>sample string 5</FullName> <EmployeeNumber>sample string 6</EmployeeNumber> <UserGroup>sample string 7</UserGroup> <GroupSchedule1>sample string 8</GroupSchedule1> <GroupSchedule2>sample string 9</GroupSchedule2> <GroupSchedule3>sample string 10</GroupSchedule3> <GroupSchedule4>sample string 11</GroupSchedule4> <GroupSchedule5>sample string 12</GroupSchedule5> <DefaultUserGroup>sample string 13</DefaultUserGroup> </Resource> <Resource> <ID>16</ID> <Name>sample string 5</Name> <UserID>14</UserID> <Email>sample string 15</Email> <BeginDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d4p1:dateTime> <d4p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d4p1:dateTime> </BeginDates> <EndDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d4p1:dateTime> <d4p1:dateTime>2024-12-22T07:54:56.9222203+01:00</d4p1:dateTime> </EndDates> <DefaultAvailable>true</DefaultAvailable> <LastName>sample string 2</LastName> <MiddleName>sample string 3</MiddleName> <FirstName>sample string 4</FirstName> <FullName>sample string 5</FullName> <EmployeeNumber>sample string 6</EmployeeNumber> <UserGroup>sample string 7</UserGroup> <GroupSchedule1>sample string 8</GroupSchedule1> <GroupSchedule2>sample string 9</GroupSchedule2> <GroupSchedule3>sample string 10</GroupSchedule3> <GroupSchedule4>sample string 11</GroupSchedule4> <GroupSchedule5>sample string 12</GroupSchedule5> <DefaultUserGroup>sample string 13</DefaultUserGroup> </Resource> </ScheduledResourcesInPeriod> </CustomerRosterData>