v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Fetch the class details of an organization - Class report API

Purpose: Use this API to fetch the class details of an organization.

You must specify center_ids and employee_ids along with other params as mentioned in the BODY PARAMS section.

get/v1/reports/classes/attendance/flat_file?page=1&size=10

Request body

center_idsstring required

Enter the unique identifier of the centers for which you want to fetch the class details report.

employee_idsobject required

list of employee ids for which report is to be generated

class_idstring

Unique identifier of the class for which you are generating the report.

guest_idstring

Unique identifier of the guest.

payment_typesstring

Type of payments that are to be included in the report

group_columnsstring

Denotes if the columns of the report are grouped.

registration_statusstring

Denotes the registration status of the class in the report.

class_type'1' | '2' | '3'

1 and 2 for Class. 3 for Workshop

original_instructor_idstring

Identifier of the instructor.

session_idstring

Session id for which roster details are required,

start_datestring date

Date range for the report to fetch details.

end_datestring date

Date range for the report to fetch details

sizeinteger

optional parameter

pageinteger

optional parameter

Response

200

{"stackTrail":"paths:/v1/reports/classes/attendance/flat_file?page=1&size=10:get:responses:200:content:application/json:schema:properties:total","oasType":"schema","type":"unknown"}

Example response

{
  "classes_attendance": [
    {
      "booking_source": "Zenoti",
      "center_name": "Pras KDEV",
      "class_category": "aug cat1",
      "class_id": "a629ddc8-bb29-4743-a2b7-5c43381572a7",
      "class_name": "CorePower Yoga 1",
      "class_subcategory": "aug sub-cat1",
      "employee_code": "13",
      "name": "Instructor One",
      "first_visit": "1",
      "group_id": "3807f48b-45a0-45b2-88d3-ec4bf88a4093",
      "guest_id": "0d33b446-6eb4-4ab1-8375-be7dec727dc1",
      "guest_name": "Lakshmi Satish",
      "invoice_id": "e1ea6bfd-18fa-4473-ae80-6ac28f4f0c85",
      "invoice_no": "2460",
      "member": "0",
      "mobile_phone": "1234567890",
      "qty": 1,
      "net_price": 15000,
      "class_type": "Class",
      "session_enddate": "2020-09-25T16:00:00",
      "session_price": 15000,
      "session_startdate": "2020-09-25T15:00:00",
      "registration_status": "Registered",
      "registration_status_date": "2020-09-20T01:08:54",
      "employee_id": "41da0802-2f06-4991-9f93-23e8ecbe34e7",
      "avg_class_attendance_count": 1,
      "session_id": "3514ecf3-7898-4cd3-96c1-0c736e07f5a1",
      "session_name": "CorePower Yoga 1"
    }
  ],
  "page_info": {
    "total": 429,
    "page": 1,
    "size": 40
  }
}