POST AppointmentReport/GenerateChartReportData
Request Information
URI Parameters
None.
Body Parameters
IConnect.Domain.Reports.CustomerReport.AppointmentReport.ReportViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SelectedCompanies | Collection of integer |
None. |
|
| SelectedProviders | Collection of integer |
None. |
|
| SelectedService | string |
None. |
|
| SelectedSource | IConnect.Domain.Reports.CustomerReport.AppointmentReport.SourceFilter |
None. |
|
| SelectedStatuses | Collection of integer |
None. |
|
| SelectedSortBy | IConnect.Domain.Enumerations.AppointmentSortByOption |
None. |
|
| SelectedEmployeePreference | boolean |
None. |
|
| ParentCustomerId | integer |
None. |
|
| BookingType | IConnect.Domain.Bookings.BookingType |
None. |
|
| CustomerId | integer |
None. |
|
| PageIndex | integer |
None. |
|
| PageSize | integer |
None. |
|
| SortOrder | IConnect.Core.Enumerations.SortOrder |
None. |
|
| IsFullReport | boolean |
None. |
|
| WithCancelDateOnly | boolean |
None. |
|
| ExcludedStatuses | Collection of IConnect.Domain.Bookings.BookingStatus |
None. |
|
| AdjustAppointmentStartEndDates | boolean |
None. |
|
| DateFilterBy | IConnect.Domain.Enumerations.AppointmentDateFilterMode |
None. |
|
| HasMembership | boolean |
None. |
|
| IncludeOtherStoreAppointments | boolean |
None. |
|
| Start | date |
None. |
|
| End | date |
None. |
|
| StartDateObjectString | string |
None. |
|
| EndDateObjectString | string |
None. |
|
| SkipTimeZoneConvertion | boolean |
None. |
|
| ForceImmediateExport | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"SelectedCompanies": [
1,
2
],
"SelectedProviders": [
1,
2
],
"SelectedService": "sample string 1",
"SelectedSource": 1,
"SelectedStatuses": [
1,
2
],
"SelectedSortBy": 1,
"SelectedEmployeePreference": true,
"ParentCustomerId": 1,
"BookingType": 0,
"CustomerId": 1,
"PageIndex": 1,
"PageSize": 1,
"SortOrder": 1,
"IsFullReport": true,
"WithCancelDateOnly": true,
"ExcludedStatuses": [
0,
0
],
"AdjustAppointmentStartEndDates": true,
"DateFilterBy": 0,
"HasMembership": true,
"IncludeOtherStoreAppointments": true,
"Start": "2025-12-15T16:13:51.3044441-05:00",
"End": "2025-12-15T16:13:51.3044441-05:00",
"StartDateObjectString": "{\"year\":2025,\"month\":12,\"date\":15,\"hours\":16,\"minutes\":13,\"seconds\":51,\"miliseconds\":304}",
"EndDateObjectString": "{\"year\":2025,\"month\":12,\"date\":15,\"hours\":16,\"minutes\":13,\"seconds\":51,\"miliseconds\":304}",
"SkipTimeZoneConvertion": true,
"ForceImmediateExport": true
}
application/xml, text/xml
Sample:
<ReportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.CustomerReport.AppointmentReport">
<_x003C_End_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2025-12-15T16:13:51.3044441-05:00</_x003C_End_x003E_k__BackingField>
<_x003C_ForceImmediateExport_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">true</_x003C_ForceImmediateExport_x003E_k__BackingField>
<_x003C_SkipTimeZoneConvertion_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">true</_x003C_SkipTimeZoneConvertion_x003E_k__BackingField>
<_x003C_Start_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2025-12-15T16:13:51.3044441-05:00</_x003C_Start_x003E_k__BackingField>
<_x003C_AdjustAppointmentStartEndDates_x003E_k__BackingField>true</_x003C_AdjustAppointmentStartEndDates_x003E_k__BackingField>
<_x003C_BookingType_x003E_k__BackingField>Appointment</_x003C_BookingType_x003E_k__BackingField>
<_x003C_CustomerId_x003E_k__BackingField>1</_x003C_CustomerId_x003E_k__BackingField>
<_x003C_DateFilterBy_x003E_k__BackingField>ByStartDate</_x003C_DateFilterBy_x003E_k__BackingField>
<_x003C_ExcludedStatuses_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Bookings">
<d2p1:BookingStatus>RequiresApproval</d2p1:BookingStatus>
<d2p1:BookingStatus>RequiresApproval</d2p1:BookingStatus>
</_x003C_ExcludedStatuses_x003E_k__BackingField>
<_x003C_HasMembership_x003E_k__BackingField>true</_x003C_HasMembership_x003E_k__BackingField>
<_x003C_IncludeOtherStoreAppointments_x003E_k__BackingField>true</_x003C_IncludeOtherStoreAppointments_x003E_k__BackingField>
<_x003C_IsFullReport_x003E_k__BackingField>true</_x003C_IsFullReport_x003E_k__BackingField>
<_x003C_PageIndex_x003E_k__BackingField>1</_x003C_PageIndex_x003E_k__BackingField>
<_x003C_PageSize_x003E_k__BackingField>1</_x003C_PageSize_x003E_k__BackingField>
<_x003C_ParentCustomerId_x003E_k__BackingField>1</_x003C_ParentCustomerId_x003E_k__BackingField>
<_x003C_SelectedCompanies_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</_x003C_SelectedCompanies_x003E_k__BackingField>
<_x003C_SelectedEmployeePreference_x003E_k__BackingField>true</_x003C_SelectedEmployeePreference_x003E_k__BackingField>
<_x003C_SelectedProviders_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</_x003C_SelectedProviders_x003E_k__BackingField>
<_x003C_SelectedService_x003E_k__BackingField>sample string 1</_x003C_SelectedService_x003E_k__BackingField>
<_x003C_SelectedSortBy_x003E_k__BackingField>Customer</_x003C_SelectedSortBy_x003E_k__BackingField>
<_x003C_SelectedSource_x003E_k__BackingField>Online</_x003C_SelectedSource_x003E_k__BackingField>
<_x003C_SelectedStatuses_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</_x003C_SelectedStatuses_x003E_k__BackingField>
<_x003C_SortOrder_x003E_k__BackingField>Ascending</_x003C_SortOrder_x003E_k__BackingField>
<_x003C_WithCancelDateOnly_x003E_k__BackingField>true</_x003C_WithCancelDateOnly_x003E_k__BackingField>
</ReportViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IConnect.Domain.Reports.CustomerReport.AppointmentReport.ChartTab.ChartReportItem| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount | integer |
None. |
|
| OnlineBookingCount | integer |
None. |
|
| InStoreBookingCount | integer |
None. |
|
| ApptCreatedByDuringBusinessHoursCount | integer |
None. |
|
| ApptCreatedAfterHoursCount | integer |
None. |
|
| OnlineBookingPersent | integer |
None. |
|
| InStoreBookingPersent | integer |
None. |
|
| ApptCreatedByDuringBusinessHoursPersent | integer |
None. |
|
| ApptCreatedAfterHoursPersent | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalCount": 3,
"OnlineBookingCount": 1,
"InStoreBookingCount": 2,
"ApptCreatedByDuringBusinessHoursCount": 3,
"ApptCreatedAfterHoursCount": 4,
"OnlineBookingPersent": 33,
"InStoreBookingPersent": 67,
"ApptCreatedByDuringBusinessHoursPersent": 100,
"ApptCreatedAfterHoursPersent": 133
}
application/xml, text/xml
Sample:
<ChartReportItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.CustomerReport.AppointmentReport.ChartTab"> <ApptCreatedAfterHoursCount>4</ApptCreatedAfterHoursCount> <ApptCreatedByDuringBusinessHoursCount>3</ApptCreatedByDuringBusinessHoursCount> <InStoreBookingCount>2</InStoreBookingCount> <OnlineBookingCount>1</OnlineBookingCount> </ChartReportItem>