Needio.Services

<back to all web services

GetSaleDashboardStatisticsRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/User/GetSaleDashboardStatistics/
GetSaleDashboardStatisticsRequest Parameters:
NameParameterData TypeRequiredDescription
StoreIdqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetSaleDashboardStatisticsResponse Parameters:
NameParameterData TypeRequiredDescription
SaleDashboardDTOformSaleDashboardDTONo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
SaleDashboardDTO Parameters:
NameParameterData TypeRequiredDescription
NewOrdersCountformintNo
ApprovedOrdersCountformintNo
ShippedOrdersCountformintNo
RejectOrdersCountformintNo
ReturnOrdersCountformintNo
ChatCountformintNo
CancelOrdersCountformintNo
GetSaleDashboardStatisticsResponse Parameters:
NameParameterData TypeRequiredDescription
SaleDashboardDTOformSaleDashboardDTONo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /User/GetSaleDashboardStatistics/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetSaleDashboardStatisticsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <DeviceUUID>String</DeviceUUID>
  <StoreId>0</StoreId>
</GetSaleDashboardStatisticsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSaleDashboardStatisticsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <SaleDashboardDTO xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:ApprovedOrdersCount>0</d2p1:ApprovedOrdersCount>
    <d2p1:CancelOrdersCount>0</d2p1:CancelOrdersCount>
    <d2p1:ChatCount>0</d2p1:ChatCount>
    <d2p1:NewOrdersCount>0</d2p1:NewOrdersCount>
    <d2p1:RejectOrdersCount>0</d2p1:RejectOrdersCount>
    <d2p1:ReturnOrdersCount>0</d2p1:ReturnOrdersCount>
    <d2p1:ShippedOrdersCount>0</d2p1:ShippedOrdersCount>
  </SaleDashboardDTO>
</GetSaleDashboardStatisticsResponse>