This repository has been archived by the owner on Oct 17, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
498096e
commit c5ba969
Showing
1 changed file
with
91 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,30 +12,96 @@ tags: | |
| - Objects | ||
| --- | ||
|
|
||
| :::warning Development Documentation | ||
| This documentation is also used for development purposes. | ||
| Some of the information may not be relevant to you. | ||
| Also some information may not be accessible for you. (For more information on what is accessible to you, see the respective endpoint documentations) | ||
| ## Homework | ||
|
|
||
| | Parameter | Type | Length | Description | Example Value | | ||
| | --------- | --------------- | ---------- | --------------------------------- | ---------------- | | ||
| | id | String | 8 Chars | The ID of the Task | `"jqhugsad"` | | ||
| | subject | String | 8 Chars | The Subject the Task is linked to | `"idsa7jka"` | | ||
| | year | String | 8 Chars | The Year the Task is linked to | `"a76ak8g8"` | | ||
| | given | Date (ISO 8601) | | The Date when the Task was given | `"2021-09-01"` | | ||
| | deadline | Date (ISO 8601) | | The Date when the Task is due | `"2021-09-02"` | | ||
| | text | String | < 64 Chars | The Text of the Task | `"Read Page 12"` | | ||
| | type | String | 1 Char | The Type of the Task | `"w"` | | ||
| | status | int | 0, 1, 2 | The Status of the Task | `0` | | ||
|
|
||
| ### Values for `type` | ||
|
|
||
| | Value | Description | | ||
| | ----- | ----------- | | ||
| | `"w"` | Worksheet | | ||
| | `"B"` | Book | | ||
| | `"V"` | Vocabulary | | ||
| | `"O"` | Other | | ||
|
|
||
| ### Values for `status` | ||
|
|
||
| | Value | Description | | ||
| | ----- | ----------- | | ||
| | `0` | Open | | ||
| | `1` | Done | | ||
| | `2` | Skipped | | ||
|
|
||
| ## Year | ||
|
|
||
| | Parameter | Type | Length | Description | Example Value | | ||
| | --------- | ------ | ------- | -------------------- | ------------- | | ||
| | id | String | 8 Chars | The ID of the Year | `"a76ak8g8"` | | ||
| | name | String | < 20 | The Name of the Year | `"2021/2022"` | | ||
|
|
||
| ## Subject | ||
|
|
||
| | Parameter | Type | Length | Description | Example Value | | ||
| | --------- | --------------- | ---------- | ----------------------------------------------- | -------------- | | ||
| | id | String | 8 Chars | The ID of the Subject | `"idsa7jka"` | | ||
| | name | String | < 20 | The Name of the Subject | `"Math"` | | ||
| | color | String | 6 Chars | The Color of the Subject (Hex) | `"ff0000"` | | ||
| | last_used | Date (ISO 8601) | | The last date a grade was added to this Subject | `"2021-09-01"` | | ||
| | grade_k | int | | The Weight of Exams | `45` | | ||
| | grade_m | int | | The Weight of Oral Grades | `24` | | ||
| | grade_t | String | | The Weight of Tests | `16` | | ||
| | grade_s | int | | The weight of the "other"-Category | `15` | | ||
| | average | float | 4 Decimals | The Average of all Grades | `2.41` | | ||
| | year | String | 8 Chars | The Year the Subject is linked to | `"a76ak8g8"` | | ||
|
|
||
| ### Values for `grade_t` | ||
|
|
||
| | Value | Description | | ||
| | --------- | --------------------------------------------------------------------- | | ||
| | Number | If a number is given, Tests are rated normally with the Weight given. | | ||
| | `"1exam"` | The Weight of Tests is the same as the Weight of ONE exam. | | ||
|
|
||
| :::note Why do we have a `"1exam"`-Value? | ||
| In Germany, the Weight of Tests is usually the same as the Weight of ONE exam. | ||
| As Noten-App is mainly used in Germany, we have added this Value. | ||
| ::: | ||
|
|
||
| ## Account | ||
|
|
||
| | Parameter | Type | Description | Example Value | | ||
| | ---------------- | ----------------------------- | ---------------------------------------- | ------------------------------------ | | ||
| | id | string (modified UUID-Format) | The Account ID of the User | 5negptbo-lt6v-9qos-ws1a-1s5qxe36k3op | | ||
| | displayname | string | The displayname of the User | "John Doe" | | ||
| | username | string | The username of the User | "johndoe" | | ||
| | email | string | The email of the User | "[email protected]" | | ||
| | account_creation | string (Timestamp) | The creation date of the Account | "2022-07-03 20:33:24" | | ||
| | delete_until | string (Timestamp) | The date the Account will be deleted | null | | ||
| | rounding | int | Decimal places grades will be rounded to | 2 | | ||
| | sorting | string | The sorting method of the grades | "average" | | ||
|
|
||
| ## Application | ||
|
|
||
| | Parameter | Type | Description | Example Value | | ||
| | --------- | ------ | ---------------------------- | --------------------- | | ||
| | appname | string | The name of the Application | "MyApp" | | ||
| | appurl | string | The URL of the Application | "https://example.com" | | ||
| | apptoken | string | The token of the Application | "1234567890" | | ||
| | appid | string | The ID of the Application | "1234567890" | | ||
| ## Grade | ||
|
|
||
| | Parameter | Type | Length | Description | Example Value | | ||
| | --------- | --------------- | ---------- | -------------------------------- | --------------- | | ||
| | id | String | 8 Chars | The ID of the Grade | `"jqhugsad"` | | ||
| | subject | String | 8 Chars | The Class the Grade is linked to | `"idsa7jka"` | | ||
| | type | String | 1 Char | The Type of the Grade | `"k"` | | ||
| | note | String | < 64 | The Text of the Grade | `"Second Exam"` | | ||
| | date | Date (ISO 8601) | | The Date of the Grade | `"2021-09-01"` | | ||
| | grade | float | 2 Decimals | The Value of the Grade | `2.3` | | ||
| | year | String | 8 Chars | The Year the Grade is linked to | `"a76ak8g8"` | | ||
|
|
||
| ### Values for `type` | ||
|
|
||
| | Value | Description | | ||
| | ----- | ----------- | | ||
| | `"k"` | Exam | | ||
| | `"m"` | Oral Grade | | ||
| | `"t"` | Test | | ||
| | `"s"` | Other | | ||
|
|
||
| ## Settings | ||
|
|
||
| | Parameter | Type | Length | Description | Example Value | | ||
| | ----------- | ------ | ------ | --------------------------------- | ------------- | | ||
| | rounding | int | 1 | The Rounding of Grades | `1` | | ||
| | sorting | String | 16 | The Sorting of Grades | `"average"` | | ||
| | gradesystem | String | 16 | The Gradesystem | `"points"` | | ||
| | school_year | String | 8 | The Year the user currently is in | `"a76ak8g8"` | | ||