Class Manager
GET /v1/enrolments/chart/by-month

By Month Chart Enrolment

Query parameters

  • fromDate string Required

    Start date for the chart (YYYY-MM)

  • toDate string Required

    End date for the chart (YYYY-MM)

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • name string Required

      Period

    • data array[object] Required

      Array of chart data

      Chart Data schema

      Hide data attributes Show data attributes object
      • label string Required

        Label for the chart data

      • values array[object] Required

        Array of chart data values

        Chart Data Value schema

        Hide values attributes Show values attributes object
        • label string Required

          Label for the data value

        • value integer Required

          Numeric value
  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
GET /v1/enrolments/chart/by-month 
curl \
 --request GET 'https://localhost/v1/enrolments/chart/by-month?fromDate=string&toDate=string'
Response examples (200) 
[
  {
    "name": "2024-09",
    "data": [
      {
        "label": "Charges",
        "values": [
          {
            "label": "Transactions",
            "value": 50000
          }
        ]
      }
    ]
  }
]
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}