Needio.Services

<back to all web services

GetUserDashboardStatisticsRequest

Requires Authentication
The following routes are available for this service:
All Verbs/User/GetUserDashboardStatistics/
GetUserDashboardStatisticsRequest Parameters:
NameParameterData TypeRequiredDescription
IncludeUserStatisticsqueryboolNo
IncludeUserSalesStatisticsqueryboolNo
IncludeUserOrderStatisticsqueryboolNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
GetUserDashboardStatisticsResponse Parameters:
NameParameterData TypeRequiredDescription
UserDashBoardStatisticsformUserDashboardStatisticsDTONo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
UserDashboardStatisticsDTO Parameters:
NameParameterData TypeRequiredDescription
UserSaleStatisticsformUserSaleStatisticsDTONo
UserOrderStatisticsformUserOrderStatisticsDTONo
UserStatisticsformUserStatisticsDTONo
UserSaleStatisticsDTO Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
SaleCountformintNo
SaleAmountformdecimalNo
CancelledSaleCountformintNo
CancelledSaleAmountformdecimalNo
InProgressSaleCountformintNo
InProgressSaleAmountformdecimalNo
UserOrderStatisticsDTO Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
OrderCountformintNo
OrderAmountformdecimalNo
CancelledOrderCountformintNo
CancelledOrderAmountformdecimalNo
InProgressOrderCountformintNo
InProgressOrderAmountformdecimalNo
UserStatisticsDTO Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
PostCountformintNo
ActivePostCountformintNo
PostViewCountformintNo
PostLikeCountformintNo
PostFollowCountformintNo
PostRateCountformintNo
PostAvgRateformdecimalNo
StoreCountformintNo
ActiveStoreCountformintNo
StoreViewCountformintNo
StoreLikeCountformintNo
StoreFollowCountformintNo
StoreRateCountformintNo
StoreAvgRateformdecimalNo
FollowCountformintNo
FollowedCountformintNo
BanCountformintNo
BannedCountformintNo
GetUserDashboardStatisticsResponse Parameters:
NameParameterData TypeRequiredDescription
UserDashBoardStatisticsformUserDashboardStatisticsDTONo

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/GetUserDashboardStatistics/ HTTP/1.1 
Host: baseservices2.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetUserDashboardStatisticsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <IncludeUserOrderStatistics>false</IncludeUserOrderStatistics>
  <IncludeUserSalesStatistics>false</IncludeUserSalesStatistics>
  <IncludeUserStatistics>false</IncludeUserStatistics>
</GetUserDashboardStatisticsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetUserDashboardStatisticsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <UserDashBoardStatistics xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.Models">
    <d2p1:UserOrderStatistics>
      <d2p1:CancelledOrderAmount>0</d2p1:CancelledOrderAmount>
      <d2p1:CancelledOrderCount>0</d2p1:CancelledOrderCount>
      <d2p1:InProgressOrderAmount>0</d2p1:InProgressOrderAmount>
      <d2p1:InProgressOrderCount>0</d2p1:InProgressOrderCount>
      <d2p1:OrderAmount>0</d2p1:OrderAmount>
      <d2p1:OrderCount>0</d2p1:OrderCount>
      <d2p1:UserId>0</d2p1:UserId>
    </d2p1:UserOrderStatistics>
    <d2p1:UserSaleStatistics>
      <d2p1:CancelledSaleAmount>0</d2p1:CancelledSaleAmount>
      <d2p1:CancelledSaleCount>0</d2p1:CancelledSaleCount>
      <d2p1:InProgressSaleAmount>0</d2p1:InProgressSaleAmount>
      <d2p1:InProgressSaleCount>0</d2p1:InProgressSaleCount>
      <d2p1:SaleAmount>0</d2p1:SaleAmount>
      <d2p1:SaleCount>0</d2p1:SaleCount>
      <d2p1:UserId>0</d2p1:UserId>
    </d2p1:UserSaleStatistics>
    <d2p1:UserStatistics>
      <d2p1:ActivePostCount>0</d2p1:ActivePostCount>
      <d2p1:ActiveStoreCount>0</d2p1:ActiveStoreCount>
      <d2p1:BanCount>0</d2p1:BanCount>
      <d2p1:BannedCount>0</d2p1:BannedCount>
      <d2p1:FollowCount>0</d2p1:FollowCount>
      <d2p1:FollowedCount>0</d2p1:FollowedCount>
      <d2p1:PostAvgRate>0</d2p1:PostAvgRate>
      <d2p1:PostCount>0</d2p1:PostCount>
      <d2p1:PostFollowCount>0</d2p1:PostFollowCount>
      <d2p1:PostLikeCount>0</d2p1:PostLikeCount>
      <d2p1:PostRateCount>0</d2p1:PostRateCount>
      <d2p1:PostViewCount>0</d2p1:PostViewCount>
      <d2p1:StoreAvgRate>0</d2p1:StoreAvgRate>
      <d2p1:StoreCount>0</d2p1:StoreCount>
      <d2p1:StoreFollowCount>0</d2p1:StoreFollowCount>
      <d2p1:StoreLikeCount>0</d2p1:StoreLikeCount>
      <d2p1:StoreRateCount>0</d2p1:StoreRateCount>
      <d2p1:StoreViewCount>0</d2p1:StoreViewCount>
      <d2p1:UserId>0</d2p1:UserId>
    </d2p1:UserStatistics>
  </UserDashBoardStatistics>
</GetUserDashboardStatisticsResponse>