Class Manager
POST /v1/discount-schemes/

Create Discount Scheme

application/json

Body Required

Request for creating/updating a new discount scheme

  • scheme string Required

    Values are course_qty_by_family, course_qty_by_student, or student_qty_by_family.

  • type string Required

    Values are percent or fixed.

  • application string Required

    Values are total_tuition or individual_item.

  • enabled boolean Required

    Enabled

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      id

    • companyId string Required

      Company ID

    • scheme string Required

      Values are course_qty_by_family, course_qty_by_student, or student_qty_by_family.

    • type string Required

      Values are percent or fixed.

    • application string Required

      Values are total_tuition or individual_item.

    • enabled boolean Required

      Enabled

    • deletedAt string(date-time) | null

      Deleted at date

    • createdAt string(date-time) Required

      Created at date

    • updatedAt string(date-time) Required

      Updated at date
  • 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
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
POST /v1/discount-schemes/ 
curl \
 --request POST 'https://localhost/v1/discount-schemes/' \
 --header "Content-Type: application/json" \
 --data '{"scheme":"course_qty_by_family","type":"percent","application":"total_tuition","enabled":false}'
Request examples 
{
  "scheme": "course_qty_by_family",
  "type": "percent",
  "application": "total_tuition",
  "enabled": false
}
Response examples (200) 
{
  "id": "dsc_xxxxxxxxxxx",
  "companyId": "co_123123123123",
  "scheme": "course_qty_by_family",
  "type": "percent",
  "application": "total_tuition",
  "enabled": false,
  "deletedAt": "2023-12-05 14:30:41",
  "createdAt": "2023-12-05 14:30:41",
  "updatedAt": "2023-12-05 14:30:41"
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (422) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}