openapi: 3.0.1 info: title: Announcement API description: List of APIs related to Announcement version: '1.0' servers: - url: https://luminus.azure-api.net/announcement paths: '/{annID}': get: tags: - Announcement summary: Get announcement description: "1. Get details of the announcement. \r\n2. Add log if the announcement is active." operationId: GetAnnouncement parameters: - name: annID in: path description: Format - uuid. Announcement ID required: true schema: type: string - name: populate in: query description: 'Populate additional information. Accepted entities: creator, lastUpdatedUser' schema: type: string responses: '200': description: 'Returns an [API_Announcement.API.Announcement] object' content: text/plain: schema: $ref: '#/components/schemas/API_Announcement.API.Announcement' examples: default: value: application/json: schema: $ref: '#/components/schemas/API_Announcement.API.Announcement' example: id: string parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: true email: true excludeOwner: true access: access_Full: true access_Read: true access_Create: true access_Update: true access_Delete: true access_Settings_Read: true access_Settings_Update: true createdDate: string creatorID: string creatorName: string creatorUserID: string creatorEmail: string lastUpdatedDate: string lastUpdatedBy: string lastUpdatedByName: string lastUpdatedByUserID: string lastUpdatedByEmail: string text/json: schema: $ref: '#/components/schemas/API_Announcement.API.Announcement' example: id: string parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: true email: true excludeOwner: true access: access_Full: true access_Read: true access_Create: true access_Update: true access_Delete: true access_Settings_Read: true access_Settings_Update: true createdDate: string creatorID: string creatorName: string creatorUserID: string creatorEmail: string lastUpdatedDate: string lastUpdatedBy: string lastUpdatedByName: string lastUpdatedByUserID: string lastUpdatedByEmail: string '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/AnnIDGet400TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/AnnIDGet400ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/AnnIDGet400TextJsonResponse' example: string '403': description: Login user not authorized to perform this action content: text/plain: schema: $ref: '#/components/schemas/AnnIDGet403TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/AnnIDGet403ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/AnnIDGet403TextJsonResponse' example: string '404': description: Not Found content: text/plain: schema: $ref: '#/components/schemas/AnnIDGet404TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/AnnIDGet404ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/AnnIDGet404TextJsonResponse' example: string '500': description: Server Error content: text/plain: schema: $ref: '#/components/schemas/AnnIDGet500TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/AnnIDGet500ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/AnnIDGet500TextJsonResponse' example: string /Active: get: tags: - Announcement summary: Get active announcements description: "1. Get the list of active announcements (for all teaching/enrolled modules) that are accessible to the login user.\r\n2. Add log if titleOnly is set to false" operationId: GetActiveAnnouncements parameters: - name: sortby in: query schema: type: string - name: offset in: query description: Format - int32. schema: type: integer - name: limit in: query description: Format - int32. schema: type: integer - name: where in: query schema: type: string - name: populate in: query description: 'Populate additional information. Accepted entities: creator, lastUpdatedUser' schema: type: string - name: titleOnly in: query description: True by default. Set to False to return announcement details and add log. schema: type: boolean default: true responses: '200': description: 'Returns list of [API_Announcement.API.Announcement]' content: text/plain: schema: $ref: '#/components/schemas/API_Announcement-API-AnnouncementArray' examples: default: value: application/json: schema: $ref: '#/components/schemas/API_Announcement-API-AnnouncementArray-1' example: - id: string parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: true email: true excludeOwner: true access: access_Full: true access_Read: true access_Create: true access_Update: true access_Delete: true access_Settings_Read: true access_Settings_Update: true createdDate: string creatorID: string creatorName: string creatorUserID: string creatorEmail: string lastUpdatedDate: string lastUpdatedBy: string lastUpdatedByName: string lastUpdatedByUserID: string lastUpdatedByEmail: string text/json: schema: $ref: '#/components/schemas/API_Announcement-API-AnnouncementArray-2' example: - id: string parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: true email: true excludeOwner: true access: access_Full: true access_Read: true access_Create: true access_Update: true access_Delete: true access_Settings_Read: true access_Settings_Update: true createdDate: string creatorID: string creatorName: string creatorUserID: string creatorEmail: string lastUpdatedDate: string lastUpdatedBy: string lastUpdatedByName: string lastUpdatedByUserID: string lastUpdatedByEmail: string '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ActiveGet400TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/ActiveGet400ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/ActiveGet400TextJsonResponse' example: string '403': description: Login user not authorized to perform this action content: text/plain: schema: $ref: '#/components/schemas/ActiveGet403TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/ActiveGet403ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/ActiveGet403TextJsonResponse' example: string '404': description: Not Found content: text/plain: schema: $ref: '#/components/schemas/ActiveGet404TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/ActiveGet404ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/ActiveGet404TextJsonResponse' example: string '500': description: Server Error content: text/plain: schema: $ref: '#/components/schemas/ActiveGet500TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/ActiveGet500ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/ActiveGet500TextJsonResponse' example: string /Unread: get: tags: - Announcement summary: Get unread announcements description: "1. Get the list of unread announcements (for all teaching/enrolled modules) that are accessible to the login user.\r\n2. Add log for all active announcements if titleOnly is set to false" operationId: GetUnreadAnnouncements parameters: - name: sortby in: query schema: type: string - name: offset in: query description: Format - int32. schema: type: integer - name: limit in: query description: Format - int32. schema: type: integer - name: where in: query schema: type: string - name: populate in: query description: 'Populate additional information. Accepted entities: creator, lastUpdatedUser' schema: type: string - name: titleOnly in: query description: True by default. Set to False to return announcement details and add log. schema: type: boolean default: true responses: '200': description: 'Returns list of [API_Announcement.API.Announcement]' content: text/plain: schema: $ref: '#/components/schemas/API_Announcement-Models-AnnouncementArray-3' examples: default: value: application/json: schema: $ref: '#/components/schemas/API_Announcement-Models-AnnouncementArray-4' example: - startDate: string endDate: string rootID: string id: string createdDate: string creatorID: string lastUpdatedDate: string lastUpdatedBy: string lastDeletedDate: string lastDeletedBy: string name: string publish: true parentID: string properties: string typeID: { } text/json: schema: $ref: '#/components/schemas/API_Announcement-Models-AnnouncementArray-5' example: - startDate: string endDate: string rootID: string id: string createdDate: string creatorID: string lastUpdatedDate: string lastUpdatedBy: string lastDeletedDate: string lastDeletedBy: string name: string publish: true parentID: string properties: string typeID: { } '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/UnreadGet400TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/UnreadGet400ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/UnreadGet400TextJsonResponse' example: string '403': description: Login user not authorized to perform this action content: text/plain: schema: $ref: '#/components/schemas/UnreadGet403TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/UnreadGet403ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/UnreadGet403TextJsonResponse' example: string '404': description: Not Found content: text/plain: schema: $ref: '#/components/schemas/UnreadGet404TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/UnreadGet404ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/UnreadGet404TextJsonResponse' example: string '500': description: Server Error content: text/plain: schema: $ref: '#/components/schemas/UnreadGet500TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/UnreadGet500ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/UnreadGet500TextJsonResponse' example: string /: put: tags: - Announcement summary: Update announcement description: "1. Update an announcement.\r\n2. Only users with Access_Setting_Update access to the announcement can update it.\r\n3. If InheritedResourceID is valid, the announcement will inherit its access rights from InheritedResourceID.\r\n4. If InheritedResourceID is null but group and/or user access are/is defined, the groups and users will have access to the announcement.\r\n5. If InheritedResourceID is null and no group/user access is defined, only creator will have access to the announcement." operationId: UpdateAnnouncement requestBody: description: Announcement to update content: application/json-patch+json: schema: $ref: '#/components/schemas/API_Announcement.API.InputAnnouncementForUpdate' example: id: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: false email: false excludeOwner: false access: groupAccess: - groupID: string accessRole: { } userAccess: - userID: string accessRole: { } publicAccess: { } inheritedResourceID: string application/json: schema: $ref: '#/components/schemas/API_Announcement.API.InputAnnouncementForUpdate' example: id: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: false email: false excludeOwner: false access: groupAccess: - groupID: string accessRole: { } userAccess: - userID: string accessRole: { } publicAccess: { } inheritedResourceID: string text/json: schema: $ref: '#/components/schemas/API_Announcement.API.InputAnnouncementForUpdate' example: id: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: false email: false excludeOwner: false access: groupAccess: - groupID: string accessRole: { } userAccess: - userID: string accessRole: { } publicAccess: { } inheritedResourceID: string application/*+json: schema: $ref: '#/components/schemas/API_Announcement.API.InputAnnouncementForUpdate' example: id: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: false email: false excludeOwner: false access: groupAccess: - groupID: string accessRole: { } userAccess: - userID: string accessRole: { } publicAccess: { } inheritedResourceID: string responses: '200': description: Returns the record updated content: text/plain: schema: $ref: '#/components/schemas/API_Announcement.API.Announcement' examples: default: value: application/json: schema: $ref: '#/components/schemas/API_Announcement.API.Announcement' example: id: string parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: true email: true excludeOwner: true access: access_Full: true access_Read: true access_Create: true access_Update: true access_Delete: true access_Settings_Read: true access_Settings_Update: true createdDate: string creatorID: string creatorName: string creatorUserID: string creatorEmail: string lastUpdatedDate: string lastUpdatedBy: string lastUpdatedByName: string lastUpdatedByUserID: string lastUpdatedByEmail: string text/json: schema: $ref: '#/components/schemas/API_Announcement.API.Announcement' example: id: string parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: true email: true excludeOwner: true access: access_Full: true access_Read: true access_Create: true access_Update: true access_Delete: true access_Settings_Read: true access_Settings_Update: true createdDate: string creatorID: string creatorName: string creatorUserID: string creatorEmail: string lastUpdatedDate: string lastUpdatedBy: string lastUpdatedByName: string lastUpdatedByUserID: string lastUpdatedByEmail: string '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/Put400TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Put400ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Put400TextJsonResponse' example: string '403': description: Login user not authorized to perform this action content: text/plain: schema: $ref: '#/components/schemas/Put403TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Put403ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Put403TextJsonResponse' example: string '404': description: Not Found content: text/plain: schema: $ref: '#/components/schemas/Put404TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Put404ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Put404TextJsonResponse' example: string '500': description: Server Error content: text/plain: schema: $ref: '#/components/schemas/Put500TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Put500ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Put500TextJsonResponse' example: string post: tags: - Announcement summary: Add announcement description: "1. Create a new announcement and add log for the login user.\r\n2. Only users with Access_Setting_Update access to the module can create a new announcement.\r\n3. If InheritedResourceID is valid, the announcement will inherit its access rights from InheritedResourceID.\r\n4. If InheritedResourceID is null but group and/or user access are/is defined, the groups and users will have access to the announcement.\r\n5. If InheritedResourceID is null and no group/user access is defined, only creator will have access to the announcement." operationId: AddAnnouncement requestBody: description: Announcement to create content: application/json-patch+json: schema: $ref: '#/components/schemas/API_Announcement.API.InputAnnouncementForCreate' example: parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: false email: false excludeOwner: false access: groupAccess: - groupID: string accessRole: { } userAccess: - userID: string accessRole: { } publicAccess: { } inheritedResourceID: string application/json: schema: $ref: '#/components/schemas/API_Announcement.API.InputAnnouncementForCreate' example: parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: false email: false excludeOwner: false access: groupAccess: - groupID: string accessRole: { } userAccess: - userID: string accessRole: { } publicAccess: { } inheritedResourceID: string text/json: schema: $ref: '#/components/schemas/API_Announcement.API.InputAnnouncementForCreate' example: parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: false email: false excludeOwner: false access: groupAccess: - groupID: string accessRole: { } userAccess: - userID: string accessRole: { } publicAccess: { } inheritedResourceID: string application/*+json: schema: $ref: '#/components/schemas/API_Announcement.API.InputAnnouncementForCreate' example: parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: false email: false excludeOwner: false access: groupAccess: - groupID: string accessRole: { } userAccess: - userID: string accessRole: { } publicAccess: { } inheritedResourceID: string responses: '201': description: Returns the record inserted content: text/plain: schema: $ref: '#/components/schemas/API_Announcement.API.Announcement' examples: default: value: application/json: schema: $ref: '#/components/schemas/API_Announcement.API.Announcement' example: id: string parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: true email: true excludeOwner: true access: access_Full: true access_Read: true access_Create: true access_Update: true access_Delete: true access_Settings_Read: true access_Settings_Update: true createdDate: string creatorID: string creatorName: string creatorUserID: string creatorEmail: string lastUpdatedDate: string lastUpdatedBy: string lastUpdatedByName: string lastUpdatedByUserID: string lastUpdatedByEmail: string text/json: schema: $ref: '#/components/schemas/API_Announcement.API.Announcement' example: id: string parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: true email: true excludeOwner: true access: access_Full: true access_Read: true access_Create: true access_Update: true access_Delete: true access_Settings_Read: true access_Settings_Update: true createdDate: string creatorID: string creatorName: string creatorUserID: string creatorEmail: string lastUpdatedDate: string lastUpdatedBy: string lastUpdatedByName: string lastUpdatedByUserID: string lastUpdatedByEmail: string '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/Post400TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Post400ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Post400TextJsonResponse' example: string '403': description: Login user not authorized to perform this action content: text/plain: schema: $ref: '#/components/schemas/Post403TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Post403ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Post403TextJsonResponse' example: string '404': description: Not Found content: text/plain: schema: $ref: '#/components/schemas/Post404TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Post404ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Post404TextJsonResponse' example: string '500': description: Server Error content: text/plain: schema: $ref: '#/components/schemas/Post500TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Post500ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Post500TextJsonResponse' example: string delete: tags: - Announcement summary: Delete announcements description: Only users with Access_Delete access to the announcements can delete them. operationId: DeleteAnnouncements requestBody: description: IDs of the announcements to delete. content: application/json-patch+json: schema: $ref: '#/components/schemas/lib.Hosts.Models.APIListIDInput' example: iDs: - string application/json: schema: $ref: '#/components/schemas/lib.Hosts.Models.APIListIDInput' example: iDs: - string text/json: schema: $ref: '#/components/schemas/lib.Hosts.Models.APIListIDInput' example: iDs: - string application/*+json: schema: $ref: '#/components/schemas/lib.Hosts.Models.APIListIDInput' example: iDs: - string responses: '200': description: Returns IDs of the announcements deleted content: text/plain: schema: $ref: '#/components/schemas/Delete200TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Delete200ApplicationJsonResponse' example: - string text/json: schema: $ref: '#/components/schemas/Delete200TextJsonResponse' example: - string '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/Delete400TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Delete400ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Delete400TextJsonResponse' example: string '403': description: Login user not authorized to perform this action content: text/plain: schema: $ref: '#/components/schemas/Delete403TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Delete403ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Delete403TextJsonResponse' example: string '404': description: Not Found content: text/plain: schema: $ref: '#/components/schemas/Delete404TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Delete404ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Delete404TextJsonResponse' example: string '500': description: Server Error content: text/plain: schema: $ref: '#/components/schemas/Delete500TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Delete500ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Delete500TextJsonResponse' example: string patch: tags: - Announcement summary: Publish announcement description: "1. Publish or unpublish an announcement.\r\n2. Only users with Access_Setting_Update access to the announcement can publish or unpublish it." operationId: PublishAnnouncement requestBody: description: Announcement ID and publish status content: application/json-patch+json: schema: $ref: '#/components/schemas/API_Announcement.API.InputAnnouncementForUpdate' example: id: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: false email: false excludeOwner: false access: groupAccess: - groupID: string accessRole: { } userAccess: - userID: string accessRole: { } publicAccess: { } inheritedResourceID: string application/json: schema: $ref: '#/components/schemas/API_Announcement.API.InputAnnouncementForUpdate' example: id: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: false email: false excludeOwner: false access: groupAccess: - groupID: string accessRole: { } userAccess: - userID: string accessRole: { } publicAccess: { } inheritedResourceID: string text/json: schema: $ref: '#/components/schemas/API_Announcement.API.InputAnnouncementForUpdate' example: id: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: false email: false excludeOwner: false access: groupAccess: - groupID: string accessRole: { } userAccess: - userID: string accessRole: { } publicAccess: { } inheritedResourceID: string application/*+json: schema: $ref: '#/components/schemas/API_Announcement.API.InputAnnouncementForUpdate' example: id: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: false email: false excludeOwner: false access: groupAccess: - groupID: string accessRole: { } userAccess: - userID: string accessRole: { } publicAccess: { } inheritedResourceID: string responses: '200': description: Returns the record updated content: text/plain: schema: $ref: '#/components/schemas/API_Announcement.API.Announcement' examples: default: value: application/json: schema: $ref: '#/components/schemas/API_Announcement.API.Announcement' example: id: string parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: true email: true excludeOwner: true access: access_Full: true access_Read: true access_Create: true access_Update: true access_Delete: true access_Settings_Read: true access_Settings_Update: true createdDate: string creatorID: string creatorName: string creatorUserID: string creatorEmail: string lastUpdatedDate: string lastUpdatedBy: string lastUpdatedByName: string lastUpdatedByUserID: string lastUpdatedByEmail: string text/json: schema: $ref: '#/components/schemas/API_Announcement.API.Announcement' example: id: string parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: true email: true excludeOwner: true access: access_Full: true access_Read: true access_Create: true access_Update: true access_Delete: true access_Settings_Read: true access_Settings_Update: true createdDate: string creatorID: string creatorName: string creatorUserID: string creatorEmail: string lastUpdatedDate: string lastUpdatedBy: string lastUpdatedByName: string lastUpdatedByUserID: string lastUpdatedByEmail: string '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/Patch400TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Patch400ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Patch400TextJsonResponse' example: string '403': description: Login user not authorized to perform this action content: text/plain: schema: $ref: '#/components/schemas/Patch403TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Patch403ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Patch403TextJsonResponse' example: string '404': description: Not Found content: text/plain: schema: $ref: '#/components/schemas/Patch404TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Patch404ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Patch404TextJsonResponse' example: string '500': description: Server Error content: text/plain: schema: $ref: '#/components/schemas/Patch500TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/Patch500ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/Patch500TextJsonResponse' example: string '/Active/{parentID}': get: tags: - Announcement summary: Get active announcements by module description: "1. Get the list of active announcements (for one module) that are accessible to the login user.\r\n2. Add log if titleOnly is set to false." operationId: GetActiveAnnouncementsByModule parameters: - name: parentID in: path description: 'Format - uuid. Parent ID, e.g. ModuleID' required: true schema: type: string - name: sortby in: query schema: type: string - name: offset in: query description: Format - int32. schema: type: integer - name: limit in: query description: Format - int32. schema: type: integer - name: where in: query schema: type: string - name: populate in: query description: 'Populate additional information. Accepted entities: creator, lastUpdatedUser' schema: type: string - name: titleOnly in: query description: True by default. Set to False to return announcement details and add log. schema: type: boolean default: true responses: '200': description: 'Returns list of [API_Announcement.API.Announcement]' content: text/plain: schema: $ref: '#/components/schemas/API_Announcement-API-AnnouncementArray-3' examples: default: value: application/json: schema: $ref: '#/components/schemas/API_Announcement-API-AnnouncementArray-4' example: - id: string parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: true email: true excludeOwner: true access: access_Full: true access_Read: true access_Create: true access_Update: true access_Delete: true access_Settings_Read: true access_Settings_Update: true createdDate: string creatorID: string creatorName: string creatorUserID: string creatorEmail: string lastUpdatedDate: string lastUpdatedBy: string lastUpdatedByName: string lastUpdatedByUserID: string lastUpdatedByEmail: string text/json: schema: $ref: '#/components/schemas/API_Announcement-API-AnnouncementArray-5' example: - id: string parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: true email: true excludeOwner: true access: access_Full: true access_Read: true access_Create: true access_Update: true access_Delete: true access_Settings_Read: true access_Settings_Update: true createdDate: string creatorID: string creatorName: string creatorUserID: string creatorEmail: string lastUpdatedDate: string lastUpdatedBy: string lastUpdatedByName: string lastUpdatedByUserID: string lastUpdatedByEmail: string '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ActiveParentIDGet400TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/ActiveParentIDGet400ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/ActiveParentIDGet400TextJsonResponse' example: string '403': description: Login user not authorized to perform this action content: text/plain: schema: $ref: '#/components/schemas/ActiveParentIDGet403TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/ActiveParentIDGet403ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/ActiveParentIDGet403TextJsonResponse' example: string '404': description: Not Found content: text/plain: schema: $ref: '#/components/schemas/ActiveParentIDGet404TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/ActiveParentIDGet404ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/ActiveParentIDGet404TextJsonResponse' example: string '500': description: Server Error content: text/plain: schema: $ref: '#/components/schemas/ActiveParentIDGet500TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/ActiveParentIDGet500ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/ActiveParentIDGet500TextJsonResponse' example: string '/NonArchived/{parentID}': get: tags: - Announcement summary: Get non-archived announcements by module description: "1. Non-archived announcements include both scheduled and active announcements.\r\n2. Get the list of non-archived announcements (for one module) that are accessible to the login user.\r\n3. Add log for all active announcements if titleOnly is set to false.\r\n4. Only users with Access_Setting_Read access to the scheduled announcements can view them." operationId: GetNonArchivedAnnouncementsByModule parameters: - name: parentID in: path description: 'Format - uuid. Parent ID, e.g. ModuleID' required: true schema: type: string - name: sortby in: query schema: type: string - name: offset in: query description: Format - int32. schema: type: integer - name: limit in: query description: Format - int32. schema: type: integer - name: where in: query schema: type: string - name: populate in: query description: 'Populate additional information. Accepted entities: creator, lastUpdatedUser' schema: type: string - name: titleOnly in: query description: True by default. Set to False to return announcement details and add log. schema: type: boolean default: true responses: '200': description: 'Returns list of [API_Announcement.API.Announcement]' content: text/plain: schema: $ref: '#/components/schemas/API_Announcement-API-AnnouncementArray-6' examples: default: value: application/json: schema: $ref: '#/components/schemas/API_Announcement-API-AnnouncementArray-7' example: - id: string parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: true email: true excludeOwner: true access: access_Full: true access_Read: true access_Create: true access_Update: true access_Delete: true access_Settings_Read: true access_Settings_Update: true createdDate: string creatorID: string creatorName: string creatorUserID: string creatorEmail: string lastUpdatedDate: string lastUpdatedBy: string lastUpdatedByName: string lastUpdatedByUserID: string lastUpdatedByEmail: string text/json: schema: $ref: '#/components/schemas/API_Announcement-API-AnnouncementArray-8' example: - id: string parentID: string title: string description: string displayFrom: string expireAfter: string archiveAfter: string publish: true sms: true email: true excludeOwner: true access: access_Full: true access_Read: true access_Create: true access_Update: true access_Delete: true access_Settings_Read: true access_Settings_Update: true createdDate: string creatorID: string creatorName: string creatorUserID: string creatorEmail: string lastUpdatedDate: string lastUpdatedBy: string lastUpdatedByName: string lastUpdatedByUserID: string lastUpdatedByEmail: string '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/NonArchivedParentIDGet400TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/NonArchivedParentIDGet400ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/NonArchivedParentIDGet400TextJsonResponse' example: string '403': description: Login user not authorized to perform this action content: text/plain: schema: $ref: '#/components/schemas/NonArchivedParentIDGet403TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/NonArchivedParentIDGet403ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/NonArchivedParentIDGet403TextJsonResponse' example: string '404': description: Not Found content: text/plain: schema: $ref: '#/components/schemas/NonArchivedParentIDGet404TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/NonArchivedParentIDGet404ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/NonArchivedParentIDGet404TextJsonResponse' example: string '500': description: Server Error content: text/plain: schema: $ref: '#/components/schemas/NonArchivedParentIDGet500TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/NonArchivedParentIDGet500ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/NonArchivedParentIDGet500TextJsonResponse' example: string '/Archived/{parentID}': get: tags: - Announcement summary: Get archived announcements by module description: "1. Get the list of archived announcements (for one module) that are accessible to the login user.\r\n2. Only users with Access_Setting_Read access to the archived announcements can view them." operationId: GetArchivedAnnouncementsByModule parameters: - name: parentID in: path description: 'Format - uuid. Parent ID, e.g. ModuleID' required: true schema: type: string - name: sortby in: query schema: type: string - name: offset in: query description: Format - int32. schema: type: integer - name: limit in: query description: Format - int32. schema: type: integer - name: where in: query schema: type: string - name: populate in: query description: 'Populate additional information. Accepted entities: creator, lastUpdatedUser' schema: type: string - name: titleOnly in: query description: True by default. Set to False to return announcement details. schema: type: boolean default: true responses: '200': description: 'Returns list of [API_Announcement.API.Announcement]' content: text/plain: schema: $ref: '#/components/schemas/API_Announcement-Models-AnnouncementArray' examples: default: value: application/json: schema: $ref: '#/components/schemas/API_Announcement-Models-AnnouncementArray-1' example: - startDate: string endDate: string rootID: string id: string createdDate: string creatorID: string lastUpdatedDate: string lastUpdatedBy: string lastDeletedDate: string lastDeletedBy: string name: string publish: true parentID: string properties: string typeID: { } text/json: schema: $ref: '#/components/schemas/API_Announcement-Models-AnnouncementArray-2' example: - startDate: string endDate: string rootID: string id: string createdDate: string creatorID: string lastUpdatedDate: string lastUpdatedBy: string lastDeletedDate: string lastDeletedBy: string name: string publish: true parentID: string properties: string typeID: { } '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ArchivedParentIDGet400TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/ArchivedParentIDGet400ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/ArchivedParentIDGet400TextJsonResponse' example: string '403': description: Login user not authorized to perform this action content: text/plain: schema: $ref: '#/components/schemas/ArchivedParentIDGet403TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/ArchivedParentIDGet403ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/ArchivedParentIDGet403TextJsonResponse' example: string '404': description: Not Found content: text/plain: schema: $ref: '#/components/schemas/ArchivedParentIDGet404TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/ArchivedParentIDGet404ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/ArchivedParentIDGet404TextJsonResponse' example: string '500': description: Server Error content: text/plain: schema: $ref: '#/components/schemas/ArchivedParentIDGet500TextPlainResponse' examples: default: value: application/json: schema: $ref: '#/components/schemas/ArchivedParentIDGet500ApplicationJsonResponse' example: string text/json: schema: $ref: '#/components/schemas/ArchivedParentIDGet500TextJsonResponse' example: string components: schemas: contract.ACL.Models.Access_Result: type: object properties: access_Full: type: boolean description: all accesses on the resource and its contents access_Read: type: boolean description: read-only access on the contents access_Create: type: boolean description: create access on the contents access_Update: type: boolean description: update access on the contents access_Delete: type: boolean description: delete access on the contents access_Settings_Read: type: boolean description: read-only access on the resource setting access_Settings_Update: type: boolean description: update access on the resource setting description: flags to define access rights API_Announcement.API.Announcement: required: - access - archiveAfter - createdDate - creatorID - displayFrom - email - excludeOwner - expireAfter - id - lastUpdatedBy - lastUpdatedDate - parentID - publish - sms - title type: object properties: id: type: string description: Announcement ID format: uuid parentID: type: string description: ID of the parent resource format: uuid title: type: string description: Announcement title description: type: string description: Announcement description displayFrom: type: string description: Announcement display start date format: date-time expireAfter: type: string description: Announcement expiry date. Students can view expired announcement however the announcement will not be highlighted as "New". format: date-time archiveAfter: type: string description: Announcement display end date. Students cannot view announcement that has been archived. format: date-time publish: type: boolean description: True if the announcement is published sms: type: boolean description: True if the announcement has been sent by SMS email: type: boolean description: True if the announcement has been sent by email excludeOwner: type: boolean description: True to exclude module owner from the list of email/SMS recipients. access: allOf: - $ref: '#/components/schemas/contract.ACL.Models.Access_Result' description: Announcement access rights createdDate: type: string description: The date the announcement is created format: date-time creatorID: type: string description: The Guid of the user who created the announcement format: uuid creatorName: type: string description: The name of the user who created the announcement creatorUserID: type: string description: The user ID of the user who created the announcement creatorEmail: type: string description: The email address of the user who created the announcement lastUpdatedDate: type: string description: The date the announcement is last updated format: date-time lastUpdatedBy: type: string description: The Guid of the user who last updated the announcement format: uuid lastUpdatedByName: type: string description: The name of the user who last updated the announcement lastUpdatedByUserID: type: string description: The user ID of the user who last updated the announcement lastUpdatedByEmail: type: string description: The email address of the user who last updated the announcement description: The Announcement output class contract.Resource.Models.TypeList: enum: - 1 - 2 - 6 - 7 - 8 - 10 - 11 - 13 - 14 - 15 - 16 - 17 - 19 - 20 - 22 - 24 - 25 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 39 - 41 - 42 - 44 - 45 - 47 - 48 - 51 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 - 83 - 100 - 200 - 1000 - 1001 - 1002 - 1003 - 1004 - 1005 - 1006 type: integer description: type of resource or content format: int32 API_Announcement.Models.Announcement: type: object properties: startDate: type: string description: the date which this resource is open to students. format: date-time endDate: type: string description: the date which this resource is closed from students. format: date-time rootID: type: string description: 'the root ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.' format: uuid id: type: string description: identifier format: uuid createdDate: type: string description: The date this record is created format: date-time creatorID: type: string description: the ID of the user who created this record format: uuid lastUpdatedDate: type: string description: the date this record is edited last time format: date-time lastUpdatedBy: type: string description: the ID of the user who edited this record last time format: uuid lastDeletedDate: type: string description: the date this record is deleted if the value is not null format: date-time lastDeletedBy: type: string description: the ID of the user who deleted this record if the value is not null format: uuid name: type: string description: the name/title of the record publish: type: boolean description: the publish flag which determin whether the record is published to students. parentID: type: string description: '' format: uuid properties: type: string description: the serialized string for the rest content properites. typeID: allOf: - $ref: '#/components/schemas/contract.Resource.Models.TypeList' description: the content type description: "The Announcement class inherits [contract.Resource.Models.Resource] \r\n" contract.ACL.Models.Resource_AccessRole: enum: - 1 - 2 - 3 - 4 - 5 - 6 type: integer description: customized user role for IVLE. format: int32 contract.ACL.Models.InputGroupACLWithRole: required: - accessRole - groupID type: object properties: groupID: type: string description: the group id format: uuid accessRole: allOf: - $ref: '#/components/schemas/contract.ACL.Models.Resource_AccessRole' description: the role defined for the group description: group role access contract.ACL.Models.InputUserACLWithRole: required: - accessRole - userID type: object properties: userID: type: string description: individual id of the user format: uuid accessRole: allOf: - $ref: '#/components/schemas/contract.ACL.Models.Resource_AccessRole' description: The role defined for the user description: user role access contract.ACL.Models.InputRoleAccess: type: object properties: groupAccess: type: array items: $ref: '#/components/schemas/contract.ACL.Models.InputGroupACLWithRole' description: Group access rights defined for this resource userAccess: type: array items: $ref: '#/components/schemas/contract.ACL.Models.InputUserACLWithRole' description: Individual user access rights which is different from the groups the user belongs to (if any) publicAccess: allOf: - $ref: '#/components/schemas/contract.ACL.Models.Resource_AccessRole' description: the access rights which the user defined for public. null means NO_ACCESS inheritedResourceID: type: string description: not null means it follow permission from another resource format: uuid description: input access with role definition API_Announcement.API.InputAnnouncementForCreate: required: - archiveAfter - displayFrom - expireAfter - title type: object properties: parentID: type: string description: ID of the parent resource. Set to null if the announcement has no parent resource. format: uuid title: maxLength: 500 minLength: 1 type: string description: Announcement title description: type: string description: Announcement description displayFrom: type: string description: Announcement display start date format: date-time expireAfter: type: string description: Announcement expiry date. Students can view expired announcement however the announcement will not be highlighted as "New". format: date-time archiveAfter: type: string description: Announcement display end date. Students cannot view announcement that has been archived. format: date-time publish: type: boolean description: True by default. Students cannot view announcements that are un-published. default: true sms: type: boolean description: False by default. Set to True to send the announcement by SMS. default: false email: type: boolean description: False by default. Set to True to send the announcement by email. default: false excludeOwner: type: boolean description: False by default. True to exclude module owner from the list of email/SMS recipients. default: false access: allOf: - $ref: '#/components/schemas/contract.ACL.Models.InputRoleAccess' description: "Announcement access rights, refer to [contract.ACL.Models.InputRoleAccess]\r\nPublic access not supported for announcement." description: HTTP Post Input class for announcement creation API_Announcement.API.InputAnnouncementForUpdate: required: - archiveAfter - displayFrom - expireAfter - id - title type: object properties: id: type: string description: Announcement ID format: uuid title: maxLength: 500 minLength: 1 type: string description: Announcement title description: type: string description: Announcement description displayFrom: type: string description: Announcement display start date format: date-time expireAfter: type: string description: Announcement expiry date. Students can view expired announcement however the announcement will not be highlighted as "New". format: date-time archiveAfter: type: string description: Announcement display end date. Students cannot view announcement that has been archived. format: date-time publish: type: boolean description: True by default. Students cannot view announcements that are un-published. default: true sms: type: boolean description: False by default. Set to True to send the announcement by SMS. default: false email: type: boolean description: False by default. Set to True to send the announcement by email. default: false excludeOwner: type: boolean description: False by default. True to exclude module owner from the list of email/SMS recipients. default: false access: allOf: - $ref: '#/components/schemas/contract.ACL.Models.InputRoleAccess' description: "Announcement access rights, refer to [contract.ACL.Models.InputRoleAccess]\r\nPublic access not supported for announcement." description: HTTP Post Input class for announcement modification lib.Hosts.Models.APIListIDInput: type: object properties: iDs: type: array items: type: string format: uuid AnnIDGet400TextPlainResponse: type: string AnnIDGet400ApplicationJsonResponse: type: string AnnIDGet400TextJsonResponse: type: string AnnIDGet403TextPlainResponse: type: string AnnIDGet403ApplicationJsonResponse: type: string AnnIDGet403TextJsonResponse: type: string AnnIDGet404TextPlainResponse: type: string AnnIDGet404ApplicationJsonResponse: type: string AnnIDGet404TextJsonResponse: type: string AnnIDGet500TextPlainResponse: type: string AnnIDGet500ApplicationJsonResponse: type: string AnnIDGet500TextJsonResponse: type: string API_Announcement-API-AnnouncementArray: type: array items: $ref: '#/components/schemas/API_Announcement.API.Announcement' API_Announcement-API-AnnouncementArray-1: type: array items: $ref: '#/components/schemas/API_Announcement.API.Announcement' API_Announcement-API-AnnouncementArray-2: type: array items: $ref: '#/components/schemas/API_Announcement.API.Announcement' ActiveGet400TextPlainResponse: type: string ActiveGet400ApplicationJsonResponse: type: string ActiveGet400TextJsonResponse: type: string ActiveGet403TextPlainResponse: type: string ActiveGet403ApplicationJsonResponse: type: string ActiveGet403TextJsonResponse: type: string ActiveGet404TextPlainResponse: type: string ActiveGet404ApplicationJsonResponse: type: string ActiveGet404TextJsonResponse: type: string ActiveGet500TextPlainResponse: type: string ActiveGet500ApplicationJsonResponse: type: string ActiveGet500TextJsonResponse: type: string API_Announcement-API-AnnouncementArray-3: type: array items: $ref: '#/components/schemas/API_Announcement.API.Announcement' API_Announcement-API-AnnouncementArray-4: type: array items: $ref: '#/components/schemas/API_Announcement.API.Announcement' API_Announcement-API-AnnouncementArray-5: type: array items: $ref: '#/components/schemas/API_Announcement.API.Announcement' ActiveParentIDGet400TextPlainResponse: type: string ActiveParentIDGet400ApplicationJsonResponse: type: string ActiveParentIDGet400TextJsonResponse: type: string ActiveParentIDGet403TextPlainResponse: type: string ActiveParentIDGet403ApplicationJsonResponse: type: string ActiveParentIDGet403TextJsonResponse: type: string ActiveParentIDGet404TextPlainResponse: type: string ActiveParentIDGet404ApplicationJsonResponse: type: string ActiveParentIDGet404TextJsonResponse: type: string ActiveParentIDGet500TextPlainResponse: type: string ActiveParentIDGet500ApplicationJsonResponse: type: string ActiveParentIDGet500TextJsonResponse: type: string API_Announcement-API-AnnouncementArray-6: type: array items: $ref: '#/components/schemas/API_Announcement.API.Announcement' API_Announcement-API-AnnouncementArray-7: type: array items: $ref: '#/components/schemas/API_Announcement.API.Announcement' API_Announcement-API-AnnouncementArray-8: type: array items: $ref: '#/components/schemas/API_Announcement.API.Announcement' NonArchivedParentIDGet400TextPlainResponse: type: string NonArchivedParentIDGet400ApplicationJsonResponse: type: string NonArchivedParentIDGet400TextJsonResponse: type: string NonArchivedParentIDGet403TextPlainResponse: type: string NonArchivedParentIDGet403ApplicationJsonResponse: type: string NonArchivedParentIDGet403TextJsonResponse: type: string NonArchivedParentIDGet404TextPlainResponse: type: string NonArchivedParentIDGet404ApplicationJsonResponse: type: string NonArchivedParentIDGet404TextJsonResponse: type: string NonArchivedParentIDGet500TextPlainResponse: type: string NonArchivedParentIDGet500ApplicationJsonResponse: type: string NonArchivedParentIDGet500TextJsonResponse: type: string API_Announcement-Models-AnnouncementArray: type: array items: $ref: '#/components/schemas/API_Announcement.Models.Announcement' API_Announcement-Models-AnnouncementArray-1: type: array items: $ref: '#/components/schemas/API_Announcement.Models.Announcement' API_Announcement-Models-AnnouncementArray-2: type: array items: $ref: '#/components/schemas/API_Announcement.Models.Announcement' ArchivedParentIDGet400TextPlainResponse: type: string ArchivedParentIDGet400ApplicationJsonResponse: type: string ArchivedParentIDGet400TextJsonResponse: type: string ArchivedParentIDGet403TextPlainResponse: type: string ArchivedParentIDGet403ApplicationJsonResponse: type: string ArchivedParentIDGet403TextJsonResponse: type: string ArchivedParentIDGet404TextPlainResponse: type: string ArchivedParentIDGet404ApplicationJsonResponse: type: string ArchivedParentIDGet404TextJsonResponse: type: string ArchivedParentIDGet500TextPlainResponse: type: string ArchivedParentIDGet500ApplicationJsonResponse: type: string ArchivedParentIDGet500TextJsonResponse: type: string API_Announcement-Models-AnnouncementArray-3: type: array items: $ref: '#/components/schemas/API_Announcement.Models.Announcement' API_Announcement-Models-AnnouncementArray-4: type: array items: $ref: '#/components/schemas/API_Announcement.Models.Announcement' API_Announcement-Models-AnnouncementArray-5: type: array items: $ref: '#/components/schemas/API_Announcement.Models.Announcement' UnreadGet400TextPlainResponse: type: string UnreadGet400ApplicationJsonResponse: type: string UnreadGet400TextJsonResponse: type: string UnreadGet403TextPlainResponse: type: string UnreadGet403ApplicationJsonResponse: type: string UnreadGet403TextJsonResponse: type: string UnreadGet404TextPlainResponse: type: string UnreadGet404ApplicationJsonResponse: type: string UnreadGet404TextJsonResponse: type: string UnreadGet500TextPlainResponse: type: string UnreadGet500ApplicationJsonResponse: type: string UnreadGet500TextJsonResponse: type: string Post400TextPlainResponse: type: string Post400ApplicationJsonResponse: type: string Post400TextJsonResponse: type: string Post403TextPlainResponse: type: string Post403ApplicationJsonResponse: type: string Post403TextJsonResponse: type: string Post404TextPlainResponse: type: string Post404ApplicationJsonResponse: type: string Post404TextJsonResponse: type: string Post500TextPlainResponse: type: string Post500ApplicationJsonResponse: type: string Post500TextJsonResponse: type: string Put400TextPlainResponse: type: string Put400ApplicationJsonResponse: type: string Put400TextJsonResponse: type: string Put403TextPlainResponse: type: string Put403ApplicationJsonResponse: type: string Put403TextJsonResponse: type: string Put404TextPlainResponse: type: string Put404ApplicationJsonResponse: type: string Put404TextJsonResponse: type: string Put500TextPlainResponse: type: string Put500ApplicationJsonResponse: type: string Put500TextJsonResponse: type: string Patch400TextPlainResponse: type: string Patch400ApplicationJsonResponse: type: string Patch400TextJsonResponse: type: string Patch403TextPlainResponse: type: string Patch403ApplicationJsonResponse: type: string Patch403TextJsonResponse: type: string Patch404TextPlainResponse: type: string Patch404ApplicationJsonResponse: type: string Patch404TextJsonResponse: type: string Patch500TextPlainResponse: type: string Patch500ApplicationJsonResponse: type: string Patch500TextJsonResponse: type: string Delete200TextPlainResponse: type: array items: type: string format: uuid Delete200ApplicationJsonResponse: type: array items: type: string format: uuid Delete200TextJsonResponse: type: array items: type: string format: uuid Delete400TextPlainResponse: type: string Delete400ApplicationJsonResponse: type: string Delete400TextJsonResponse: type: string Delete403TextPlainResponse: type: string Delete403ApplicationJsonResponse: type: string Delete403TextJsonResponse: type: string Delete404TextPlainResponse: type: string Delete404ApplicationJsonResponse: type: string Delete404TextJsonResponse: type: string Delete500TextPlainResponse: type: string Delete500ApplicationJsonResponse: type: string Delete500TextJsonResponse: type: string securitySchemes: apiKeyHeader: type: apiKey name: Ocp-Apim-Subscription-Key in: header apiKeyQuery: type: apiKey name: subscription-key in: query security: - apiKeyHeader: [ ] - apiKeyQuery: [ ]