The Homework API from Alleva — 8 operation(s) for homework.
openapi: 3.2.0
info:
title: Alleva Rest Homework API
version: '1.0'
security:
- Bearer: []
tags:
- name: Homework
paths:
/homework/{id}/assignment:
get:
tags:
- Homework
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
/v{version}/homework/{id}/assignment:
get:
tags:
- Homework
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
/homework/{id}:
patch:
tags:
- Homework
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Homework'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Homework'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Homework'
get:
tags:
- Homework
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Homework'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Homework'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Homework'
/v{version}/homework/{id}:
patch:
tags:
- Homework
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Homework'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Homework'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Homework'
get:
tags:
- Homework
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Homework'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Homework'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Homework'
/homework/{id}/notes:
post:
tags:
- Homework
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/HomeworkNote'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/HomeworkNote'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/HomeworkNote'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/HomeworkNote'
responses:
'200':
description: Success
/v{version}/homework/{id}/notes:
post:
tags:
- Homework
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/HomeworkNote'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/HomeworkNote'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/HomeworkNote'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/HomeworkNote'
responses:
'200':
description: Success
/homework:
get:
tags:
- Homework
parameters:
- name: Limit
in: query
schema:
type: integer
format: int64
- name: Cursor
in: query
schema:
type: integer
format: int32
- name: StartDate
in: query
schema:
type: string
format: date-time
- name: EndDate
in: query
schema:
type: string
format: date-time
- name: fields
in: query
schema:
type: array
items:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Homework'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Homework'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Homework'
/v{version}/homework:
get:
tags:
- Homework
parameters:
- name: Limit
in: query
schema:
type: integer
format: int64
- name: Cursor
in: query
schema:
type: integer
format: int32
- name: StartDate
in: query
schema:
type: string
format: date-time
- name: EndDate
in: query
schema:
type: string
format: date-time
- name: fields
in: query
schema:
type: array
items:
type: string
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Homework'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Homework'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Homework'
components:
schemas:
ResourceLink:
type: object
properties:
id:
type: integer
format: int32
route:
type:
- string
- 'null'
additionalProperties: false
HomeworkNote:
type: object
properties:
id:
type: integer
format: int32
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
note:
type:
- string
- 'null'
status:
type:
- string
- 'null'
createdById:
type: integer
format: int32
writeOnly: true
createdDate:
type: string
format: date-time
additionalProperties: false
Homework:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
client:
$ref: '#/components/schemas/ResourceLink'
treatmentPlan:
$ref: '#/components/schemas/ResourceLink'
title:
type:
- string
- 'null'
goals:
type:
- string
- 'null'
suggestions:
type:
- string
- 'null'
isWiley:
type: boolean
fileName:
type:
- string
- 'null'
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
status:
type:
- string
- 'null'
problem:
type:
- string
- 'null'
assignment:
type:
- string
- 'null'
notes:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/HomeworkNote'
additionalProperties: false
JToken:
type: array
items:
$ref: '#/components/schemas/JToken'
securitySchemes:
Bearer:
type: apiKey
description: "JWT Authorization header using the Bearer scheme. \n\n Enter Bearer [space] and then\
\ your token in the text input below.\n\nExample: Bearer 12345abcdef"
name: Authorization
in: header
servers:
- url: https://api.helloalleva.com
description: Base URL reconciled from apis.yml