v2.0-client.yml

basePath: /v2.0
definitions:
  BadRequest:
    properties:
      message:
        type: string
    type: object
  Contact:
    properties:
      district:
        type: string
        x-validation: true
      email:
        type: string
        x-nullable: true
      id:
        type: string
        x-validation: true
      name:
        type: string
      phone:
        type: string
        x-nullable: true
      phone_type:
        enum:
        - Cell
        - Home
        - Work
        - Other
        - ""
        type: string
        x-nullable: true
        x-validation: true
      relationship:
        enum:
        - Parent
        - Grandparent
        - Self
        - Aunt/Uncle
        - Sibling
        - Other
        - ""
        type: string
        x-nullable: true
        x-validation: true
      sis_id:
        type: string
        x-nullable: true
      students:
        items:
          type: string
        type: array
        x-validation: true
      type:
        enum:
        - Parent/Guardian
        - Emergency
        - Primary
        - Secondary
        - Family
        - Other
        - ""
        type: string
        x-validation: true
    type: object
  ContactObject:
    properties:
      object:
        $ref: '#/definitions/Contact'
    type: object
  ContactResponse:
    properties:
      data:
        $ref: '#/definitions/Contact'
    type: object
  ContactsResponse:
    properties:
      data:
        items:
          $ref: '#/definitions/ContactResponse'
        type: array
    type: object
  Course:
    properties:
      id:
        type: string
        x-validation: true
      name:
        type: string
        x-nullable: true
      number:
        type: string
        x-nullable: true
    type: object
  CourseObject:
    properties:
      object:
        $ref: '#/definitions/Course'
    type: object
  CourseResponse:
    properties:
      data:
        $ref: '#/definitions/Course'
    type: object
  CoursesResponse:
    properties:
      data:
        items:
          $ref: '#/definitions/CourseResponse'
        type: array
    type: object
  Credentials:
    properties:
      district_username:
        type: string
    type: object
  District:
    properties:
      error:
        type: string
      id:
        type: string
        x-validation: true
      last_sync:
        format: datetime
        type: string
        x-nullable: true
        x-validation: true
      launch_date:
        format: datetime
        type: string
        x-validation: true
      mdr_number:
        type: string
        x-nullable: true
      name:
        type: string
      nces_id:
        type: string
        x-nullable: true
      pause_end:
        format: datetime
        type: string
        x-nullable: true
        x-validation: true
      pause_start:
        format: datetime
        type: string
        x-nullable: true
        x-validation: true
      sis_type:
        type: string
        x-validation: true
      state:
        enum:
        - running
        - pending
        - error
        - paused
        type: string
        x-validation: true
    type: object
  DistrictAdmin:
    properties:
      district:
        type: string
        x-validation: true
      email:
        type: string
      id:
        type: string
        x-validation: true
      name:
        $ref: '#/definitions/AdminName'
        x-nullable: true
      title:
        type: string
        x-nullable: true
    type: object
  DistrictAdminObject:
    properties:
      object:
        $ref: '#/definitions/DistrictAdmin'
    type: object
  DistrictAdminResponse:
    properties:
      data:
        $ref: '#/definitions/DistrictAdmin'
    type: object
  DistrictAdminsResponse:
    properties:
      data:
        items:
          $ref: '#/definitions/DistrictAdminResponse'
        type: array
    type: object
  DistrictObject:
    properties:
      object:
        $ref: '#/definitions/District'
    type: object
  DistrictResponse:
    properties:
      data:
        $ref: '#/definitions/District'
    type: object
  DistrictsResponse:
    properties:
      data:
        items:
          $ref: '#/definitions/DistrictResponse'
        type: array
    type: object
  Event:
    discriminator: type
    properties:
      created:
        format: datetime
        type: string
        x-validation: true
      id:
        type: string
        x-validation: true
      type:
        type: string
        x-validation: true
    required:
    - type
    type: object
  EventResponse:
    properties:
      data:
        $ref: '#/definitions/Event'
    type: object
  EventsResponse:
    properties:
      data:
        items:
          $ref: '#/definitions/EventResponse'
        type: array
    type: object
  InternalError:
    properties:
      message:
        type: string
    type: object
  Location:
    properties:
      address:
        type: string
        x-nullable: true
      city:
        type: string
        x-nullable: true
      lat:
        type: string
        x-nullable: true
      lon:
        type: string
        x-nullable: true
      state:
        type: string
        x-nullable: true
      zip:
        type: string
        x-nullable: true
    type: object
  Name:
    properties:
      first:
        type: string
        x-nullable: true
      middle:
        type: string
        x-nullable: true
      last:
        type: string
        x-nullable: true
    type: object
  AdminName:
    properties:
      first:
        type: string
        x-nullable: true
      last:
        type: string
        x-nullable: true
    type: object
  NotFound:
    properties:
      message:
        type: string
    type: object
  Principal:
    properties:
      email:
        type: string
        x-nullable: true
      name:
        type: string
        x-nullable: true
    type: object
  School:
    properties:
      created:
        format: datetime
        type: string
        x-validation: true
      district:
        type: string
        x-validation: true
      high_grade:
        enum:
        - "1"
        - "2"
        - "3"
        - "4"
        - "5"
        - "6"
        - "7"
        - "8"
        - "9"
        - "10"
        - "11"
        - "12"
        - PreKindergarten
        - Kindergarten
        - PostGraduate
        - Other
        type: string
        x-nullable: true
        x-validation: true
      id:
        type: string
        x-validation: true
      last_modified:
        format: datetime
        type: string
        x-validation: true
      location:
        $ref: '#/definitions/Location'
        x-nullable: true
      low_grade:
        enum:
        - "1"
        - "2"
        - "3"
        - "4"
        - "5"
        - "6"
        - "7"
        - "8"
        - "9"
        - "10"
        - "11"
        - "12"
        - PreKindergarten
        - Kindergarten
        - PostGraduate
        - Other
        type: string
        x-nullable: true
        x-validation: true
      mdr_number:
        type: string
        x-nullable: true
      name:
        type: string
      nces_id:
        type: string
        x-nullable: true
      phone:
        type: string
        x-nullable: true
      principal:
        $ref: '#/definitions/Principal'
      school_number:
        type: string
      sis_id:
        type: string
      state_id:
        type: string
        x-nullable: true
    type: object
  SchoolAdmin:
    properties:
      credentials:
        $ref: '#/definitions/Credentials'
      district:
        type: string
        x-validation: true
      email:
        type: string
      id:
        type: string
        x-validation: true
      name:
        $ref: '#/definitions/AdminName'
      schools:
        items:
          type: string
        type: array
        x-validation: true
      staff_id:
        type: string
      title:
        type: string
        x-nullable: true
    type: object
  SchoolAdminObject:
    properties:
      object:
        $ref: '#/definitions/SchoolAdmin'
    type: object
  SchoolAdminResponse:
    properties:
      data:
        $ref: '#/definitions/SchoolAdmin'
    type: object
  SchoolAdminsResponse:
    properties:
      data:
        items:
          $ref: '#/definitions/SchoolAdminResponse'
        type: array
    type: object
  SchoolObject:
    properties:
      object:
        $ref: '#/definitions/School'
    type: object
  SchoolResponse:
    properties:
      data:
        $ref: '#/definitions/School'
    type: object
  SchoolsResponse:
    properties:
      data:
        items:
          $ref: '#/definitions/SchoolResponse'
        type: array
    type: object
  Section:
    properties:
      course:
        type: string
        x-nullable: true
        x-validation: true
      created:
        format: datetime
        type: string
        x-validation: true
      district:
        type: string
        x-validation: true
      grade:
        enum:
        - "1"
        - "2"
        - "3"
        - "4"
        - "5"
        - "6"
        - "7"
        - "8"
        - "9"
        - "10"
        - "11"
        - "12"
        - PreKindergarten
        - Kindergarten
        - PostGraduate
        - Other
        type: string
        x-nullable: true
        x-validation: true
      id:
        type: string
        x-validation: true
      last_modified:
        format: datetime
        type: string
        x-validation: true
      name:
        type: string
      period:
        type: string
        x-nullable: true
      school:
        type: string
        x-validation: true
      section_number:
        type: string
        x-nullable: true
      sis_id:
        type: string
      students:
        items:
          type: string
        type: array
        x-validation: true
      subject:
        enum:
        - english/language arts
        - math
        - science
        - social studies
        - language
        - homeroom/advisory
        - interventions/online learning
        - technology and engineering
        - PE and health
        - arts and music
        - other
        type: string
        x-validation: true
      teacher:
        type: string
        x-nullable: true
        x-validation: true
      teachers:
        items:
          type: string
        type: array
        x-validation: true
      term_id:
        type: string
        x-nullable: true
        x-validation: true
    type: object
  SectionObject:
    properties:
      object:
        $ref: '#/definitions/Section'
    type: object
  SectionResponse:
    properties:
      data:
        $ref: '#/definitions/Section'
    type: object
  SectionsResponse:
    properties:
      data:
        items:
          $ref: '#/definitions/SectionResponse'
        type: array
    type: object
  Student:
    properties:
      created:
        format: datetime
        type: string
        x-validation: true
      credentials:
        $ref: '#/definitions/Credentials'
      district:
        type: string
        x-validation: true
      dob:
        format: datetime
        type: string
        x-nullable: true
        x-validation: true
      ell_status:
        enum:
        - "Y"
        - "N"
        - ""
        type: string
        x-nullable: true
        x-validation: true
      email:
        type: string
        x-nullable: true
      gender:
        enum:
        - M
        - F
        - ""
        type: string
        x-nullable: true
        x-validation: true
      grade:
        enum:
        - "1"
        - "2"
        - "3"
        - "4"
        - "5"
        - "6"
        - "7"
        - "8"
        - "9"
        - "10"
        - "11"
        - "12"
        - PreKindergarten
        - Kindergarten
        - PostGraduate
        - Other
        type: string
        x-nullable: true
        x-validation: true
      graduation_year:
        type: string
        x-nullable: true
        x-validation: true
      hispanic_ethnicity:
        enum:
        - "Y"
        - "N"
        - ""
        type: string
        x-nullable: true
        x-validation: true
      home_language:
        enum:
        - English
        - Albanian
        - Amharic
        - Arabic
        - Bengali
        - Bosnian
        - Burmese
        - Cantonese
        - Chinese
        - Dutch
        - Farsi
        - French
        - German
        - Hebrew
        - Hindi
        - Hmong
        - Ilocano
        - Japanese
        - Javanese
        - Karen
        - Khmer
        - Korean
        - Laotian
        - Latvian
        - Malay
        - Mandarin
        - Nepali
        - Oromo
        - Polish
        - Portuguese
        - Punjabi
        - Romanian
        - Russian
        - Samoan
        - Serbian
        - Somali
        - Spanish
        - Swahili
        - Tagalog
        - Tamil
        - Telugu
        - Thai
        - Tigrinya
        - Turkish
        - Ukrainian
        - Urdu
        - Vietnamese
        type: string
        x-nullable: true
        x-validation: true
      id:
        type: string
        x-validation: true
      iep_status:
        type: string
        x-nullable: true
      last_modified:
        format: datetime
        type: string
        x-validation: true
      location:
        $ref: '#/definitions/Location'
        x-nullable: true
      name:
        $ref: '#/definitions/Name'
      race:
        enum:
        - Caucasian
        - Asian
        - Black or African American
        - American Indian
        - Hawaiian or Other Pacific Islander
        - Two or More Races
        - Unknown
        - ""
        type: string
        x-nullable: true
        x-validation: true
      school:
        type: string
        x-validation: true
      schools:
        items:
          type: string
        type: array
        x-validation: true
      sis_id:
        type: string
      state_id:
        type: string
        x-nullable: true
      student_number:
        type: string
        x-nullable: true
      unweighted_gpa:
        type: string
        x-nullable: true
      weighted_gpa:
        type: string
        x-nullable: true
    type: object
  StudentObject:
    properties:
      object:
        $ref: '#/definitions/Student'
    type: object
  StudentResponse:
    properties:
      data:
        $ref: '#/definitions/Student'
    type: object
  StudentsResponse:
    properties:
      data:
        items:
          $ref: '#/definitions/StudentResponse'
        type: array
    type: object
  Teacher:
    properties:
      created:
        format: datetime
        type: string
        x-validation: true
      credentials:
        $ref: '#/definitions/Credentials'
        x-nullable: true
      district:
        type: string
        x-validation: true
      email:
        type: string
        x-nullable: true
      id:
        type: string
        x-validation: true
      last_modified:
        format: datetime
        type: string
        x-validation: true
      name:
        $ref: '#/definitions/Name'
      school:
        type: string
        x-validation: true
      schools:
        items:
          type: string
        type: array
        x-validation: true
      sis_id:
        type: string
      state_id:
        type: string
        x-nullable: true
      teacher_number:
        type: string
        x-nullable: true
      title:
        type: string
        x-nullable: true
    type: object
  TeacherObject:
    properties:
      object:
        $ref: '#/definitions/Teacher'
    type: object
  TeacherResponse:
    properties:
      data:
        $ref: '#/definitions/Teacher'
    type: object
  TeachersResponse:
    properties:
      data:
        items:
          $ref: '#/definitions/TeacherResponse'
        type: array
    type: object
  Term:
    properties:
      end_date:
        format: datetime
        type: string
        x-nullable: true
        x-validation: true
      id:
        type: string
        x-validation: true
      name:
        type: string
        x-nullable: true
      start_date:
        format: datetime
        type: string
        x-nullable: true
        x-validation: true
    type: object
  TermObject:
    properties:
      object:
        $ref: '#/definitions/Term'
    type: object
  TermResponse:
    properties:
      data:
        $ref: '#/definitions/Term'
    type: object
  TermsResponse:
    properties:
      data:
        items:
          $ref: '#/definitions/TermResponse'
        type: array
    type: object
  contacts.created:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/ContactObject'
      type: object
  contacts.deleted:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/ContactObject'
      type: object
  contacts.updated:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/ContactObject'
        previous_attributes:
          additionalProperties:
            type: object
      type: object
  courses.created:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/CourseObject'
      type: object
  courses.deleted:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/CourseObject'
      type: object
  courses.updated:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/CourseObject'
        previous_attributes:
          additionalProperties:
            type: object
      type: object
  districtadmins.created:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/DistrictAdminObject'
      type: object
  districtadmins.deleted:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/DistrictAdminObject'
      type: object
  districtadmins.updated:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/DistrictAdminObject'
        previous_attributes:
          additionalProperties:
            type: object
      type: object
  districts.created:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/DistrictObject'
      type: object
  districts.deleted:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/DistrictObject'
      type: object
  districts.updated:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/DistrictObject'
        previous_attributes:
          additionalProperties:
            type: object
      type: object
  schooladmins.created:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/SchoolAdminObject'
      type: object
  schooladmins.deleted:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/SchoolAdminObject'
      type: object
  schooladmins.updated:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/SchoolAdminObject'
        previous_attributes:
          additionalProperties:
            type: object
      type: object
  schools.created:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/SchoolObject'
      type: object
  schools.deleted:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/SchoolObject'
      type: object
  schools.updated:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/SchoolObject'
        previous_attributes:
          additionalProperties:
            type: object
      type: object
  sections.created:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/SectionObject'
      type: object
  sections.deleted:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/SectionObject'
      type: object
  sections.updated:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/SectionObject'
        previous_attributes:
          additionalProperties:
            type: object
      type: object
  students.created:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/StudentObject'
      type: object
  students.deleted:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/StudentObject'
      type: object
  students.updated:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/StudentObject'
        previous_attributes:
          additionalProperties:
            type: object
      type: object
  teachers.created:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/TeacherObject'
      type: object
  teachers.deleted:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/TeacherObject'
      type: object
  teachers.updated:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/TeacherObject'
        previous_attributes:
          additionalProperties:
            type: object
      type: object
  terms.created:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/TermObject'
      type: object
  terms.deleted:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/TermObject'
      type: object
  terms.updated:
    allOf:
    - $ref: '#/definitions/Event'
    - properties:
        data:
          $ref: '#/definitions/TermObject'
        previous_attributes:
          additionalProperties:
            type: object
      type: object
host: api.clever.com
info:
  description: The Clever API
  title: Clever API
  version: 2.0.0
paths:
  /contacts:
    get:
      description: Returns a list of student contacts
      operationId: getContacts
      parameters:
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/ContactsResponse'
      tags:
      - Data
  /contacts/{id}:
    get:
      description: Returns a specific student contact
      operationId: getContact
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/ContactResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /contacts/{id}/district:
    get:
      description: Returns the district for a student contact
      operationId: getDistrictForContact
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/DistrictResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /contacts/{id}/students:
    get:
      description: Returns the students for a student contact
      operationId: getStudentsForContact
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/StudentsResponse'
      tags:
      - Data
  /courses:
    get:
      description: Returns a list of courses
      operationId: getCourses
      parameters:
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/CoursesResponse'
      tags:
      - Data
  /courses/{id}:
    get:
      description: Returns a specific course
      operationId: getCourse
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/CourseResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /courses/{id}/district:
    get:
      description: Returns the district for a course
      operationId: getDistrictForCourse
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/DistrictResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /courses/{id}/sections:
    get:
      description: Returns the sections for a Courses
      operationId: getSectionsForCourse
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SectionsResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /district_admins:
    get:
      description: Returns a list of district admins
      operationId: getDistrictAdmins
      parameters:
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/DistrictAdminsResponse'
      tags:
      - Data
  /district_admins/{id}:
    get:
      description: Returns a specific district admin
      operationId: getDistrictAdmin
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/DistrictAdminResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /district_admins/{id}/district:
    get:
      description: Returns the district for a district admin
      operationId: getDistrictForDistrictAdmin
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/DistrictResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /districts:
    get:
      description: Returns a list of districts
      operationId: getDistricts
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/DistrictsResponse'
      tags:
      - Data
  /districts/{id}:
    get:
      description: Returns a specific district
      operationId: getDistrict
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/DistrictResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /events:
    get:
      description: Returns a list of events
      operationId: getEvents
      parameters:
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      - in: query
        name: school
        type: string
      - collectionFormat: multi
        in: query
        items:
          type: string
        name: record_type
        type: array
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/EventsResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Events
  /events/{id}:
    get:
      description: Returns the specific event
      operationId: getEvent
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/EventResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Events
  /school_admins:
    get:
      description: Returns a list of school admins
      operationId: getSchoolAdmins
      parameters:
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SchoolAdminsResponse'
      tags:
      - Data
  /school_admins/{id}:
    get:
      description: Returns a specific school admin
      operationId: getSchoolAdmin
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SchoolAdminResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /school_admins/{id}/district:
    get:
      description: Returns the district for a school admin
      operationId: getDistrictForSchoolAdmin
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/DistrictResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /school_admins/{id}/schools:
    get:
      description: Returns the schools for a school admin
      operationId: getSchoolsForSchoolAdmin
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SchoolsResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /schools:
    get:
      description: Returns a list of schools
      operationId: getSchools
      parameters:
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SchoolsResponse'
      tags:
      - Data
  /schools/{id}:
    get:
      description: Returns a specific school
      operationId: getSchool
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SchoolResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /schools/{id}/district:
    get:
      description: Returns the district for a school
      operationId: getDistrictForSchool
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/DistrictResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /schools/{id}/sections:
    get:
      description: Returns the sections for a school
      operationId: getSectionsForSchool
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SectionsResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /schools/{id}/students:
    get:
      description: Returns the students for a school
      operationId: getStudentsForSchool
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/StudentsResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /schools/{id}/teachers:
    get:
      description: Returns the teachers for a school
      operationId: getTeachersForSchool
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/TeachersResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /sections:
    get:
      description: Returns a list of sections
      operationId: getSections
      parameters:
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SectionsResponse'
      tags:
      - Data
  /sections/{id}:
    get:
      description: Returns a specific section
      operationId: getSection
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SectionResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /sections/{id}/course:
    get:
      description: Returns the course for a section
      operationId: getCourseForSection
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/CourseResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /sections/{id}/district:
    get:
      description: Returns the district for a section
      operationId: getDistrictForSection
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/DistrictResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /sections/{id}/school:
    get:
      description: Returns the school for a section
      operationId: getSchoolForSection
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SchoolResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /sections/{id}/students:
    get:
      description: Returns the students for a section
      operationId: getStudentsForSection
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/StudentsResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /sections/{id}/teacher:
    get:
      description: Returns the primary teacher for a section
      operationId: getTeacherForSection
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/TeacherResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /sections/{id}/teachers:
    get:
      description: Returns the teachers for a section
      operationId: getTeachersForSection
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/TeachersResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /sections/{id}/term:
    get:
      description: Returns the term for a section
      operationId: getTermForSection
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/TermResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /students:
    get:
      description: Returns a list of students
      operationId: getStudents
      parameters:
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/StudentsResponse'
      tags:
      - Data
  /students/{id}:
    get:
      description: Returns a specific student
      operationId: getStudent
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/StudentResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /students/{id}/contacts:
    get:
      description: Returns the contacts for a student
      operationId: getContactsForStudent
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/ContactsResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /students/{id}/district:
    get:
      description: Returns the district for a student
      operationId: getDistrictForStudent
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/DistrictResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /students/{id}/school:
    get:
      description: Returns the primary school for a student
      operationId: getSchoolForStudent
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SchoolResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /students/{id}/schools:
    get:
      description: Returns the schools for a student
      operationId: getSchoolsForStudent
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SchoolsResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /students/{id}/sections:
    get:
      description: Returns the sections for a student
      operationId: getSectionsForStudent
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SectionsResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /students/{id}/teachers:
    get:
      description: Returns the teachers for a student
      operationId: getTeachersForStudent
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/TeachersResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /teachers:
    get:
      description: Returns a list of teachers
      operationId: getTeachers
      parameters:
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/TeachersResponse'
      tags:
      - Data
  /teachers/{id}:
    get:
      description: Returns a specific teacher
      operationId: getTeacher
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/TeacherResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /teachers/{id}/district:
    get:
      description: Returns the district for a teacher
      operationId: getDistrictForTeacher
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/DistrictResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /teachers/{id}/school:
    get:
      description: Retrieves school info for a teacher.
      operationId: getSchoolForTeacher
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SchoolResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /teachers/{id}/schools:
    get:
      description: Returns the schools for a teacher
      operationId: getSchoolsForTeacher
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SchoolsResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /teachers/{id}/sections:
    get:
      description: Returns the sections for a teacher
      operationId: getSectionsForTeacher
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SectionsResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /teachers/{id}/students:
    get:
      description: Returns the students for a teacher
      operationId: getStudentsForTeacher
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/StudentsResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /terms:
    get:
      description: Returns a list of terms
      operationId: getTerms
      parameters:
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/TermsResponse'
      tags:
      - Data
  /terms/{id}:
    get:
      description: Returns a specific term
      operationId: getTerm
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/TermResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /terms/{id}/district:
    get:
      description: Returns the district for a term
      operationId: getDistrictForTerm
      parameters:
      - in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/DistrictResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
  /terms/{id}/sections:
    get:
      description: Returns the sections for a term
      operationId: getSectionsForTerm
      parameters:
      - in: path
        name: id
        required: true
        type: string
      - in: query
        name: limit
        type: integer
      - in: query
        name: starting_after
        type: string
      - in: query
        name: ending_before
        type: string
      responses:
        "200":
          description: OK Response
          schema:
            $ref: '#/definitions/SectionsResponse'
        "404":
          $ref: '#/responses/NotFound'
      tags:
      - Data
produces:
- application/json
responses:
  BadRequest:
    description: Bad Request
    schema:
      $ref: '#/definitions/BadRequest'
  InternalError:
    description: Internal Error
    schema:
      $ref: '#/definitions/InternalError'
  NotFound:
    description: Entity Not Found
    schema:
      $ref: '#/definitions/NotFound'
schemes:
- https
security:
- oauth: []
securityDefinitions:
  oauth:
    authorizationUrl: https://clever.com/oauth/authorize
    flow: accessCode
    tokenUrl: https://clever.com/oauth/tokens
    type: oauth2
    x-default: TEST_TOKEN
swagger: "2.0"
x-samples-languages:
- curl
- node
- ruby
- python
- php
- java
- go