POST api/admin/dashboard

Generate overall dashboard - required administrative access

Request Information

URI Parameters

None.

Body Parameters

ReportInput
NameDescriptionTypeAdditional information
Year

integer

None.

SecurityToken

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Year": 1,
  "SecurityToken": "sample string 2"
}

Response Information

Resource Description

SubscriptionStat
NameDescriptionTypeAdditional information
Subscriber

integer

None.

SubscriptionMonthlyAvg

integer

None.

SubscriptionThisMonth

integer

None.

ThisMonthName

string

None.

Collection

decimal number

None.

CommissionPaid

decimal number

None.

CommissionPending

decimal number

None.

MonthlyCollections

Collection of CollectionStat

None.

Response Formats

application/json, text/json

Sample:
{
  "Subscriber": 1,
  "SubscriptionMonthlyAvg": 2,
  "SubscriptionThisMonth": 3,
  "ThisMonthName": "sample string 4",
  "Collection": 5.1,
  "CommissionPaid": 6.1,
  "CommissionPending": 7.1,
  "MonthlyCollections": [
    {
      "Month": 1,
      "MonthName": "sample string 2",
      "Amount": 3.1
    },
    {
      "Month": 1,
      "MonthName": "sample string 2",
      "Amount": 3.1
    }
  ]
}