Leo1

Leo1 student account API

The student account API from Leo1 — 4 operation(s) for student account.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.leo1.in/
📖
APIReference
https://docs.leo1.in/api/start-transaction
📖
GettingStarted
https://docs.leo1.in/intro
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/leo1/refs/heads/main/authentication/leo1-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/leo1/refs/heads/main/openapi/leo1-student-account-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/leo1/refs/heads/main/asyncapi/leo1-fees-webhooks.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/leo1/refs/heads/main/errors/leo1-problem-types.yml

OpenAPI Specification

leo1-student-account-api-openapi.yml Raw ↑ 
openapi: 3.0.2
info:
  title: leofees_backend api student account API
  version: version
  description: General system endpoints for the API.
tags:
- name: student account
paths:
  /api/v1/student_account/:
    get:
      tags:
      - student account
      summary: Get Student Accounts
      operationId: get_student_accounts_api_v1_student_account__get
      parameters:
      - required: true
        schema:
          title: Student Ids
          type: string
        name: student_ids
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /api/v1/student_account/bulk_create:
    post:
      tags:
      - student account
      summary: Create Bulk Student Accounts
      operationId: create_bulk_student_accounts_api_v1_student_account_bulk_create_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateStudentAccountRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /api/v1/student_account/bulk_update:
    put:
      tags:
      - student account
      summary: Update Bulk Student Accounts
      operationId: update_bulk_student_accounts_api_v1_student_account_bulk_update_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateStudentAccountRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /api/v1/student_account/bulk_delete:
    delete:
      tags:
      - student account
      summary: Delete Bulk Student Accounts
      operationId: delete_bulk_student_accounts_api_v1_student_account_bulk_delete_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteStudentAccountRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
components:
  schemas:
    ValidationError:
      title: ValidationError
      required:
      - loc
      - msg
      - type
      type: object
      properties:
        loc:
          title: Location
          type: array
          items:
            anyOf:
            - type: string
            - type: integer
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
    UpdateStudentAccountRequest:
      title: UpdateStudentAccountRequest
      required:
      - student_ids
      type: object
      properties:
        student_ids:
          title: Student Ids
          type: array
          items:
            type: integer
          description: Student IDs are required
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    CreateStudentAccountRequest:
      title: CreateStudentAccountRequest
      required:
      - student_ids
      type: object
      properties:
        student_ids:
          title: Student Ids
          type: array
          items:
            type: integer
          description: Student IDs are required
    DeleteStudentAccountRequest:
      title: DeleteStudentAccountRequest
      required:
      - student_ids
      type: object
      properties:
        student_ids:
          title: Student Ids
          type: array
          items:
            type: integer
          description: Student IDs are required
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: secret-key