All Verbs | /service/QuerySiteDashboardSummary |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DateRange | query | string | No | |
StartDate | query | string | No | |
EndDate | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
ShipMethod | form | string | No | |
ShipName | form | string | No | |
ShipCity | form | string | No | |
ShipState | form | string | No | |
OrderDate | form | DateTime | No | |
OrderStatus | form | string | No | |
TrackingNumber | form | string | No | |
ItemCode | form | string | No | |
QtyOrdered | form | int | No | |
PricePaid | form | double | No | |
ActualFreightAmount | form | double | No | |
PromoCode | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/QuerySiteDashboardSummary HTTP/1.1
Host: www.bernhardthospitality.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"dateRange":"String","startDate":"String","endDate":"String","skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"offset":0,"total":0,"results":[{"id":"String","shipMethod":"String","shipName":"String","shipCity":"String","shipState":"String","orderDate":"0001-01-01T00:00:00.0000000Z","orderStatus":"String","trackingNumber":"String","itemCode":"String","qtyOrdered":0,"pricePaid":0,"actualFreightAmount":0,"promoCode":"String"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}