n8n-nodes-academyfive-api 0.0.1-beta

package/dist/specs/schemas/src/Api/EventSeries/Handler/EventSeriesCustomPatchSchema.json

@@ -0,0 +1,837 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "EventSeriesCustom",
+  "type": "object",
+  "properties": {
+    "data": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "eventseries",
+          "examples": [
+            "eventseries"
+          ]
+        },
+        "id": {
+          "type": "string",
+          "minimum": 1,
+          "maxLength": 20,
+          "minLength": 1,
+          "examples": [
+            "1"
+          ]
+        },
+        "attributes": {
+          "$ref": "#/definitions/eventSeries"
+        }
+      }
+    }
+  },
+
+  "definitions": {
+    "eventSeries": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/lectureEventSeriesSchema"
+        },
+        {
+          "$ref": "#/definitions/singularEventSeriesSchema"
+        },
+        {
+          "$ref": "#/definitions/examEventSeriesSchema"
+        }
+      ]
+    },
+
+    "lectureEventPatchSchema": {
+      "oneOf": [
+        {
+          "$ref": "#/definitions/specificPatchTimeSchema"
+        },
+        {
+          "$ref": "#/definitions/allDayPatchSchema"
+        }
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "The id of the event date"
+        },
+        "op": {
+          "type": "string",
+          "description": "The operation on the event date, has to be 'update' in this context",
+          "examples": ["update"]
+        },
+        "teachingUnits": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Amount of teaching units for this event",
+          "examples": [
+            1.0,
+            2.5,
+            3.0
+          ]
+        },
+        "lectureSeriesPartId": {
+          "type": "integer",
+          "minimum": 1,
+          "examples": [
+            1,
+            2,
+            3
+          ],
+          "description": "Id of the corresponding lectureSeriesPart. Note: The corresponding EventSeries needs to be  of the type lecture. If the lectureSeries is split into parts, this field is required."
+        }
+      },
+      "required": [
+        "id",
+        "op"
+      ]
+    },
+
+    "baseEventPatchSchema": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/_baseEventPatchSchema"
+        }
+      ]
+    },
+    "_baseEventPatchSchema": {
+      "properties": {
+        "planningStatusId": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Id of the in AC5 configured planing statuses",
+          "examples": [
+            21,
+            42
+          ]
+        },
+        "customEventTypeId": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Custom event type, configured in AC5",
+          "examples": [
+            1,
+            2,
+            3
+          ]
+        },
+        "date": {
+          "type": "string",
+          "format": "date",
+          "description": "Date of event",
+          "examples": [
+            "2000-02-14"
+          ]
+        },
+        "roomIds": {
+          "type": "array",
+          "items": {
+            "type": "integer",
+            "minimum": 1
+          },
+          "description": "Ids of the rooms, configured in AC5",
+          "examples": [
+            [
+              1,
+              2,
+              3
+            ],
+            [
+              21,
+              23,
+              42
+            ]
+          ]
+        },
+        "lecturerIds": {
+          "type": "array",
+          "items": {
+            "type": "integer",
+            "minimum": 1
+          },
+          "description": "ProfileIds of the lecturers",
+          "examples": [
+            [
+              1,
+              2,
+              3
+            ],
+            [
+              9,
+              8,
+              7
+            ]
+          ]
+        },
+        "planningGroupIds": {
+          "type": "array",
+          "items": {
+            "type": "integer",
+            "minimum": 1
+          },
+          "description": "Ids of the planning groups, configured in AC5",
+          "examples": [
+            [
+              1,
+              2,
+              3
+            ],
+            [
+              9,
+              8,
+              7
+            ]
+          ]
+        },
+        "comment": {
+          "type": "string",
+          "description": "Free text field",
+          "examples": [
+            "Bacon ipsum dolor amet t-bone bresaola short loin shank, strip steak ribeye swine jowl."
+          ]
+        },
+        "comment2": {
+          "type": "string",
+          "description": "Additional free text field",
+          "examples": [
+            "Bacon ipsum dolor amet t-bone."
+          ]
+        },
+        "customId": {
+          "type": "string",
+          "description": "Custom id",
+          "maxLength": 255,
+          "examples": [
+            "ID47"
+          ]
+        },
+        "link": {
+          "type": "string",
+          "description": "Free text field",
+          "examples": [
+            "https://www.simovative.com"
+          ]
+        },
+        "linkLabel": {
+          "type": "string",
+          "description": "the label for the link",
+          "examples": [
+            "zoomlink"
+          ]
+        }
+      }
+    },
+
+    "lectureEventDatePostSchema": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/lectureEventPostSchema"
+        },
+        {
+          "$ref": "#/definitions/baseEventPostSchema"
+        }
+      ]
+    },
+
+    "lectureEventDatePatchSchema": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/lectureEventPatchSchema"
+        },
+        {
+          "$ref": "#/definitions/baseEventPatchSchema"
+        }
+      ]
+    },
+
+    "lectureEventPostSchema": {
+      "oneOf": [
+        {
+          "$ref": "EventDatePostSchema.json#/definitions/specificTimeSchema"
+        },
+        {
+          "$ref": "EventDatePostSchema.json#/definitions/allDaySchema"
+        }
+      ],
+      "properties": {
+        "op": {
+          "type": "string",
+          "description": "The operation on the event date, has to be 'add' in this context",
+          "examples": ["add"]
+        },
+        "teachingUnits": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Amount of teaching units for this event",
+          "examples": [
+            1.0,
+            2.5,
+            3.0
+          ]
+        },
+        "lectureSeriesPartId": {
+          "type": "integer",
+          "minimum": 1,
+          "examples": [
+            1,
+            2,
+            3
+          ],
+          "description": "Id of the corresponding lectureSeriesPart. Note: The corresponding EventSeries needs to be  of the type lecture. If the lectureSeries is split into parts, this field is required."
+        }
+      },
+      "required": [
+        "teachingUnits",
+        "op"
+      ]
+    },
+    "baseEventPostSchema": {
+      "properties": {
+        "planningStatusId": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Id of the in AC5 configured planing statuses",
+          "examples": [
+            21,
+            42
+          ]
+        },
+        "customEventTypeId": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Custom event type, configured in AC5",
+          "examples": [
+            1,
+            2,
+            3
+          ]
+        },
+        "date": {
+          "type": "string",
+          "format": "date",
+          "description": "Date of event",
+          "examples": [
+            "2000-02-14"
+          ]
+        },
+        "roomIds": {
+          "type": "array",
+          "items": {
+            "type": "integer",
+            "minimum": 1
+          },
+          "description": "Ids of the rooms, configured in AC5",
+          "examples": [
+            [
+              1,
+              2,
+              3
+            ],
+            [
+              21,
+              23,
+              42
+            ]
+          ]
+        },
+        "lecturerIds": {
+          "type": "array",
+          "items": {
+            "type": "integer",
+            "minimum": 1
+          },
+          "description": "ProfileIds of the lecturers",
+          "examples": [
+            [
+              1,
+              2,
+              3
+            ],
+            [
+              9,
+              8,
+              7
+            ]
+          ]
+        },
+        "planningGroupIds": {
+          "type": "array",
+          "items": {
+            "type": "integer",
+            "minimum": 1
+          },
+          "description": "Ids of the planning groups, configured in AC5",
+          "examples": [
+            [
+              1,
+              2,
+              3
+            ],
+            [
+              9,
+              8,
+              7
+            ]
+          ]
+        },
+        "comment": {
+          "type": "string",
+          "description": "Free text field",
+          "examples": [
+            "Bacon ipsum dolor amet t-bone bresaola short loin shank, strip steak ribeye swine jowl."
+          ]
+        },
+        "customId": {
+          "type": "string",
+          "description": "Custom id",
+          "maxLength": 255,
+          "examples": [
+            "ID47"
+          ]
+        },
+        "link": {
+          "type": "string",
+          "description": "Free text field",
+          "examples": [
+            "https://www.simovative.com"
+          ]
+        },
+        "linkLabel": {
+          "type": "string",
+          "description": "the label for the link",
+          "examples": [
+            "zoomlink"
+          ]
+        }
+      },
+      "required": [
+        "planningStatusId",
+        "customEventTypeId",
+        "date"
+      ]
+    },
+
+    "baseEventDateDeleteSchema": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "The event date id to delete",
+          "examples": ["1"]
+        },
+        "op": {
+          "type": "string",
+          "description": "The operation on the event date,  has to be 'delete' in this context",
+          "examples": ["delete"]
+        }
+      },
+      "required": [
+        "id",
+        "op"
+      ]
+    },
+
+    "examEventDatePostSchema": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/examEventPostSchema"
+        },
+        {
+          "$ref": "EventDatePostSchema.json#/definitions/baseSchema"
+        }
+      ]
+    },
+
+    "examEventPostSchema": {
+      "oneOf": [
+        {
+          "$ref": "EventDatePostSchema.json#/definitions/specificTimeSchema"
+        },
+        {
+          "$ref": "EventDatePostSchema.json#/definitions/allDaySchema"
+        }
+      ],
+      "properties": {
+        "op": {
+          "type": "string",
+          "description": "The operation on the event date, has to be 'add' in this context",
+          "examples": [
+            "add"
+          ]
+        },
+        "assessorIds": {
+          "type": "array",
+          "items": {
+            "type": "integer",
+            "minimum": 1
+          },
+          "description": "ProfileIds of the assessors",
+          "examples": [
+            [
+              1,
+              2,
+              3
+            ],
+            [
+              9,
+              8,
+              7
+            ]
+          ]
+        }
+      },
+      "required": [
+        "op"
+      ]
+    },
+
+    "examEventDatePatchSchema": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/examEventPatchSchema"
+        },
+        {
+          "$ref": "#/definitions/baseEventPatchSchema"
+        }
+      ]
+    },
+
+    "examEventPatchSchema": {
+      "oneOf": [
+        {
+          "$ref": "#/definitions/specificPatchTimeSchema"
+        },
+        {
+          "$ref": "#/definitions/allDayPatchSchema"
+        }
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "The id of the event date",
+          "examples": [
+            "1"
+          ]
+        },
+        "op": {
+          "type": "string",
+          "description": "The operation on the event date, has to be update in this case",
+          "examples": [
+            "update"
+          ]
+        },
+        "assessorIds": {
+          "type": "array",
+          "items": {
+            "type": "integer",
+            "minimum": 1
+          },
+          "description": "ProfileIds of the assessors",
+          "examples": [
+            [
+              1,
+              2,
+              3
+            ],
+            [
+              9,
+              8,
+              7
+            ]
+          ]
+        }
+      },
+      "required": [
+        "id",
+        "op"
+      ]
+    },
+
+    "lectureEventSeriesSchema": {
+      "anyOf": [
+        {
+          "properties": {
+            "eventDates": {
+              "type": "array",
+              "minItems": 1,
+              "maxItems": 750,
+              "description": "Array of eventDates to add based on type lecture. minItems: 1",
+              "items": {
+                "$ref": "#/definitions/lectureEventDatePostSchema"
+              }
+            }
+          }
+        },
+        {
+          "properties": {
+            "eventDates": {
+              "type": "array",
+              "minItems": 1,
+              "maxItems": 750,
+              "description": "Array of eventDates to update based on type lecture. minItems: 1",
+              "items": {
+                "$ref": "#/definitions/lectureEventDatePatchSchema"
+              }
+            }
+          }
+        },
+        {
+          "$ref": "#/definitions/eventDateDeleteSchema"
+        }
+      ]
+    },
+
+    "singularEventSeriesSchema": {
+      "anyOf": [
+        {
+          "properties": {
+            "eventDates": {
+              "type": "array",
+              "minItems": 1,
+              "maxItems": 750,
+              "description": "Array of eventDates based on type singular. minItems: 1",
+              "items": {
+                "$ref": "#/definitions/singleEventDatePostSchema"
+              }
+            }
+          }
+        },
+        {
+          "properties": {
+            "eventDates": {
+              "type": "array",
+              "minItems": 1,
+              "maxItems": 750,
+              "description": "Array of eventDates based on type singular. minItems: 1",
+              "items": {
+                "$ref": "#/definitions/singleEventDatePatchSchema"
+              }
+            }
+          }
+        },
+        {
+          "$ref": "#/definitions/eventDateDeleteSchema"
+        }
+      ]
+    },
+
+    "singleEventDatePostSchema": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/singleEventPostSchema"
+        },
+        {
+          "$ref": "EventDatePostSchema.json#/definitions/baseSchema"
+        }
+      ]
+    },
+    "singleEventPostSchema": {
+      "oneOf": [
+        {
+          "$ref": "EventDatePostSchema.json#/definitions/specificTimeSchema"
+        },
+        {
+          "$ref": "EventDatePostSchema.json#/definitions/allDaySchema"
+        }
+      ],
+      "properties": {
+        "title": {
+          "type": "string",
+          "description": "Title of the event, only needed if event is not based on a lecture or exam",
+          "examples": [
+            "Rehearsal of the singing club"
+          ]
+        },
+        "op": {
+          "type": "string",
+          "description": "The operation on the event date, has to be 'add' in this context",
+          "examples": [
+            "add"
+          ]
+        }
+      },
+      "required": [
+        "title",
+        "op"
+      ]
+    },
+
+    "singleEventDatePatchSchema": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/singleEventPatchSchema"
+        },
+        {
+          "$ref": "#/definitions/baseEventPatchSchema"
+        }
+      ]
+    },
+
+    "singleEventPatchSchema": {
+      "oneOf": [
+        {
+          "$ref": "#/definitions/specificPatchTimeSchema"
+        },
+        {
+          "$ref": "#/definitions/allDayPatchSchema"
+        }
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "The id of the event date",
+          "examples": [
+            "1"
+          ]
+        },
+        "op": {
+          "type": "string",
+          "description": "The operation on the event date, has to be 'update' in this context",
+          "examples": [
+            "update"
+          ]
+        },
+        "title": {
+          "type": "string",
+          "description": "Title of the event, only needed if event is not based on a lecture or exam",
+          "examples": [
+            "Rehearsal of the singing club"
+          ]
+        }
+      },
+      "required": [
+        "id",
+        "op"
+      ]
+    },
+
+    "examEventSeriesSchema": {
+      "anyOf": [{
+        "properties": {
+          "eventDates": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 1,
+            "description": "Array of eventDates based on type exam. minItems: 1, maxItems:1",
+            "items": {
+              "$ref": "#/definitions/examEventDatePostSchema"
+            }
+          }
+        }
+      },
+        {
+          "properties": {
+            "eventDates": {
+              "type": "array",
+              "minItems": 1,
+              "maxItems": 1,
+              "description": "Array of eventDates based on type exam. minItems: 1, maxItems:1",
+              "items": {
+                "$ref": "#/definitions/examEventDatePatchSchema"
+              }
+            }
+          }
+        },
+        {
+          "$ref": "#/definitions/eventDateDeleteSchema"
+        }
+      ]
+
+
+    },
+
+    "eventDateDeleteSchema": {
+      "properties": {
+        "eventDates": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 750,
+          "description": "Array of eventDates to delete. minItems: 1",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "The event date id to delete",
+                "examples": ["1"]
+              },
+              "op": {
+                "type": "string",
+                "description": "The operation on the event date, has to be 'delete' in this context",
+                "examples": ["delete"]
+              }
+            },
+            "required": [
+              "id",
+              "op"
+            ]
+          }
+        }
+      }
+    },
+
+    "specificPatchTimeSchema": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/_specificPatchTimeSchema"
+        }
+      ]
+    },
+    "_specificPatchTimeSchema": {
+      "properties": {
+        "allDay": {
+          "type": "boolean",
+          "enum": [
+            false
+          ],
+          "description": "If false the start and end time is required",
+          "examples": [
+            false
+          ]
+        },
+        "startTime": {
+          "type": "string",
+          "format": "time",
+          "description": "The start time of the event, for example 12:00:00",
+          "examples": [
+            "12:00:00",
+            "12:15:00"
+          ]
+        },
+        "endTime": {
+          "type": "string",
+          "format": "time",
+          "description": "The end time of the event, for example 14:00:00",
+          "examples": [
+            "14:00:00",
+            "14:15:00"
+          ]
+        }
+      }
+    },
+    "allDayPatchSchema": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/_allDayPatchSchema"
+        }
+      ]
+    },
+    "_allDayPatchSchema": {
+      "properties": {
+        "allDay": {
+          "type": "boolean",
+          "enum": [
+            true
+          ],
+          "description": "If true the start and end time are automatically set to 00:00:00 and 23:59:00 respectively",
+          "examples": [
+            true
+          ]
+        }
+      }
+    }
+  }
+}