POST Dashboard/DashboardData
Request Information
URI Parameters
None.
Body Parameters
IConnect.Domain.Dashboard.DashboardRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| EmployeeId | integer |
None. |
|
| NoOfDays | integer |
None. |
|
| IncludeTax | boolean |
None. |
|
| IncludeGiftCardSales | boolean |
None. |
|
| IsMobile | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"EmployeeId": 1,
"NoOfDays": 1,
"IncludeTax": true,
"IncludeGiftCardSales": true,
"IsMobile": true
}
application/xml, text/xml
Sample:
<DashboardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Dashboard"> <EmployeeId>1</EmployeeId> <IncludeGiftCardSales>true</IncludeGiftCardSales> <IncludeTax>true</IncludeTax> <IsMobile>true</IsMobile> <NoOfDays>1</NoOfDays> </DashboardRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IConnect.Domain.Dashboard.DashboardData| Name | Description | Type | Additional information |
|---|---|---|---|
| DashboardItems | Collection of IConnect.Domain.Dashboard.DashboardItem |
None. |
|
| OrderSourceItems | Collection of IConnect.Domain.Dashboard.DashboardItem |
None. |
|
| OrderTypeItems | Collection of IConnect.Domain.Dashboard.DashboardItem |
None. |
Response Formats
application/json, text/json
Sample:
{
"DashboardItems": [
{
"Today": true,
"Week": true,
"Month": true,
"Date": "2024-10-18T04:40:03.5133525-04:00",
"FormattedDate": "sample string 5",
"OrderType": "sample string 6",
"OrderSource": "sample string 7",
"ProductTotal": 8.0,
"GiftCardTotal": 9.0,
"ServiceTotal": 10.0,
"ProductTaxes": 11.0,
"GiftCardTaxes": 12.0,
"ServiceTaxes": 13.0,
"TransactionNumber": 14,
"FulfilledPoQuantity": 15,
"PaidTransactionNumber": 16,
"TransactionNumberGiftCardsOnly": 17,
"PaidTransactionNumberGiftCardsOnly": 18,
"TargetProductsSales": 19.0,
"TargetServicesSales": 20.0,
"Quantity": 21.0,
"QuantityGiftCardsOnly": 22.0,
"TotalTargetSales": 39.0,
"RealPayment": 23.0,
"NewCustomers": 24,
"Appointments": 25,
"ActualLaborCost": 26.0,
"ReviewAvgRating": 27.0
},
{
"Today": true,
"Week": true,
"Month": true,
"Date": "2024-10-18T04:40:03.5133525-04:00",
"FormattedDate": "sample string 5",
"OrderType": "sample string 6",
"OrderSource": "sample string 7",
"ProductTotal": 8.0,
"GiftCardTotal": 9.0,
"ServiceTotal": 10.0,
"ProductTaxes": 11.0,
"GiftCardTaxes": 12.0,
"ServiceTaxes": 13.0,
"TransactionNumber": 14,
"FulfilledPoQuantity": 15,
"PaidTransactionNumber": 16,
"TransactionNumberGiftCardsOnly": 17,
"PaidTransactionNumberGiftCardsOnly": 18,
"TargetProductsSales": 19.0,
"TargetServicesSales": 20.0,
"Quantity": 21.0,
"QuantityGiftCardsOnly": 22.0,
"TotalTargetSales": 39.0,
"RealPayment": 23.0,
"NewCustomers": 24,
"Appointments": 25,
"ActualLaborCost": 26.0,
"ReviewAvgRating": 27.0
}
],
"OrderSourceItems": [
{
"Today": true,
"Week": true,
"Month": true,
"Date": "2024-10-18T04:40:03.5133525-04:00",
"FormattedDate": "sample string 5",
"OrderType": "sample string 6",
"OrderSource": "sample string 7",
"ProductTotal": 8.0,
"GiftCardTotal": 9.0,
"ServiceTotal": 10.0,
"ProductTaxes": 11.0,
"GiftCardTaxes": 12.0,
"ServiceTaxes": 13.0,
"TransactionNumber": 14,
"FulfilledPoQuantity": 15,
"PaidTransactionNumber": 16,
"TransactionNumberGiftCardsOnly": 17,
"PaidTransactionNumberGiftCardsOnly": 18,
"TargetProductsSales": 19.0,
"TargetServicesSales": 20.0,
"Quantity": 21.0,
"QuantityGiftCardsOnly": 22.0,
"TotalTargetSales": 39.0,
"RealPayment": 23.0,
"NewCustomers": 24,
"Appointments": 25,
"ActualLaborCost": 26.0,
"ReviewAvgRating": 27.0
},
{
"Today": true,
"Week": true,
"Month": true,
"Date": "2024-10-18T04:40:03.5133525-04:00",
"FormattedDate": "sample string 5",
"OrderType": "sample string 6",
"OrderSource": "sample string 7",
"ProductTotal": 8.0,
"GiftCardTotal": 9.0,
"ServiceTotal": 10.0,
"ProductTaxes": 11.0,
"GiftCardTaxes": 12.0,
"ServiceTaxes": 13.0,
"TransactionNumber": 14,
"FulfilledPoQuantity": 15,
"PaidTransactionNumber": 16,
"TransactionNumberGiftCardsOnly": 17,
"PaidTransactionNumberGiftCardsOnly": 18,
"TargetProductsSales": 19.0,
"TargetServicesSales": 20.0,
"Quantity": 21.0,
"QuantityGiftCardsOnly": 22.0,
"TotalTargetSales": 39.0,
"RealPayment": 23.0,
"NewCustomers": 24,
"Appointments": 25,
"ActualLaborCost": 26.0,
"ReviewAvgRating": 27.0
}
],
"OrderTypeItems": [
{
"Today": true,
"Week": true,
"Month": true,
"Date": "2024-10-18T04:40:03.5133525-04:00",
"FormattedDate": "sample string 5",
"OrderType": "sample string 6",
"OrderSource": "sample string 7",
"ProductTotal": 8.0,
"GiftCardTotal": 9.0,
"ServiceTotal": 10.0,
"ProductTaxes": 11.0,
"GiftCardTaxes": 12.0,
"ServiceTaxes": 13.0,
"TransactionNumber": 14,
"FulfilledPoQuantity": 15,
"PaidTransactionNumber": 16,
"TransactionNumberGiftCardsOnly": 17,
"PaidTransactionNumberGiftCardsOnly": 18,
"TargetProductsSales": 19.0,
"TargetServicesSales": 20.0,
"Quantity": 21.0,
"QuantityGiftCardsOnly": 22.0,
"TotalTargetSales": 39.0,
"RealPayment": 23.0,
"NewCustomers": 24,
"Appointments": 25,
"ActualLaborCost": 26.0,
"ReviewAvgRating": 27.0
},
{
"Today": true,
"Week": true,
"Month": true,
"Date": "2024-10-18T04:40:03.5133525-04:00",
"FormattedDate": "sample string 5",
"OrderType": "sample string 6",
"OrderSource": "sample string 7",
"ProductTotal": 8.0,
"GiftCardTotal": 9.0,
"ServiceTotal": 10.0,
"ProductTaxes": 11.0,
"GiftCardTaxes": 12.0,
"ServiceTaxes": 13.0,
"TransactionNumber": 14,
"FulfilledPoQuantity": 15,
"PaidTransactionNumber": 16,
"TransactionNumberGiftCardsOnly": 17,
"PaidTransactionNumberGiftCardsOnly": 18,
"TargetProductsSales": 19.0,
"TargetServicesSales": 20.0,
"Quantity": 21.0,
"QuantityGiftCardsOnly": 22.0,
"TotalTargetSales": 39.0,
"RealPayment": 23.0,
"NewCustomers": 24,
"Appointments": 25,
"ActualLaborCost": 26.0,
"ReviewAvgRating": 27.0
}
]
}
application/xml, text/xml
Sample:
<DashboardData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Dashboard">
<DashboardItems>
<DashboardItem>
<ActualLaborCost>26</ActualLaborCost>
<Appointments>25</Appointments>
<Date>2024-10-18T04:40:03.5133525-04:00</Date>
<FormattedDate>sample string 5</FormattedDate>
<FulfilledPoQuantity>15</FulfilledPoQuantity>
<GiftCardTaxes>12</GiftCardTaxes>
<GiftCardTotal>9</GiftCardTotal>
<Month>true</Month>
<NewCustomers>24</NewCustomers>
<OrderSource>sample string 7</OrderSource>
<OrderType>sample string 6</OrderType>
<PaidTransactionNumber>16</PaidTransactionNumber>
<PaidTransactionNumberGiftCardsOnly>18</PaidTransactionNumberGiftCardsOnly>
<ProductTaxes>11</ProductTaxes>
<ProductTotal>8</ProductTotal>
<Quantity>21</Quantity>
<QuantityGiftCardsOnly>22</QuantityGiftCardsOnly>
<RealPayment>23</RealPayment>
<ReviewAvgRating>27</ReviewAvgRating>
<ServiceTaxes>13</ServiceTaxes>
<ServiceTotal>10</ServiceTotal>
<TargetProductsSales>19</TargetProductsSales>
<TargetServicesSales>20</TargetServicesSales>
<Today>true</Today>
<TransactionNumber>14</TransactionNumber>
<TransactionNumberGiftCardsOnly>17</TransactionNumberGiftCardsOnly>
<Week>true</Week>
</DashboardItem>
<DashboardItem>
<ActualLaborCost>26</ActualLaborCost>
<Appointments>25</Appointments>
<Date>2024-10-18T04:40:03.5133525-04:00</Date>
<FormattedDate>sample string 5</FormattedDate>
<FulfilledPoQuantity>15</FulfilledPoQuantity>
<GiftCardTaxes>12</GiftCardTaxes>
<GiftCardTotal>9</GiftCardTotal>
<Month>true</Month>
<NewCustomers>24</NewCustomers>
<OrderSource>sample string 7</OrderSource>
<OrderType>sample string 6</OrderType>
<PaidTransactionNumber>16</PaidTransactionNumber>
<PaidTransactionNumberGiftCardsOnly>18</PaidTransactionNumberGiftCardsOnly>
<ProductTaxes>11</ProductTaxes>
<ProductTotal>8</ProductTotal>
<Quantity>21</Quantity>
<QuantityGiftCardsOnly>22</QuantityGiftCardsOnly>
<RealPayment>23</RealPayment>
<ReviewAvgRating>27</ReviewAvgRating>
<ServiceTaxes>13</ServiceTaxes>
<ServiceTotal>10</ServiceTotal>
<TargetProductsSales>19</TargetProductsSales>
<TargetServicesSales>20</TargetServicesSales>
<Today>true</Today>
<TransactionNumber>14</TransactionNumber>
<TransactionNumberGiftCardsOnly>17</TransactionNumberGiftCardsOnly>
<Week>true</Week>
</DashboardItem>
</DashboardItems>
<OrderSourceItems>
<DashboardItem>
<ActualLaborCost>26</ActualLaborCost>
<Appointments>25</Appointments>
<Date>2024-10-18T04:40:03.5133525-04:00</Date>
<FormattedDate>sample string 5</FormattedDate>
<FulfilledPoQuantity>15</FulfilledPoQuantity>
<GiftCardTaxes>12</GiftCardTaxes>
<GiftCardTotal>9</GiftCardTotal>
<Month>true</Month>
<NewCustomers>24</NewCustomers>
<OrderSource>sample string 7</OrderSource>
<OrderType>sample string 6</OrderType>
<PaidTransactionNumber>16</PaidTransactionNumber>
<PaidTransactionNumberGiftCardsOnly>18</PaidTransactionNumberGiftCardsOnly>
<ProductTaxes>11</ProductTaxes>
<ProductTotal>8</ProductTotal>
<Quantity>21</Quantity>
<QuantityGiftCardsOnly>22</QuantityGiftCardsOnly>
<RealPayment>23</RealPayment>
<ReviewAvgRating>27</ReviewAvgRating>
<ServiceTaxes>13</ServiceTaxes>
<ServiceTotal>10</ServiceTotal>
<TargetProductsSales>19</TargetProductsSales>
<TargetServicesSales>20</TargetServicesSales>
<Today>true</Today>
<TransactionNumber>14</TransactionNumber>
<TransactionNumberGiftCardsOnly>17</TransactionNumberGiftCardsOnly>
<Week>true</Week>
</DashboardItem>
<DashboardItem>
<ActualLaborCost>26</ActualLaborCost>
<Appointments>25</Appointments>
<Date>2024-10-18T04:40:03.5133525-04:00</Date>
<FormattedDate>sample string 5</FormattedDate>
<FulfilledPoQuantity>15</FulfilledPoQuantity>
<GiftCardTaxes>12</GiftCardTaxes>
<GiftCardTotal>9</GiftCardTotal>
<Month>true</Month>
<NewCustomers>24</NewCustomers>
<OrderSource>sample string 7</OrderSource>
<OrderType>sample string 6</OrderType>
<PaidTransactionNumber>16</PaidTransactionNumber>
<PaidTransactionNumberGiftCardsOnly>18</PaidTransactionNumberGiftCardsOnly>
<ProductTaxes>11</ProductTaxes>
<ProductTotal>8</ProductTotal>
<Quantity>21</Quantity>
<QuantityGiftCardsOnly>22</QuantityGiftCardsOnly>
<RealPayment>23</RealPayment>
<ReviewAvgRating>27</ReviewAvgRating>
<ServiceTaxes>13</ServiceTaxes>
<ServiceTotal>10</ServiceTotal>
<TargetProductsSales>19</TargetProductsSales>
<TargetServicesSales>20</TargetServicesSales>
<Today>true</Today>
<TransactionNumber>14</TransactionNumber>
<TransactionNumberGiftCardsOnly>17</TransactionNumberGiftCardsOnly>
<Week>true</Week>
</DashboardItem>
</OrderSourceItems>
<OrderTypeItems>
<DashboardItem>
<ActualLaborCost>26</ActualLaborCost>
<Appointments>25</Appointments>
<Date>2024-10-18T04:40:03.5133525-04:00</Date>
<FormattedDate>sample string 5</FormattedDate>
<FulfilledPoQuantity>15</FulfilledPoQuantity>
<GiftCardTaxes>12</GiftCardTaxes>
<GiftCardTotal>9</GiftCardTotal>
<Month>true</Month>
<NewCustomers>24</NewCustomers>
<OrderSource>sample string 7</OrderSource>
<OrderType>sample string 6</OrderType>
<PaidTransactionNumber>16</PaidTransactionNumber>
<PaidTransactionNumberGiftCardsOnly>18</PaidTransactionNumberGiftCardsOnly>
<ProductTaxes>11</ProductTaxes>
<ProductTotal>8</ProductTotal>
<Quantity>21</Quantity>
<QuantityGiftCardsOnly>22</QuantityGiftCardsOnly>
<RealPayment>23</RealPayment>
<ReviewAvgRating>27</ReviewAvgRating>
<ServiceTaxes>13</ServiceTaxes>
<ServiceTotal>10</ServiceTotal>
<TargetProductsSales>19</TargetProductsSales>
<TargetServicesSales>20</TargetServicesSales>
<Today>true</Today>
<TransactionNumber>14</TransactionNumber>
<TransactionNumberGiftCardsOnly>17</TransactionNumberGiftCardsOnly>
<Week>true</Week>
</DashboardItem>
<DashboardItem>
<ActualLaborCost>26</ActualLaborCost>
<Appointments>25</Appointments>
<Date>2024-10-18T04:40:03.5133525-04:00</Date>
<FormattedDate>sample string 5</FormattedDate>
<FulfilledPoQuantity>15</FulfilledPoQuantity>
<GiftCardTaxes>12</GiftCardTaxes>
<GiftCardTotal>9</GiftCardTotal>
<Month>true</Month>
<NewCustomers>24</NewCustomers>
<OrderSource>sample string 7</OrderSource>
<OrderType>sample string 6</OrderType>
<PaidTransactionNumber>16</PaidTransactionNumber>
<PaidTransactionNumberGiftCardsOnly>18</PaidTransactionNumberGiftCardsOnly>
<ProductTaxes>11</ProductTaxes>
<ProductTotal>8</ProductTotal>
<Quantity>21</Quantity>
<QuantityGiftCardsOnly>22</QuantityGiftCardsOnly>
<RealPayment>23</RealPayment>
<ReviewAvgRating>27</ReviewAvgRating>
<ServiceTaxes>13</ServiceTaxes>
<ServiceTotal>10</ServiceTotal>
<TargetProductsSales>19</TargetProductsSales>
<TargetServicesSales>20</TargetServicesSales>
<Today>true</Today>
<TransactionNumber>14</TransactionNumber>
<TransactionNumberGiftCardsOnly>17</TransactionNumberGiftCardsOnly>
<Week>true</Week>
</DashboardItem>
</OrderTypeItems>
</DashboardData>