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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	IncludeUserStatistics: False,
	IncludeUserSalesStatistics: False,
	IncludeUserOrderStatistics: False,
	start: 2020-07-07T18:11:25.5781784+03:00
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	UserDashBoardStatistics: 
	{
		UserSaleStatistics: 
		{
			UserId: 0,
			SaleCount: 0,
			SaleAmount: 0,
			CancelledSaleCount: 0,
			CancelledSaleAmount: 0,
			InProgressSaleCount: 0,
			InProgressSaleAmount: 0
		},
		UserOrderStatistics: 
		{
			UserId: 0,
			OrderCount: 0,
			OrderAmount: 0,
			CancelledOrderCount: 0,
			CancelledOrderAmount: 0,
			InProgressOrderCount: 0,
			InProgressOrderAmount: 0
		},
		UserStatistics: 
		{
			UserId: 0,
			PostCount: 0,
			ActivePostCount: 0,
			PostViewCount: 0,
			PostLikeCount: 0,
			PostFollowCount: 0,
			PostRateCount: 0,
			PostAvgRate: 0,
			StoreCount: 0,
			ActiveStoreCount: 0,
			StoreViewCount: 0,
			StoreLikeCount: 0,
			StoreFollowCount: 0,
			StoreRateCount: 0,
			StoreAvgRate: 0,
			FollowCount: 0,
			FollowedCount: 0,
			BanCount: 0,
			BannedCount: 0
		}
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	}
}