{"openapi":"3.0.1","info":{"title":"Synap API","description":"Access to Synap's core resources, built to OpenAPI and JSON:API specification.","version":"3.0.0","contact":{"name":"Synap","url":"https://synap.ac"}},"servers":[{"url":"https://api.synap.ac/v3","description":"Production"},{"url":"https://api-stage.synap.ac/v3","description":"Staging"}],"security":[],"paths":{"/access-migrations":{"post":{"summary":"Create AccessMigration","tags":["Access Policies"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AccessMigration","enum":["AccessMigration"]},"attributes":{"type":"object","properties":{"permissions":{"type":"string","enum":["core","all","none"]},"searchData":{"type":"boolean"}}},"relationships":{"type":"object","required":["portal"],"properties":{"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccessMigration"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/access-policies":{"post":{"summary":"Create AccessPolicy","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AccessPolicy","enum":["AccessPolicy"]},"attributes":{"type":"object","properties":{"target":{"type":"string","readOnly":false},"targetLabel":{"type":"string","readOnly":true},"subTarget":{"type":"string","readOnly":false},"subTargetLabel":{"type":"string","readOnly":true},"action":{"type":"string","readOnly":false},"actionLabel":{"type":"string","readOnly":true},"effect":{"type":"string","readOnly":false,"enum":["allow","deny"]},"position":{"type":"number","readOnly":true},"inherited":{"type":"boolean","readOnly":true},"isSpecific":{"type":"boolean","readOnly":true},"isCore":{"type":"boolean","readOnly":true},"targetCondition":{"type":"object","required":["field","operation","value"],"additionalProperties":false,"properties":{"field":{"type":"string"},"operation":{"type":"string","enum":["$eq","$ne","$exists","$in","$gt","$lt"]},"value":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}]}},"readOnly":false}}},"relationships":{"type":"object","properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"inheritedFromUserGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"associations":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["AccessPolicy"],"example":"AccessPolicy"}]}}}}},"deprecated":true},"targetResource":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TargetResource","enum":["TargetResource"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccessPolicy"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List AccessPolicies","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"userGroup":{"type":"string"},"user":{"type":"string","description":"Return all access policies that apply to the user with this id, including policies inherited from parent user groups. Returns an empty array if the requesting user cannot view the target user, or if the target user does not exist."},"custom":{"type":"object","properties":{"target":{"type":"string","enum":["libraryContent","test","note","content","survey","scormCourse","assignment","assignmentGroup","collection","course","exam","userGroup"]},"targetId":{"type":"string"},"subPortalId":{"type":"string","nullable":true}}}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AccessPolicy"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/access-policies/{object_id}":{"get":{"summary":"Get AccessPolicy","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccessPolicy"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AccessPolicy","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AccessPolicy"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccessPolicy"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete AccessPolicy","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/access-policies/operations":{"post":{"summary":"BETA: Atomically apply operations to AccessPolicies","description":"BETA: JSON:API Atomic Operations extension. Send `atomic:operations` with `op: \"add\"` (create a specific policy), `op: \"update\"` (change the effect of a global policy, or the effect and target condition of a specific policy) and `op: \"remove\"` (delete a specific policy) — up to 100 per request, in any combination. The batch is all-or-nothing: if any operation is rejected, no change is applied. `atomic:results` holds one entry per operation, in request order; a `remove` yields an entry with no `data`. Use the media type `application/vnd.api+json; ext=\"https://jsonapi.org/ext/atomic\"`.","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["atomic:operations"],"additionalProperties":false,"properties":{"atomic:operations":{"type":"array","minItems":1,"maxItems":100,"items":{"oneOf":[{"type":"object","required":["op","data"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["add"]},"data":{"type":"object","required":["type","attributes","relationships"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["AccessPolicy"]},"attributes":{"type":"object","required":["target","action","effect","targetCondition"],"additionalProperties":false,"properties":{"target":{"type":"string"},"subTarget":{"type":"string"},"action":{"type":"string"},"effect":{"type":"string","enum":["allow","deny"]},"targetCondition":{"type":"object","required":["field","operation","value"],"additionalProperties":false,"properties":{"field":{"type":"string"},"operation":{"type":"string","enum":["$eq","$ne","$exists","$in","$gt","$lt"]},"value":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}]}}}}},"relationships":{"type":"object","required":["userGroup"],"additionalProperties":false,"properties":{"userGroup":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["type","id"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["UserGroup"]},"id":{"type":"string"}}}}}}}}}}},{"type":"object","required":["op","data"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["update"]},"data":{"type":"object","required":["type","id","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["AccessPolicy"]},"id":{"type":"string"},"attributes":{"type":"object","required":["effect"],"additionalProperties":false,"properties":{"effect":{"type":"string","enum":["allow","deny"]},"targetCondition":{"type":"object","required":["field","operation","value"],"additionalProperties":false,"properties":{"field":{"type":"string"},"operation":{"type":"string","enum":["$eq","$ne","$exists","$in","$gt","$lt"]},"value":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}]}}}}}}}}},{"type":"object","required":["op","ref"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["remove"]},"ref":{"type":"object","required":["type","id"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["AccessPolicy"]},"id":{"type":"string"}}}}}]}}}}},"application/vnd.api+json; ext=\"https://jsonapi.org/ext/atomic\"":{"schema":{"type":"object","required":["atomic:operations"],"additionalProperties":false,"properties":{"atomic:operations":{"type":"array","minItems":1,"maxItems":100,"items":{"oneOf":[{"type":"object","required":["op","data"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["add"]},"data":{"type":"object","required":["type","attributes","relationships"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["AccessPolicy"]},"attributes":{"type":"object","required":["target","action","effect","targetCondition"],"additionalProperties":false,"properties":{"target":{"type":"string"},"subTarget":{"type":"string"},"action":{"type":"string"},"effect":{"type":"string","enum":["allow","deny"]},"targetCondition":{"type":"object","required":["field","operation","value"],"additionalProperties":false,"properties":{"field":{"type":"string"},"operation":{"type":"string","enum":["$eq","$ne","$exists","$in","$gt","$lt"]},"value":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}]}}}}},"relationships":{"type":"object","required":["userGroup"],"additionalProperties":false,"properties":{"userGroup":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["type","id"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["UserGroup"]},"id":{"type":"string"}}}}}}}}}}},{"type":"object","required":["op","data"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["update"]},"data":{"type":"object","required":["type","id","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["AccessPolicy"]},"id":{"type":"string"},"attributes":{"type":"object","required":["effect"],"additionalProperties":false,"properties":{"effect":{"type":"string","enum":["allow","deny"]},"targetCondition":{"type":"object","required":["field","operation","value"],"additionalProperties":false,"properties":{"field":{"type":"string"},"operation":{"type":"string","enum":["$eq","$ne","$exists","$in","$gt","$lt"]},"value":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}]}}}}}}}}},{"type":"object","required":["op","ref"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["remove"]},"ref":{"type":"object","required":["type","id"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["AccessPolicy"]},"id":{"type":"string"}}}}}]}}}}}}},"responses":{"200":{"description":"Operations applied atomically","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["atomic:results"],"properties":{"atomic:results":{"type":"array","items":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccessPolicy"}}}}}}},"application/vnd.api+json; ext=\"https://jsonapi.org/ext/atomic\"":{"schema":{"type":"object","required":["atomic:results"],"properties":{"atomic:results":{"type":"array","items":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccessPolicy"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/access-policy-resets":{"post":{"summary":"Create AccessPolicyReset","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AccessPolicyReset","enum":["AccessPolicyReset"]},"attributes":{"type":"object","properties":{"permissions":{"type":"string","enum":["core","all"]}}},"relationships":{"type":"object","properties":{"userGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccessPolicyReset"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/account-closure-requests":{"post":{"summary":"Create AccountClosureRequest","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AccountClosureRequest","enum":["AccountClosureRequest"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccountClosureRequest"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/account-closures":{"post":{"summary":"Create AccountClosure","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AccountClosure","enum":["AccountClosure"]},"attributes":{"type":"object","properties":{"confirmationToken":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccountClosure"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/account-closures/{object_id}":{"patch":{"summary":"Update AccountClosure","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AccountClosure"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccountClosure"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/action-logs":{"get":{"summary":"List ActionLogs","tags":["Auditing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"owner":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ActionLog"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/action-logs/{object_id}":{"get":{"summary":"Get ActionLog","tags":["Auditing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ActionLog"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/annotations":{"post":{"summary":"Create Annotation","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Annotation","enum":["Annotation"]},"attributes":{"type":"object","properties":{"collectionItemId":{"type":"string","readOnly":false},"body":{"type":"string","readOnly":false}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Annotation"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List Annotations","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"collectionItemId":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Annotation"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/annotations/{object_id}":{"get":{"summary":"Get Annotation","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Annotation"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Annotation","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Annotation"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Annotation"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete Annotation","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-group-course-versions":{"post":{"summary":"Create AssignmentGroupCourseVersion","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentGroupCourseVersion","enum":["AssignmentGroupCourseVersion"]},"attributes":{"type":"object","required":["publishStrategy"],"properties":{"id":{"type":"string","readOnly":true},"publishStrategy":{"type":"string","enum":["new-enrollees","not-started","incomplete","completed","failed","passed","all"],"readOnly":false},"retainPreviousVersionAssignments":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","required":["assignmentGroup"],"properties":{"assignmentGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentGroup","enum":["AssignmentGroup"]}}}}},"backgroundJob":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BackgroundJob","enum":["BackgroundJob"]}}}}},"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentGroupCourseVersion"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List AssignmentGroupCourseVersions","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"assignmentGroup":{"type":"string"}}}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["version","-version"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentGroupCourseVersion"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/assignment-group-data-exports":{"post":{"summary":"Create AssignmentGroupDataExport","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentGroupDataExport","enum":["AssignmentGroupDataExport"]},"attributes":{"type":"object","required":["type"],"properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":false,"enum":["survey-responses"]}}},"relationships":{"type":"object","required":["assignmentGroup"],"properties":{"assignmentGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentGroup","enum":["AssignmentGroup"]}}}}}}}}}}}}}},"responses":{"201":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentGroupDataExport"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}},"meta":{"type":"object","properties":{}}}}}}},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/assignment-group-headline-insights/{object_id}":{"get":{"summary":"Get AssignmentGroupHeadlineInsight","tags":["Assignments"],"security":[{},{"SessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentGroupHeadlineInsight"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}},"meta":{"type":"object","properties":{}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/assignment-groups":{"post":{"summary":"Create AssignmentGroup","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentGroup","enum":["AssignmentGroup"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false,"minLength":1},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"image":{"type":"object","readOnly":false,"deprecated":true,"description":"This property is deprecated. Use the relation \"coverImage\" instead.","properties":{"url":{"type":"string"}}},"absoluteDeadline":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"relativeDeadline":{"type":"string","readOnly":false,"nullable":true,"deprecated":true,"description":"This property is deprecated. Use the property \"relativeDeadlineMs\" instead."},"relativeDeadlineMs":{"type":"number","minimum":3600000,"maximum":31536000000,"readOnly":false,"nullable":true,"description":"The relative deadline in milliseconds, minimum 1 hour, maximum 1 year"},"deadlineType":{"type":"string","enum":["indefinite","absolute","relative"],"readOnly":false},"progressionType":{"type":"string","enum":["fixed-linear","flexible-linear","flexible-open"],"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false},"isActive":{"deprecated":true,"description":"This property is deprecated. Use the property \"status\" instead.","type":"boolean","readOnly":true},"isPendingActivation":{"deprecated":true,"description":"This property is deprecated. Use the property \"status\" instead.","type":"boolean","readOnly":true},"isCompleted":{"deprecated":true,"description":"This property is deprecated. Use the property \"status\" instead.","type":"boolean","readOnly":true},"isArchived":{"type":"boolean","readOnly":false},"status":{"type":"string","readOnly":false,"enum":["inactive","pendingActivation","active","complete","cancelled","closed"],"nullable":false},"certificateTemplateId":{"type":"string","readOnly":false,"nullable":true},"certificateIgnoreSubPortalBranding":{"type":"boolean","readOnly":false,"nullable":false},"certificateShareList":{"type":"array","readOnly":false,"nullable":true,"maxItems":4,"items":{"type":"object","required":["label","urlPrefix"],"properties":{"label":{"type":"string","minLength":1,"maxLength":100},"urlPrefix":{"type":"string"}}}},"startDate":{"type":"string","nullable":true},"endDate":{"type":"string","nullable":true}}},"relationships":{"type":"object","required":["userGroup","sourceCourse"],"properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"sourceCourse":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"reviewers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentGroup"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/assignment-groups/{object_id}":{"get":{"summary":"Get AssignmentGroup","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentGroup"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AssignmentGroup","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AssignmentGroup"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentGroup"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete AssignmentGroup","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-headline-insights/{object_id}":{"get":{"summary":"Get AssignmentHeadlineInsight","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentHeadlineInsight"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/assignment-item-audios/{object_id}":{"get":{"summary":"Get AssignmentItemAudio","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemAudio"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AssignmentItemAudio","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AssignmentItemAudio"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemAudio"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-item-documents/{object_id}":{"get":{"summary":"Get AssignmentItemDocument","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemDocument"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AssignmentItemDocument","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AssignmentItemDocument"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemDocument"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-item-embeds/{object_id}":{"get":{"summary":"Get AssignmentItemEmbed","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemEmbed"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AssignmentItemEmbed","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AssignmentItemEmbed"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemEmbed"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-item-notes/{object_id}":{"get":{"summary":"Get AssignmentItemNote","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemNote"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AssignmentItemNote","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AssignmentItemNote"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemNote"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-item-pulses":{"post":{"summary":"Create AssignmentItemPulse","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemPulse","enum":["AssignmentItemPulse"]},"attributes":{"type":"object","required":["pulseInterval"],"additionalProperties":false,"properties":{"pulseInterval":{"type":"number","readOnly":false,"default":15,"description":"The interval in seconds at which the assignment item is pulsed."}}},"relationships":{"type":"object","required":["assignmentItem"],"additionalProperties":false,"properties":{"assignmentItem":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["AssignmentItemAudio","AssignmentItemDocument","AssignmentItemEmbed","AssignmentItemNote","AssignmentItemQuiz","AssignmentItemScorm","AssignmentItemSurvey","AssignmentItemTextEntry","AssignmentItemUpload","AssignmentItemVideo","AssignmentItemZip"],"example":"AssignmentItemAudio"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemPulse"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/assignment-item-quizzes/{object_id}":{"get":{"summary":"Get AssignmentItemQuiz","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemQuiz"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AssignmentItemQuiz","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AssignmentItemQuiz"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemQuiz"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-item-reviews/{object_id}":{"get":{"summary":"Get AssignmentItemReview","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemReview"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AssignmentItemReview","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AssignmentItemReview"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemReview"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete AssignmentItemReview","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-item-reviews":{"post":{"summary":"Create AssignmentItemReview","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]},"attributes":{"type":"object","required":["scope"],"properties":{"body":{"type":"string","readOnly":false,"nullable":true},"scope":{"type":"string","enum":["shared","internal"],"readOnly":false,"nullable":false}}},"relationships":{"type":"object","required":["assignmentItem"],"properties":{"assignmentItem":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["AssignmentItemAudio","AssignmentItemDocument","AssignmentItemEmbed","AssignmentItemNote","AssignmentItemQuiz","AssignmentItemScorm","AssignmentItemSurvey","AssignmentItemTextEntry","AssignmentItemUpload","AssignmentItemVideo","AssignmentItemZip"],"example":"AssignmentItemAudio"}]}}}}},"supportingContent":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemReview"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/assignment-item-scorms/{object_id}":{"get":{"summary":"Get AssignmentItemScorm","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemScorm"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AssignmentItemScorm","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AssignmentItemScorm"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemScorm"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-item-self-assessment-outcomes":{"post":{"summary":"Create AssignmentItemSelfAssessmentOutcome","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemSelfAssessmentOutcome","enum":["AssignmentItemSelfAssessmentOutcome"]},"attributes":{"type":"object","required":["selfAssessmentOutcome"],"properties":{"selfAssessmentOutcome":{"type":"object","readOnly":false}}},"relationships":{"type":"object","required":["assignmentItem"],"properties":{"assignmentItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemSurvey","enum":["AssignmentItemSurvey"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemSelfAssessmentOutcome"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/assignment-item-surveys/{object_id}":{"get":{"summary":"Get AssignmentItemSurvey","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemSurvey"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AssignmentItemSurvey","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AssignmentItemSurvey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemSurvey"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-item-text-entries/{object_id}":{"get":{"summary":"Get AssignmentItemTextEntry","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemTextEntry"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AssignmentItemTextEntry","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AssignmentItemTextEntry"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemTextEntry"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-item-uploads/{object_id}":{"get":{"summary":"Get AssignmentItemUpload","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemUpload"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AssignmentItemUpload","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AssignmentItemUpload"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemUpload"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-item-videos/{object_id}":{"get":{"summary":"Get AssignmentItemVideo","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemVideo"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AssignmentItemVideo","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AssignmentItemVideo"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemVideo"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-item-zips/{object_id}":{"get":{"summary":"Get AssignmentItemZip","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemZip"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AssignmentItemZip","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AssignmentItemZip"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentItemZip"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-manual-reviews":{"post":{"summary":"Create AssignmentManualReview","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentManualReview","enum":["AssignmentManualReview"]},"attributes":{"type":"object","properties":{"isApproved":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentManualReview"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/assignment-reattempts":{"post":{"summary":"Create AssignmentReattempt","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentReattempt","enum":["AssignmentReattempt"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["assignment"],"properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"newAssignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentReattempt"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/assignment-resets":{"post":{"summary":"Create AssignmentReset","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentReset","enum":["AssignmentReset"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["assignment"],"properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentReset"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/assignment-revocations":{"post":{"summary":"Create AssignmentRevocation","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentRevocation","enum":["AssignmentRevocation"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentRevocation"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/assignment-revocations/{object_id}":{"delete":{"summary":"Delete AssignmentRevocation","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/assignment-scorm-results/{object_id}":{"get":{"summary":"Get AssignmentScormResult","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentScormResult"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/assignment-scorm-results":{"post":{"summary":"Create AssignmentScormResult","description":"Triggers a fetch of the SCORM result from SCORM Cloud.","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentScormResult","enum":["AssignmentScormResult"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["UNKNOWN","COMPLETED","INCOMPLETE"],"readOnly":true},"result":{"type":"string","enum":["UNKNOWN","PASSED","FAILED"],"readOnly":true},"score":{"type":"number","format":"float","readOnly":true},"timeSpentInSeconds":{"type":"number","readOnly":true}}},"relationships":{"type":"object","properties":{"assignmentItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemScorm","enum":["AssignmentItemScorm"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentScormResult"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/assignment-self-assessment-reports":{"post":{"summary":"Create AssignmentSelfAssessmentReport","description":"Generates a new self-assessment report for an assignment. Report will be emailed to the assignment owner.","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentSelfAssessmentReport","enum":["AssignmentSelfAssessmentReport"]},"attributes":{"type":"object","additionalProperties":false,"properties":{}},"relationships":{"type":"object","required":["assignment"],"properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentSelfAssessmentReport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/assignments":{"post":{"summary":"Create Assignment","description":"This endpoint can only be used to create preview assignments. For all other assignments to be created, please activate the assignment group.","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]},"attributes":{"type":"object","required":["isPreview"],"properties":{"createdAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"image":{"type":"object","deprecated":true,"description":"Use `coverImage` instead","readOnly":true,"properties":{"url":{"type":"string"}}},"deadline":{"type":"string","format":"date-time","readOnly":false},"status":{"type":"string","enum":["Not started","In progress","Pending review","Failed","Passed","Completed","Missed deadline","Revoked"],"nullable":false,"readOnly":false},"progress":{"type":"number","readOnly":true},"startDate":{"type":"string","readOnly":true},"endDate":{"type":"string","readOnly":true},"setDate":{"type":"string","readOnly":true},"timeSpentInMinutes":{"type":"number","readOnly":true},"totalItems":{"type":"number","readOnly":true},"itemsCompleted":{"type":"number","readOnly":true},"attemptNumber":{"type":"number","readOnly":true},"isReviewRequired":{"type":"boolean","readOnly":true},"certificateShareList":{"type":"array","readOnly":true,"nullable":true,"maxItems":4,"items":{"type":"object","required":["label","urlPrefix"],"properties":{"label":{"type":"string","minLength":1,"maxLength":100},"urlPrefix":{"type":"string"}}}},"isPreview":{"type":"boolean","readOnly":false},"versionNumber":{"type":"number","readOnly":true}}},"relationships":{"type":"object","required":["assignmentGroup"],"properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":false,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["AssignmentItemAudio","AssignmentItemDocument","AssignmentItemEmbed","AssignmentItemNote","AssignmentItemQuiz","AssignmentItemScorm","AssignmentItemSurvey","AssignmentItemTextEntry","AssignmentItemUpload","AssignmentItemVideo","AssignmentItemZip"],"example":"AssignmentItemAudio"}]}}}}}},"folders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["AssignmentFolder"],"example":"AssignmentFolder"}]}}}}}},"certificate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Certificate","enum":["Certificate"]}}}}},"certificateFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"assignmentGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentGroup","enum":["AssignmentGroup"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Assignment"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List Assignments","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"assignmentGroup":{"type":"string"},"user":{"type":"string"},"status":{"type":"array","items":{"type":"string","enum":["Not started","In progress","Pending review","Failed","Passed","Completed","Missed deadline","Revoked"]}},"versionNumber":{"type":"array","items":{"type":"number"}}}}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["createdAt","-createdAt"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Assignment"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/assignments/{object_id}":{"get":{"summary":"Get Assignment","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Assignment"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Assignment","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Assignment"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Assignment"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/attempt-active-durations":{"post":{"summary":"Report cumulative active time for an attempt sitting","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptActiveDuration","enum":["AttemptActiveDuration"]},"attributes":{"type":"object","required":["activeTime"],"additionalProperties":false,"properties":{"activeTime":{"type":"object","writeOnly":true,"required":["sittingMs"],"additionalProperties":false,"description":"Cumulative active-millisecond counters, never deltas, in the same shape the attempt stores them. The server merges every counter with max(), so resending is always safe. Send only counters that grew.","properties":{"sittingMs":{"type":"object","description":"Exactly one entry: the syncing sitting's id mapped to its own cumulative total. Keys must match ^[A-Za-z0-9_-]{1,64}$, at most 100 per request.","maxProperties":1,"additionalProperties":{"type":"integer","minimum":0,"maximum":2592000000},"minProperties":1},"sectionMs":{"type":"object","description":"Sparse map of sectionId to cumulative active milliseconds for the attempt. Keys that are not real sections of the attempt are ignored. Keys must match ^[A-Za-z0-9_-]{1,64}$, at most 100 per request.","maxProperties":100,"additionalProperties":{"type":"integer","minimum":0,"maximum":2592000000}},"sectionInstructionsMs":{"type":"object","description":"Sparse map of sectionId to cumulative active milliseconds spent on that section's instructions screen, a subset of sectionMs. Keys must match ^[A-Za-z0-9_-]{1,64}$, at most 100 per request.","maxProperties":100,"additionalProperties":{"type":"integer","minimum":0,"maximum":2592000000}},"sectionOutroMs":{"type":"object","description":"Sparse map of sectionId to cumulative active milliseconds spent on that section's outro screen, a subset of sectionMs. Keys must match ^[A-Za-z0-9_-]{1,64}$, at most 100 per request.","maxProperties":100,"additionalProperties":{"type":"integer","minimum":0,"maximum":2592000000}},"attemptInstructionsMs":{"type":"integer","minimum":0,"maximum":2592000000,"description":"Cumulative active milliseconds on the attempt's own instructions screen, which precedes every section and so belongs to none of them."},"questionMs":{"type":"object","description":"Sparse map of questionId to cumulative active milliseconds for the attempt. Keys must match ^[A-Za-z0-9_-]{1,64}$, at most 100 per request.","maxProperties":100,"additionalProperties":{"type":"integer","minimum":0,"maximum":2592000000}}}},"totalMs":{"type":"integer","minimum":0,"readOnly":true,"description":"The attempt-wide merged lifetime total after this sync."}}},"relationships":{"type":"object","required":["attempt"],"additionalProperties":false,"properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptActiveDuration"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/attempt-charts":{"get":{"summary":"List AttemptCharts","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","required":["attempt"],"properties":{"attempt":{"type":"string"},"chartTypes":{"type":"array","items":{"type":"string","enum":["individualStudentVsCohortBellCurve","subjectBreakdown","topicBreakdown","subtopicBreakdown","skillBreakdown","difficultyBreakdown","subjectProgress","topicProgress","subtopicProgress","overallProgress"]}},"cohort":{"type":"string","enum":["exam","quiz","sourceQuiz"],"description":"Used to override the default analytics cohort for the attempt."},"viewerType":{"type":"string","default":"student","enum":["student","admin"],"description":"Used to override the result settings for an attempt"},"tagFilterByFacet":{"type":"object","properties":{"subject":{"type":"array","items":{"type":"string"}},"topic":{"type":"array","items":{"type":"string"}},"subtopic":{"type":"array","items":{"type":"string"}}},"description":"Used to filter the chart data by facet. Each property corresponds to a facet type, and the values are arrays of tag IDs to filter by."}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AttemptChart"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/attempt-code-login":{"post":{"summary":"Create AttemptCodeLogin","tags":["Attempts"],"parameters":[],"security":[],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["code"],"properties":{"code":{"type":"string","minLength":3,"maxLength":11},"datapoint":{"type":"string","deprecated":true,"description":"Superseded by datapoints."},"datapoints":{"type":"array","description":"Corroborating details. A code shared across an exam requires both a surname and an externalId; a code unique to one candidate takes the single detail its exam asks for.","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["none","surname","externalId"]},"value":{"type":"string","minLength":1}}}}}}}}}}}}},"responses":{"200":{"description":"The login outcome, with a session token when active","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptCodeLogin"}}}}}},"400":{"description":"Malformed request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"The code or corroborating datapoint did not match","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/attempt-insights":{"get":{"summary":"List AttemptInsights","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","required":["attempt"],"properties":{"attempt":{"type":"string"},"insightTypes":{"type":"array","items":{"type":"string","enum":["microOutcomeCorrect","microOutcomeIncorrect","microOutcomePartial","miniIndividualTimeSpent","miniIndividualAttemptImprovement","miniIndividualStudentVsCohortAverage","miniIndividualPercentile","miniIndividualAttemptGrade"]}},"cohort":{"type":"string","enum":["exam","quiz","sourceQuiz"],"description":"Used to override the default analytics cohort for the attempt."},"viewerType":{"type":"string","default":"student","enum":["student","admin"],"description":"Used to override the result settings for an attempt"}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AttemptInsight"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/attempt-locks":{"post":{"summary":"Create AttemptLock","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptLock","enum":["AttemptLock"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["attempt"],"properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptLock"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/attempt-locks/{object_id}":{"patch":{"summary":"Update AttemptLock","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AttemptLock"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptLock"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete AttemptLock","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/attempt-markings":{"post":{"summary":"Create AttemptMarking","description":"Unstable / experimental — do not adopt externally, this may be withdrawn without notice.","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptMarking","enum":["AttemptMarking"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["attempt"],"properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"responses":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"maxItems":100,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Response"],"example":"Response"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptMarking"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/attempt-overrides":{"post":{"summary":"Create AttemptOverride","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptOverride","enum":["AttemptOverride"]},"attributes":{"type":"object","properties":{"overrides":{"type":"array","items":{"type":"string","enum":["score","points","credits","penalties","grade"]},"nullable":true},"comment":{"type":"string","readOnly":false},"grade":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"score":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"points":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"credits":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"penalties":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"reverted":{"type":"boolean"}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptOverride"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List AttemptOverrides","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"attempt":{"type":"object","properties":{"id":{"type":"string"}}}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AttemptOverride"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/attempt-player-states/{object_id}":{"get":{"summary":"Get AttemptPlayerState","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptPlayerState"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/attempt-result-configs":{"get":{"summary":"List AttemptResultConfigs","parameters":[{"name":"attemptId","in":"query","required":true,"schema":{"type":"string"}},{"name":"viewAsAdmin","in":"query","required":false,"schema":{"type":"boolean"}}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"tags":["Attempts"],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptResultConfig"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/attempt-revoke-reversals":{"post":{"summary":"Create AttemptRevokeReversal","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptRevokeReversal","enum":["AttemptRevokeReversal"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptRevokeReversal"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List AttemptRevokeReversals","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"foo":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AttemptRevokeReversal"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/attempt-revoke-reversals/{object_id}":{"get":{"summary":"Get AttemptRevokeReversal","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptRevokeReversal"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AttemptRevokeReversal","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AttemptRevokeReversal"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptRevokeReversal"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete AttemptRevokeReversal","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/attempt-schedules":{"get":{"summary":"List AttemptSchedules","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"attempts":{"type":"array","items":{"type":"string"}}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AttemptSchedule"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/attempt-schedules/{object_id}":{"get":{"summary":"Get AttemptSchedule","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptSchedule"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AttemptSchedule","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AttemptSchedule"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptSchedule"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/attempt-sittings":{"post":{"summary":"Create AttemptSitting","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptSitting","enum":["AttemptSitting"]},"attributes":{"type":"object","properties":{"sessionId":{"type":"string","readOnly":true},"timeStarted":{"type":"string","readOnly":true},"ip":{"type":"string","readOnly":true},"userAgent":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptSitting"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/attempt-submissions":{"post":{"summary":"Create AttemptSubmission","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptSubmission","enum":["AttemptSubmission"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptSubmission"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/attempt-tag-labels":{"get":{"summary":"List AttemptTagLabels","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"attemptId","in":"query","required":true,"schema":{"type":"string"}},{"name":"facet","in":"query","required":true,"schema":{"type":"string"}},{"name":"filters","in":"query","schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"parent":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}}}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AttemptTagLabel"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/attempt-timer-resets":{"post":{"summary":"Create AttemptTimerReset","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptTimerReset","enum":["AttemptTimerReset"]},"attributes":{"type":"object","properties":{"sectionId":{"type":"string","readOnly":false,"nullable":true,"description":"Section to activate. Leave as empty string to reset to first section."},"timeAddedInMins":{"type":"number","readOnly":false,"description":"Time added in minutes, set to 0 to grant reset to default."}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptTimerReset"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/attempt-timers":{"get":{"summary":"List AttemptTimers","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"attempts":{"type":"array","items":{"type":"string"}}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AttemptTimer"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/attempt-timers/{object_id}":{"get":{"summary":"Get AttemptTimer","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptTimer"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AttemptTimer","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AttemptTimer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttemptTimer"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/attempts":{"post":{"summary":"Create Attempt","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]},"attributes":{"type":"object","properties":{"title":{"type":"string","readOnly":true},"loginCode":{"type":"string","readOnly":true,"nullable":true,"description":"The candidate's code-login credential. Only present for requesters who can edit the exam, and only on attempts of exams with code login enabled."},"createdAt":{"type":"string","readOnly":true},"isCompleted":{"type":"boolean","readOnly":true},"timeStarted":{"type":"string","readOnly":true},"timeCompleted":{"type":"string","readOnly":true},"proctor":{"type":"object","readOnly":true,"additionalProperties":true,"deprecated":true,"description":"Deprecated. Use flattened fields such as `proctorEnabled`, `proctorVendor` etc instead."},"resitCount":{"type":"number","readOnly":false,"description":"Can be used to generate a resit attempt. If not provided, the attempt will be a new attempt. All requests by students are determined as resit requests, even if this is omitted."},"attemptsAllowed":{"type":"number","nullable":true,"readOnly":true},"schedule":{"type":"object","readOnly":true,"properties":{"activateAt":{"type":"string"},"deactivateAt":{"type":"string","nullable":true}}},"candidateOpenDate":{"type":"string","readOnly":true,"description":"Earliest date at which candidate could have started their exam. Useful for displaying a \"user friendly\" open date for indefinite/ongoing exams with rolling registrations"},"status":{"type":"string","readOnly":true,"enum":["draft","scheduled","active","completed","cancelled"]},"submissionType":{"type":"string","readOnly":true,"nullable":true,"enum":["user","system","moderator","userTimedOut","abandoned",null]},"settings":{"type":"object","readOnly":true,"additionalProperties":true},"state":{"type":"object","readOnly":true,"additionalProperties":true},"quizSetup":{"type":"object","readOnly":false,"additionalProperties":true},"grade":{"type":"object","readOnly":true,"nullable":true,"additionalProperties":true},"examStatus":{"type":"string","readOnly":true},"proctorStatus":{"type":"string","readOnly":true},"score":{"type":"number","readOnly":true},"marks":{"type":"object","nullable":true,"properties":{"points":{"type":"number","readOnly":true},"maxPoints":{"type":"number","readOnly":true},"credits":{"type":"number","readOnly":true},"penalties":{"type":"number","readOnly":true}}},"isRevoked":{"type":"boolean","readOnly":true},"isArchived":{"type":"boolean","readOnly":true,"description":"Hides the attempt from the candidate's exam list. The result remains valid, unlike revoking."},"isOpen":{"type":"boolean","readOnly":true},"isUpcoming":{"type":"boolean","readOnly":true},"isPast":{"type":"boolean","readOnly":true},"isPreview":{"type":"boolean","readOnly":true},"resultsPageHidden":{"type":"boolean","readOnly":false},"resultsScoreHidden":{"type":"boolean","readOnly":false},"version":{"type":"string","readOnly":true},"resultsStatus":{"type":"string","readOnly":false,"enum":["pending","finalised","released"]},"resultsMarkingStatus":{"type":"string","readOnly":false,"enum":["notStarted","inProgress","readyToFinalise","finalised","completed"]},"resultsPendingMarks":{"type":"number","readOnly":true,"nullable":true},"proctorEnabled":{"type":"boolean","readOnly":true,"nullable":true},"proctorVendor":{"type":"string","readOnly":true,"nullable":true},"proctorSessionId":{"type":"string","readOnly":true,"nullable":true},"proctorIsApproved":{"type":"boolean","readOnly":true,"nullable":true},"proctorReviews":{"type":"array","readOnly":true,"nullable":true,"items":{"type":"object","required":["userId","action","timestamp"],"properties":{"id":{"type":"string","readOnly":true},"userId":{"type":"string"},"action":{"type":"string","enum":["approve","reject","comment"]},"timestamp":{"type":"string"},"body":{"type":"string","nullable":true}}}},"proctorRequiresReview":{"type":"boolean","readOnly":true,"nullable":true},"proctorBreaches":{"type":"integer","minimum":0,"readOnly":true,"nullable":true},"proctorLiveProctoring":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleUsePrivateTestArea":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleVisibleFace":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowInteractionWithOthers":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowOtherMaterials":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowNoiseMakingDevices":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowAdditionalDevices":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleAllowMouseKeyboardMonitorOnly":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowAppsOrBroswerTabs":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowExamContentSharing":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowTextPrediction":{"type":"boolean","readOnly":true,"nullable":true},"proctorSynopticLevel":{"type":"string","enum":["web","browser","desktop",null],"readOnly":true,"nullable":true},"proctorScreenMonitoring":{"type":"string","enum":["none","recreation","recreationWithSnapshots","video",null],"readOnly":true,"nullable":true},"proctorWebcamMonitoring":{"type":"string","enum":["none","snapshots","audioVideo",null],"readOnly":true,"nullable":true},"proctorRequireFullscreen":{"type":"boolean","readOnly":true,"nullable":true},"proctorRestrictTabs":{"type":"boolean","readOnly":true,"nullable":true},"proctorRestrictDisplays":{"type":"boolean","readOnly":true,"nullable":true},"proctorKeyboardShortcutsEnabled":{"type":"boolean","readOnly":true,"nullable":true},"proctorScreenshotPrevention":{"type":"boolean","readOnly":true,"nullable":true},"proctorAiReview":{"type":"boolean","readOnly":true,"nullable":true},"proctorAiFlagCandidateLeftFrame":{"type":"boolean","readOnly":true,"nullable":true},"proctorAiFlagMultiplePeopleInFrame":{"type":"boolean","readOnly":true,"nullable":true},"proctorAiPrompts":{"type":"array","readOnly":true,"nullable":true,"items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true}}}},"proctorOnBreach":{"type":"string","enum":["freeze","silent",null],"readOnly":true,"nullable":true},"proctorBlockedApplicationsPolicy":{"type":"string","enum":["none","default",null],"readOnly":true,"nullable":true},"estrangedMarkers":{"type":"object","readOnly":true,"description":"Ids of assigned markers who are no longer members of the exam's user group for their role, per role. Empty arrays when every assigned marker is still a member. Only present on the exam-scoped attempt search, and only when `withEstrangedMarkers=true` is sent; a role key appears only when its assigned-marker relationship was included and the exam has a user group for that role.","properties":{"provisional":{"type":"array","items":{"type":"string"}},"moderating":{"type":"array","items":{"type":"string"}},"escalating":{"type":"array","items":{"type":"string"}},"backReading":{"type":"array","items":{"type":"string"}},"auditing":{"type":"array","items":{"type":"string"}}}},"ltiLaunch":{"type":"object","readOnly":true,"nullable":true,"additionalProperties":false,"required":["consumerKey","contextId","resourceLinkId"],"properties":{"consumerKey":{"type":"string"},"contextId":{"type":"string","nullable":true},"resourceLinkId":{"type":"string","nullable":true},"launchPresentationReturnUrl":{"type":"string","nullable":true},"lisResultSourcedId":{"type":"string","nullable":true},"lisOutcomeServiceUrl":{"type":"string","nullable":true},"scorePostbackUrl":{"type":"string","nullable":true},"scopes":{"type":"array","items":{"type":"string"},"nullable":true},"vendorData":{"type":"object","additionalProperties":true,"nullable":true},"externalUserId":{"type":"string","nullable":true}}}}},"relationships":{"type":"object","properties":{"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"examVoucher":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamVoucher","enum":["ExamVoucher"]}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"assignmentItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItem","enum":["AssignmentItem"]}}}}},"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"collectionItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItem","enum":["CollectionItem"]}}}}},"collectionMock":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionMock","enum":["CollectionMock"]}}}}},"study":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Study","enum":["Study"]}}}}},"studyItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"StudyItem","enum":["StudyItem"]}}}}},"responses":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Response"],"example":"Response"}]}}}}}},"responsesV2":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["PlayerAudioResponse","PlayerVideoResponse","PlayerClozeDragAndDropResponse","PlayerClozeDropDownResponse","PlayerClozeTextResponse","PlayerFileUploadResponse","PlayerFreeTextResponse","PlayerInformationalResponse","PlayerMultipleChoiceResponse","PlayerRankedResponse","PlayerSingleChoiceResponse","PlayerShortAnswerResponse","PlayerSpreadsheetResponse","PlayerImageHotspotResponse","PlayerOffPlatformResponse","PlayerFlashcardResponse","PlayerTrueOrFalseResponse","PlayerDrawingResponse"],"example":"PlayerAudioResponse"}]}}}}}},"marker":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"markingState":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingState","enum":["MarkingState"]}}}}},"assignedMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"assignedProvisionalMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"assignedModeratingMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"assignedEscalatingMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"assignedAuditingMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"assignedBackReadingMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"certificate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Certificate","enum":["Certificate"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Attempt"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List Attempts","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","in":"query","required":false,"explode":false,"schema":{"type":"object","properties":{"isExam":{"type":"boolean"},"examId":{"type":"string"},"testId":{"type":"string"},"mockId":{"type":"string"},"collectionId":{"type":"string"},"completedBefore":{"type":"string","format":"date-time"},"owner":{"type":"string"},"examStatus":{"type":"array","items":{"type":"string","enum":["enrolled","notified","preflight","started","submitted","revoked","expired","cancelled"]}},"scheduleState":{"type":"array","items":{"type":"string","enum":["open","upcoming","past"]}},"title":{"type":"string"},"proctorStatus":{"type":"array","items":{"type":"string","enum":["disabled","enabled","readyForReview","reviewNotRequired","inReview","passed","failed","error"]}},"markingStatus":{"type":"array","items":{"type":"string","enum":["notStarted","inProgress","completed","readyToFinalise","finalised"]}},"gradeStatus":{"type":"array","items":{"type":"string","enum":["passed","failed"]}},"resultStatus":{"type":"array","items":{"type":"string","enum":["pending","finalised","released"]}},"testVersions":{"type":"array","items":{"type":"string"}},"lockStatus":{"type":"array","items":{"type":"string","enum":["unlocked","locked","none"]}},"isCompleted":{"type":"boolean"},"attemptStatus":{"type":"array","description":"Lifecycle position from the `timeStarted` / `timeCompleted` timestamps. Values are OR'd, so `[\"inProgress\",\"completed\"]` selects every attempt that was started.","items":{"type":"string","enum":["completed","inProgress","notStarted"]}},"isArchived":{"type":"boolean","description":"When omitted, archived and unarchived attempts are both returned. `false` excludes archived attempts; `true` returns archived attempts only."},"isSelfStudy":{"type":"boolean","description":"Restricts results to the owner's completed self-study attempts (attempts on generated tests the owner authored). Requires `filter[owner]`. When `examId` is given, `isSelfStudy` is ignored; contradictory `isCompleted`/`isExam` filters are ignored in self-study mode. Composes with the other list filters and defaults the sort to `timeCompleted` descending when no sort is given."}}}},{"name":"withEstrangedMarkers","in":"query","required":false,"description":"Opts in to the `estrangedMarkers` attribute on the exam-scoped search. The attribute carries one key per assigned-marker relationship named in `include` that the exam has a user group for; without this parameter nothing is computed and the attribute is omitted.","schema":{"type":"boolean"}},{"name":"sort","in":"query","required":false,"schema":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["openDate","closeDate","timeAllowed","score","breaches","timeSpent","timeStarted","timeCompleted","title","examStatus"]},"order":{"type":"string","enum":["ascending","descending"]}}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Attempt"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/attempts/{object_id}":{"get":{"summary":"Get Attempt","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Attempt"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","properties":{"isOnDemandResitAvailable":{"type":"boolean"}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Attempt","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Attempt"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Attempt"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/attempts/{object_id}/relationships/assigned-moderating-markers":{"post":{"summary":"Assign Moderating Markers","description":"Deprecated: use `POST /v3/attempts/operations` to assign markers across many attempts and roles in one request. This endpoint continues to work unchanged.","deprecated":true,"tags":["Attempts"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"]}]}}}}}}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"delete":{"summary":"Unassign Moderating Markers","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"]}]}}}}}}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/attempts/{object_id}/relationships/assigned-back-reading-markers":{"post":{"summary":"Assign Backreaders","description":"Deprecated: use `POST /v3/attempts/operations` to assign markers across many attempts and roles in one request. This endpoint continues to work unchanged.","deprecated":true,"tags":["Attempts"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"]}]}}}}}}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"delete":{"summary":"Unassign Backreaders","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"]}]}}}}}}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/attempts/{object_id}/relationships/assigned-escalating-markers":{"post":{"summary":"Assign Escalating Markers","description":"Deprecated: use `POST /v3/attempts/operations` to assign markers across many attempts and roles in one request. This endpoint continues to work unchanged.","deprecated":true,"tags":["Attempts"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"]}]}}}}}}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"delete":{"summary":"Unassign Escalating Markers","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"]}]}}}}}}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/attempts/{object_id}/relationships/assigned-auditing-markers":{"post":{"summary":"Assign Auditing Markers","description":"Deprecated: use `POST /v3/attempts/operations` to assign markers across many attempts and roles in one request. This endpoint continues to work unchanged.","deprecated":true,"tags":["Attempts"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"]}]}}}}}}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"delete":{"summary":"Unassign Auditing Markers","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"]}]}}}}}}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/attempts/{object_id}/relationships/assigned-provisional-markers":{"post":{"summary":"Assign Provisional Markers","description":"Deprecated: use `POST /v3/attempts/operations` to assign markers across many attempts and roles in one request. This endpoint continues to work unchanged.","deprecated":true,"tags":["Attempts"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"]}]}}}}}}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"delete":{"summary":"Unassign Provisional Markers","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"]}]}}}}}}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/attempts/operations":{"post":{"summary":"BETA: Atomically assign markers across many Attempts","description":"BETA: JSON:API Atomic Operations extension. Send `atomic:operations` with `op: \"add\"` against an Attempt per-role marker relationship. A request may carry up to 100 operations and up to 100 marker/attempt/role combinations in total, counting every marker in every operation — the combined total is usually the binding limit, and a request over it is rejected before anything is read. Chunk above that. Any invalid operation rejects the whole batch before anything is written, and each offending operation is reported as its own error with a `source.pointer` of `/atomic:operations/{index}`. A failure part-way through writing is compensated, and a `500` naming an unrecoverable partial application is the only case in which some of the batch may stand. Unassignment is not available here — use `DELETE /v3/attempts/{objectId}/relationships/assigned-*-markers`, one attempt at a time. Responds `501` for a portal without the post-submission attempt management rollout. Use the media type `application/vnd.api+json; ext=\"https://jsonapi.org/ext/atomic\"`.","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["atomic:operations"],"additionalProperties":false,"properties":{"atomic:operations":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["op","ref","data"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["add"]},"ref":{"type":"object","required":["type","id","relationship"],"additionalProperties":false,"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Attempt"]}]},"id":{"$ref":"#/components/schemas/ObjectId"},"relationship":{"type":"string","enum":["assignedProvisionalMarkers","assignedModeratingMarkers","assignedBackReadingMarkers","assignedEscalatingMarkers","assignedAuditingMarkers"]}}},"data":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["type","id"],"additionalProperties":false,"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"]}]},"id":{"$ref":"#/components/schemas/ObjectId"}}}}}}}}}},"application/vnd.api+json; ext=\"https://jsonapi.org/ext/atomic\"":{"schema":{"type":"object","required":["atomic:operations"],"additionalProperties":false,"properties":{"atomic:operations":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["op","ref","data"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["add"]},"ref":{"type":"object","required":["type","id","relationship"],"additionalProperties":false,"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Attempt"]}]},"id":{"$ref":"#/components/schemas/ObjectId"},"relationship":{"type":"string","enum":["assignedProvisionalMarkers","assignedModeratingMarkers","assignedBackReadingMarkers","assignedEscalatingMarkers","assignedAuditingMarkers"]}}},"data":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["type","id"],"additionalProperties":false,"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"]}]},"id":{"$ref":"#/components/schemas/ObjectId"}}}}}}}}}}}},"responses":{"200":{"description":"Operations applied atomically","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["atomic:results"],"properties":{"atomic:results":{"type":"array","items":{"type":"object","required":["meta"],"properties":{"meta":{"type":"object","required":["assigned","sessionCreated","deferred"],"properties":{"assigned":{"type":"integer","description":"Markers this operation added. Zero when every marker was already assigned."},"sessionCreated":{"type":"boolean","description":"Whether a marking session was created for each marker added."},"deferred":{"type":"boolean","description":"True when the markers are recorded but their sessions are created later, once the marking phase they belong to is reached. Their inbox is legitimately empty until then."}}}}}}}}},"application/vnd.api+json; ext=\"https://jsonapi.org/ext/atomic\"":{"schema":{"type":"object","required":["atomic:results"],"properties":{"atomic:results":{"type":"array","items":{"type":"object","required":["meta"],"properties":{"meta":{"type":"object","required":["assigned","sessionCreated","deferred"],"properties":{"assigned":{"type":"integer","description":"Markers this operation added. Zero when every marker was already assigned."},"sessionCreated":{"type":"boolean","description":"Whether a marking session was created for each marker added."},"deferred":{"type":"boolean","description":"True when the markers are recorded but their sessions are created later, once the marking phase they belong to is reached. Their inbox is legitimately empty until then."}}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"501":{"description":"Not enabled for this portal","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/attribute-configs":{"post":{"summary":"Create AttributeConfig","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AttributeConfig","enum":["AttributeConfig"]},"attributes":{"type":"object","required":["label","type"],"additionalProperties":false,"properties":{"customId":{"type":"string","readOnly":false,"maxLength":100},"target":{"type":"string","readOnly":false,"enum":["User","Collection","CollectionItem","Exam","LearningRecord","Response","Attempt","Question","SubPortal","UserGroup","AssignmentGroup","Test","Note","Content"]},"type":{"type":"string","enum":["boolean","date","multiChoice","multiText","number","singleChoice","text","link","file"],"readOnly":false},"label":{"type":"string","readOnly":false,"minLength":1,"maxLength":200},"sublabel":{"type":"string","readOnly":false,"maxLength":100,"nullable":true},"description":{"type":"string","readOnly":false,"maxLength":500,"nullable":true},"options":{"type":"array","readOnly":false,"nullable":true,"minItems":1,"maxItems":1000,"items":{"type":"object","properties":{"value":{"anyOf":[{"type":"string","minLength":1},{"type":"number"},{"type":"boolean"}]},"label":{"type":"string"}}}},"labelQuestion":{"type":"string","readOnly":false,"maxLength":500,"nullable":true},"registration":{"type":"object","properties":{"collect":{"type":"boolean"}},"nullable":true,"readOnly":false},"required":{"type":"boolean","readOnly":false},"editPermission":{"type":"number","enum":[0,1,2],"readOnly":false},"viewPermission":{"type":"number","enum":[0,1,2],"readOnly":false},"settings":{"type":"object","nullable":true,"properties":{"link":{"type":"object","properties":{"display":{"type":"object","properties":{"asButton":{"type":"boolean"}}},"authenticated":{"type":"boolean"},"clickBehavior":{"type":"string","enum":["newWindow","sameWindow","modal","modalWithDownload","download","action"],"readOnly":false,"nullable":false}}}}},"inUse":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttributeConfig"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List AttributeConfigs","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"explode":false,"schema":{"type":"object","properties":{"target":{"type":"string","enum":["User","Collection","CollectionItem","Exam","LearningRecord","Response","Attempt","Question","SubPortal","UserGroup","AssignmentGroup","Test","Note","Content"]},"viewPermission":{"type":"number","enum":[0,1,2]}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AttributeConfig"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/attribute-configs/{object_id}":{"get":{"summary":"Get AttributeConfig","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttributeConfig"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update AttributeConfig","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AttributeConfig"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AttributeConfig"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete AttributeConfig","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/authentication-option-adfs":{"post":{"summary":"Create ADFS AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AuthenticationOptionAdfs","enum":["AuthenticationOptionAdfs"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"label":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"isActive":{"type":"boolean","readOnly":false},"preventRegistration":{"type":"boolean","readOnly":false},"authProviderId":{"type":"string","readOnly":false},"type":{"type":"string","enum":["adfs"],"readOnly":false},"domain":{"type":"string","readOnly":false},"tenantId":{"type":"string","readOnly":false},"federationMetadataUrl":{"type":"string","readOnly":false},"spEntityId":{"type":"string","readOnly":true},"isUsingRetiredCertificate":{"type":"boolean","readOnly":true,"description":"Warning: true when SAML assertions are being decrypted with the retired SP certificate."}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionAdfs"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/authentication-option-adfs/{object_id}":{"get":{"summary":"Get ADFS AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionAdfs"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update ADFS AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionAdfs"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionAdfs"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete ADFS AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/authentication-option-auth0":{"post":{"summary":"Create Auth0 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AuthenticationOptionAuth0","enum":["AuthenticationOptionAuth0"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"label":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"isActive":{"type":"boolean","readOnly":false},"preventRegistration":{"type":"boolean","readOnly":false},"authProviderId":{"type":"string","readOnly":false},"type":{"type":"string","enum":["auth0"],"readOnly":false},"domain":{"type":"string","readOnly":false},"clientId":{"type":"string","readOnly":false},"clientSecret":{"type":"string","readOnly":false},"callbackUrl":{"type":"string","readOnly":true},"scope":{"type":"array","items":{"type":"string"},"readOnly":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionAuth0"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/authentication-option-auth0/{object_id}":{"get":{"summary":"Get Auth0 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionAuth0"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Auth0 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionAuth0"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionAuth0"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete Auth0 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/authentication-option-jwt":{"post":{"summary":"Create JWT AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AuthenticationOptionJwt","enum":["AuthenticationOptionJwt"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"label":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"isActive":{"type":"boolean","readOnly":false},"preventRegistration":{"type":"boolean","readOnly":false},"authProviderId":{"type":"string","readOnly":false},"type":{"type":"string","enum":["jwt"],"readOnly":false},"secret":{"type":"string","readOnly":false},"loginPageUrl":{"type":"string","readOnly":false,"nullable":true},"embedLoginPage":{"type":"boolean","readOnly":false},"callbackUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionJwt"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/authentication-option-jwt/{object_id}":{"get":{"summary":"Get JWT AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionJwt"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update JWT AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionJwt"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionJwt"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete JWT AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/authentication-option-local/{object_id}":{"get":{"summary":"Get Local AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionLocal"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Local AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionLocal"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionLocal"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/authentication-option-lti1p1":{"post":{"summary":"Create LTI1.1 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AuthenticationOptionLti1p1","enum":["AuthenticationOptionLti1p1"]},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["lti_1p1"],"readOnly":false},"name":{"type":"string","readOnly":false,"minLength":1},"label":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"isActive":{"type":"boolean","readOnly":false},"preventRegistration":{"type":"boolean","readOnly":false},"clientId":{"type":"string","readOnly":true},"clientSecret":{"type":"string","readOnly":true},"launchUrl":{"type":"string","readOnly":true},"launchType":{"type":"string","enum":["collection","exam"],"readOnly":false},"outcomeServiceUrl":{"type":"string","readOnly":false,"nullable":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionLti1p1"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/authentication-option-lti1p1/{object_id}":{"get":{"summary":"Get LTI1.1 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionLti1p1"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update LTI1.1 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionLti1p1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionLti1p1"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete LTI1.1 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/authentication-option-lti1p3":{"post":{"summary":"Create LTI1.3 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AuthenticationOptionLti1p3","enum":["AuthenticationOptionLti1p3"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"label":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"isActive":{"type":"boolean","readOnly":false},"preventRegistration":{"type":"boolean","readOnly":false},"type":{"type":"string","enum":["lti_1p3"],"readOnly":false},"issuer":{"type":"string","minimum":1,"readOnly":false},"clientId":{"type":"string","minimum":1,"readOnly":false},"deploymentId":{"type":"string","minimum":1,"readOnly":false},"jwksUrl":{"type":"string","format":"uri","readOnly":false},"oidcAuthUrl":{"type":"string","format":"uri","readOnly":false},"authTokenUrl":{"type":"string","format":"uri","readOnly":false},"toolJwksUrl":{"type":"string","format":"uri","readOnly":true,"description":"Synap public keyset URL for the platform to verify our JWTs"},"toolLoginUrl":{"type":"string","format":"uri","readOnly":true,"description":"Synap OIDC login initiation URL"},"toolRedirectUrl":{"type":"string","format":"uri","readOnly":true,"description":"Synap redirect URI where the platform posts the ID token"}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionLti1p3"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/authentication-option-lti1p3/{object_id}":{"get":{"summary":"Get LTI1.3 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionLti1p3"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update LTI1.3 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionLti1p3"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionLti1p3"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete LTI1.3 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/authentication-option-saml":{"post":{"summary":"Create SAML AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"AuthenticationOptionSaml","enum":["AuthenticationOptionSaml"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"label":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"isActive":{"type":"boolean","readOnly":false},"preventRegistration":{"type":"boolean","readOnly":false},"authProviderId":{"type":"string","readOnly":false},"type":{"type":"string","enum":["saml"],"readOnly":false},"idpLoginUrl":{"type":"string","readOnly":false},"metadataUrl":{"type":"string","readOnly":false},"spEntityId":{"type":"string","readOnly":true},"attributeFirstName":{"type":"string","readOnly":false,"nullable":true},"attributeLastName":{"type":"string","readOnly":false,"nullable":true},"attributeEmail":{"type":"string","readOnly":false,"nullable":true},"attributeSubPortalId":{"type":"string","readOnly":false,"nullable":true},"isUsingRetiredCertificate":{"type":"boolean","readOnly":true,"description":"Warning: true when SAML assertions are being decrypted with the retired SP certificate."}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionSaml"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/authentication-option-saml/{object_id}":{"get":{"summary":"Get SAML AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionSaml"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update SAML AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionSaml"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationOptionSaml"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete SAML AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/authentication-options":{"get":{"summary":"List AuthenticationOptions","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"isActive":{"type":"boolean"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AuthenticationOption"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/available-access-policies":{"get":{"summary":"List AvailableAccessPolicies","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"target":{"type":"string","enum":["libraryContent","test","note","content","survey","scormCourse","assignment","collection","course","exam","userGroup"]}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AvailableAccessPolicy"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/background-jobs/{object_id}":{"get":{"summary":"Get BackgroundJob","tags":["Notifications"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/billing-infos/current":{"get":{"summary":"Get Billing Info","tags":["Billing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/BillingInfo"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/bot-sessions":{"post":{"summary":"Create BotSession","tags":["Authentication"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"BotSession","enum":["BotSession"]},"attributes":{"type":"object","required":["apiKeyToken"],"properties":{"apiKeyToken":{"type":"string","readOnly":false},"sessionToken":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"botUser":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BotUser","enum":["BotUser"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BotSession"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/bot-users":{"post":{"summary":"Create BotUser","tags":["Users"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"BotUser","enum":["BotUser"]},"attributes":{"type":"object","required":["name","vendorIdentifier"],"properties":{"name":{"type":"string","readOnly":false},"vendorIdentifier":{"type":"string","readOnly":false,"enum":["rosalyn"]}}},"relationships":{"type":"object","properties":{"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BotUser"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List BotUsers","tags":["Users"],"security":[],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","required":["apiKeyToken"],"properties":{"apiKeyToken":{"type":"string"},"attempt":{"type":"string"}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BotUser"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/certificates/{object_id}":{"get":{"summary":"Get Certificate","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Certificate"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/certificates":{"get":{"summary":"List Certificates","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"attempt":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Certificate"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}},"post":{"summary":"Create Certificate","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Certificate","enum":["Certificate"]},"attributes":{"type":"object","properties":{"html":{"type":"string","readOnly":true},"documentKey":{"type":"string","readOnly":true},"expiryDate":{"type":"string","readOnly":true},"validationUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Document","enum":["Document"]}}}}},"template":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Template","enum":["Template"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Certificate"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/chart-js":{"get":{"summary":"Get Chart","tags":["Insights"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["portal-activity","engagement","sl-overview"]},"user":{"type":"string"}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ChartJs"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}},"meta":{"properties":{}}}}}}},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/checkout-sessions":{"post":{"summary":"Create CheckoutSession","tags":["Shop"],"security":[],"parameters":[{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CheckoutSession","enum":["CheckoutSession"]},"attributes":{"type":"object","properties":{"productIdentifier":{"type":"string","readOnly":false,"description":"Deprecated on create — send the `product` relationship instead, as an identifier is not unique across portals. One of the two is required."},"currency":{"type":"string","enum":["gbp","eur","usd"],"readOnly":false,"description":"The currency to charge in. Defaults to the product's default currency. Must be one of the currencies the product is priced in, otherwise the request is rejected."},"customerData":{"type":"object","nullable":true,"properties":{"id":{"type":"string","nullable":true,"description":"The external payment gateway customer ID"},"email":{"type":"string","nullable":true,"description":"Can be used to link the payment gateway Customer."}}},"paymentGatewayToken":{"type":"string","readOnly":true,"nullable":true,"description":"The payment gateway token, only for paid products."},"paymentGatewayUrl":{"type":"string","readOnly":true,"nullable":true,"description":"The hosted payment gateway Checkout URL, only returned when creating a paid Checkout Session."},"isCheckoutCompleted":{"type":"boolean","readOnly":true,"nullable":false,"description":"Indicates if the user has completed the checkout form and is ready for processing."},"isPaymentSuccessful":{"type":"boolean","readOnly":true,"nullable":true,"description":"Indicates if the payment gateway checkout was successful."},"processedAt":{"type":"string","readOnly":true,"nullable":true,"description":"The date and time the subscription was processed."},"processingError":{"type":"string","nullable":true,"readOnly":true,"description":"If the payment was successful but the subscription was not created, this will contain the error message."}}},"relationships":{"type":"object","properties":{"storeOffer":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"StoreOffer","enum":["StoreOffer"]}}}}},"product":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Product","enum":["Product"]}}}}},"subscription":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Subscription","enum":["Subscription"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CheckoutSession"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/checkout-sessions/{object_id}":{"get":{"summary":"Get CheckoutSession","tags":["Shop"],"security":[],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CheckoutSession"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CheckoutSession","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CheckoutSession"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CheckoutSession"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/clone-jobs":{"post":{"summary":"Create CloneJob","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CloneJob","enum":["CloneJob"]},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["quiz","course","collection","exam","exam-template"],"readOnly":false},"sourceId":{"type":"string","readOnly":false},"state":{"type":"string","enum":["pending","started","completed","failed"],"readOnly":true},"cloneId":{"type":"string","readOnly":true},"label":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CloneJob"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/clone-jobs/{object_id}":{"get":{"summary":"Get CloneJob","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CloneJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collection-accesses":{"post":{"summary":"Create CollectionAccess","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionAccess","enum":["CollectionAccess"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"level":{"type":"string","readOnly":false,"nullable":false,"enum":["editor","none","full","restricted"]},"upgradeInstructionsType":{"type":"string","readOnly":false,"nullable":false,"enum":["product","storeOffer"]},"upgradeInstructionsData":{"readOnly":false,"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}},"relationships":{"type":"object","properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionAccess"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collection-accesses/{object_id}":{"delete":{"summary":"Delete CollectionAccess","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/collection-folders":{"post":{"summary":"Create CollectionFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]},"attributes":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","readOnly":false,"minLength":1,"maxLength":150}}},"relationships":{"type":"object","required":["collection"],"additionalProperties":false,"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionSubFolder","CollectionItem","CollectionItemAudio","CollectionItemDocument","CollectionItemEmbed","CollectionItemNote","CollectionItemQuiz","CollectionItemVideo","CollectionItemZip"],"example":"CollectionSubFolder"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionFolder"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CollectionFolders","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"collection":{"type":"string"}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CollectionFolder"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/collection-folders/{object_id}":{"get":{"summary":"Get CollectionFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionFolder"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CollectionFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CollectionFolder"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionFolder"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CollectionFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/collection-folders/{object_id}/relationships/items":{"patch":{"summary":"Reorder CollectionFolder Items","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionSubFolder","CollectionItem","CollectionItemAudio","CollectionItemDocument","CollectionItemEmbed","CollectionItemNote","CollectionItemQuiz","CollectionItemVideo","CollectionItemZip"],"example":"CollectionSubFolder"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"post":{"summary":"Create CollectionSubFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]},"attributes":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"type":{"type":"string","readOnly":true,"enum":["sub-folder"]},"name":{"type":"string","readOnly":false,"minLength":1,"maxLength":150}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionItem","CollectionItemAudio","CollectionItemDocument","CollectionItemEmbed","CollectionItemNote","CollectionItemQuiz","CollectionItemVideo","CollectionItemZip"],"example":"CollectionItem"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionSubFolder"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collection-folders/{object_id}/relationships/items/{object_id}":{"get":{"summary":"Get CollectionSubFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionSubFolder"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CollectionSubFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CollectionSubFolder"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionSubFolder"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CollectionSubFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/collection-folders/{object_id}/relationships/items/{object_id}/relationships/items":{"patch":{"summary":"Reorder CollectionSubFolder Items","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionItem","CollectionItemAudio","CollectionItemDocument","CollectionItemEmbed","CollectionItemNote","CollectionItemQuiz","CollectionItemVideo","CollectionItemZip"],"example":"CollectionItem"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/collection-item-audio":{"post":{"summary":"Create CollectionItemAudio","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemAudio","enum":["CollectionItemAudio"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["audio"]},"releaseStatus":{"type":"string","enum":["available","previewOnly"],"readOnly":false,"nullable":false},"studyEnabled":{"type":"boolean","readOnly":false,"nullable":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":false,"format":"date-time"},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true,"format":"date-time"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["collection","audio"],"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"audio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemAudio"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CollectionItemAudio (Use Generic)","tags":["Collections"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collection-item-audio/{object_id}":{"get":{"summary":"Get CollectionItemAudio","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"studied","in":"query","required":false,"description":"If true, the item will be marked as seen in the requesting user's collection progress.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemAudio"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CollectionItemAudio","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CollectionItemAudio"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemAudio"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CollectionItemAudio","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/collection-item-document/{object_id}":{"get":{"summary":"Get CollectionItemDocument","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"studied","in":"query","required":false,"description":"If true, the item will be marked as seen in the requesting user's collection progress.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemDocument"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CollectionItemDocument","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CollectionItemDocument"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemDocument"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CollectionItemDocument","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/collection-item-document":{"post":{"summary":"Create CollectionItemDocument","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemDocument","enum":["CollectionItemDocument"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["document"]},"releaseStatus":{"type":"string","enum":["available","previewOnly"],"readOnly":false,"nullable":false},"studyEnabled":{"type":"boolean","readOnly":false,"nullable":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":false,"format":"date-time"},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true,"format":"date-time"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true,"nullable":false},"startAtPage":{"readOnly":false,"type":"number","nullable":true}}},"relationships":{"type":"object","additionalProperties":false,"required":["collection","document"],"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemDocument"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collection-item-embed":{"post":{"summary":"Create CollectionItemEmbed","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemEmbed","enum":["CollectionItemEmbed"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["embed"]},"releaseStatus":{"type":"string","enum":["available","previewOnly"],"readOnly":false,"nullable":false},"studyEnabled":{"type":"boolean","readOnly":false,"nullable":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":false,"format":"date-time"},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true,"format":"date-time"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["collection","embed"],"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"embed":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemEmbed"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CollectionItemEmbeds (Use Generic)","tags":["Collections"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collection-item-embed/{object_id}":{"get":{"summary":"Get CollectionItemEmbed","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"studied","in":"query","required":false,"description":"If true, the item will be marked as seen in the requesting user's collection progress.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemEmbed"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CollectionItemEmbed","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CollectionItemEmbed"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemEmbed"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CollectionItemEmbed","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/collection-item-note":{"post":{"summary":"Create CollectionItemNote","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemNote","enum":["CollectionItemNote"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["note"]},"releaseStatus":{"type":"string","enum":["available","previewOnly"],"readOnly":false,"nullable":false},"studyEnabled":{"type":"boolean","readOnly":false,"nullable":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":false,"format":"date-time"},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true,"format":"date-time"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["collection","note"],"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"note":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Note","enum":["Note"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemNote"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CollectionItemNotes (Use Generic)","tags":["Collections"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collection-item-note/{object_id}":{"get":{"summary":"Get CollectionItemNote","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"studied","in":"query","required":false,"description":"If true, the item will be marked as seen in the requesting user's collection progress.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemNote"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CollectionItemNote","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CollectionItemNote"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemNote"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CollectionItemNote","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/collection-item-pdf-exports":{"post":{"summary":"Create CollectionItemPdfExport","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemPdfExport","enum":["CollectionItemPdfExport"]},"attributes":{"type":"object","properties":{"answerMode":{"type":"string","enum":["inline","answerKey","none"]},"answerBooklet":{"type":"boolean"},"fontSizePt":{"type":"number","enum":[11,15,18]},"fontFamily":{"type":"string","enum":["sans-serif","serif"]}}},"relationships":{"type":"object","required":["collectionItem"],"properties":{"collectionItem":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionItem","CollectionItemAudio","CollectionItemDocument","CollectionItemEmbed","CollectionItemNote","CollectionItemQuiz","CollectionItemVideo","CollectionItemZip"],"example":"CollectionItem"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemPdfExport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collection-item-quiz":{"post":{"summary":"Create CollectionItemQuiz","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemQuiz","enum":["CollectionItemQuiz"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["quiz"]},"releaseStatus":{"type":"string","enum":["available","previewOnly"],"readOnly":false,"nullable":false},"studyEnabled":{"type":"boolean","readOnly":false,"nullable":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":false,"format":"date-time"},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true,"format":"date-time"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true,"nullable":false},"totalQuestions":{"type":"number","readOnly":true}}},"relationships":{"type":"object","additionalProperties":false,"required":["collection","quiz"],"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"quizAttemptSetupConfig":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizAttemptSetupConfig","enum":["QuizAttemptSetupConfig"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemQuiz"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CollectionItems - use generic CollectionItem","tags":["Collections"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collection-item-quiz/{object_id}":{"get":{"summary":"Get CollectionItemQuiz","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["quiz","quiz.sections","quizAttemptSetupConfig","collection","folder","subFolder","coverImage"]}}},{"name":"studied","in":"query","required":false,"description":"If true, the item will be marked as seen in the requesting user's collection progress.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemQuiz"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CollectionItemQuiz","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CollectionItemQuiz"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemQuiz"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CollectionItemQuiz","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/collection-item-video":{"post":{"summary":"Create CollectionItemVideo","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemVideo","enum":["CollectionItemVideo"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["video"]},"releaseStatus":{"type":"string","enum":["available","previewOnly"],"readOnly":false,"nullable":false},"studyEnabled":{"type":"boolean","readOnly":false,"nullable":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":false,"format":"date-time"},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true,"format":"date-time"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["collection","video"],"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"video":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemVideo"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CollectionItems - use generic CollectionItem","tags":["Collections"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collection-item-video/{object_id}":{"get":{"summary":"Get CollectionItemVideo","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"studied","in":"query","required":false,"description":"If true, the item will be marked as seen in the requesting user's collection progress.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemVideo"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CollectionItemVideo","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CollectionItemVideo"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemVideo"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CollectionItemVideo","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/collection-item-zip":{"post":{"summary":"Create CollectionItemZip","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemZip","enum":["CollectionItemZip"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["zip"]},"releaseStatus":{"type":"string","enum":["available","previewOnly"],"readOnly":false,"nullable":false},"studyEnabled":{"type":"boolean","readOnly":false,"nullable":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":false,"format":"date-time"},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true,"format":"date-time"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["collection","zip"],"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"zip":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemZip"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CollectionItems - use generic CollectionItem","tags":["Collections"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collection-item-zip/{object_id}":{"get":{"summary":"Get CollectionItemZip","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"studied","in":"query","required":false,"description":"If true, the item will be marked as seen in the requesting user's collection progress.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemZip"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CollectionItemZip","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CollectionItemZip"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionItemZip"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CollectionItemZip","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/collection-items":{"get":{"summary":"List CollectionItems","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"collection":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CollectionItem"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/collection-mocks":{"get":{"summary":"List CollectionMocks","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CollectionMock"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/collection-pdf-exports":{"post":{"summary":"Create CollectionPdfExport","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionPdfExport","enum":["CollectionPdfExport"]},"attributes":{"type":"object","properties":{"fontSizePt":{"type":"number","enum":[11,15,18]},"fontFamily":{"type":"string","enum":["sans-serif","serif"]}}},"relationships":{"type":"object","required":["collection"],"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionPdfExport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collection-progresses":{"post":{"summary":"Create CollectionProgress","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionProgress","enum":["CollectionProgress"]},"attributes":{"type":"object","properties":{"percentageSeen":{"type":"number","readOnly":true},"tally":{"type":"object","readOnly":true,"properties":{"unseen":{"type":"number","readOnly":false},"seen":{"type":"number","readOnly":false},"updated":{"type":"number","readOnly":false},"new":{"type":"number","readOnly":false}}},"progress":{"type":"array","readOnly":true,"required":["collectionItemId","status"],"items":{"type":"object","properties":{"collectionItemId":{"type":"string"},"targetId":{"type":"string"},"targetType":{"type":"string","enum":["test","note","content"]},"status":{"type":"string"},"lastSeen":{"type":"string","nullable":true},"firstSeen":{"type":"string","nullable":true},"timesSeen":{"type":"number"}}}}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionProgress"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CollectionProgresses","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"collection":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CollectionProgress"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/collection-progresses/{object_id}":{"patch":{"summary":"Update CollectionProgress","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CollectionProgress"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionProgress"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"get":{"summary":"Get CollectionProgress","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionProgress"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collection-sub-folders":{"get":{"summary":"List CollectionSubFolders","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"collectionFolder":{"type":"string"}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CollectionSubFolder"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/collection-tag-breakdowns/{object_id}":{"get":{"summary":"Get CollectionTagBreakdown","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionTagBreakdown"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collections":{"get":{"summary":"List Collections","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","required":["assignedTo"],"properties":{"assignedTo":{"type":"object","properties":{"type":{"type":"string","enum":["user","group"]},"id":{"type":"string"}},"required":["type","id"]}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Collection"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}},"post":{"summary":"Create Collection","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]},"attributes":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false,"nullable":false,"minLength":1},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"settings":{"type":"object","deprecated":true,"properties":{"takeTest":{"type":"object","additionalProperties":true},"playerView":{"type":"object","properties":{"enabled":{"type":"boolean"},"hideOverviewPage":{"type":"boolean"}}},"trackedProgress":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"annotations":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"export":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"generatedAttempts":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"mocks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string","nullable":true},"filters":{"type":"object","additionalProperties":true},"quizLength":{"type":"number","minimum":1},"passScore":{"type":"number","minimum":0,"maximum":100,"nullable":true},"examSittingAttrs":{"type":"object","additionalProperties":true}}}},"restrictedAccess":{"type":"object","properties":{"label":{"type":"string"}}},"sorting":{"type":"object","properties":{"prioritise":{"type":"boolean"}}}}},"attr":{"type":"object","readOnly":false,"nullable":true},"extraInformation":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"isArchived":{"type":"boolean","readOnly":false,"nullable":true},"generatedAttemptsEnabled":{"type":"boolean","readOnly":false},"mocks":{"type":"array","nullable":true,"items":{"type":"object","required":["id","filters","quizLength"],"properties":{"id":{"type":"string"},"title":{"type":"string","nullable":true,"minLength":1,"maxLength":120},"filters":{"type":"object","additionalProperties":true,"properties":{"weightingType":{"type":"string","enum":["absolute","percentage"]},"filterRules":{"type":"array","minItems":0,"maxItems":125,"description":"Array of filter rules to apply to the dynamic quiz content.","items":{"type":"object","properties":{"weighting":{"type":"number"},"matchingRules":{"type":"array","minItems":0,"maxItems":20,"description":"Array of matching rules to apply to the filter rule. Each rule will be treated as an AND operation. Matching rules can not be a mix of tag and EMQ rules.","items":{"anyOf":[{"type":"object","required":["tagId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["tagId"],"properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}}}]}}}}}}},"quizLength":{"type":"number","minimum":1},"passScore":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"examSittingAttrs":{"type":"object","nullable":true,"additionalProperties":true},"timeInMs":{"type":"number","nullable":true,"minimum":1}}}},"annotationsEnabled":{"type":"boolean","readOnly":false},"exportEnabled":{"type":"boolean","readOnly":false},"playerViewEnabled":{"type":"boolean","readOnly":false},"playerViewHideOverviewPage":{"type":"boolean","readOnly":false},"restrictedAccessLabel":{"type":"string","readOnly":false,"nullable":true},"sortingPrioritise":{"type":"boolean","readOnly":false},"takeTestSettings":{"type":"object","nullable":true,"additionalProperties":true,"deprecated":true,"description":"deprecated, use top level setting fields instead"},"allowedModes":{"type":"array","nullable":true,"items":{"type":"string","enum":["practice","exam","timedExam"]},"minItems":1,"maxItems":3},"allowedLengths":{"type":"array","items":{"type":"string","enum":["default","quick","medium","long","extraLong"]}},"allowedPlayers":{"type":"array","items":{"type":"string","enum":["default","ucat","usmle"]}},"allowedTagSets":{"type":"array","nullable":true,"items":{"type":"string"}},"allowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","skill","difficulty","context"]}},"calculatorEnabled":{"type":"boolean","readOnly":false,"default":false},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"],"readOnly":false},"allowMultipleTagSelection":{"type":"boolean","readOnly":false,"default":false},"excludeUntaggedQuestions":{"type":"boolean","readOnly":false,"default":false},"showMasteryFilters":{"type":"boolean","readOnly":false,"default":false},"calculatorType":{"type":"string","enum":["basic","scientific"]},"notepadEnabled":{"type":"boolean","readOnly":false,"default":false},"strikethroughEnabled":{"type":"boolean","readOnly":false,"default":false},"highlightingEnabled":{"type":"boolean","readOnly":false,"default":false},"bookmarkingEnabled":{"type":"boolean","readOnly":false,"default":false},"labValuesEnabled":{"type":"boolean","readOnly":false,"default":false},"labValuesHtml":{"type":"string","readOnly":false},"flaggingEnabled":{"type":"boolean","readOnly":false,"default":false},"resultsMessageCompleted":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageSettingHideTitle":{"type":"boolean","readOnly":false,"default":false},"resultsMetricScoreEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricTimeSpentEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricGradeEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricQuestionBreakdownDisplayLevel":{"type":"string","enum":["full","hideStemAndOptions","hideCorrectOptions","incorrectOnlyHideCorrectOptions","none"],"readOnly":false},"resultsMetricAnalyticsCohort":{"type":"string","enum":["exam","test","sourceTest"],"default":"test"},"resultsMetricCohortAverageEnabled":{"type":"boolean","readOnly":false,"default":false},"resultsMetricCohortPercentileEnabled":{"type":"boolean","readOnly":false,"default":false},"resultsMetricCohortScoreDistributionEnabled":{"type":"boolean","readOnly":false,"default":false},"resultsMetricTagBreakdownEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricTagProgressEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricTagProgressFacetsEnabled":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"subject":{"type":"boolean","readOnly":false},"topic":{"type":"boolean","readOnly":false},"subtopic":{"type":"boolean","readOnly":false},"skill":{"type":"boolean","readOnly":false},"difficulty":{"type":"boolean","readOnly":false}},"default":{"subject":true,"topic":true,"subtopic":true,"skill":true,"difficulty":true}},"resultsEducatorViewAsAdminEnabled":{"type":"boolean","readOnly":false,"default":true},"trackedProgressEnabled":{"type":"boolean","readOnly":false},"accessLevel":{"type":"string","enum":["editor","none","full","restricted"],"readOnly":true},"totalItems":{"type":"number","readOnly":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionItem","CollectionItemAudio","CollectionItemDocument","CollectionItemEmbed","CollectionItemNote","CollectionItemQuiz","CollectionItemVideo","CollectionItemZip"],"example":"CollectionItem"}]}}}}}},"lockedItems":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionItem","CollectionItemAudio","CollectionItemDocument","CollectionItemEmbed","CollectionItemNote","CollectionItemQuiz","CollectionItemVideo","CollectionItemZip"],"example":"CollectionItem"}]}}}}}},"folders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionFolder"],"example":"CollectionFolder"}]}}}}}},"icon":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"collectionAccess":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionAccess"],"example":"CollectionAccess"}]}}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Collection"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/collections/{object_id}":{"get":{"summary":"Get Collection","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Collection"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Collection","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Collection"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Collection"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete Collection","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/collections/{object_id}/relationships/folders":{"patch":{"summary":"Reorder Collection Folders","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionFolder"],"example":"CollectionFolder"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/collections/{object_id}/relationships/items":{"patch":{"summary":"Reorder Collection Items","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionItem","CollectionItemAudio","CollectionItemDocument","CollectionItemEmbed","CollectionItemNote","CollectionItemQuiz","CollectionItemVideo","CollectionItemZip"],"example":"CollectionItem"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/content-embed-data":{"post":{"summary":"Create ContentEmbedDatum","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ContentEmbedDatum","enum":["ContentEmbedDatum"]},"attributes":{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["iframe","video"],"readOnly":false},"source":{"type":"string","readOnly":false},"url":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"thumbnailUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContentEmbedDatum"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/contents":{"post":{"summary":"Create Content","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]},"attributes":{"type":"object","required":["isLibraryItem"],"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":false,"minLength":1},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","enum":["audio","document","embed","video","zip","image"],"readOnly":false},"attachmentMimeType":{"type":"string","readOnly":true,"nullable":true},"isLibraryItem":{"type":"boolean","readOnly":false},"isArchived":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"attachment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"embedData":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ContentEmbedDatum","enum":["ContentEmbedDatum"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Content"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/contents/{object_id}":{"get":{"summary":"Get Content","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Content"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Content","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Content"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Content"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete Content","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/contents/{object_id}/relationships/collaborating-users":{"post":{"summary":"Add Content Collaborating Users","description":"Add users as collaborators to this content item. The request body should contain an array of User resource identifier objects.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove Content Collaborating Users","description":"Remove users as collaborators from this content item. The request body should contain an array of User resource identifier objects to remove.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/contents/{object_id}/relationships/collaborating-user-groups":{"post":{"summary":"Add Content Collaborating User Groups","description":"Add user groups as collaborators to this content item. The request body should contain an array of UserGroup resource identifier objects.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove Content Collaborating User Groups","description":"Remove user groups as collaborators from this content item. The request body should contain an array of UserGroup resource identifier objects to remove.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/course-folders":{"post":{"summary":"Create CourseFolder","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","readOnly":false,"minLength":1,"maxLength":150},"imageUrl":{"type":"string","readOnly":false,"nullable":true}}},"relationships":{"type":"object","required":["course"],"additionalProperties":false,"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CourseItemAudio","CourseItemDocument","CourseItemEmbed","CourseItemNote","CourseItemQuiz","CourseItemScorm","CourseItemSurvey","CourseItemTextEntry","CourseItemUpload","CourseItemVideo","CourseItemZip"],"example":"CourseItemAudio"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseFolder"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CourseFolders","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"course":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CourseFolder"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/course-folders/{object_id}":{"get":{"summary":"Get CourseFolder","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseFolder"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CourseFolder","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CourseFolder"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseFolder"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CourseFolder","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/course-folders/{object_id}/relationships/items":{"patch":{"summary":"Update CourseFolder Items","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CourseItem","CourseItemAudio","CourseItemDocument","CourseItemEmbed","CourseItemNote","CourseItemQuiz","CourseItemScorm","CourseItemSurvey","CourseItemTextEntry","CourseItemUpload","CourseItemVideo","CourseItemZip"],"example":"CourseItem"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/course-item-audio":{"post":{"summary":"Create CourseItemAudio","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemAudio","enum":["CourseItemAudio"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["audio"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"shouldPreview":{"type":"boolean","readOnly":false,"nullable":false},"allowDownload":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["course","audio"],"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"audio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemAudio"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CourseItemAudio (Use Generic)","tags":["Courses"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/course-item-audio/{object_id}":{"get":{"summary":"Get CourseItemAudio","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemAudio"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CourseItemAudio","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CourseItemAudio"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemAudio"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CourseItemAudio","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/course-item-document":{"post":{"summary":"Create CourseItemDocument","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemDocument","enum":["CourseItemDocument"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["document"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"shouldPreview":{"type":"boolean","readOnly":false,"nullable":false},"allowDownload":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["course","document"],"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemDocument"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CourseItemDocument (Use Generic)","tags":["Courses"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/course-item-document/{object_id}":{"get":{"summary":"Get CourseItemDocument","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemDocument"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CourseItemDocument","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CourseItemDocument"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemDocument"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CourseItemDocument","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/course-item-embed":{"post":{"summary":"Create CourseItemEmbed","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemEmbed","enum":["CourseItemEmbed"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["embed"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"shouldPreview":{"type":"boolean","readOnly":false,"nullable":false},"allowDownload":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["course","embed"],"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"embed":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemEmbed"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CourseItemEmbed (Use Generic)","tags":["Courses"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/course-item-embed/{object_id}":{"get":{"summary":"Get CourseItemEmbed","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemEmbed"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CourseItemEmbed","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CourseItemEmbed"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemEmbed"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CourseItemEmbed","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/course-item-note":{"post":{"summary":"Create CourseItemNote","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemNote","enum":["CourseItemNote"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["note"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["course","note"],"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"note":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Note","enum":["Note"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemNote"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CourseItemNote (Use Generic)","tags":["Courses"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/course-item-note/{object_id}":{"get":{"summary":"Get CourseItemNote","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemNote"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CourseItemNote","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CourseItemNote"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemNote"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CourseItemNote","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/course-item-quiz":{"post":{"summary":"Create CourseItemQuiz","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemQuiz","enum":["CourseItemQuiz"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["quiz"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"passScore":{"type":"number","readOnly":false,"nullable":true},"quizMode":{"type":"string","enum":["practice","exam","timedExam"],"readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["course","quiz"],"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemQuiz"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CourseItemQuiz (Use Generic)","tags":["Courses"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/course-item-quiz/{object_id}":{"get":{"summary":"Get CourseItemQuiz","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemQuiz"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CourseItemQuiz","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CourseItemQuiz"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemQuiz"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CourseItemQuiz","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/course-item-scorm":{"post":{"summary":"Create CourseItemScorm","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemScorm","enum":["CourseItemScorm"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["scorm"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["course","scorm"],"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"scorm":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ScormCourse","enum":["ScormCourse"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemScorm"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CourseItemScorm (Use Generic)","tags":["Courses"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/course-item-scorm/{object_id}":{"get":{"summary":"Get CourseItemScorm","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemScorm"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CourseItemScorm","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CourseItemScorm"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemScorm"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CourseItemScorm","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/course-item-survey":{"post":{"summary":"Create CourseItemSurvey","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemSurvey","enum":["CourseItemSurvey"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["survey"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["course","survey"],"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"survey":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Survey","enum":["Survey"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemSurvey"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CourseItemSurvey (Use Generic)","tags":["Courses"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/course-item-survey/{object_id}":{"get":{"summary":"Get CourseItemSurvey","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemSurvey"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CourseItemSurvey","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CourseItemSurvey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemSurvey"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CourseItemSurvey","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/course-item-text-entry":{"post":{"summary":"Create CourseItemTextEntry","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemTextEntry","enum":["CourseItemTextEntry"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["textEntry"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"wordLimit":{"type":"number","minimum":0,"nullable":true,"readOnly":false},"multiLine":{"type":"boolean","nullable":false,"readOnly":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["course"],"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemTextEntry"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CourseItemTextEntry (Use Generic)","tags":["Courses"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/course-item-text-entry/{object_id}":{"get":{"summary":"Get CourseItemTextEntry","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemTextEntry"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CourseItemTextEntry","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CourseItemTextEntry"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemTextEntry"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CourseItemTextEntry","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/course-item-upload":{"post":{"summary":"Create CourseItemUpload","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemUpload","enum":["CourseItemUpload"]},"attributes":{"type":"object","additionalProperties":false,"required":["title","contentType"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["upload"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"contentType":{"type":"string","readOnly":false,"enum":["audio","document","video","zip","image"]}}},"relationships":{"type":"object","additionalProperties":false,"required":["course"],"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemUpload"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CourseItemUpload (Use Generic)","tags":["Courses"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/course-item-upload/{object_id}":{"get":{"summary":"Get CourseItemUpload","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemUpload"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CourseItemUpload","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CourseItemUpload"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemUpload"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CourseItemUpload","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/course-item-video":{"post":{"summary":"Create CourseItemVideo","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemVideo","enum":["CourseItemVideo"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["video"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"shouldPreview":{"type":"boolean","readOnly":false,"nullable":false},"allowDownload":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["course","video"],"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"video":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemVideo"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CourseItemVideo (Use Generic)","tags":["Courses"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/course-item-video/{object_id}":{"get":{"summary":"Get CourseItemVideo","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemVideo"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CourseItemVideo","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CourseItemVideo"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemVideo"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CourseItemVideo","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/course-item-zip":{"post":{"summary":"Create CourseItemZip","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemZip","enum":["CourseItemZip"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["zip"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"shouldPreview":{"type":"boolean","readOnly":false,"nullable":false},"allowDownload":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"required":["course","zip"],"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"zip":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemZip"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List CourseItemZip (Use Generic)","tags":["Courses"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/course-item-zip/{object_id}":{"get":{"summary":"Get CourseItemZip","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemZip"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update CourseItemZip","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CourseItemZip"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseItemZip"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete CourseItemZip","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/course-items":{"get":{"summary":"List CourseItems","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"course":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CourseItem"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/courses":{"post":{"summary":"Create Course","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]},"attributes":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false,"nullable":false,"minLength":1},"description":{"type":"string","readOnly":false,"nullable":true},"isArchived":{"type":"boolean","readOnly":true,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"versionNumber":{"type":"number","readOnly":true},"publishedAt":{"type":"string","readOnly":true},"totalItems":{"type":"number","readOnly":true}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CourseItem","CourseItemAudio","CourseItemDocument","CourseItemEmbed","CourseItemNote","CourseItemQuiz","CourseItemScorm","CourseItemSurvey","CourseItemTextEntry","CourseItemUpload","CourseItemVideo","CourseItemZip"],"example":"CourseItem"}]}}}}}},"folders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CourseFolder"],"example":"CourseFolder"}]}}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Course"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/courses/{object_id}":{"get":{"summary":"Get Course","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Course"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Course","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Course"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Course"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete Course","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/courses/{object_id}/relationships/folders":{"patch":{"summary":"Reorder Course Folders","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CourseFolder"],"example":"CourseFolder"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/courses/{object_id}/relationships/items":{"patch":{"summary":"Reorder Course Items","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CourseItem","CourseItemAudio","CourseItemDocument","CourseItemEmbed","CourseItemNote","CourseItemQuiz","CourseItemScorm","CourseItemSurvey","CourseItemTextEntry","CourseItemUpload","CourseItemVideo","CourseItemZip"],"example":"CourseItem"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/custom-insights":{"get":{"summary":"List CustomInsights","tags":["Insights"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","schema":{"anyOf":[{"type":"object","required":["insightType","userId"],"properties":{"insightType":{"type":"string","enum":["studentProgress"]},"userId":{"type":"string"}}}]}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomInsight"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/documents":{"get":{"summary":"List Documents","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","required":["userGroup"],"properties":{"userGroup":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/email-verifications":{"post":{"summary":"Create EmailVerification","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"EmailVerification","enum":["EmailVerification"]},"attributes":{"type":"object","properties":{"verified":{"type":"boolean","enum":[true],"readOnly":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EmailVerification"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/email-verifications/{object_id}":{"patch":{"summary":"Update EmailVerification","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/EmailVerification"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EmailVerification"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/emq-group-exports":{"post":{"summary":"Create EmqGroupExport","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"EmqGroupExport","enum":["EmqGroupExport"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["quiz"],"properties":{"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EmqGroupExport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/emq-group-import-validations":{"post":{"summary":"Create EmqGroupImportValidation","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"EmqGroupImportValidation","enum":["EmqGroupImportValidation"]},"attributes":{"type":"object","properties":{"toCreate":{"type":"number","readOnly":false},"toUpdate":{"type":"number","readOnly":false},"toDelete":{"type":"number","readOnly":false}}},"relationships":{"type":"object","properties":{"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EmqGroupImportValidation"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/emq-group-imports":{"post":{"summary":"Create EmqGroupImport","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"EmqGroupImport","enum":["EmqGroupImport"]},"attributes":{"type":"object","properties":{"csvUrl":{"type":"string","readOnly":false},"fieldMap":{"type":"object","readOnly":false}}},"relationships":{"type":"object","properties":{"backgroundJob":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BackgroundJob","enum":["BackgroundJob"]}}}}},"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EmqGroupImport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/enriched-attempt-options":{"get":{"summary":"List EnrichedAttemptOptions","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"origin":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EnrichedAttemptOption"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/enriched-attempts":{"get":{"summary":"List EnrichedAttempts","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"portalId":{"type":"string"},"origin":{"type":"object","properties":{"type":{"type":"string","enum":["assignmentGroup","assignment","collection","collectionItem","exam","test"]},"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"propertyFilters":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["assignedMarker","assignedModeratingMarker","assignedProvisionalMarker","attemptStatus","examStatus","grade","markingStatus","proctorStatus","quiz","quizVersion","resultsStatus","user","userGroup"]},"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}},"dateFilter":{"type":"object","properties":{"type":{"type":"string","enum":["completedAt","createdAt","finalisedAt","releasedAt","startedAt"]},"start":{"type":"string"},"end":{"type":"string"}}},"sort":{"type":"object","properties":{"type":{"type":"string","enum":["createdAt","finalisedAt","releasedAt","timeCompleted","timeStarted","score"]},"order":{"type":"string","enum":["ascending","descending"]}}}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EnrichedAttempt"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/exam-attempt-headline-insights/{object_id}":{"get":{"summary":"Get ExamAttemptHeadlineInsight","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamAttemptHeadlineInsight"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-candidate-exports":{"post":{"summary":"Create ExamCandidateExport","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ExamCandidateExport","enum":["ExamCandidateExport"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamCandidateExport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-halls/{object_id}":{"get":{"summary":"Get ExamHall","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamHall"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-previews":{"post":{"summary":"Create ExamPreview","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ExamPreview","enum":["ExamPreview"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamPreview"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-question-stats":{"get":{"summary":"List ExamQuestionStats","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","required":["exam"],"properties":{"exam":{"type":"string"},"version":{"type":"string","pattern":"^[0-9]+$"},"versions":{"type":"array","items":{"type":"string","pattern":"^[0-9]+$"}}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ExamQuestionStats"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time"}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/exam-question-stats-exports":{"post":{"summary":"Create ExamQuestionStatsExport","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ExamQuestionStatsExport","enum":["ExamQuestionStatsExport"]},"attributes":{"type":"object","properties":{"examId":{"type":"string"},"version":{"type":"string","pattern":"^[0-9]+$"},"versions":{"type":"array","items":{"type":"string","pattern":"^[0-9]+$"}}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamQuestionStatsExport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-stats":{"get":{"summary":"Get ExamStats","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","required":["exam"],"properties":{"exam":{"type":"string"},"version":{"type":"string","pattern":"^[0-9]+$"},"versions":{"type":"array","items":{"type":"string","pattern":"^[0-9]+$"}}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ExamStats"}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time"}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/exam-template-sections":{"post":{"summary":"Create ExamTemplateSection","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ExamTemplateSection","enum":["ExamTemplateSection"]},"attributes":{"type":"object","required":["title","isDynamic"],"additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"minLength":1,"maxLength":100},"isDynamic":{"type":"boolean","readOnly":false},"doi":{"type":"string","readOnly":false,"nullable":false,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"instructionsEnabled":{"type":"boolean","readOnly":false,"default":false},"instructionsTitle":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":100},"instructionsBody":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":25000},"instructionsTimerEnabled":{"type":"boolean","readOnly":false,"nullable":true},"instructionsTimerHidden":{"type":"boolean","readOnly":false,"nullable":true},"instructionsTimerDurationMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1,"maximum":86400000},"instructionsAudioAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"instructionsAudioAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"instructionsDisableAudioControls":{"type":"boolean","readOnly":false,"nullable":true},"outroEnabled":{"type":"boolean","readOnly":false,"default":false},"outroTitle":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":100},"outroBody":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":25000},"outroTimerEnabled":{"type":"boolean","readOnly":false,"nullable":true},"outroTimerHidden":{"type":"boolean","readOnly":false,"nullable":true},"outroTimerDurationMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1,"maximum":86400000},"outroAudioAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"outroAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"outroAudioAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"outroDisableAudioControls":{"type":"boolean","readOnly":false,"nullable":true},"timerEnabled":{"type":"boolean","readOnly":false,"default":false},"timerHidden":{"type":"boolean","readOnly":false,"default":false},"timerDurationMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1},"timerInferFromQuestions":{"type":"boolean","readOnly":false,"nullable":true},"index":{"type":"number","readOnly":true},"navigationDisableNavigation":{"type":"boolean","readOnly":false,"nullable":true},"navigationDisableControlPanel":{"type":"boolean","readOnly":false,"nullable":true},"navigationDisableNotifications":{"type":"boolean","readOnly":false,"nullable":true},"grades":{"type":"array","nullable":true,"items":{"type":"object","required":["label"],"properties":{"label":{"type":"string","readOnly":false},"minScore":{"description":"A default failing grade should have minScore set to `null`","type":"number","readOnly":false,"nullable":true},"isPass":{"type":"boolean","readOnly":false},"description":{"type":"string","readOnly":false,"nullable":true}}}},"scoreModifiers":{"type":"array","nullable":true,"readOnly":false,"items":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"type":"string","enum":["omitLowestScoringQuestionPerSection"]}}}}}},"relationships":{"type":"object","required":["examTemplate"],"properties":{"examTemplate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamTemplate","enum":["ExamTemplate"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"outroAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamTemplateSection"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List ExamTemplateSections","tags":["Exams"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-template-sections/{object_id}":{"get":{"summary":"Get ExamTemplateSection","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamTemplateSection"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update ExamTemplateSection","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ExamTemplateSection"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamTemplateSection"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete ExamTemplateSection","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-templates":{"post":{"summary":"Create ExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ExamTemplate","enum":["ExamTemplate"]},"attributes":{"type":"object","required":["name","isDynamic"],"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","minLength":1,"maxLength":255},"description":{"type":"string","nullable":true},"isDynamic":{"type":"boolean","readOnly":false},"dynamicIsSectioned":{"type":"boolean","nullable":true},"lockedByDefault":{"type":"boolean","nullable":true},"ipAllowList":{"type":"array","items":{"type":"string"},"nullable":true},"resumeAllowed":{"type":"boolean","nullable":true},"resumeSameSession":{"type":"boolean","nullable":true},"passcodeEnabled":{"type":"boolean","nullable":true},"passcodeValue":{"type":"string","nullable":true},"hideFromCandidateList":{"type":"boolean","nullable":true},"allowedMode":{"type":"string","nullable":true},"allowedPlayers":{"type":"array","items":{"type":"string"},"nullable":true},"passFailEnabled":{"type":"boolean","nullable":true},"calculatorEnabled":{"type":"boolean","nullable":true},"calculatorType":{"type":"string","nullable":true},"notepadEnabled":{"type":"boolean","nullable":true},"resizableQuestionPanelsEnabled":{"type":"boolean","nullable":true},"strikethroughEnabled":{"type":"boolean","nullable":true},"highlightingEnabled":{"type":"boolean","nullable":true},"bookmarkingEnabled":{"type":"boolean","nullable":true},"flaggingEnabled":{"type":"boolean","nullable":true},"micEnabled":{"type":"boolean","nullable":true},"resumeLaterButtonEnabled":{"type":"boolean","nullable":true},"labValuesEnabled":{"type":"boolean","nullable":true},"labValuesHtml":{"type":"string","nullable":true},"additionalInformationEnabled":{"type":"boolean","nullable":true},"additionalInformationHtml":{"type":"string","nullable":true},"additionalInformationTitle":{"type":"string","nullable":true},"additionalInformationIcon":{"type":"string","nullable":true},"externalPlayerType":{"type":"string","nullable":true},"deferResultEnabled":{"type":"boolean","nullable":true},"deferResultAlwaysRelease":{"type":"boolean","nullable":true},"deferResultMessage":{"type":"string","nullable":true},"optionShuffling":{"type":"string","nullable":true},"questionShuffling":{"type":"string","nullable":true},"sectionShufflingEnabled":{"type":"boolean","nullable":true},"softSectionsEnabled":{"type":"boolean","nullable":true},"sectionGradesEnabled":{"type":"boolean","nullable":true},"advancedGradingEnabled":{"type":"boolean","nullable":true},"availableMarksEnabled":{"type":"boolean","nullable":true},"pinnedMessageDuringTest":{"type":"string","nullable":true},"excludeInformationalQuestionsFromCounts":{"type":"boolean","nullable":true},"timerEnabled":{"type":"boolean","nullable":true},"timerTimeInMs":{"type":"number","nullable":true},"timerUseSections":{"type":"boolean","nullable":true},"timerUseQuestions":{"type":"boolean","nullable":true},"timerEnforceFullTime":{"type":"boolean","nullable":true},"timerExtraTimeMultiplier":{"type":"number","nullable":true},"timerSoftTimer":{"type":"boolean","nullable":true},"disableCopying":{"type":"boolean","nullable":true},"disablePasting":{"type":"boolean","nullable":true},"disableRightClick":{"type":"boolean","nullable":true},"disableNavigation":{"type":"boolean","nullable":true},"disableControlPanel":{"type":"boolean","nullable":true},"disableNotifications":{"type":"boolean","nullable":true},"styleTheme":{"type":"string","nullable":true},"styleFontSize":{"type":"string","nullable":true},"creditsPerQuestion":{"type":"number","nullable":true},"enablePenalties":{"type":"boolean","nullable":true},"penaltiesPerQuestion":{"type":"number","nullable":true},"partialCreditsPerQuestion":{"type":"number","nullable":true},"grades":{"type":"array","nullable":true,"items":{"type":"object","required":["label","minScore"],"properties":{"label":{"type":"string"},"description":{"type":"string","nullable":true},"minScore":{"type":"number","nullable":true},"isPass":{"type":"boolean","nullable":true},"advancedCriteria":{"type":"object","nullable":true,"properties":{"sectionRequirements":{"type":"object","nullable":true,"properties":{"type":{"type":"string"},"count":{"type":"number","nullable":true},"sectionIds":{"type":"array","items":{"type":"string"},"nullable":true}}},"excludeFromResitAttempts":{"type":"boolean","nullable":true}}}}}},"instructionsEnabled":{"type":"boolean","nullable":true},"instructionsTitle":{"type":"string","nullable":true},"instructionsBody":{"type":"string","nullable":true},"instructionsTimerDurationMs":{"type":"number","nullable":true},"instructionsEnforcedTimer":{"type":"string","nullable":true},"instructionsAudioAutoAdvance":{"type":"string","nullable":true},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","minimum":0,"maximum":3600000,"nullable":true},"instructionsAudioAutoPlay":{"type":"boolean","nullable":true},"instructionsDisableAudioControls":{"type":"boolean","nullable":true},"resultDetailedViewEnabled":{"type":"boolean","nullable":true},"resultEducatorsViewAsAdminEnabled":{"type":"boolean","nullable":true},"resultHideResultsPage":{"type":"boolean","nullable":true},"resultGlobalHideScore":{"type":"boolean","nullable":true},"resultScoreEnabled":{"type":"boolean","nullable":true},"resultTimeSpentEnabled":{"type":"boolean","nullable":true},"resultGradeEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownGradeEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownScoreEnabled":{"type":"boolean","nullable":true},"resultQuestionBreakdownDisplay":{"type":"string","nullable":true},"resultAnalyticsCohort":{"type":"string","nullable":true},"resultCohortAverageEnabled":{"type":"boolean","nullable":true},"resultPercentileEnabled":{"type":"boolean","nullable":true},"resultScoreDistributionEnabled":{"type":"boolean","nullable":true},"resultTagBreakdownEnabled":{"type":"boolean","nullable":true},"resultProgressEnabled":{"type":"boolean","nullable":true},"resultFacetSubjectEnabled":{"type":"boolean","nullable":true},"resultFacetTopicEnabled":{"type":"boolean","nullable":true},"resultFacetSubtopicEnabled":{"type":"boolean","nullable":true},"resultFacetSkillEnabled":{"type":"boolean","nullable":true},"resultFacetDifficultyEnabled":{"type":"boolean","nullable":true},"resultMessagePassed":{"type":"string","nullable":true},"resultMessageFailed":{"type":"string","nullable":true},"resultMessageResitsRemaining":{"type":"string","nullable":true},"resultMessageNoResitsRemaining":{"type":"string","nullable":true},"resultMessageCompleted":{"type":"string","nullable":true},"resultMessageSettingHideTitle":{"type":"boolean","nullable":true},"resultHiddenMessage":{"type":"string","nullable":true},"resultHiddenSettingHideTitle":{"type":"boolean","nullable":true},"resultOverviewWhenPassedMessage":{"type":"string","nullable":true},"resultOverviewWhenFailedHasResitsMessage":{"type":"string","nullable":true},"resultOverviewWhenFailedNoResitsMessage":{"type":"string","nullable":true},"resultOverviewWhenCompleteNoGradesMessage":{"type":"string","nullable":true},"resultOverviewWhenCompletedNeutralGradesMessage":{"type":"string","nullable":true},"markingDoubleEnabled":{"type":"boolean","nullable":true},"markingDoubleAllocation":{"type":"string","nullable":true},"markingDoubleMinMarkers":{"type":"number","nullable":true},"markingDoubleSequence":{"type":"string","nullable":true},"markingBlindProvisionalMarker":{"type":"boolean","nullable":true},"markingBlindModeratingMarker":{"type":"boolean","nullable":true},"markingBlindEscalationMarker":{"type":"boolean","nullable":true},"markingBlindBackReadingMarker":{"type":"boolean","nullable":true},"markingBlindAuditingMarker":{"type":"boolean","nullable":true},"markingBlindIsolate":{"type":"boolean","nullable":true},"markerConcealmentProvisional":{"type":"boolean","nullable":true},"markerConcealmentModerating":{"type":"boolean","nullable":true},"markerConcealmentEscalation":{"type":"boolean","nullable":true},"markerConcealmentAuditing":{"type":"boolean","nullable":true},"markingEscalationEnabled":{"type":"boolean","nullable":true},"markingEscalationModeratorsCanEscalate":{"type":"boolean","nullable":true},"markingEscalationReasons":{"type":"array","nullable":true,"items":{"type":"object","required":["label","description"],"properties":{"slug":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}},"markingBackReadingEnabled":{"type":"boolean","nullable":true},"markingAuditingEnabled":{"type":"boolean","nullable":true},"markingResolutionEnabled":{"type":"boolean","nullable":true},"markingProvisionalMarkerAllocation":{"type":"string","nullable":true},"markingModeratingMarkerAllocation":{"type":"string","nullable":true},"markingEscalationMarkerAllocation":{"type":"string","nullable":true},"preExamInstructions":{"type":"string","nullable":true},"notificationAutomateEmails":{"type":"boolean","nullable":true},"notificationResultsEmailEnabled":{"type":"boolean","nullable":true},"certificatesEnabled":{"type":"boolean","nullable":true},"certificatesIssueOnFail":{"type":"boolean","nullable":true},"certificatesTemplateId":{"type":"string","nullable":true},"certificatesQrCode":{"type":"boolean","nullable":true},"certificatesResultsPage":{"type":"boolean","nullable":true},"certificatesTtl":{"type":"number","nullable":true},"certificatesIgnoreSubPortalBranding":{"type":"boolean","nullable":true},"certificatesSharingImageUrl":{"type":"string","nullable":true},"resitEnabled":{"type":"boolean","nullable":true},"resitType":{"type":"string","nullable":true},"resitMode":{"type":"string","nullable":true},"resitAllowedAttempts":{"type":"number","nullable":true},"resitGradeIndependent":{"type":"boolean","nullable":true},"resitDelay":{"type":"number","nullable":true},"resitCloseDelay":{"type":"number","nullable":true},"legalEnabled":{"type":"boolean","nullable":true},"legalConfirmationType":{"type":"string","nullable":true},"legalTitle":{"type":"string","nullable":true},"legalBody":{"type":"string","nullable":true},"legalCheckboxLabel":{"type":"string","nullable":true},"legalConfirmationStaticText":{"type":"string","nullable":true},"proctorEnabled":{"type":"boolean","nullable":true},"proctorVendor":{"type":"string","nullable":true},"proctorRequireFullscreen":{"type":"boolean","nullable":true},"proctorRestrictTabs":{"type":"boolean","nullable":true},"proctorRestrictDisplays":{"type":"boolean","nullable":true},"proctorWebcamMonitoring":{"type":"string","nullable":true},"proctorScreenMonitoring":{"type":"string","nullable":true},"proctorSynopticLevel":{"type":"string","nullable":true},"proctorScreenshotPrevention":{"type":"boolean","nullable":true},"proctorRecordSession":{"type":"boolean","nullable":true},"proctorRecordSnapshots":{"type":"boolean","nullable":true},"proctorRecordDesktop":{"type":"boolean","nullable":true},"proctorAiReview":{"type":"boolean","nullable":true},"proctorAiPrompts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true}}}},"proctorOnBreach":{"type":"string","nullable":true},"proctorReviewMode":{"type":"string","enum":["always","never","onBreach",null],"nullable":true},"proctorLiveProctoring":{"type":"boolean","nullable":true},"proctorBlockedApplicationsPolicy":{"type":"string","enum":["none","default",null],"nullable":true},"shuffleDynamicFilters":{"type":"boolean","nullable":true},"shuffleAllDynamicQuestions":{"type":"boolean","nullable":true},"dynamicTagSetId":{"type":"string","nullable":true},"dynamicVariationEnabled":{"type":"boolean","nullable":true},"dynamicVariantsMax":{"type":"number","nullable":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}},"globalDefaultSettings":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"GlobalExamTemplate","enum":["GlobalExamTemplate"]}}}}},"sections":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["ExamTemplateSection"],"example":"ExamTemplateSection"}]}}}}}},"markers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"moderatingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"escalatingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"backReadingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"auditingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"sourceQuiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"sourceExam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamTemplate"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List ExamTemplates","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"subPortal":{"type":"string"},"owner":{"type":"string"},"isDynamic":{"type":"string","enum":["true","false"]}}}},{"name":"search","in":"query","required":false,"description":"Partial, case-insensitive match against exam template name.","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt","name","-name"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ExamTemplate"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/exam-templates/{object_id}":{"get":{"summary":"Get ExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamTemplate"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update ExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ExamTemplate"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamTemplate"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete ExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-templates/{object_id}/relationships/collaborating-users":{"post":{"summary":"Add ExamTemplate Collaborating Users","description":"Add users as collaborators to this exam template. The request body should contain an array of User resource identifier objects.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove ExamTemplate Collaborating Users","description":"Remove users as collaborators from this exam template. The request body should contain an array of User resource identifier objects to remove.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-templates/{object_id}/relationships/collaborating-user-groups":{"post":{"summary":"Add ExamTemplate Collaborating User Groups","description":"Add user groups as collaborators to this exam template. The request body should contain an array of UserGroup resource identifier objects.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove ExamTemplate Collaborating User Groups","description":"Remove user groups as collaborators from this exam template. The request body should contain an array of UserGroup resource identifier objects to remove.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-templates/{object_id}/relationships/sections":{"patch":{"summary":"Update ExamTemplate Sections","description":"Reorder (or clear) the sections of this exam template. The request body must contain either the complete ordered array of ExamTemplateSection resource identifier objects, or null to remove every section.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["ExamTemplateSection"],"example":"ExamTemplateSection"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-templates/{object_id}/relationships/markers":{"patch":{"summary":"Set ExamTemplate Markers Group","description":"Set the shared user group exams created from this template use as their markers, or null to clear it. Only a shared group of the Marker user type within the template's own (sub-)portal is accepted — an exam's ad-hoc internal marker list cannot be templated.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-templates/{object_id}/relationships/moderating-markers":{"patch":{"summary":"Set ExamTemplate Moderating Markers Group","description":"Set the shared user group exams created from this template use as their moderating markers, or null to clear it. Only a shared group of the Marker user type within the template's own (sub-)portal is accepted — an exam's ad-hoc internal marker list cannot be templated.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-templates/{object_id}/relationships/escalating-markers":{"patch":{"summary":"Set ExamTemplate Escalating Markers Group","description":"Set the shared user group exams created from this template use as their escalating markers, or null to clear it. Only a shared group of the Marker user type within the template's own (sub-)portal is accepted — an exam's ad-hoc internal marker list cannot be templated.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-templates/{object_id}/relationships/back-reading-markers":{"patch":{"summary":"Set ExamTemplate Back Reading Markers Group","description":"Set the shared user group exams created from this template use as their back reading markers, or null to clear it. Only a shared group of the Marker user type within the template's own (sub-)portal is accepted — an exam's ad-hoc internal marker list cannot be templated.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-templates/{object_id}/relationships/auditing-markers":{"patch":{"summary":"Set ExamTemplate Auditing Markers Group","description":"Set the shared user group exams created from this template use as their auditing markers, or null to clear it. Only a shared group of the Marker user type within the template's own (sub-)portal is accepted — an exam's ad-hoc internal marker list cannot be templated.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-v-2s":{"post":{"summary":"Create ExamV2","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]},"attributes":{"type":"object","required":["name","isDynamic"],"additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true},"directUserRegistrationEnabled":{"type":"boolean","readOnly":false,"description":"If true, the exam will created with an implicit user group and users can be registered directly into the exam without the need for user group management."},"isDynamic":{"type":"boolean","readOnly":false},"isSectioned":{"type":"boolean","readOnly":false},"shortDescription":{"type":"string","nullable":true},"preExamInstructions":{"type":"string","nullable":true},"markingDoubleEnabled":{"type":"boolean"},"markingDoubleAllocation":{"type":"string","enum":["manual","roundRobin"],"nullable":true},"markingDoubleMinMarkers":{"type":"number","nullable":true},"markingDoubleSequence":{"type":"string","enum":["parallel","serial"],"nullable":true},"markingBlindProvisionalMarker":{"type":"boolean"},"markingBlindModeratingMarker":{"type":"boolean"},"markingBlindEscalationMarker":{"type":"boolean"},"markingBlindBackReadingMarker":{"type":"boolean"},"markingBlindAuditingMarker":{"type":"boolean"},"markingBlindIsolate":{"type":"boolean"},"markerConcealmentProvisional":{"type":"boolean"},"markerConcealmentModerating":{"type":"boolean"},"markerConcealmentEscalation":{"type":"boolean"},"markerConcealmentAuditing":{"type":"boolean"},"markingEscalationEnabled":{"type":"boolean"},"markingEscalationModeratorsCanEscalate":{"type":"boolean"},"markingEscalationReasons":{"type":"array","minItems":1,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}},"markingBackReadingEnabled":{"type":"boolean"},"markingAuditingEnabled":{"type":"boolean"},"markingResolutionEnabled":{"type":"boolean"},"notificationAutomateEmails":{"type":"boolean"},"notificationResultsEmailEnabled":{"type":"boolean","default":true},"hideFromCandidateList":{"type":"boolean"},"markingModeratingMarkerAllocation":{"type":"string","enum":["manual","roundRobin"],"nullable":true},"markingProvisionalMarkerAllocation":{"type":"string","enum":["manual","roundRobin"],"nullable":true},"markingEscalationMarkerAllocation":{"type":"string","enum":["manual","roundRobin"],"nullable":true},"ipAllowList":{"type":"array","readOnly":false,"nullable":true,"minItems":1,"items":{"type":"string"}},"lockedByDefault":{"type":"boolean","readOnly":false,"nullable":true},"resumeSameSession":{"type":"boolean","readOnly":false,"nullable":true},"resumeAllowed":{"type":"boolean","readOnly":false,"nullable":true},"passcodeEnabled":{"type":"boolean","readOnly":false,"nullable":false},"passcodeValue":{"type":"string","readOnly":false,"nullable":true},"codeLoginEnabled":{"type":"boolean","readOnly":false,"nullable":false},"codeLoginVerifyWith":{"type":"string","enum":["none","surname","externalId"],"readOnly":false,"nullable":true},"codeLoginSharedCode":{"type":"boolean","readOnly":false,"nullable":false,"description":"Every candidate sitting the exam signs in with the exam's id as their code, identifying themselves with both their external ID and their surname. Ignores codeLoginVerifyWith."},"codeLoginGenerateMissingAttempt":{"type":"boolean","readOnly":false,"nullable":false,"description":"Create an attempt during a shared-code sign-in for a student on the portal who does not have one yet."},"attr":{"type":"object"},"isArchived":{"type":"boolean"},"mutexLockKey":{"type":"string","nullable":true,"readOnly":true},"mutexLockExpiresAt":{"type":"string","nullable":true,"readOnly":true},"mutexLockType":{"type":"string","enum":["full","write"],"readOnly":true},"testVersions":{"type":"object","readOnly":true,"properties":{"DRAFT":{"type":"string"}},"additionalProperties":{"oneOf":[{"type":"string"},{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"publishedBy":{"type":"string"},"publishedAt":{"type":"string"},"status":{"type":"string","enum":["draft","published","closed","cancelled"]},"scheduleOpenDate":{"type":"string","nullable":true},"scheduleCloseDate":{"type":"string","nullable":true},"previousVersionId":{"type":"string","nullable":true}}}]}},"resultEducatorsViewAsAdminEnabled":{"type":"boolean"},"resultDetailedViewEnabled":{"type":"boolean"}}},"relationships":{"type":"object","required":["userGroup","sourceQuizzes"],"properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"markers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"moderatingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"escalatingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"auditingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"backReadingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"setupJob":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BackgroundJob","enum":["BackgroundJob"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"publishedVersion":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"currentVersion":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}},"sourceQuizzes":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Quiz"],"example":"Quiz"}]}}}}}},"template":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamTemplate","enum":["ExamTemplate"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Exam-V-2"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"Find ExamV2s","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"search","in":"query","required":false,"allowReserved":true,"schema":{"type":"string"}},{"name":"filter","in":"query","required":false,"explode":false,"schema":{"type":"object","properties":{"propertyFilters":{"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]},"operator":{"type":"string","enum":["$eq","$ne","$exists","$gt","$gte","$lt","$lte","$in","$nin","$or"]}}}}}}},{"name":"sort","in":"query","schema":{"type":"string","enum":["-createdAt","-targetCreatedAt"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Exam-V-2"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/exam-v-2s/{object_id}":{"get":{"summary":"Get ExamV2","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Exam-V-2"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update ExamV2","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Exam-V-2"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Exam-V-2"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete ExamV2","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/relationships/collaborating-users":{"post":{"summary":"Add ExamV2 Collaborating Users","description":"Add users as collaborators to this exam. The request body should contain an array of User resource identifier objects.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove ExamV2 Collaborating Users","description":"Remove users as collaborators from this exam. The request body should contain an array of User resource identifier objects to remove.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/relationships/collaborating-user-groups":{"post":{"summary":"Add ExamV2 Collaborating User Groups","description":"Add user groups as collaborators to this exam. The request body should contain an array of UserGroup resource identifier objects.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove ExamV2 Collaborating User Groups","description":"Remove user groups as collaborators from this exam. The request body should contain an array of UserGroup resource identifier objects to remove.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/markers":{"post":{"summary":"Create Internal Markers Group","tags":["Exams"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"]}]}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroup"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}},"meta":{"type":"object","properties":{}}}}}}},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/relationships/markers":{"patch":{"summary":"Set Shared Markers Group","tags":["Exams"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"]}]}}}}}}}},"responses":{"204":{"description":"No content"},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/moderating-markers":{"post":{"summary":"Create Internal Moderating Markers Group","tags":["Exams"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"]}]}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroup"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}},"meta":{"type":"object","properties":{}}}}}}},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/relationships/moderating-markers":{"patch":{"summary":"Set Shared Moderating Markers Group","tags":["Exams"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"]}]}}}}}}}},"responses":{"204":{"description":"No content"},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/relationships/escalating-markers":{"patch":{"summary":"Set Shared Escalating Markers Group","tags":["Exams"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"]}]}}}}}}}},"responses":{"204":{"description":"No content"},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/relationships/auditing-markers":{"patch":{"summary":"Set Shared Auditing Markers Group","tags":["Exams"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"]}]}}}}}}}},"responses":{"204":{"description":"No content"},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/escalating-markers":{"post":{"summary":"Create Internal Escalating Markers Group","tags":["Exams"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"]}]}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroup"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}},"meta":{"type":"object","properties":{}}}}}}},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/auditing-markers":{"post":{"summary":"Create Internal Auditing Markers Group","tags":["Exams"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"]}]}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroup"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}},"meta":{"type":"object","properties":{}}}}}}},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/back-reading-markers":{"post":{"summary":"Create Internal BackReading Markers Group","tags":["Exams"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"]}]}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroup"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}},"meta":{"type":"object","properties":{}}}}}}},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/relationships/back-reading-markers":{"patch":{"summary":"Set Shared BackReading Markers Group","tags":["Exams"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"]}]}}}}}}}},"responses":{"204":{"description":"No content"},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/relationships/sections":{"patch":{"summary":"Update Exam Section","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["ExamSection"],"example":"ExamSection"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/currentVersion":{"post":{"summary":"Creates a new draft version of the underlying quiz","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":false,"minLength":1,"maxLength":300},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"description":{"type":"string","nullable":true,"readOnly":false,"maxLength":50000},"shortDescription":{"type":"string","nullable":true,"readOnly":false,"minLength":0,"maxLength":1500},"totalQuestions":{"type":"number","nullable":false,"readOnly":true},"instructionsEnabled":{"type":"boolean","readOnly":false,"nullable":false,"default":false},"instructionsTitle":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":300},"instructionsBody":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":25000},"instructionsTimerDurationMs":{"type":"number","nullable":true,"readOnly":false,"minimum":1,"maximum":86400000},"instructionsEnforcedTimer":{"type":"string","readOnly":false,"enum":["afterAudioStarts","immediately"]},"instructionsAudioAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"instructionsAudioAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"instructionsDisableAudioControls":{"type":"boolean","readOnly":false,"nullable":true},"markingCreditsPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"default":1},"markingPartialCreditsPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0},"markingPenaltiesPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0},"markingPenaltiesEnabled":{"type":"boolean","nullable":true,"readOnly":false,"default":false},"grades":{"type":"array","nullable":true,"items":{"type":"object","properties":{"label":{"type":"string","readOnly":false},"minScore":{"type":"number","readOnly":false},"isPass":{"type":"boolean","readOnly":false,"nullable":true},"description":{"type":"string","readOnly":false,"nullable":true},"advancedCriteria":{"type":"object","readOnly":false,"nullable":true,"properties":{"sectionRequirements":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","enum":["none","requiredCount","allPass","selectedPass"],"readOnly":false,"nullable":true},"count":{"type":"number","readOnly":false,"nullable":true},"sectionIds":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"string","readOnly":false,"nullable":true}}}},"excludeFromResitAttempts":{"type":"boolean","readOnly":false,"nullable":true}}}}}},"allowedModes":{"type":"array","nullable":true,"items":{"type":"string","enum":["practice","exam","timedExam"]},"minItems":1,"maxItems":3},"allowedLengths":{"type":"array","items":{"type":"string","enum":["default","quick","medium","long","extraLong"]}},"allowedPlayers":{"type":"array","items":{"type":"string","enum":["default","ucat","usmle"]}},"allowedTagSets":{"type":"array","nullable":true,"items":{"type":"string"}},"allowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","skill","difficulty","context"]}},"calculatorEnabled":{"type":"boolean","readOnly":false,"default":false},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"],"readOnly":false},"allowMultipleTagSelection":{"type":"boolean","readOnly":false,"default":false},"excludeUntaggedQuestions":{"type":"boolean","readOnly":false,"default":false},"showMasteryFilters":{"type":"boolean","readOnly":false,"default":false},"calculatorType":{"type":"string","enum":["basic","scientific"]},"securityDisableCopying":{"type":"boolean","readOnly":false,"default":false},"securityDisablePasting":{"type":"boolean","readOnly":false,"default":false},"securityDisableRightClick":{"type":"boolean","readOnly":false,"default":false},"navigationDisableNavigation":{"type":"boolean","readOnly":false,"default":false},"navigationDisableControlPanel":{"type":"boolean","readOnly":false,"default":false},"navigationDisableNotifications":{"type":"boolean","readOnly":false,"default":false},"softSectionsEnabled":{"type":"boolean","readOnly":false,"default":false},"notepadEnabled":{"type":"boolean","readOnly":false,"default":false},"resizableQuestionPanelsEnabled":{"type":"boolean","readOnly":false,"default":true},"strikethroughEnabled":{"type":"boolean","readOnly":false,"default":false},"highlightingEnabled":{"type":"boolean","readOnly":false,"default":false},"bookmarkingEnabled":{"type":"boolean","readOnly":false,"default":false},"micSettingsEnabled":{"type":"boolean","readOnly":false,"default":false},"labValuesEnabled":{"type":"boolean","readOnly":false,"default":false},"labValuesHtml":{"type":"string","readOnly":false},"additionalInformationEnabled":{"type":"boolean","readOnly":false,"default":false},"additionalInformationTitle":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":120},"additionalInformationIcon":{"type":"string","readOnly":false,"nullable":true},"additionalInformationHtml":{"type":"string","readOnly":false},"resumeLaterButtonEnabled":{"type":"boolean","readOnly":false,"default":false},"flaggingEnabled":{"type":"boolean","readOnly":false,"default":false},"showAvailableMarks":{"type":"boolean","readOnly":false,"default":false},"playerType":{"type":"string","enum":["default","ucat","usmle"],"default":"default"},"theme":{"type":"string","default":"default"},"fontSize":{"type":"string","enum":["xSmall","small","medium","large","xLarge"],"default":"medium"},"pinnedMessageDuringTest":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":1500},"deferResultsEnabled":{"type":"boolean","readOnly":false,"default":false},"deferResultsMessage":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":25000},"deferResultsAlwaysRelease":{"type":"boolean","readOnly":false},"whenCompleteNoGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000,"deprecated":true},"completedMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000,"deprecated":true},"resultsHideResults":{"type":"boolean","readOnly":false,"default":false},"resultsGlobalHideScore":{"type":"boolean","readOnly":false,"default":false},"resultsDetailedViewEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsOverviewWhenPassedMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenFailedHasResitsMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenFailedNoResitsMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenCompleteNoGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenCompletedNeutralGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessagePassed":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageFailed":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageResitsRemaining":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageNoResitsRemaining":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageCompleted":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageSettingHideTitle":{"type":"boolean","readOnly":false,"default":false},"resultsHiddenMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsHiddenSettingHideTitle":{"type":"boolean","readOnly":false,"default":false},"resultsMetricScoreEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricTimeSpentEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricGradeEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricProgressEnabled":{"type":"boolean","readOnly":false,"deprecated":true,"description":"Use resultsMetricTagProgressEnabled instead","default":true},"resultsMetricQuestionBreakdownDisplayLevel":{"type":"string","enum":["full","hideStemAndOptions","hideCorrectOptions","incorrectOnlyHideCorrectOptions","none"],"readOnly":false},"resultsMetricAnalyticsCohort":{"type":"string","enum":["exam","test","sourceTest"],"default":"test"},"resultsMetricCohortAverageEnabled":{"type":"boolean","readOnly":false,"default":false},"resultsMetricCohortPercentileEnabled":{"type":"boolean","readOnly":false,"default":false},"resultsMetricCohortScoreDistributionEnabled":{"type":"boolean","readOnly":false,"default":false},"resultsMetricTagBreakdownEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricTagProgressEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricSectionBreakdownEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricSectionBreakdownGradeEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricSectionBreakdownScoreEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricTagProgressFacetsEnabled":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"subject":{"type":"boolean","readOnly":false},"topic":{"type":"boolean","readOnly":false},"subtopic":{"type":"boolean","readOnly":false},"skill":{"type":"boolean","readOnly":false},"difficulty":{"type":"boolean","readOnly":false}},"default":{"subject":true,"topic":true,"subtopic":true,"skill":true,"difficulty":true}},"resultsEducatorViewAsAdminEnabled":{"type":"boolean","readOnly":false,"default":true},"timerEnabled":{"type":"boolean","readOnly":false,"default":false},"timerHidden":{"type":"boolean","readOnly":false,"default":false},"timerUseQuestions":{"type":"boolean","readOnly":false},"timerUseSections":{"type":"boolean","readOnly":false},"timerEnforceFullTime":{"type":"boolean","readOnly":false},"timerTimeInMs":{"type":"number","nullable":true,"readOnly":false,"minimum":1,"maximum":86400000},"timerExtraTimeMultiplier":{"type":"number","readOnly":false,"nullable":true},"timerSoftTimer":{"type":"boolean","readOnly":false},"mutexLockKey":{"type":"string","readOnly":true,"nullable":true},"mutexLockExpiresAt":{"type":"string","readOnly":true,"nullable":true},"mutexLockType":{"type":"string","enum":["write","full",null],"readOnly":true,"nullable":true},"certificatesEnabled":{"type":"boolean","readOnly":false},"certificatesTemplateId":{"type":"string","nullable":true,"readOnly":false},"certificatesQrCode":{"type":"boolean","nullable":true,"readOnly":false},"certificatesTtl":{"type":"number","nullable":true,"readOnly":false},"certificatesIgnoreSubPortalBranding":{"type":"boolean","nullable":true,"readOnly":false},"certificatesIssueOnFail":{"type":"boolean","nullable":true,"readOnly":false},"certificatesResultsPage":{"type":"boolean","nullable":true,"readOnly":false},"certificatesSharingImageUrl":{"type":"string","nullable":true,"readOnly":false},"resitEnabled":{"type":"boolean","nullable":false,"readOnly":false},"resitType":{"type":"string","enum":["continuous","fixedDate","onDemand","rolling",null],"nullable":true,"readOnly":false},"resitMode":{"type":"string","enum":["standard","fixed","progressive","preferUnseen",null],"readOnly":false,"nullable":true},"resitGradeIndependent":{"type":"boolean","nullable":true,"readOnly":false},"resitAllowedAttempts":{"type":"number","nullable":true,"readOnly":false},"resitDelay":{"type":"number","nullable":true,"readOnly":false},"resitCloseDelay":{"type":"number","nullable":true,"readOnly":false},"resitScheduleActivateAt":{"type":"string","nullable":true,"readOnly":false},"resitScheduleDeactivateAt":{"type":"string","nullable":true,"readOnly":false},"proctorEnabled":{"type":"boolean","readOnly":false,"nullable":false},"proctorVendor":{"type":"string","readOnly":false,"enum":["internal","rosalyn","synopticV2",null],"nullable":true},"proctorRequireFullscreen":{"type":"boolean","readOnly":false,"nullable":false},"proctorRestrictTabs":{"type":"boolean","readOnly":false,"nullable":false},"proctorRestrictDisplays":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordSession":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordSnapshots":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordDesktop":{"type":"boolean","readOnly":false,"nullable":false},"proctorSynopticLevel":{"type":"string","readOnly":false,"nullable":false,"enum":["web","browser","desktop"]},"proctorScreenMonitoring":{"type":"string","readOnly":false,"nullable":false,"enum":["none","recreation","recreationWithSnapshots","video"]},"proctorWebcamMonitoring":{"type":"string","readOnly":false,"nullable":false,"enum":["none","snapshots","audioVideo"]},"proctorRestrictKeyboardShortcuts":{"type":"boolean","readOnly":false,"nullable":false},"proctorScreenshotPrevention":{"type":"boolean","readOnly":false,"nullable":true},"proctorAiReview":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiFlagCandidateLeftFrame":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiFlagMultiplePeopleInFrame":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiPrompts":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"prompt":{"type":"string","readOnly":false},"level":{"type":"string","readOnly":false,"enum":["info","warning","breach"]},"colour":{"type":"string","readOnly":false,"nullable":true}}}},"proctorOnBreach":{"type":"string","enum":["freeze","silent",null],"readOnly":false,"nullable":true},"proctorReviewOptional":{"type":"boolean","readOnly":false,"nullable":false},"proctorReviewMode":{"type":"string","enum":["always","never","onBreach",null],"readOnly":false,"nullable":true},"proctorLiveProctoring":{"type":"boolean","readOnly":false,"nullable":false},"proctorBlockedApplicationsPolicy":{"type":"string","readOnly":false,"nullable":true,"enum":["none","default",null]},"proctorRosalynRuleUsePrivateTestArea":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleVisibleFace":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowInteractionWithOthers":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowOtherMaterials":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowNoiseMakingDevices":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowAdditionalDevices":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleAllowMouseKeyboardMonitorOnly":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowAppsOrBroswerTabs":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowExamContentSharing":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowTextPrediction":{"type":"boolean","readOnly":false,"nullable":false},"access":{"type":"object","readOnly":true,"properties":{"exam":{"type":"object","properties":{"objectId":{"type":"string","nullable":true}}}}},"legalEnabled":{"type":"boolean","readOnly":false},"legalTitle":{"type":"string","readOnly":false,"nullable":true},"legalBody":{"type":"string","readOnly":false,"nullable":true},"legalCheckboxLabel":{"type":"string","readOnly":false,"nullable":true},"legalConfirmationType":{"type":"string","enum":["checkbox","staticText","candidateName"],"readOnly":false,"nullable":true},"legalConfirmationStaticText":{"type":"string","readOnly":false,"nullable":true},"dynamicVariationEnabled":{"type":"boolean","readOnly":false},"dynamicVariationMaxVariants":{"type":"number","minimum":0,"readOnly":false,"nullable":true},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":true},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true},"scheduleSubmissionDueDate":{"type":"string","readOnly":false,"nullable":true},"scheduleRelativeCloseTimeInMs":{"type":"number","minimum":0,"readOnly":false,"nullable":true},"dynamicFiltersWeightingType":{"type":"string","enum":["absolute","percentage"],"nullable":true,"readOnly":false},"dynamicFilterRules":{"nullable":true,"type":"array","minItems":0,"maxItems":125,"description":"Array of filter rules to apply to the dynamic quiz content.","items":{"type":"object","properties":{"weighting":{"type":"number"},"shuffleQuestions":{"type":"boolean","default":false},"matchingRules":{"type":"array","minItems":0,"maxItems":20,"description":"Array of matching rules to apply to the filter rule. Each rule will be treated as an AND operation. Matching rules can not be a mix of tag and EMQ rules.","items":{"oneOf":[{"anyOf":[{"type":"object","required":["tagId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["tagId"],"properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}}}]},{"anyOf":[{"type":"object","required":["emqGroupId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"emqGroupId":{"type":"string","minLength":5,"maxLength":32}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["emqGroupId"],"properties":{"emqGroupId":{"type":"string","minLength":5,"maxLength":32}}}}]},{"anyOf":[{"type":"object","required":["questionId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"questionId":{"type":"string","minLength":5,"maxLength":32}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["questionId"],"properties":{"questionId":{"type":"string","minLength":5,"maxLength":32}}}}]}]}}}}},"isDynamic":{"type":"boolean","readOnly":false},"isSectioned":{"type":"boolean","readOnly":true},"shuffleDynamicFilters":{"type":"boolean","nullable":true,"description":"If true then the dynamic filters will be shuffled for each attempt.","default":false},"shuffleAllDynamicQuestions":{"type":"boolean","nullable":true,"description":"If true then all questions selected accross filter rules will be shuffled. EMQ grouping will be maintained.","default":false},"shuffleSectionsEnabled":{"type":"boolean","readOnly":false,"default":false},"shuffleQuestions":{"type":"string","enum":["disabled","random","enabled"],"readOnly":false,"description":"If true then the questions will be shuffled for each attempt.","default":"disabled"},"version":{"type":"string","readOnly":false},"status":{"type":"string","enum":["draft","published","cancelled","closed"],"readOnly":false,"nullable":false},"isGenerated":{"type":"boolean","readOnly":true,"nullable":true},"isArchived":{"type":"boolean","readOnly":true},"excludeInformationalQuestionsFromCounts":{"type":"boolean","readOnly":false},"sectionGradesEnabled":{"type":"boolean","readOnly":false},"advancedGradingEnabled":{"type":"boolean","readOnly":false},"passFailEnabled":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"questions":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}},"emqGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizEmqGroup"],"example":"QuizEmqGroup"}]}}}}}},"sections":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizSection"],"example":"QuizSection"}]}}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"sourceContentQuizzes":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Quiz"],"example":"Quiz"}]}}}}}},"sourceSettingsQuiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TagSet","enum":["TagSet"]}}}}},"setupValidation":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSetupValidation","enum":["QuizSetupValidation"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Quiz"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/relationships/currentVersion":{"patch":{"summary":"Discards the current draft quiz and replaces it with the latest published version.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Quiz"],"example":"Quiz"}]}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Quiz"],"example":"Quiz"}]}}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-v-2s/{object_id}/relationships/publishedVersion":{"patch":{"summary":"Sets a quiz as the current published version. New attempts for this exam will use the publishedVersion quiz.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Quiz"],"example":"Quiz"}]}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Quiz"],"example":"Quiz"}]}}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-voucher-batch-jobs":{"post":{"summary":"Create ExamVoucherBatchJob","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ExamVoucherBatchJob","enum":["ExamVoucherBatchJob"]},"attributes":{"type":"object","required":["count"],"properties":{"batch":{"type":"string","minLength":1,"maxLength":255,"description":"Batch identifier to prefix voucher codes with"},"count":{"type":"integer","minimum":1,"maximum":1000,"description":"Number of vouchers to create"},"expiresAt":{"type":"string","format":"date-time","nullable":true,"description":"Optional expiration date for all vouchers in the batch"}}},"relationships":{"type":"object","required":["exam"],"properties":{"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamVoucherBatchJob"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-voucher-exports":{"post":{"summary":"Create ExamVoucherExport","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ExamVoucherExport","enum":["ExamVoucherExport"]},"attributes":{"type":"object","properties":{"batch":{"type":"string","minLength":1,"maxLength":255,"description":"Optional batch name to filter vouchers by"}}},"relationships":{"type":"object","required":["exam"],"properties":{"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamVoucherExport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/exam-vouchers":{"post":{"summary":"Create ExamVoucher","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ExamVoucher","enum":["ExamVoucher"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"code":{"type":"string","readOnly":false,"minLength":1,"maxLength":255},"batch":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":255},"expiresAt":{"type":"string","nullable":true,"readOnly":false},"isRedeemed":{"type":"boolean","readOnly":true},"isRevoked":{"type":"boolean","readOnly":false},"redeemedAt":{"type":"string","readOnly":true,"nullable":true},"examName":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"redeemedBy":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamVoucher"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List ExamVouchers","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","required":["exam"],"properties":{"exam":{"type":"string"},"batch":{"type":"string"}}}},{"name":"sort","in":"query","required":false,"description":"Sort by createdAt field. Use \"-createdAt\" for descending (default) or \"createdAt\" for ascending.","schema":{"type":"string","enum":["createdAt","-createdAt"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ExamVoucher"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/exam-vouchers/{object_id}":{"get":{"summary":"Get ExamVoucher","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamVoucher"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update ExamVoucher","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ExamVoucher"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamVoucher"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete ExamVoucher","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/exam-vouchers/verify":{"post":{"summary":"Verify ExamVoucher","tags":["Exams"],"parameters":[],"security":[],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["code"],"properties":{"code":{"type":"string","example":"EXAM-123-ABC"}}}}}}}}}},"responses":{"201":{"description":"Valid code - returns the verified ExamVoucher","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamVoucher"}}}}}},"400":{"description":"Missing or invalid code format","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Code is expired or already redeemed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Code does not exist","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/examinee-notifications":{"post":{"summary":"Create ExamineeNotification","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ExamineeNotification","enum":["ExamineeNotification"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam","enum":["Exam"]}}}}},"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamineeNotification"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/export-enriched-attempts":{"post":{"summary":"Create ExportEnrichedAttempt","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ExportEnrichedAttempt","enum":["ExportEnrichedAttempt"]},"attributes":{"type":"object","properties":{"backgroundJobId":{"type":"string"},"filter":{"type":"object","properties":{"portalId":{"type":"string"},"origin":{"type":"object","properties":{"type":{"type":"string","enum":["assignmentGroup","assignment","collection","collectionItem","exam","test"]},"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"propertyFilters":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["assignedMarker","assignedModeratingMarker","assignedProvisionalMarker","attemptStatus","examStatus","grade","markingStatus","proctorStatus","quiz","quizVersion","resultsStatus","user","userGroup"]},"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}},"dateFilter":{"type":"object","properties":{"type":{"type":"string","enum":["completedAt","createdAt","finalisedAt","releasedAt","startedAt"]},"start":{"type":"string"},"end":{"type":"string"}}},"sort":{"type":"object","properties":{"type":{"type":"string","enum":["createdAt","finalisedAt","releasedAt","timeCompleted","timeStarted","score"]},"order":{"type":"string","enum":["ascending","descending"]}}}}},"breakdown":{"type":"string","enum":["question","score","none"]},"includes":{"type":"array","items":{"type":"string","enum":["sections","userAttributes","examAttributes","attemptAttributes"]}},"useSource":{"type":"boolean"}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExportEnrichedAttempt"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/external-exam-sittings":{"post":{"summary":"Create ExternalExamSitting","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ExternalExamSitting","enum":["ExternalExamSitting"]},"attributes":{"type":"object","required":["date"],"properties":{"score":{"type":"number","readOnly":false,"minimum":0,"maximum":100},"date":{"type":"string","readOnly":false},"isPassed":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","required":["mock"],"properties":{"mock":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionMock","enum":["CollectionMock"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExternalExamSitting"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List ExternalExamSittings","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"mock":{"type":"string"}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ExternalExamSitting"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/external-exam-sittings/{object_id}":{"patch":{"summary":"Update ExternalExamSitting","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ExternalExamSitting"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExternalExamSitting"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/external-proctor-session-results/{object_id}":{"get":{"summary":"Get ExternalProctorSessionResult","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExternalProctorSessionResults"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/external-proctor-sessions":{"post":{"summary":"Create ExternalProctorSession","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ExternalProctorSession","enum":["ExternalProctorSession"]},"attributes":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"reference":{"type":"string","description":"External proctor vendor reference for this session.","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExternalProctorSession"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/facet-configs":{"get":{"summary":"List FacetConfigs","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FacetConfig"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/files":{"post":{"summary":"Create File","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]},"attributes":{"type":"object","properties":{"path":{"type":"string","readOnly":false,"description":"Fingerprinted on create. Use returned value in Parse.File as `name`."},"s3Path":{"type":"string","readOnly":true,"description":"Actual path within S3 bucket. Usually same as `path` except for public files."},"signedUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/File"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/files/{object_id}":{"get":{"summary":"Get File","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/File"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/flag-exports":{"post":{"summary":"Create FlagExport","tags":["User Feedback"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"FlagExport","enum":["FlagExport"]},"attributes":{"type":"object","properties":{"isReviewed":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}},"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FlagExport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/flags":{"post":{"summary":"Create Flag","tags":["User Feedback"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Flag","enum":["Flag"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"comment":{"type":"string","readOnly":false,"nullable":true},"source":{"type":"string","readOnly":false,"nullable":false},"issue":{"type":"string","readOnly":false,"nullable":false},"isReviewed":{"type":"boolean","readOnly":true,"nullable":false,"description":"Whether the flag has been reviewed by a moderator, when a flag is created this is automatically set to false"}}},"relationships":{"type":"object","required":["question"],"properties":{"planter":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"question":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}},"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Flag"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List Flags","tags":["User Feedback"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"isReviewed":{"type":"boolean"},"question":{"type":"string"},"planter":{"type":"string"}}}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["createdAt","-createdAt","isReviewed","-isReviewed"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Flag"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/flags/{object_id}":{"get":{"summary":"Get Flag","tags":["User Feedback"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Flag"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Flag","tags":["User Feedback"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Flag"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Flag"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/generate-test-jobs":{"post":{"summary":"Create GenerateTestJob","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"GenerateTestJob","enum":["GenerateTestJob"]},"attributes":{"type":"object","properties":{"source":{"type":"object","readOnly":false,"properties":{"type":{"type":"string","enum":["collection"]},"objectId":{"type":"string"}}},"length":{"type":"number","readOnly":false},"tagFilters":{"type":"object","readOnly":false,"properties":{"weightingType":{"type":"string","enum":["percentage","absolute"]},"filterRules":{"type":"array","maxItems":125,"items":{"type":"object","properties":{"weighting":{"type":"number"},"matchingRules":{"type":"array","minItems":1,"items":{"anyOf":[{"type":"object"},{"type":"array","items":{"type":"object"}}]}}}}}}},"masteryLevels":{"type":"array","items":{"type":"string","enum":["unseen","weak","moderate","strong","mastered"]},"readOnly":false},"randomise":{"type":"boolean","readOnly":false},"state":{"type":"string","enum":["pending","started","completed","failed"],"readOnly":true}}},"relationships":{"type":"object","properties":{"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TagSet","enum":["TagSet"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GenerateTestJob"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/generate-test-jobs/{object_id}":{"get":{"summary":"Get GenerateTestJob","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/GenerateTestJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/generated-accounts":{"post":{"summary":"Create GeneratedAccount","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"GeneratedAccount","enum":["GeneratedAccount"]},"attributes":{"type":"object","deprecated":true,"properties":{"name":{"type":"string","readOnly":false},"email":{"type":"string","readOnly":false},"externalId":{"type":"string","readOnly":false},"password":{"type":"string","readOnly":false},"timezone":{"type":"string","readOnly":false},"attr":{"type":"object","readOnly":false},"disableWelcomeEmail":{"type":"boolean","readOnly":false},"customMessage":{"type":"string","readOnly":false}}},"relationships":{"type":"object","required":["userGroup"],"properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GeneratedAccount"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"deprecated":true}},"/generated-tests":{"post":{"summary":"Create GeneratedTest","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"GeneratedTest","enum":["GeneratedTest"]},"attributes":{"type":"object","properties":{"source":{"type":"object","readOnly":false,"properties":{"type":{"type":"string","enum":["collection"]},"objectId":{"type":"string"}}},"length":{"type":"number"},"tagFilters":{"type":"object"},"tagSetId":{"deprecated":true,"type":"string"}}},"relationships":{"type":"object","properties":{"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TagSet","enum":["TagSet"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GeneratedTest"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/generic-notifications":{"post":{"summary":"Create GenericNotification","tags":["Notifications"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"GenericNotification","enum":["GenericNotification"]},"attributes":{"type":"object","properties":{"subject":{"type":"string","readOnly":false},"body":{"type":"string","readOnly":false},"previewText":{"type":"string","readOnly":false},"replyTo":{"type":"string","readOnly":false},"ccSender":{"type":"boolean","readOnly":false},"bcc":{"type":"array","readOnly":false,"items":{"type":"object","required":["email"],"properties":{"name":{"type":"string","readOnly":false},"email":{"type":"string","readOnly":false}}}},"attachments":{"type":"array","readOnly":false,"items":{"type":"object","required":["filename","content","type"],"properties":{"filename":{"type":"string","readOnly":false},"content":{"type":"string","readOnly":false},"type":{"type":"string","enum":["application/pdf","application/json","text/csv","text/html","text/plain"],"readOnly":false}}}}}},"relationships":{"type":"object","properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"attempts":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Attempt"],"example":"Attempt"}]}}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"users":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GenericNotification"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/global-exam-templates":{"post":{"summary":"Create GlobalExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"GlobalExamTemplate","enum":["GlobalExamTemplate"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"lockedByDefault":{"type":"boolean","nullable":true},"ipAllowList":{"type":"array","items":{"type":"string"},"nullable":true},"resumeAllowed":{"type":"boolean","nullable":true},"resumeSameSession":{"type":"boolean","nullable":true},"passcodeEnabled":{"type":"boolean","nullable":true},"passcodeValue":{"type":"string","nullable":true},"hideFromCandidateList":{"type":"boolean","nullable":true},"allowedMode":{"type":"string","nullable":true},"allowedPlayers":{"type":"array","items":{"type":"string"},"nullable":true},"passFailEnabled":{"type":"boolean","nullable":true},"calculatorEnabled":{"type":"boolean","nullable":true},"calculatorType":{"type":"string","nullable":true},"notepadEnabled":{"type":"boolean","nullable":true},"resizableQuestionPanelsEnabled":{"type":"boolean","nullable":true},"strikethroughEnabled":{"type":"boolean","nullable":true},"highlightingEnabled":{"type":"boolean","nullable":true},"bookmarkingEnabled":{"type":"boolean","nullable":true},"flaggingEnabled":{"type":"boolean","nullable":true},"micEnabled":{"type":"boolean","nullable":true},"resumeLaterButtonEnabled":{"type":"boolean","nullable":true},"labValuesEnabled":{"type":"boolean","nullable":true},"labValuesHtml":{"type":"string","nullable":true},"additionalInformationEnabled":{"type":"boolean","nullable":true},"additionalInformationHtml":{"type":"string","nullable":true},"additionalInformationTitle":{"type":"string","nullable":true},"additionalInformationIcon":{"type":"string","nullable":true},"externalPlayerType":{"type":"string","nullable":true},"deferResultEnabled":{"type":"boolean","nullable":true},"deferResultAlwaysRelease":{"type":"boolean","nullable":true},"deferResultMessage":{"type":"string","nullable":true},"optionShuffling":{"type":"string","nullable":true},"questionShuffling":{"type":"string","nullable":true},"sectionShufflingEnabled":{"type":"boolean","nullable":true},"softSectionsEnabled":{"type":"boolean","nullable":true},"sectionGradesEnabled":{"type":"boolean","nullable":true},"advancedGradingEnabled":{"type":"boolean","nullable":true},"availableMarksEnabled":{"type":"boolean","nullable":true},"pinnedMessageDuringTest":{"type":"string","nullable":true},"excludeInformationalQuestionsFromCounts":{"type":"boolean","nullable":true},"timerEnabled":{"type":"boolean","nullable":true},"timerTimeInMs":{"type":"number","nullable":true},"timerUseSections":{"type":"boolean","nullable":true},"timerUseQuestions":{"type":"boolean","nullable":true},"timerEnforceFullTime":{"type":"boolean","nullable":true},"timerExtraTimeMultiplier":{"type":"number","nullable":true},"timerSoftTimer":{"type":"boolean","nullable":true},"disableCopying":{"type":"boolean","nullable":true},"disablePasting":{"type":"boolean","nullable":true},"disableRightClick":{"type":"boolean","nullable":true},"disableNavigation":{"type":"boolean","nullable":true},"disableControlPanel":{"type":"boolean","nullable":true},"disableNotifications":{"type":"boolean","nullable":true},"styleTheme":{"type":"string","nullable":true},"styleFontSize":{"type":"string","nullable":true},"creditsPerQuestion":{"type":"number","nullable":true},"enablePenalties":{"type":"boolean","nullable":true},"penaltiesPerQuestion":{"type":"number","nullable":true},"partialCreditsPerQuestion":{"type":"number","nullable":true},"grades":{"type":"array","nullable":true,"items":{"type":"object","required":["label","minScore"],"properties":{"label":{"type":"string"},"description":{"type":"string","nullable":true},"minScore":{"type":"number","nullable":true},"isPass":{"type":"boolean","nullable":true},"advancedCriteria":{"type":"object","nullable":true,"properties":{"sectionRequirements":{"type":"object","nullable":true,"properties":{"type":{"type":"string"},"count":{"type":"number","nullable":true},"sectionIds":{"type":"array","items":{"type":"string"},"nullable":true}}},"excludeFromResitAttempts":{"type":"boolean","nullable":true}}}}}},"instructionsEnabled":{"type":"boolean","nullable":true},"instructionsTitle":{"type":"string","nullable":true},"instructionsBody":{"type":"string","nullable":true},"instructionsTimerDurationMs":{"type":"number","nullable":true},"instructionsEnforcedTimer":{"type":"string","nullable":true},"instructionsAudioAutoAdvance":{"type":"string","nullable":true},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","minimum":0,"maximum":3600000,"nullable":true},"instructionsAudioAutoPlay":{"type":"boolean","nullable":true},"instructionsDisableAudioControls":{"type":"boolean","nullable":true},"resultDetailedViewEnabled":{"type":"boolean","nullable":true},"resultEducatorsViewAsAdminEnabled":{"type":"boolean","nullable":true},"resultHideResultsPage":{"type":"boolean","nullable":true},"resultGlobalHideScore":{"type":"boolean","nullable":true},"resultScoreEnabled":{"type":"boolean","nullable":true},"resultTimeSpentEnabled":{"type":"boolean","nullable":true},"resultGradeEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownGradeEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownScoreEnabled":{"type":"boolean","nullable":true},"resultQuestionBreakdownDisplay":{"type":"string","nullable":true},"resultAnalyticsCohort":{"type":"string","nullable":true},"resultCohortAverageEnabled":{"type":"boolean","nullable":true},"resultPercentileEnabled":{"type":"boolean","nullable":true},"resultScoreDistributionEnabled":{"type":"boolean","nullable":true},"resultTagBreakdownEnabled":{"type":"boolean","nullable":true},"resultProgressEnabled":{"type":"boolean","nullable":true},"resultFacetSubjectEnabled":{"type":"boolean","nullable":true},"resultFacetTopicEnabled":{"type":"boolean","nullable":true},"resultFacetSubtopicEnabled":{"type":"boolean","nullable":true},"resultFacetSkillEnabled":{"type":"boolean","nullable":true},"resultFacetDifficultyEnabled":{"type":"boolean","nullable":true},"resultMessagePassed":{"type":"string","nullable":true},"resultMessageFailed":{"type":"string","nullable":true},"resultMessageResitsRemaining":{"type":"string","nullable":true},"resultMessageNoResitsRemaining":{"type":"string","nullable":true},"resultMessageCompleted":{"type":"string","nullable":true},"resultMessageSettingHideTitle":{"type":"boolean","nullable":true},"resultHiddenMessage":{"type":"string","nullable":true},"resultHiddenSettingHideTitle":{"type":"boolean","nullable":true},"resultOverviewWhenPassedMessage":{"type":"string","nullable":true},"resultOverviewWhenFailedHasResitsMessage":{"type":"string","nullable":true},"resultOverviewWhenFailedNoResitsMessage":{"type":"string","nullable":true},"resultOverviewWhenCompleteNoGradesMessage":{"type":"string","nullable":true},"resultOverviewWhenCompletedNeutralGradesMessage":{"type":"string","nullable":true},"markingDoubleEnabled":{"type":"boolean","nullable":true},"markingDoubleAllocation":{"type":"string","nullable":true},"markingDoubleMinMarkers":{"type":"number","nullable":true},"markingDoubleSequence":{"type":"string","nullable":true},"markingBlindProvisionalMarker":{"type":"boolean","nullable":true},"markingBlindModeratingMarker":{"type":"boolean","nullable":true},"markingBlindEscalationMarker":{"type":"boolean","nullable":true},"markingBlindBackReadingMarker":{"type":"boolean","nullable":true},"markingBlindAuditingMarker":{"type":"boolean","nullable":true},"markingBlindIsolate":{"type":"boolean","nullable":true},"markerConcealmentProvisional":{"type":"boolean","nullable":true},"markerConcealmentModerating":{"type":"boolean","nullable":true},"markerConcealmentEscalation":{"type":"boolean","nullable":true},"markerConcealmentAuditing":{"type":"boolean","nullable":true},"markingEscalationEnabled":{"type":"boolean","nullable":true},"markingEscalationModeratorsCanEscalate":{"type":"boolean","nullable":true},"markingEscalationReasons":{"type":"array","nullable":true,"items":{"type":"object","required":["label","description"],"properties":{"slug":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}},"markingBackReadingEnabled":{"type":"boolean","nullable":true},"markingAuditingEnabled":{"type":"boolean","nullable":true},"markingResolutionEnabled":{"type":"boolean","nullable":true},"markingProvisionalMarkerAllocation":{"type":"string","nullable":true},"markingModeratingMarkerAllocation":{"type":"string","nullable":true},"markingEscalationMarkerAllocation":{"type":"string","nullable":true},"preExamInstructions":{"type":"string","nullable":true},"notificationAutomateEmails":{"type":"boolean","nullable":true},"notificationResultsEmailEnabled":{"type":"boolean","nullable":true},"certificatesEnabled":{"type":"boolean","nullable":true},"certificatesIssueOnFail":{"type":"boolean","nullable":true},"certificatesTemplateId":{"type":"string","nullable":true},"certificatesQrCode":{"type":"boolean","nullable":true},"certificatesResultsPage":{"type":"boolean","nullable":true},"certificatesTtl":{"type":"number","nullable":true},"certificatesIgnoreSubPortalBranding":{"type":"boolean","nullable":true},"certificatesSharingImageUrl":{"type":"string","nullable":true},"resitEnabled":{"type":"boolean","nullable":true},"resitType":{"type":"string","nullable":true},"resitMode":{"type":"string","nullable":true},"resitAllowedAttempts":{"type":"number","nullable":true},"resitGradeIndependent":{"type":"boolean","nullable":true},"resitDelay":{"type":"number","nullable":true},"resitCloseDelay":{"type":"number","nullable":true},"legalEnabled":{"type":"boolean","nullable":true},"legalConfirmationType":{"type":"string","nullable":true},"legalTitle":{"type":"string","nullable":true},"legalBody":{"type":"string","nullable":true},"legalCheckboxLabel":{"type":"string","nullable":true},"legalConfirmationStaticText":{"type":"string","nullable":true},"proctorEnabled":{"type":"boolean","nullable":true},"proctorVendor":{"type":"string","nullable":true},"proctorRequireFullscreen":{"type":"boolean","nullable":true},"proctorRestrictTabs":{"type":"boolean","nullable":true},"proctorRestrictDisplays":{"type":"boolean","nullable":true},"proctorWebcamMonitoring":{"type":"string","nullable":true},"proctorScreenMonitoring":{"type":"string","nullable":true},"proctorSynopticLevel":{"type":"string","nullable":true},"proctorScreenshotPrevention":{"type":"boolean","nullable":true},"proctorRecordSession":{"type":"boolean","nullable":true},"proctorRecordSnapshots":{"type":"boolean","nullable":true},"proctorRecordDesktop":{"type":"boolean","nullable":true},"proctorAiReview":{"type":"boolean","nullable":true},"proctorAiPrompts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true}}}},"proctorOnBreach":{"type":"string","nullable":true},"proctorReviewMode":{"type":"string","enum":["always","never","onBreach",null],"nullable":true},"proctorLiveProctoring":{"type":"boolean","nullable":true},"proctorBlockedApplicationsPolicy":{"type":"string","enum":["none","default",null],"nullable":true},"shuffleDynamicFilters":{"type":"boolean","nullable":true},"shuffleAllDynamicQuestions":{"type":"boolean","nullable":true},"dynamicTagSetId":{"type":"string","nullable":true},"dynamicVariationEnabled":{"type":"boolean","nullable":true},"dynamicVariantsMax":{"type":"number","nullable":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GlobalExamTemplate"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"Get GlobalExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"subPortal":{"type":"string"}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/GlobalExamTemplate"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/global-exam-templates/{object_id}":{"patch":{"summary":"Update GlobalExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GlobalExamTemplate"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GlobalExamTemplate"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete GlobalExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/highlights":{"post":{"summary":"Create Highlight","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Highlight","enum":["Highlight"]},"attributes":{"type":"object","properties":{"collectionItemId":{"type":"string","readOnly":false},"color":{"type":"string","readOnly":false},"range":{"type":"string","readOnly":false},"summary":{"type":"string","readOnly":false}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Highlight"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List Highlights","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"collectionItemId":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Highlight"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/highlights/{object_id}":{"get":{"summary":"Get Highlight","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Highlight"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Highlight","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Highlight"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Highlight"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete Highlight","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/ice-candidates/{object_id}":{"get":{"summary":"Get IceCandidate","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/IceCandidate"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/insights-tag-breakdowns":{"get":{"summary":"List InsightsTagBreakdowns","tags":["Insights"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","description":"Either provide cohort-based filters (cohort, targetId, timeFrameUnit, timeFrameAmount) or exam-based filters (examId, optional version). Both variants support tagSetId and tagBreakdowns.","properties":{"cohort":{"type":"string","enum":["user","portal","userGroup"],"description":"The type of cohort to filter the insights data by"},"type":{"type":"string","enum":["user","portal","userGroup"],"description":"The level to which the data is aggregated. This will default to match the cohort provided. Some combinations are not supported. For exam aggregating by usergroup for a whole portal"},"targetId":{"type":"string"},"timeFrameUnit":{"type":"string","enum":["days","weeks","months","years"]},"timeFrameAmount":{"type":"number","minimum":1},"examId":{"type":"string","description":"Filter by exam ID. When provided, cohort/targetId/timeFrame are not required."},"version":{"type":"string","pattern":"^[0-9]+$","description":"Exam version number. Only used with examId. Filters to a specific published version of the exam."},"versions":{"type":"array","items":{"type":"string","pattern":"^[0-9]+$"},"description":"Exam version numbers. Only used with examId. Filters to a merged set of published exam versions."},"tagSetId":{"type":"string","nullable":true},"tagBreakdowns":{"type":"array","items":{"type":"string","enum":["exam","module","subject","topic","subtopic","difficulty","skill","context"]}}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InsightsTagBreakdown"}},"meta":{"type":"object","properties":{"lastUpdated":{"type":"string","format":"date-time"}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/integrations":{"post":{"summary":"Create Integration","tags":["Integrations"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Integration","enum":["Integration"]},"attributes":{"type":"object","required":["credentials","vendorIdentifier"],"properties":{"credentials":{"type":"object","writeOnly":true,"description":"The credentials for the integration. Please check the docs for the desired Integration. Credentials are never returned - use `configuredCredentialKeys` and `publicCredentials` instead.","additionalProperties":{"type":"string"}},"configuredCredentialKeys":{"type":"array","readOnly":true,"description":"Names of the credential keys that are set on this integration, without their values.","items":{"type":"string"}},"publicCredentials":{"type":"object","readOnly":true,"description":"Credential values that the vendor publishes to browsers, e.g. a Stripe publishable key. Secrets are never included.","additionalProperties":{"type":"string"}},"vendorIdentifier":{"type":"string","enum":["rosalyn","skilljar","stripe"],"readOnly":false}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Integration"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/integrations/{object_id}":{"get":{"summary":"Get Integration","tags":["Integrations"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Integration"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Integration","tags":["Integrations"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Integration"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Integration"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete Integration","tags":["Integrations"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/invite-exports":{"post":{"summary":"Create InviteExport","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"InviteExport","enum":["InviteExport"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InviteExport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/invites":{"get":{"summary":"List Invites","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"search","in":"query","required":false,"allowReserved":true,"schema":{"type":"string"},"description":"Search for invites by email address or name."},{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"userGroup":{"type":"string"},"status":{"type":"array","items":{"type":"string","enum":["pending","accepted","cancelled","expired"]}}}}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["lastSent","-lastSent"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Invite"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/invites/{object_id}":{"get":{"summary":"Get Invite","tags":["Users"],"security":[],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Invite"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Invite","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Invite"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Invite"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/learning-record-exports":{"post":{"summary":"Create LearningRecordExport","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"LearningRecordExport","enum":["LearningRecordExport"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["user"],"properties":{"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LearningRecordExport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/learning-records":{"post":{"summary":"Create LearningRecord","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"LearningRecord","enum":["LearningRecord"]},"attributes":{"type":"object","required":["name","achievedOn","visibleToStudent"],"properties":{"name":{"type":"string","readOnly":false,"minLength":1},"score":{"type":"number","readOnly":false,"nullable":false,"minimum":0,"maximum":100},"achievedOn":{"type":"string"},"visibleToStudent":{"type":"boolean","readOnly":false},"attr":{"type":"object","readOnly":false,"default":{}}}},"relationships":{"type":"object","required":["owner"],"properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LearningRecord"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List LearningRecords","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"userId":{"type":"string"}}}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["_created_at","-_created_at","achievedOn","-achievedOn"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LearningRecord"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/learning-records/{object_id}":{"get":{"summary":"Get LearningRecord","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/LearningRecord"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update LearningRecord","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/LearningRecord"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LearningRecord"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete LearningRecord","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/legacy-access-upgrade-options":{"get":{"summary":"List LegacyAccessUpgradeOptions","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"collection":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LegacyAccessUpgradeOption"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/login-qr-code":{"get":{"summary":"Get App Login QR Code","tags":["Users"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/LoginQrCode"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}},"meta":{"type":"object","properties":{}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/manage-billing-sessions":{"post":{"summary":"Create ManageBillingSession","tags":["Billing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ManageBillingSession","enum":["ManageBillingSession"]},"attributes":{"type":"object","required":["type"],"properties":{"type":{"type":"string","readOnly":false,"enum":["manage-billing","manage-payment-sources","upgrade-trial"],"description":"The type of billing session to create. Use the `id` as the Chargebee token."},"chargebeeHostedPage":{"type":"object","readOnly":true,"nullable":true,"description":"Data used by the Chargebee hosted pages SDK to render the page. Only present if the type is not `manage-billing`."}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ManageBillingSession"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/marketing-consents":{"post":{"summary":"Create MarketingConsent","tags":["Users"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"MarketingConsent","enum":["MarketingConsent"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MarketingConsent"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/marketing-consents/{object_id}":{"delete":{"summary":"Delete MarketingConsent","tags":["Users"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/marking-entries":{"post":{"summary":"Create MarkingEntry","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingEntry","enum":["MarkingEntry"]},"attributes":{"type":"object","properties":{"rubricAreas":{"type":"array","items":{"type":"object"},"readOnly":true},"rubricMarks":{"type":"object","readOnly":false},"maxPoints":{"type":"number","readOnly":true},"points":{"type":"number","description":"The sum of credits and penalites.","readOnly":true,"nullable":true},"credits":{"type":"number","description":"The postivie credits awarded for the candidates answer","readOnly":false,"nullable":true},"penalties":{"type":"number","description":"The deduction of credits for the candidates answer","readOnly":false,"nullable":true},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"],"readOnly":true},"status":{"type":"string","enum":["pending","inProgress","submitted","completed","escalated","systemMarked"],"readOnly":false},"escalationReason":{"type":"object","properties":{"slug":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"comment":{"type":"string"}},"readOnly":false},"escalationResponse":{"type":"string","readOnly":false,"nullable":true},"disabled":{"type":"boolean","readOnly":true},"conflict":{"type":"boolean","readOnly":true},"timeMarked":{"type":"string","readOnly":true},"final":{"type":"boolean","readOnly":true},"candidateFeedback":{"type":"string","readOnly":false,"nullable":true},"notes":{"type":"string","readOnly":false,"nullable":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"candidate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"response":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Response","enum":["Response"]}}}}},"question":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}},"markingSession":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingSession","enum":["MarkingSession"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MarkingEntry"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List MarkingEntries","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"attempt":{"type":"string"},"response":{"type":"string"},"question":{"type":"string"}}}},{"name":"group","in":"query","required":true,"schema":{"anyOf":[{"type":"object","properties":{"markingSession":{"type":"string"}}},{"type":"object","properties":{"question":{"type":"string"},"role":{"type":"string"}}}]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MarkingEntry"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/marking-entries/{object_id}":{"patch":{"summary":"Update MarkingEntry","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MarkingEntry"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MarkingEntry"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/marking-sessions/{object_id}":{"get":{"summary":"Get MarkingSession","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/MarkingSession"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update MarkingSession","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MarkingSession"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MarkingSession"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/marking-sessions":{"get":{"summary":"List MarkingSessions","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","schema":{"type":"object","properties":{"role":{"type":"string"},"attempt":{"type":"string"},"owner":{"type":"string"},"exam":{"type":"string"},"marked":{"type":"boolean"},"mode":{"type":"string","enum":["question","attempt"]},"questionType":{"type":"array","items":{"type":"string","enum":["audioRecording","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"]}}}}},{"name":"search","in":"query","schema":{"type":"string"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["createdAt","-createdAt"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MarkingSession"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/marking-states":{"post":{"summary":"Create MarkingState","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingState","enum":["MarkingState"]},"attributes":{"type":"object","properties":{"status":{"type":"string"},"statusDetail":{"type":"object"},"provisionalScore":{"type":"number"}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MarkingState"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List MarkingStates","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"foo":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MarkingState"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/marking-states/{object_id}":{"get":{"summary":"Get MarkingState","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/MarkingState"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update MarkingState","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MarkingState"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MarkingState"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete MarkingState","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/mfa-activations":{"post":{"summary":"Activate MFA","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"MfaActivation","enum":["MfaActivation"]},"attributes":{"type":"object","properties":{"enabled":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MfaActivation"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/mfa-configs/{object_id}":{"get":{"summary":"Get MfaConfig","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/MfaConfig"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/mfa-configs":{"post":{"summary":"Create MFAConfig","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"MfaConfig","enum":["MfaConfig"]},"attributes":{"type":"object","properties":{"enabled":{"type":"boolean","readOnly":false},"qrCode":{"type":"string","readOnly":true},"recoveryCodes":{"type":"array","items":{"type":"string"},"readOnly":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MfaConfig"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/mfa-deactivations":{"post":{"summary":"Create MfaDeactivation","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"MfaDeactivation","enum":["MfaDeactivation"]},"attributes":{"type":"object","properties":{"code":{"type":"number","readOnly":false},"recoveryCode":{"type":"string","readOnly":false}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MfaDeactivation"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/mobile/attempts":{"post":{"summary":"Create MobileAttempt","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"MobileAttempt","enum":["MobileAttempt"]},"attributes":{"type":"object","properties":{"title":{"type":"string"},"status":{"type":"string"},"quizLength":{"type":"string"},"quizMode":{"type":"string"},"testId":{"type":"string"},"masteryLevels":{"type":"array","items":{"type":"string"},"nullable":true},"timeStarted":{"type":"string"},"timeCompleted":{"type":"string"},"timerEnabled":{"type":"boolean"},"timerDuration":{"type":"number"},"score":{"type":"number","nullable":true}}},"relationships":{"type":"object","properties":{"responses":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["MobileResponse"],"example":"MobileResponse"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileAttempt"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List MobileAttempts","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"owner":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MobileAttempt"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/mobile/attempts/{object_id}":{"get":{"summary":"Get MobileAttempt","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileAttempt"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update MobileAttempt","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MobileAttempt"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileAttempt"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/mobile/collection-items":{"post":{"summary":"Create MobileCollectionItem","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"MobileCollectionItem","enum":["MobileCollectionItem"]},"attributes":{"type":"object","properties":{"title":{"type":"string","nullable":false,"readOnly":true},"collectionItemType":{"type":"string","nullable":false,"readOnly":true,"enum":["audio","document","embed","note","quiz","video","zip"]},"description":{"type":"string","nullable":false,"readOnly":true},"imageUrl":{"type":"string","nullable":false,"readOnly":true},"isPreviewOnly":{"type":"boolean","nullable":false,"readOnly":true},"canStudy":{"type":"boolean","readOnly":true,"nullable":false}}},"relationships":{"type":"object","properties":{"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileQuiz","enum":["MobileQuiz"]}}}}},"note":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileNote","enum":["MobileNote"]}}}}},"audio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileAudioContent","enum":["MobileAudioContent"]}}}}},"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileDocumentContent","enum":["MobileDocumentContent"]}}}}},"embed":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileHtmlEmbedContent","enum":["MobileHtmlEmbedContent"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileCollectionItem"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List MobileCollectionItems","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"foo":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MobileCollectionItem"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/mobile/collection-items/{object_id}":{"get":{"summary":"Get MobileCollectionItem","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileCollectionItem"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update MobileCollectionItem","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MobileCollectionItem"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileCollectionItem"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete MobileCollectionItem","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/mobile/collections":{"get":{"summary":"List Collections","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MobileCollection"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/mobile/collections/{object_id}":{"get":{"summary":"Get Collection","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileCollection"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/mobile/config":{"get":{"summary":"Get the configuration the app needs before signing in","tags":["Mobile"],"security":[],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileConfig"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}},"meta":{"type":"object","properties":{}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/mobile/responses":{"get":{"summary":"List MobileResponses","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"foo":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MobileResponse"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/mobile/responses/{object_id}":{"get":{"summary":"Get MobileResponse","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileResponse"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update MobileResponse","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MobileResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/mobile/sessions/{object_id}":{"get":{"summary":"Get Session","tags":["Mobile"],"security":[],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileSession"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/mobile/spaced-learnings/{object_id}":{"get":{"summary":"Get MobileSpacedLearning","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileSpacedLearning"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update MobileSpacedLearning","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MobileSpacedLearning"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileSpacedLearning"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/mobile/spaced-learnings/{object_id}/relationships/study-items":{"post":{"summary":"Add MobileStudyItems","tags":["Mobile"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["MobileStudyItem"]}]}}}}}}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"delete":{"summary":"Remove MobileStudyItems","tags":["Mobile"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["MobileStudyItem"]}]}}}}}}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/mobile/users":{"post":{"summary":"Create MobileUser","tags":["Mobile"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"MobileUser","enum":["MobileUser"]},"attributes":{"type":"object","properties":{"name":{"type":"string","nullable":true,"readOnly":false},"emailAddress":{"type":"string","nullable":true,"readOnly":false},"profilePicture":{"type":"string","nullable":true,"readOnly":false},"timeZone":{"type":"string","nullable":true,"readOnly":false},"portalId":{"type":"string","nullable":true,"readOnly":false},"attemptCount":{"type":"number","nullable":true},"questionsAnswered":{"type":"number","nullable":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileUser"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/mobile/users/{object_id}":{"get":{"summary":"Get MobileUser","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/MobileUser"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/notes/{object_id}":{"get":{"summary":"Get Note","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Note"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"delete":{"summary":"Delete Note","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"patch":{"summary":"Update Note","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Note"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Note"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/notes":{"post":{"summary":"Create Note","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Note","enum":["Note"]},"attributes":{"type":"object","required":["title"],"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"slug":{"type":"string","readOnly":true},"privacy":{"type":"string","readOnly":false},"description":{"type":"string","readOnly":false},"shortDescription":{"type":"string","readOnly":false},"body":{"type":"string","readOnly":false},"isArchived":{"type":"boolean","readOnly":true},"isLegalDoc":{"type":"boolean","readOnly":false},"isLibraryItem":{"type":"boolean","readOnly":false,"default":true},"settings":{"deprecated":true,"description":"Deprecated. Use settingsDisplaySize and settingsPaddingEnabled instead.","type":"object","readOnly":false},"settingsDisplaySize":{"type":"string","readOnly":false,"enum":["narrow","fullWidth"]},"settingsPaddingEnabled":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Note"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/notes/{object_id}/relationships/collaborating-users":{"post":{"summary":"Add Note Collaborating Users","description":"Add users as collaborators to this note. The request body should contain an array of User resource identifier objects.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove Note Collaborating Users","description":"Remove users as collaborators from this note. The request body should contain an array of User resource identifier objects to remove.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/notes/{object_id}/relationships/collaborating-user-groups":{"post":{"summary":"Add Note Collaborating User Groups","description":"Add user groups as collaborators to this note. The request body should contain an array of UserGroup resource identifier objects.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove Note Collaborating User Groups","description":"Remove user groups as collaborators from this note. The request body should contain an array of UserGroup resource identifier objects to remove.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/notification-groups":{"get":{"summary":"List NotificationGroups","tags":["Notifications"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"type":{"type":"string","enum":["portal","user"]}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NotificationGroup"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/passkey-authentication-options":{"post":{"summary":"Create PasskeyAuthenticationOptions","description":"Public endpoint that starts a passkey login ceremony for the portal resolved from the request hostname. Takes no request body.","tags":["Authentication"],"parameters":[],"security":[],"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PasskeyAuthenticationOptions"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"403":{"description":"Passkeys are not enabled for this portal or origin","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"No portal resolved from the request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/passkey-authentications":{"post":{"summary":"Create PasskeyAuthentication","description":"Public endpoint that completes a passkey login from a WebAuthn assertion (challengeId + response). A verified assertion is user-verified, so it satisfies MFA on its own.","tags":["Authentication"],"parameters":[],"security":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"PasskeyAuthentication","enum":["PasskeyAuthentication"]},"attributes":{"type":"object","properties":{"challengeId":{"type":"string","writeOnly":true},"response":{"type":"object","writeOnly":true,"additionalProperties":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"The login outcome, with a session token on success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PasskeyAuthentication"}}}}}},"400":{"description":"Malformed request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"The passkey could not be verified","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}}}},"application/vnd.api+json":{"schema":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}}}}}},"404":{"description":"No portal resolved from the request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/passkey-enrolment-deferrals":{"post":{"summary":"Create PasskeyEnrolmentDeferral","description":"Snoozes the passkey enrolment prompt for the caller for 7 days. Takes no request body.","tags":["Authentication"],"parameters":[],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PasskeyEnrolmentDeferral"}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}}}}},"/passkey-registration-options":{"post":{"summary":"Create PasskeyRegistrationOptions","description":"Starts a passkey registration ceremony. Requires the current password as fresh re-authentication.","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"PasskeyRegistrationOptions","enum":["PasskeyRegistrationOptions"]},"attributes":{"type":"object","required":["password"],"properties":{"password":{"type":"string","writeOnly":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PasskeyRegistrationOptions"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/passkey-revocations":{"post":{"summary":"Create PasskeyRevocation","description":"Revokes one of the caller’s passkeys. Requires the current password as fresh re-authentication.","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"PasskeyRevocation","enum":["PasskeyRevocation"]},"attributes":{"type":"object","required":["passkeyId","password"],"properties":{"passkeyId":{"type":"string","readOnly":false},"password":{"type":"string","writeOnly":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PasskeyRevocation"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/passkeys":{"get":{"summary":"List the caller's Passkeys","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Passkey"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}},"post":{"summary":"Create Passkey (verify a WebAuthn registration response)","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Passkey","enum":["Passkey"]},"attributes":{"type":"object","required":["challengeId","response"],"properties":{"name":{"type":"string","maxLength":64,"readOnly":false},"challengeId":{"type":"string","writeOnly":true},"response":{"type":"object","writeOnly":true,"additionalProperties":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Passkey"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/passkeys/{object_id}":{"patch":{"summary":"Update Passkey (rename)","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Passkey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Passkey"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/password-reset-requests":{"post":{"summary":"Create PasswordResetRequest","tags":["Users"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"PasswordResetRequest","enum":["PasswordResetRequest"]},"attributes":{"type":"object","required":["emailAddress"],"properties":{"emailAddress":{"type":"string","readOnly":false},"instant":{"type":"boolean","description":"Resets password immediately. Only available to admins.","readOnly":false},"newPassword":{"type":"string","description":"New password for the user. Only available if instant is true.","readOnly":true}}},"relationships":{"type":"object","properties":{"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PasswordResetRequest"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/password-resets":{"post":{"summary":"Create PasswordReset","tags":["Users"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"PasswordReset","enum":["PasswordReset"]},"attributes":{"type":"object","required":["emailAddress"],"properties":{"emailAddress":{"type":"string","readOnly":false},"instant":{"type":"boolean","description":"Resets password immediately. Only available to admins.","readOnly":false},"newPassword":{"type":"string","description":"The users new password.","readOnly":true}}},"relationships":{"type":"object","properties":{"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PasswordReset"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/password-resets/{object_id}":{"get":{"summary":"Get PasswordReset","tags":["Users"],"security":[],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PasswordReset"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PasswordReset","tags":["Users"],"security":[],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PasswordReset"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PasswordReset"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/pdf-annotations":{"post":{"summary":"Create or Update PDF Annotation","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"PdfAnnotation","enum":["PdfAnnotation"]},"attributes":{"type":"object","properties":{"collectionItemId":{"type":"string","readOnly":false},"pageNumber":{"type":"integer","readOnly":false},"body":{"type":"object","description":"JSON blob containing strokes and text annotations for the page","properties":{"strokes":{"type":"array","items":{"type":"object","properties":{"points":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}}}},"color":{"type":"string"},"width":{"type":"number"},"mode":{"type":"string","enum":["pen","highlighter","eraser"]},"textSnapMode":{"type":"boolean"},"textSnapData":{"type":"object","properties":{"baseline":{"type":"number"},"height":{"type":"number"},"lineEndX":{"type":"number"}}}}}},"textAnnotations":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"text":{"type":"string"},"color":{"type":"string"},"fontSize":{"type":"number"}}}},"pageWidth":{"type":"number"},"pageHeight":{"type":"number"}}}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PdfAnnotation"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List PDF Annotations","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","required":["collectionItem"],"properties":{"collectionItem":{"type":"string","description":"The collection item ID to filter by"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PdfAnnotation"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/pdf-annotations/{object_id}":{"get":{"summary":"Get PDF Annotation","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PdfAnnotation"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"delete":{"summary":"Delete PDF Annotation","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/personal-access-tokens":{"post":{"summary":"Create PersonalAccessToken","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"PersonalAccessToken","enum":["PersonalAccessToken"]},"attributes":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":100,"readOnly":false},"createdAt":{"type":"string","readOnly":true},"lastUsedAt":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PersonalAccessToken"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List PersonalAccessTokens","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PersonalAccessToken"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/personal-access-tokens/{object_id}":{"patch":{"summary":"Update PersonalAccessToken","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PersonalAccessToken"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PersonalAccessToken"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete PersonalAccessToken","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-attempts/{object_id}":{"get":{"summary":"Get PlayerAttempt","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerAttempt"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerAttempt","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerAttempt"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerAttempt"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete PlayerAttempt","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-audio-responses/{object_id}":{"get":{"summary":"Get PlayerAudioResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerAudioResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerAudioResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerAudioResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerAudioResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-cloze-drag-and-drop-responses/{object_id}":{"get":{"summary":"Get PlayerClozeDragAndDropResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerClozeDragAndDropResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerClozeDragAndDropResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerClozeDragAndDropResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerClozeDragAndDropResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-cloze-drop-down-responses/{object_id}":{"get":{"summary":"Get PlayerClozeDropDownResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerClozeDropDownResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerClozeDropDownResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerClozeDropDownResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerClozeDropDownResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-cloze-text-responses/{object_id}":{"get":{"summary":"Get PlayerClozeTextResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerClozeTextResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerClozeTextResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerClozeTextResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerClozeTextResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-drawing-responses/{object_id}":{"get":{"summary":"Get PlayerDrawingResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerDrawingResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerDrawingResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerDrawingResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerDrawingResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-emq-groups/{object_id}":{"get":{"summary":"Get PlayerEmqGroup","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerEmqGroup"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerEmqGroup","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerEmqGroup"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerEmqGroup"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-file-upload-responses/{object_id}":{"get":{"summary":"Get PlayerFileUploadResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerFileUploadResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerFileUploadResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerFileUploadResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerFileUploadResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-flashcard-responses/{object_id}":{"get":{"summary":"Get PlayerFlashcardResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerFlashcardResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerFlashcardResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerFlashcardResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerFlashcardResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-free-text-responses/{object_id}":{"get":{"summary":"Get PlayerFreeTextResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerFreeTextResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerFreeTextResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerFreeTextResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerFreeTextResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-image-hotspot-responses/{object_id}":{"get":{"summary":"Get PlayerImageHotspotResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerImageHotspotResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerImageHotspotResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerImageHotspotResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerImageHotspotResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-informational-responses/{object_id}":{"get":{"summary":"Get PlayerInformationalResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerInformationalResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerInformationalResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerInformationalResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerInformationalResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-multiple-choice-responses/{object_id}":{"get":{"summary":"Get PlayerMultipleChoiceResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerMultipleChoiceResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerMultipleChoiceResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerMultipleChoiceResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerMultipleChoiceResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-off-platform-responses/{object_id}":{"get":{"summary":"Get PlayerOffPlatformResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerOffPlatformResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerOffPlatformResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerOffPlatformResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerOffPlatformResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-ranked-responses/{object_id}":{"get":{"summary":"Get PlayerRankedResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerRankedResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerRankedResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerRankedResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerRankedResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-sections/{object_id}":{"get":{"summary":"Get PlayerSection","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerSection"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerSection","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerSection"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerSection"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-short-answer-responses/{object_id}":{"get":{"summary":"Get PlayerShortAnswerResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerShortAnswerResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerShortAnswerResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerShortAnswerResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerShortAnswerResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-single-choice-responses/{object_id}":{"get":{"summary":"Get PlayerSingleChoiceResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerSingleChoiceResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerSingleChoiceResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerSingleChoiceResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerSingleChoiceResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-spreadsheet-responses/{object_id}":{"get":{"summary":"Get PlayerSpreadsheetResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerSpreadsheetResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerSpreadsheetResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerSpreadsheetResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerSpreadsheetResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-true-or-false-responses/{object_id}":{"get":{"summary":"Get PlayerTrueOrFalseResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerTrueOrFalseResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerTrueOrFalseResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerTrueOrFalseResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerTrueOrFalseResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/player-video-responses/{object_id}":{"get":{"summary":"Get PlayerVideoResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerVideoResponse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PlayerAudioResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerVideoResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerVideoResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/portal-stores":{"post":{"summary":"Create PortalStore","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"PortalStore","enum":["PortalStore"]},"attributes":{"type":"object","properties":{"name":{"type":"string","minLength":1,"readOnly":false},"description":{"type":"string","nullable":true,"readOnly":false},"pageControls":{"type":"object","readOnly":false},"requiresAuth":{"type":"boolean","readOnly":false},"headerTitle":{"type":"string","nullable":true,"readOnly":false},"headerSubtitle":{"type":"string","nullable":true,"readOnly":false},"headerImageUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"headerCoverImageUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"headerCoverImageBackground":{"type":"string","nullable":true,"readOnly":false},"headerTextColour":{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$","nullable":true,"readOnly":false}}},"relationships":{"type":"object","properties":{"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PortalStore"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List PortalStores","tags":["Shop"],"security":[],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"subPortal":{"description":"Only return stores belonging to this sub-portal.","type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PortalStore"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/portal-stores/{object_id}":{"get":{"summary":"Get PortalStore","tags":["Shop"],"security":[],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PortalStore"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update PortalStore","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PortalStore"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PortalStore"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete PortalStore","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/portal-usage/{object_id}":{"get":{"summary":"Get PortalUsage","tags":["Billing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PortalUsage"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/portals":{"post":{"summary":"Create Portal","tags":["Portals"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","enum":["CreatePortal"]},"attributes":{"type":"object","required":["sig","name","subdomain","userData"],"properties":{"sig":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":100},"subdomain":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[A-Za-z0-9-]+$"},"userData":{"type":"object","required":["name","email","password"],"properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"},"password":{"type":"string","minLength":8},"marketingEmailsConsent":{"type":"string"},"extraInformation":{"type":"object","additionalProperties":true},"cfAttributes":{"type":"object","additionalProperties":{"type":"string"}}}},"subscriptionSetup":{"type":"object","required":["externalPlanId"],"properties":{"externalPlanId":{"type":"string"},"discountCode":{"type":"string"},"cbCardToken":{"type":"string"},"cbCardCountry":{"type":"string"}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Portal"},"meta":{"type":"object","properties":{"sessionToken":{"type":"string"}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/portals/current":{"get":{"summary":"Get Portal","tags":["Portals"],"security":[],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Portal"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Portal","tags":["Portals"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Portal"}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/portals/{object_id}/relationships/owner":{"patch":{"summary":"Transfer Portal Owner","description":"Transfer ownership of the portal to another admin user. The caller must be the current portal owner.","tags":["Portals"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/proctor-captures":{"get":{"summary":"List ProctorCaptures","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"attempt":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProctorCapture"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/proctor-event-logs":{"get":{"summary":"List ProctorEventLogs","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"sessionId":{"type":"string","deprecated":true},"attempt":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProctorEventLog"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/proctor-reviews":{"get":{"summary":"List ProctorReviews","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"attempt":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProctorReview"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}},"post":{"summary":"Create ProctorReview","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ProctorReview","enum":["ProctorReview"]},"attributes":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"body":{"type":"string","readOnly":false},"action":{"type":"string","readOnly":false},"timestamp":{"type":"string","readOnly":true},"anchoredAt":{"type":"string","format":"date-time","readOnly":false}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProctorReview"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/proctor-reviews/{object_id}":{"patch":{"summary":"Update ProctorReview","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["ProctorReview"]},"attributes":{"type":"object","required":["body"],"additionalProperties":false,"properties":{"body":{"type":"string","minLength":1,"pattern":"\\S"}}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProctorReview"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete ProctorReview","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/proctor-sessions/{object_id}":{"get":{"summary":"Get ProctorSession","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProctorSession"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/proctor-sessions":{"post":{"summary":"Create ProctorSession","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ProctorSession","enum":["ProctorSession"]},"attributes":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"sessionId":{"type":"string","readOnly":true},"token":{"type":"string","readOnly":true},"enabled":{"type":"boolean","readOnly":true},"breaches":{"type":"number","readOnly":true},"requiresReview":{"type":"boolean","readOnly":true},"isApproved":{"type":"boolean","readOnly":true},"url":{"type":"string","readOnly":true},"isFinalised":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProctorSession"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/product-lists":{"post":{"summary":"Create ProductList","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ProductList","enum":["ProductList"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"description":{"type":"string","readOnly":false,"nullable":true}}},"relationships":{"type":"object","properties":{"products":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Product"],"example":"Product"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProductList"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List ProductLists","tags":["Shop"],"security":[],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductList"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/product-lists/{object_id}":{"get":{"summary":"Get ProductList","tags":["Shop"],"security":[],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProductList"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update ProductList","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ProductList"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProductList"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete ProductList","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/product-lists/{object_id}/relationships/products":{"post":{"summary":"Add Products","tags":["Shop"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Product"]}]}}}}}}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Set Products","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Product"],"example":"Product"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove Products","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Product"]}]}}}}}}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/products":{"post":{"summary":"Create Product","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Product","enum":["Product"]},"attributes":{"type":"object","required":["title","productIdentifier","purchaseMethod"],"allOf":[{"not":{"allOf":[{"required":["defaultCurrency"],"properties":{"defaultCurrency":{"enum":["gbp"]}}},{"required":["prices"],"properties":{"prices":{"type":"array","items":{"not":{"required":["currency"],"properties":{"currency":{"enum":["gbp"]}}}}}}}]}},{"not":{"allOf":[{"required":["defaultCurrency"],"properties":{"defaultCurrency":{"enum":["eur"]}}},{"required":["prices"],"properties":{"prices":{"type":"array","items":{"not":{"required":["currency"],"properties":{"currency":{"enum":["eur"]}}}}}}}]}},{"not":{"allOf":[{"required":["defaultCurrency"],"properties":{"defaultCurrency":{"enum":["usd"]}}},{"required":["prices"],"properties":{"prices":{"type":"array","items":{"not":{"required":["currency"],"properties":{"currency":{"enum":["usd"]}}}}}}}]}}],"properties":{"title":{"type":"string","readOnly":false},"isActive":{"type":"boolean","readOnly":false},"productIdentifier":{"type":"string","description":"Internal reference for the product, unique within the portal.","readOnly":false},"description":{"type":"string","nullable":true,"readOnly":false},"shortDescription":{"type":"string","nullable":true,"readOnly":false},"purchaseMethod":{"type":"string","enum":["product","free"],"readOnly":false},"requirements":{"type":"array","readOnly":false,"nullable":true,"maxItems":5,"items":{"type":"object","properties":{"type":{"type":"string","enum":["promoCode","storeOffer"]},"promoCode":{"type":"object","nullable":true,"required":["prefix"],"properties":{"prefix":{"type":"string"},"redemptions":{"type":"number"}}},"storeOffer":{"type":"object","nullable":true,"properties":{"id":{"type":"string"}}},"message":{"type":"string","description":"Store signposting message for the requirement.","readOnly":true,"nullable":true}}}},"unlockActions":{"type":"array","readOnly":false,"items":{"type":"object","properties":{"type":{"type":"string","enum":["userGroup","collection"]},"targetId":{"type":"string","nullable":true},"accessLevel":{"type":"string","nullable":true,"enum":["full","restricted"]},"config":{"type":"object","nullable":true},"fullAccessProductIdentifier":{"type":"string","nullable":true}}}},"marketingFeatures":{"type":"object","readOnly":false,"nullable":true,"required":["items"],"properties":{"heading":{"type":"string","nullable":true},"items":{"type":"array","maxItems":15,"items":{"type":"object","required":["label"],"not":{"allOf":[{"required":["iconUrl"],"properties":{"iconUrl":{"type":"string"}}},{"required":["icon"],"properties":{"icon":{"type":"string"}}}]},"properties":{"label":{"type":"string","minLength":1,"maxLength":200},"iconUrl":{"type":"string","description":"Uploaded custom image.","nullable":true},"icon":{"type":"string","description":"Picked icon class, an alternative to `iconUrl`.","minLength":1,"maxLength":60,"pattern":"^[a-z0-9]+(?: [a-z0-9]+)*$","nullable":true},"iconColour":{"type":"string","description":"Foreground colour of `icon`.","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$","nullable":true},"backgroundColour":{"type":"string","description":"Tint behind the icon.","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$","nullable":true}}}}}},"allowPromoCodes":{"type":"boolean","readOnly":false},"prices":{"type":"array","readOnly":false,"nullable":true,"description":"At most one price per currency; currency identifies a price within its product.","maxItems":3,"items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"string","enum":["gbp","eur","usd"]},"amount":{"type":"integer","description":"Minor units, e.g. 47500 for £475.00. At least 100 — one whole unit of the currency.","minimum":100},"taxBehavior":{"type":"string","description":"Whether `amount` already includes tax.","enum":["inclusive","exclusive",null],"nullable":true}}}},"defaultCurrency":{"type":"string","description":"Currency the storefront offers first. Must match one of `prices`.","enum":["gbp","eur","usd",null],"nullable":true,"readOnly":false},"amount":{"type":"number","nullable":true,"readOnly":true},"priceTag":{"type":"string","nullable":true,"readOnly":true},"currency":{"type":"string","nullable":true,"readOnly":true},"skuId":{"type":"string","nullable":true,"readOnly":true},"checkoutConfig":{"type":"object","nullable":true,"readOnly":true,"properties":{"type":{"type":"string","enum":["chargebee","stripe"]},"appId":{"type":"string","nullable":true},"publicKey":{"type":"string","nullable":true}},"required":["type"]},"isCheckoutConfigured":{"type":"boolean","description":"Whether the payment route this product needs is in place: always true for a free product, and for a paid one only while the portal holds usable Stripe integration credentials. Says nothing about the product being priced.","readOnly":true},"accessDetails":{"type":"object","nullable":true,"readOnly":true,"properties":{"accessUntilDate":{"type":"string","format":"date-time"},"accessLengthInMonths":{"type":"number","format":"int32","minimum":1,"nullable":true}},"required":["accessUntilDate"]}}},"relationships":{"type":"object","required":["coverImage"],"properties":{"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Product"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List Products","tags":["Shop"],"security":[],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"isActive":{"type":"boolean"},"productList":{"type":"string"},"productIdentifier":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/products/{object_id}":{"get":{"summary":"Get Product","tags":["Shop"],"security":[],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Product"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Product","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Product"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Product"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete Product","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/public-attribute-configs":{"get":{"summary":"List PublicAttributeConfigs","tags":["Content Metadata"],"security":[],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicAttributeConfig"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/public-authentication-options":{"get":{"summary":"List PublicAuthenticationOptions","tags":["Authentication"],"security":[],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicAuthenticationOption"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/public-certificates":{"get":{"summary":"List PublicCertificates","tags":["Certificates"],"security":[],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","required":["attempt","certificateHash"],"properties":{"attempt":{"type":"string"},"certificateHash":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicCertificate"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/question-exports":{"post":{"summary":"Create QuestionExport","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuestionExport","enum":["QuestionExport"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["quiz"],"properties":{"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuestionExport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/question-import-validations":{"post":{"summary":"Create QuestionImportValidation","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuestionImportValidation","enum":["QuestionImportValidation"]},"attributes":{"type":"object","properties":{"newTags":{"type":"number","readOnly":false},"toCreate":{"type":"number","readOnly":false},"toUpdate":{"type":"number","readOnly":false},"toDelete":{"type":"number","readOnly":false},"appendToTest":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuestionImportValidation"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/question-imports":{"post":{"summary":"Create QuestionImport","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuestionImport","enum":["QuestionImport"]},"attributes":{"type":"object","properties":{"csvUrl":{"type":"string","readOnly":false},"fieldMap":{"type":"object","readOnly":false},"appendToTest":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"backgroundJob":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BackgroundJob","enum":["BackgroundJob"]}}}}},"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuestionImport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/question-summaries":{"get":{"summary":"List QuestionSummaries","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","required":["targetId","targetType"],"properties":{"targetId":{"type":"string"},"targetType":{"type":"string","enum":["test","collection","collectionItem","userStudying"]}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/QuestionSummary"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/quiz-attempt-setup-configs":{"get":{"summary":"List QuizAttemptSetupConfigs","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","required":["source"],"properties":{"source":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["collection","assignment","study"]},"id":{"type":"string"}}}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/QuizAttemptSetupConfig"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/quiz-attempt-setup-configs/{object_id}":{"get":{"summary":"Get QuizAttemptSetupConfig","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizAttemptSetupConfig"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-emq-groups":{"post":{"summary":"Create QuizEmqGroup","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"label":{"type":"string","readOnly":false,"minLength":1,"maxLength":300},"instructionsBody":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":100000},"feedback":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"audioPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioAutoPlay":{"type":"boolean","readOnly":false,"nullable":false},"hideQuestionStem":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","required":["quiz"],"properties":{"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"audioInstructions":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizEmqGroup"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-emq-groups/{object_id}":{"get":{"summary":"Get QuizEmqGroup","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizEmqGroup"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizEmqGroup","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizEmqGroup"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizEmqGroup"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizEmqGroup","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-emq-groups/{object_id}/relationships/questions":{"patch":{"summary":"Update quiz section questions.","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestionAudioRecording","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionFileUpload","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionSingleCorrect","QuizQuestionShortAnswer","QuizQuestionVideoRecording","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestionAudioRecording"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-pdf-attempt-exports":{"post":{"summary":"Create QuizPdfAttemptExport","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizPdfAttemptExport","enum":["QuizPdfAttemptExport"]},"attributes":{"type":"object","required":["archetype"],"properties":{"archetype":{"type":"string","enum":["questionPaper","transcript"],"description":"Selects the document produced. questionPaper never includes candidate responses or answers; transcript includes the candidate’s own submitted responses."},"answerBooklet":{"type":"boolean","nullable":true,"description":"questionPaper only. Adds ruled writing space after each question."},"anonymiseCandidate":{"type":"boolean","nullable":true,"description":"Suppresses candidate identity on the cover page."},"withMarks":{"type":"boolean","nullable":true,"description":"transcript only. Includes achieved marks and per-question outcomes."},"withCorrectOptions":{"type":"boolean","nullable":true,"description":"transcript only. Includes correct answers. Output is watermarked as not for candidate release."},"fontSizePt":{"type":"number","enum":[11,15,18]},"fontFamily":{"type":"string","enum":["sans-serif","serif"]}}},"relationships":{"type":"object","required":["attempt"],"properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizPdfAttemptExport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-pdf-exports":{"post":{"summary":"Create QuizPdfExport","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizPdfExport","enum":["QuizPdfExport"]},"attributes":{"type":"object","properties":{"answerMode":{"type":"string","enum":["inline","answerKey","none"]},"answerBooklet":{"type":"boolean"},"fontSizePt":{"type":"number","enum":[11,15,18]},"fontFamily":{"type":"string","enum":["sans-serif","serif"]}}},"relationships":{"type":"object","required":["quiz"],"properties":{"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizPdfExport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-audio-recording":{"post":{"summary":"Create QuizQuestionAudioRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionAudioRecording","enum":["QuizQuestionAudioRecording"]},"attributes":{"type":"object","required":["inputLabel"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["audioRecording"]},"inputLabel":{"type":"string","readOnly":false,"maxLength":30000},"audioRecordingMaximumTimeMs":{"type":"number","readOnly":false,"minimum":1,"maximum":3600000,"default":3600000},"audioRecordingAllowDelete":{"type":"boolean","readOnly":false,"default":true},"audioRecordingAllowReRecord":{"type":"boolean","readOnly":false,"default":true},"audioRecordingAllowPause":{"type":"boolean","readOnly":false,"default":true},"audioRecordingAllowEarlySubmission":{"type":"boolean","readOnly":false,"default":true},"audioRecordingAutoRecording":{"type":"boolean","readOnly":false,"default":false},"audioRecordingAutoRecordingDelayMs":{"type":"number","readOnly":false,"minimum":0,"maximum":3600000,"default":0},"audioRecordingAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","afterAudioCompletion"],"default":"disabled"},"audioRecordingAutoAdvanceDelayMs":{"type":"number","readOnly":false,"minimum":0,"maximum":3600000,"default":0}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionAudioRecording"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionAudioRecording","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-audio-recording/{object_id}":{"get":{"summary":"Get QuizQuestionAudioRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionAudioRecording"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionAudioRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionAudioRecording"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionAudioRecording"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionAudioRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-cloze-drag-and-drop":{"post":{"summary":"Create QuizQuestionClozeDragAndDrop","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionClozeDragAndDrop","enum":["QuizQuestionClozeDragAndDrop"]},"attributes":{"type":"object","required":["clozeTemplate","blanks","possibleResponses"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["clozeDragAndDrop"]},"clozeTemplate":{"type":"string","readOnly":false,"minLength":1},"scoring":{"type":"string","enum":["exactMatch","partialMatch","matchPerBlank"],"default":"exactMatch"},"pointPerBlank":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"canReusePossibleResponses":{"type":"boolean","readOnly":false},"shareCorrectResponses":{"type":"boolean","readOnly":false},"blanks":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","readOnly":false},"correctResponseKey":{"type":"string","readOnly":false}}}},"possibleResponses":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","readOnly":false},"value":{"type":"string","readOnly":false},"credits":{"type":"array","items":{"type":"object","properties":{"blankKey":{"type":"string","readOnly":false},"value":{"type":"number","minimum":0,"readOnly":false}}},"readOnly":false,"nullable":true,"minItems":1},"penalties":{"type":"array","items":{"type":"object","properties":{"blankKey":{"type":"string","readOnly":false},"value":{"type":"number","minimum":0,"readOnly":false}}},"readOnly":false,"nullable":true,"minItems":1}}}},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"],"default":"disabled"},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false,"nullable":true}},"anyOf":[{"description":"canReusePossibleResponses can be false when shareCorrectResponses is true","properties":{"canReusePossibleResponses":{"enum":[false]},"shareCorrectResponses":{"enum":[true]}}},{"description":"shareCorrectResponses can be false when canReusePossibleResponses is true","properties":{"canReusePossibleResponses":{"enum":[true]},"shareCorrectResponses":{"enum":[false]}}},{"description":"both canReusePossibleResponses and shareCorrectResponses can be false","properties":{"canReusePossibleResponses":{"enum":[false]},"shareCorrectResponses":{"enum":[false]}}}]},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClozeDragAndDrop"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionClozeDragAndDrop","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-cloze-drag-and-drop/{object_id}":{"get":{"summary":"Get QuizQuestionClozeDragAndDrop","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClozeDragAndDrop"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionClozeDragAndDrop","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClozeDragAndDrop"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClozeDragAndDrop"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionClozeDragAndDrop","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-cloze-drop-down":{"post":{"summary":"Create QuizQuestionClozeDropDown","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionClozeDropDown","enum":["QuizQuestionClozeDropDown"]},"attributes":{"type":"object","required":["clozeTemplate","blanks"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["clozeDropDown"]},"clozeTemplate":{"type":"string","readOnly":false,"minLength":1},"scoring":{"type":"string","enum":["exactMatch","partialMatch","matchPerBlank"],"default":"exactMatch"},"pointPerBlank":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"blanks":{"type":"array","minItems":1,"items":{"type":"object","properties":{"key":{"type":"string","readOnly":false},"possibleResponses":{"type":"array","minItems":1,"items":{"type":"object","properties":{"isCorrect":{"type":"boolean","readOnly":false},"value":{"type":"string","readOnly":false},"credits":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"penalties":{"type":"number","readOnly":false,"nullable":true,"minimum":0}}}}}}},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"],"default":"disabled"},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false,"nullable":true}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClozeDropDown"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionClozeDropDown","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-cloze-drop-down/{object_id}":{"get":{"summary":"Get QuizQuestionClozeDropDown","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClozeDropDown"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionClozeDropDown","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClozeDropDown"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClozeDropDown"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionClozeDropDown","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-cloze-text":{"post":{"summary":"Create QuizQuestionClozeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionClozeText","enum":["QuizQuestionClozeText"]},"attributes":{"type":"object","required":["clozeTemplate","blanks"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["clozeText"]},"clozeTemplate":{"type":"string","readOnly":false,"minLength":1},"scoring":{"type":"string","enum":["exactMatch","partialMatch","matchPerBlank"],"default":"exactMatch"},"pointPerBlank":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"blanks":{"type":"array","minItems":1,"items":{"type":"object","properties":{"key":{"type":"string","readOnly":false},"type":{"type":"string","readOnly":false,"enum":["text","number"]},"possibleResponses":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"properties":{"value":{"anyOf":[{"type":"string","readOnly":false},{"type":"object","required":["min","max"],"properties":{"min":{"type":"number","readOnly":false},"max":{"type":"number","readOnly":false}},"readOnly":false}]},"credits":{"type":"number","readOnly":false,"nullable":true,"minimum":0}},"readOnly":false}}}}},"caseMatch":{"type":"boolean","readOnly":false,"default":false},"disableSpellcheck":{"type":"boolean","readOnly":false,"default":false},"decimalEnforcement":{"type":"number","readOnly":false,"nullable":true,"enum":[0,1,2,3,4,5,null]},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markingAllowManualMarkingForUnmatchedResponses":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClozeText"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionClozeText","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-cloze-text/{object_id}":{"get":{"summary":"Get QuizQuestionClozeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClozeText"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionClozeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClozeText"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClozeText"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionClozeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-drawing":{"post":{"summary":"Create QuizQuestionDrawing","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionDrawing","enum":["QuizQuestionDrawing"]},"attributes":{"type":"object","required":["stem"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["drawing"]},"eraserEnabled":{"type":"boolean","readOnly":false,"nullable":true},"colourPickerEnabled":{"type":"boolean","readOnly":false,"nullable":true},"strokeWidthPickerEnabled":{"type":"boolean","readOnly":false,"nullable":true},"freehandPenEnabled":{"type":"boolean","readOnly":false,"nullable":true},"drawRectEnabled":{"type":"boolean","readOnly":false,"nullable":true},"drawEllipseEnabled":{"type":"boolean","readOnly":false,"nullable":true},"drawLineEnabled":{"type":"boolean","readOnly":false,"nullable":true},"drawArrowEnabled":{"type":"boolean","readOnly":false,"nullable":true},"drawTextEnabled":{"type":"boolean","readOnly":false,"nullable":true}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionDrawing","enum":["QuizQuestionDrawing"]}}}}},"backgroundImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionDrawing"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionDrawing","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-drawing/{object_id}":{"get":{"summary":"Get QuizQuestionDrawing","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionDrawing"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionDrawing","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionDrawing"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionDrawing"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionDrawing","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-file-upload":{"post":{"summary":"Create QuizQuestionFileUpload","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionFileUpload","enum":["QuizQuestionFileUpload"]},"attributes":{"type":"object","required":["inputLabel"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["fileUpload"]},"inputLabel":{"type":"string","readOnly":false,"minLength":1,"maxLength":30000}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionFileUpload"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionFileUpload","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-file-upload/{object_id}":{"get":{"summary":"Get QuizQuestionFileUpload","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionFileUpload"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionFileUpload","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionFileUpload"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionFileUpload"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionFileUpload","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-flashcard":{"post":{"summary":"Create QuizQuestionFlashcard","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionFlashcard","enum":["QuizQuestionFlashcard"]},"attributes":{"type":"object","required":["stem","feedback"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["flashcard"]}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionFlashcard"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionFlashcard","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-flashcard/{object_id}":{"get":{"summary":"Get QuizQuestionFlashcard","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionFlashcard"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionFlashcard","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionFlashcard"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionFlashcard"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionFlashcard","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-free-text":{"post":{"summary":"Create QuizQuestionFreeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionFreeText","enum":["QuizQuestionFreeText"]},"attributes":{"type":"object","required":["inputLabel"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["freeText"]},"inputLabel":{"type":"string","readOnly":false,"minLength":1,"maxLength":30000},"showWordCount":{"type":"boolean","readOnly":false},"maxWordCount":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"enableWebcamSnapshots":{"type":"boolean","readOnly":false},"enableEquationEditor":{"type":"boolean","readOnly":false},"disableSpellcheck":{"type":"boolean","readOnly":false},"enforcePlainTextInput":{"type":"boolean","readOnly":false},"answerTemplate":{"type":"string","readOnly":false,"nullable":true,"minLength":1}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionFreeText"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionFreeText","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-free-text/{object_id}":{"get":{"summary":"Get QuizQuestionFreeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionFreeText"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionFreeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionFreeText"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionFreeText"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionFreeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-image-hotspot":{"post":{"summary":"Create QuizQuestionImageHotspot","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionImageHotspot","enum":["QuizQuestionImageHotspot"]},"attributes":{"type":"object","required":["definedAreas"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["imageHotspot"]},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false},"maximumClicks":{"type":"number","readOnly":false,"nullable":true},"markingStrategy":{"type":"string","enum":["exactMatch","partialMatch","matchPerBlank","proportionate"],"readOnly":false},"clickLimitType":{"type":"string","enum":["any","max","exact"],"readOnly":false},"definedAreas":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["slug","shape","coords"],"properties":{"slug":{"type":"string","minLength":1,"maxLength":100,"readOnly":false},"shape":{"type":"string","enum":["rect","ellipse","polygon"],"readOnly":false},"coords":{"oneOf":[{"type":"object","properties":{"centerX":{"type":"number"},"centerY":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"rotation":{"type":"number","nullable":true}},"required":["centerX","centerY","width","height"],"additionalProperties":false},{"type":"object","properties":{"points":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"additionalProperties":false},"minItems":3,"maxItems":50}},"required":["points"],"additionalProperties":false}]},"label":{"type":"string","readOnly":false},"credits":{"type":"number","readOnly":false},"penalties":{"type":"number","readOnly":false},"isCorrect":{"type":"boolean","readOnly":false}},"readOnly":false}}}},"relationships":{"type":"object","required":["quiz","hotspotImage"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionImageHotspot","enum":["QuizQuestionImageHotspot"]}}}}},"hotspotImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionImageHotspot"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionImageHotspot","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-image-hotspot/{object_id}":{"get":{"summary":"Get QuizQuestionImageHotspot","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionImageHotspot"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionImageHotspot","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionImageHotspot"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionImageHotspot"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionImageHotspot","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-informational":{"post":{"summary":"Create QuizQuestionInformational","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionInformational","enum":["QuizQuestionInformational"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["informational"]}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionInformational"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionInformational","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-informational/{object_id}":{"get":{"summary":"Get QuizQuestionInformational","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionInformational"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionInformational","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionInformational"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionInformational"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionInformational","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-multiple-correct":{"post":{"summary":"Create QuizQuestionMultipleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionMultipleCorrect","enum":["QuizQuestionMultipleCorrect"]},"attributes":{"type":"object","required":["options"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["multipleCorrect"]},"scoring":{"type":"string","enum":["exactMatch","partialMatch","proportionate"]},"options":{"allOf":[{"type":"array","items":{"type":"object","additionalProperties":false,"required":["isCorrect"],"properties":{"isCorrect":{"type":"boolean","readOnly":false},"phrase":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"image":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"credits":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"penalties":{"type":"number","readOnly":false,"nullable":true,"minimum":0}}},"anyOf":[{"type":"array","items":{"type":"object","required":["phrase"]}},{"type":"array","items":{"type":"object","required":["image"]}}]}]},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random","alphaNumeric"],"default":"disabled"},"multiCorrectLimitType":{"type":"string","enum":["any","max","exact",null],"readOnly":false,"nullable":true},"multiCorrectLimit":{"type":"number","readOnly":false,"nullable":true},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false,"nullable":true}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionMultipleCorrect"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionMultipleCorrect","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-multiple-correct/{object_id}":{"get":{"summary":"Get QuizQuestionMultipleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionMultipleCorrect"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionMultipleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionMultipleCorrect"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionMultipleCorrect"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionMultipleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-off-platform":{"post":{"summary":"Create QuizQuestionOffPlatform","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionOffPlatform","enum":["QuizQuestionOffPlatform"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["offPlatform"]},"hideFromPlayer":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionOffPlatform"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionOffPlatform","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-off-platform/{object_id}":{"get":{"summary":"Get QuizQuestionOffPlatform","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionOffPlatform"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionOffPlatform","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionOffPlatform"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionOffPlatform"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionOffPlatform","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-ranked":{"post":{"summary":"Create QuizQuestionRanked","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionRanked","enum":["QuizQuestionRanked"]},"attributes":{"type":"object","required":["options"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["ranked"]},"options":{"type":"array","items":{"type":"object","properties":{"phrase":{"type":"string","readOnly":false,"minLength":1},"rank":{"type":"number","readOnly":false,"minimum":0}}}},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random","alphaNumeric"],"default":"disabled"}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionRanked"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionRanked","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-ranked/{object_id}":{"get":{"summary":"Get QuizQuestionRanked","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionRanked"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionRanked","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionRanked"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionRanked"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionRanked","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-short-answer":{"post":{"summary":"Create QuizQuestionShortAnswer","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionShortAnswer","enum":["QuizQuestionShortAnswer"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["shortAnswer"]},"options":{"type":"array","maxItems":100,"items":{"type":"object","properties":{"value":{"type":"string","readOnly":false},"correctness":{"type":"number","readOnly":false}},"readOnly":false}},"disableSpellcheck":{"type":"boolean","readOnly":false},"caseMatch":{"type":"boolean","readOnly":false},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false},"markingAllowManualMarkingForUnmatchedResponses":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionShortAnswer"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionShortAnswer","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-short-answer/{object_id}":{"get":{"summary":"Get QuizQuestionShortAnswer","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionShortAnswer"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionShortAnswer","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionShortAnswer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionShortAnswer"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionShortAnswer","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-single-correct":{"post":{"summary":"Create QuizQuestionSingleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionSingleCorrect","enum":["QuizQuestionSingleCorrect"]},"attributes":{"type":"object","required":["options"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["singleCorrect"]},"options":{"allOf":[{"type":"array","items":{"type":"object","additionalProperties":false,"required":["isCorrect"],"properties":{"isCorrect":{"type":"boolean","readOnly":false},"phrase":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"feedback":{"type":"string","readOnly":false,"nullable":true},"image":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"credits":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"penalties":{"type":"number","readOnly":false,"nullable":true,"minimum":0}}},"anyOf":[{"type":"array","items":{"type":"object","required":["phrase"]}},{"type":"array","items":{"type":"object","required":["image"]}}]}]},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random","alphaNumeric"],"default":"disabled"},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false,"nullable":true}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionSingleCorrect"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionSingleCorrect","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-single-correct/{object_id}":{"get":{"summary":"Get QuizQuestionSingleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionSingleCorrect"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionSingleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionSingleCorrect"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionSingleCorrect"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionSingleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-spreadsheet":{"post":{"summary":"Create QuizQuestionSpreadsheet","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionSpreadsheet","enum":["QuizQuestionSpreadsheet"]},"attributes":{"type":"object","required":["inputLabel"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["spreadsheet"]},"inputLabel":{"type":"string","readOnly":false,"minLength":1,"maxLength":30000},"answerTemplate":{"type":"string","readOnly":false,"nullable":true,"minLength":1}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionSpreadsheet"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionSpreadsheet","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-spreadsheet/{object_id}":{"get":{"summary":"Get QuizQuestionSpreadsheet","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionSpreadsheet"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionSpreadsheet","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionSpreadsheet"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionSpreadsheet"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionSpreadsheet","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-true-or-false":{"post":{"summary":"Create QuizQuestionTrueOrFalse","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionTrueOrFalse","enum":["QuizQuestionTrueOrFalse"]},"attributes":{"type":"object","required":["stem","correctAnswer"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["trueOrFalse"]},"correctAnswer":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionTrueOrFalse"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionTrueOrFalse","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-true-or-false/{object_id}":{"get":{"summary":"Get QuizQuestionTrueOrFalse","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionTrueOrFalse"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionTrueOrFalse","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionTrueOrFalse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionTrueOrFalse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionTrueOrFalse","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-question-video-recording":{"post":{"summary":"Create QuizQuestionVideoRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionVideoRecording","enum":["QuizQuestionVideoRecording"]},"attributes":{"type":"object","required":["inputLabel"],"additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["videoRecording"]},"inputLabel":{"type":"string","readOnly":false,"maxLength":30000},"videoRecordingMaximumTimeMs":{"type":"number","readOnly":false,"minimum":1,"maximum":3600000,"default":3600000},"videoRecordingAllowDelete":{"type":"boolean","readOnly":false,"default":true},"videoRecordingAllowReRecord":{"type":"boolean","readOnly":false,"default":true},"videoRecordingAllowPause":{"type":"boolean","readOnly":false,"default":true},"videoRecordingAllowEarlySubmission":{"type":"boolean","readOnly":false,"default":true},"videoRecordingAutoRecording":{"type":"boolean","readOnly":false,"default":false},"videoRecordingAutoRecordingDelayMs":{"type":"number","readOnly":false,"minimum":0,"maximum":3600000,"default":0},"videoRecordingAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","afterAudioCompletion"],"default":"disabled"},"videoRecordingAutoAdvanceDelayMs":{"type":"number","readOnly":false,"minimum":0,"maximum":3600000,"default":0}}},"relationships":{"type":"object","required":["quiz"],"properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionVideoRecording"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizQuestionVideoRecording","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-question-video-recording/{object_id}":{"get":{"summary":"Get QuizQuestionVideoRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionVideoRecording"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizQuestionVideoRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionVideoRecording"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionVideoRecording"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizQuestionVideoRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-sections":{"post":{"summary":"Create QuizSection","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]},"attributes":{"type":"object","required":["title","isDynamic"],"additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"minLength":1,"maxLength":100},"isDynamic":{"type":"boolean","readOnly":false},"doi":{"type":"string","readOnly":false,"nullable":false,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"instructionsEnabled":{"type":"boolean","readOnly":false,"default":false},"instructionsTitle":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":100},"instructionsBody":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":25000},"instructionsTimerEnabled":{"type":"boolean","readOnly":false,"nullable":true},"instructionsTimerHidden":{"type":"boolean","readOnly":false,"nullable":true},"instructionsTimerDurationMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1,"maximum":86400000},"instructionsAudioAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"instructionsAudioAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"instructionsDisableAudioControls":{"type":"boolean","readOnly":false,"nullable":true},"outroEnabled":{"type":"boolean","readOnly":false,"default":false},"outroTitle":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":100},"outroBody":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":25000},"outroTimerEnabled":{"type":"boolean","readOnly":false,"nullable":true},"outroTimerHidden":{"type":"boolean","readOnly":false,"nullable":true},"outroTimerDurationMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1,"maximum":86400000},"outroAudioAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"outroAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"outroAudioAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"outroDisableAudioControls":{"type":"boolean","readOnly":false,"nullable":true},"timerEnabled":{"type":"boolean","readOnly":false,"default":false},"timerHidden":{"type":"boolean","readOnly":false,"default":false},"timerDurationMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1},"timerInferFromQuestions":{"type":"boolean","readOnly":false,"nullable":true},"index":{"type":"number","readOnly":true},"filterRules":{"type":"array","minItems":0,"maxItems":125,"description":"Array of filter rules to apply to the dynamic quiz content.","items":{"type":"object","properties":{"weighting":{"type":"number"},"shuffleQuestions":{"type":"boolean","default":false},"matchingRules":{"type":"array","minItems":0,"maxItems":20,"description":"Array of matching rules to apply to the filter rule. Each rule will be treated as an AND operation. Matching rules can not be a mix of tag and EMQ rules.","items":{"oneOf":[{"anyOf":[{"type":"object","required":["tagId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["tagId"],"properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}}}]},{"anyOf":[{"type":"object","required":["emqGroupId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"emqGroupId":{"type":"string","minLength":5,"maxLength":32}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["emqGroupId"],"properties":{"emqGroupId":{"type":"string","minLength":5,"maxLength":32}}}}]},{"anyOf":[{"type":"object","required":["questionId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"questionId":{"type":"string","minLength":5,"maxLength":32}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["questionId"],"properties":{"questionId":{"type":"string","minLength":5,"maxLength":32}}}}]}]}}}}},"navigationDisableNavigation":{"type":"boolean","readOnly":false,"nullable":true},"navigationDisableControlPanel":{"type":"boolean","readOnly":false,"nullable":true},"grades":{"type":"array","nullable":true,"items":{"type":"object","required":["label"],"properties":{"label":{"type":"string","readOnly":false},"minScore":{"description":"A default failing grade should have minScore set to `null`","type":"number","readOnly":false,"nullable":true},"isPass":{"type":"boolean","readOnly":false},"description":{"type":"string","readOnly":false,"nullable":true}}}},"scoreModifiers":{"type":"array","nullable":true,"readOnly":false,"items":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"type":"string","enum":["omitLowestScoringQuestionPerSection"]}}}}}},"relationships":{"type":"object","required":["quiz"],"properties":{"questions":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionVideoRecording","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"outroAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"setupValidation":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSetupValidation","enum":["QuizSetupValidation"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizSection"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List QuizSections","tags":["Quizzes"],"responses":{"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"405":{"description":"Method Not Allowed","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"501":{"description":"Not Implemented","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quiz-sections/{object_id}":{"get":{"summary":"Get QuizSection","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizSection"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update QuizSection","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizSection"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizSection"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete QuizSection","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-sections/{object_id}/relationships/questions":{"patch":{"summary":"Update quiz section questions.","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestionAudioRecording","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionFileUpload","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionSingleCorrect","QuizQuestionShortAnswer","QuizQuestionVideoRecording","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestionAudioRecording"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"post":{"summary":"Add quiz section questions.","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestionAudioRecording","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionFileUpload","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionSingleCorrect","QuizQuestionShortAnswer","QuizQuestionVideoRecording","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestionAudioRecording"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quiz-tag-breakdowns/{object_id}":{"get":{"summary":"Get QuizTagBreakdown","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizTagBreakdown"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quizzes":{"post":{"summary":"Create Quiz","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":false,"minLength":1,"maxLength":300},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"description":{"type":"string","nullable":true,"readOnly":false,"maxLength":50000},"shortDescription":{"type":"string","nullable":true,"readOnly":false,"minLength":0,"maxLength":1500},"totalQuestions":{"type":"number","nullable":false,"readOnly":true},"instructionsEnabled":{"type":"boolean","readOnly":false,"nullable":false,"default":false},"instructionsTitle":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":300},"instructionsBody":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":25000},"instructionsTimerDurationMs":{"type":"number","nullable":true,"readOnly":false,"minimum":1,"maximum":86400000},"instructionsEnforcedTimer":{"type":"string","readOnly":false,"enum":["afterAudioStarts","immediately"]},"instructionsAudioAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"instructionsAudioAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"instructionsDisableAudioControls":{"type":"boolean","readOnly":false,"nullable":true},"markingCreditsPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"default":1},"markingPartialCreditsPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0},"markingPenaltiesPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0},"markingPenaltiesEnabled":{"type":"boolean","nullable":true,"readOnly":false,"default":false},"grades":{"type":"array","nullable":true,"items":{"type":"object","properties":{"label":{"type":"string","readOnly":false},"minScore":{"type":"number","readOnly":false},"isPass":{"type":"boolean","readOnly":false,"nullable":true},"description":{"type":"string","readOnly":false,"nullable":true},"advancedCriteria":{"type":"object","readOnly":false,"nullable":true,"properties":{"sectionRequirements":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","enum":["none","requiredCount","allPass","selectedPass"],"readOnly":false,"nullable":true},"count":{"type":"number","readOnly":false,"nullable":true},"sectionIds":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"string","readOnly":false,"nullable":true}}}},"excludeFromResitAttempts":{"type":"boolean","readOnly":false,"nullable":true}}}}}},"allowedModes":{"type":"array","nullable":true,"items":{"type":"string","enum":["practice","exam","timedExam"]},"minItems":1,"maxItems":3},"allowedLengths":{"type":"array","items":{"type":"string","enum":["default","quick","medium","long","extraLong"]}},"allowedPlayers":{"type":"array","items":{"type":"string","enum":["default","ucat","usmle"]}},"allowedTagSets":{"type":"array","nullable":true,"items":{"type":"string"}},"allowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","skill","difficulty","context"]}},"calculatorEnabled":{"type":"boolean","readOnly":false,"default":false},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"],"readOnly":false},"allowMultipleTagSelection":{"type":"boolean","readOnly":false,"default":false},"excludeUntaggedQuestions":{"type":"boolean","readOnly":false,"default":false},"showMasteryFilters":{"type":"boolean","readOnly":false,"default":false},"calculatorType":{"type":"string","enum":["basic","scientific"]},"securityDisableCopying":{"type":"boolean","readOnly":false,"default":false},"securityDisablePasting":{"type":"boolean","readOnly":false,"default":false},"securityDisableRightClick":{"type":"boolean","readOnly":false,"default":false},"navigationDisableNavigation":{"type":"boolean","readOnly":false,"default":false},"navigationDisableControlPanel":{"type":"boolean","readOnly":false,"default":false},"navigationDisableNotifications":{"type":"boolean","readOnly":false,"default":false},"softSectionsEnabled":{"type":"boolean","readOnly":false,"default":false},"notepadEnabled":{"type":"boolean","readOnly":false,"default":false},"resizableQuestionPanelsEnabled":{"type":"boolean","readOnly":false,"default":true},"strikethroughEnabled":{"type":"boolean","readOnly":false,"default":false},"highlightingEnabled":{"type":"boolean","readOnly":false,"default":false},"bookmarkingEnabled":{"type":"boolean","readOnly":false,"default":false},"micSettingsEnabled":{"type":"boolean","readOnly":false,"default":false},"labValuesEnabled":{"type":"boolean","readOnly":false,"default":false},"labValuesHtml":{"type":"string","readOnly":false},"additionalInformationEnabled":{"type":"boolean","readOnly":false,"default":false},"additionalInformationTitle":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":120},"additionalInformationIcon":{"type":"string","readOnly":false,"nullable":true},"additionalInformationHtml":{"type":"string","readOnly":false},"resumeLaterButtonEnabled":{"type":"boolean","readOnly":false,"default":false},"flaggingEnabled":{"type":"boolean","readOnly":false,"default":false},"showAvailableMarks":{"type":"boolean","readOnly":false,"default":false},"playerType":{"type":"string","enum":["default","ucat","usmle"],"default":"default"},"theme":{"type":"string","default":"default"},"fontSize":{"type":"string","enum":["xSmall","small","medium","large","xLarge"],"default":"medium"},"pinnedMessageDuringTest":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":1500},"deferResultsEnabled":{"type":"boolean","readOnly":false,"default":false},"deferResultsMessage":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":25000},"deferResultsAlwaysRelease":{"type":"boolean","readOnly":false},"whenCompleteNoGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000,"deprecated":true},"completedMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000,"deprecated":true},"resultsHideResults":{"type":"boolean","readOnly":false,"default":false},"resultsGlobalHideScore":{"type":"boolean","readOnly":false,"default":false},"resultsDetailedViewEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsOverviewWhenPassedMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenFailedHasResitsMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenFailedNoResitsMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenCompleteNoGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenCompletedNeutralGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessagePassed":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageFailed":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageResitsRemaining":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageNoResitsRemaining":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageCompleted":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageSettingHideTitle":{"type":"boolean","readOnly":false,"default":false},"resultsHiddenMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsHiddenSettingHideTitle":{"type":"boolean","readOnly":false,"default":false},"resultsMetricScoreEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricTimeSpentEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricGradeEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricProgressEnabled":{"type":"boolean","readOnly":false,"deprecated":true,"description":"Use resultsMetricTagProgressEnabled instead","default":true},"resultsMetricQuestionBreakdownDisplayLevel":{"type":"string","enum":["full","hideStemAndOptions","hideCorrectOptions","incorrectOnlyHideCorrectOptions","none"],"readOnly":false},"resultsMetricAnalyticsCohort":{"type":"string","enum":["exam","test","sourceTest"],"default":"test"},"resultsMetricCohortAverageEnabled":{"type":"boolean","readOnly":false,"default":false},"resultsMetricCohortPercentileEnabled":{"type":"boolean","readOnly":false,"default":false},"resultsMetricCohortScoreDistributionEnabled":{"type":"boolean","readOnly":false,"default":false},"resultsMetricTagBreakdownEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricTagProgressEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricSectionBreakdownEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricSectionBreakdownGradeEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricSectionBreakdownScoreEnabled":{"type":"boolean","readOnly":false,"default":true},"resultsMetricTagProgressFacetsEnabled":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"subject":{"type":"boolean","readOnly":false},"topic":{"type":"boolean","readOnly":false},"subtopic":{"type":"boolean","readOnly":false},"skill":{"type":"boolean","readOnly":false},"difficulty":{"type":"boolean","readOnly":false}},"default":{"subject":true,"topic":true,"subtopic":true,"skill":true,"difficulty":true}},"resultsEducatorViewAsAdminEnabled":{"type":"boolean","readOnly":false,"default":true},"timerEnabled":{"type":"boolean","readOnly":false,"default":false},"timerHidden":{"type":"boolean","readOnly":false,"default":false},"timerUseQuestions":{"type":"boolean","readOnly":false},"timerUseSections":{"type":"boolean","readOnly":false},"timerEnforceFullTime":{"type":"boolean","readOnly":false},"timerTimeInMs":{"type":"number","nullable":true,"readOnly":false,"minimum":1,"maximum":86400000},"timerExtraTimeMultiplier":{"type":"number","readOnly":false,"nullable":true},"timerSoftTimer":{"type":"boolean","readOnly":false},"mutexLockKey":{"type":"string","readOnly":true,"nullable":true},"mutexLockExpiresAt":{"type":"string","readOnly":true,"nullable":true},"mutexLockType":{"type":"string","enum":["write","full",null],"readOnly":true,"nullable":true},"certificatesEnabled":{"type":"boolean","readOnly":false},"certificatesTemplateId":{"type":"string","nullable":true,"readOnly":false},"certificatesQrCode":{"type":"boolean","nullable":true,"readOnly":false},"certificatesTtl":{"type":"number","nullable":true,"readOnly":false},"certificatesIgnoreSubPortalBranding":{"type":"boolean","nullable":true,"readOnly":false},"certificatesIssueOnFail":{"type":"boolean","nullable":true,"readOnly":false},"certificatesResultsPage":{"type":"boolean","nullable":true,"readOnly":false},"certificatesSharingImageUrl":{"type":"string","nullable":true,"readOnly":false},"resitEnabled":{"type":"boolean","nullable":false,"readOnly":false},"resitType":{"type":"string","enum":["continuous","fixedDate","onDemand","rolling",null],"nullable":true,"readOnly":false},"resitMode":{"type":"string","enum":["standard","fixed","progressive","preferUnseen",null],"readOnly":false,"nullable":true},"resitGradeIndependent":{"type":"boolean","nullable":true,"readOnly":false},"resitAllowedAttempts":{"type":"number","nullable":true,"readOnly":false},"resitDelay":{"type":"number","nullable":true,"readOnly":false},"resitCloseDelay":{"type":"number","nullable":true,"readOnly":false},"resitScheduleActivateAt":{"type":"string","nullable":true,"readOnly":false},"resitScheduleDeactivateAt":{"type":"string","nullable":true,"readOnly":false},"proctorEnabled":{"type":"boolean","readOnly":false,"nullable":false},"proctorVendor":{"type":"string","readOnly":false,"enum":["internal","rosalyn","synopticV2",null],"nullable":true},"proctorRequireFullscreen":{"type":"boolean","readOnly":false,"nullable":false},"proctorRestrictTabs":{"type":"boolean","readOnly":false,"nullable":false},"proctorRestrictDisplays":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordSession":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordSnapshots":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordDesktop":{"type":"boolean","readOnly":false,"nullable":false},"proctorSynopticLevel":{"type":"string","readOnly":false,"nullable":false,"enum":["web","browser","desktop"]},"proctorScreenMonitoring":{"type":"string","readOnly":false,"nullable":false,"enum":["none","recreation","recreationWithSnapshots","video"]},"proctorWebcamMonitoring":{"type":"string","readOnly":false,"nullable":false,"enum":["none","snapshots","audioVideo"]},"proctorRestrictKeyboardShortcuts":{"type":"boolean","readOnly":false,"nullable":false},"proctorScreenshotPrevention":{"type":"boolean","readOnly":false,"nullable":true},"proctorAiReview":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiFlagCandidateLeftFrame":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiFlagMultiplePeopleInFrame":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiPrompts":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"prompt":{"type":"string","readOnly":false},"level":{"type":"string","readOnly":false,"enum":["info","warning","breach"]},"colour":{"type":"string","readOnly":false,"nullable":true}}}},"proctorOnBreach":{"type":"string","enum":["freeze","silent",null],"readOnly":false,"nullable":true},"proctorReviewOptional":{"type":"boolean","readOnly":false,"nullable":false},"proctorReviewMode":{"type":"string","enum":["always","never","onBreach",null],"readOnly":false,"nullable":true},"proctorLiveProctoring":{"type":"boolean","readOnly":false,"nullable":false},"proctorBlockedApplicationsPolicy":{"type":"string","readOnly":false,"nullable":true,"enum":["none","default",null]},"proctorRosalynRuleUsePrivateTestArea":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleVisibleFace":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowInteractionWithOthers":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowOtherMaterials":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowNoiseMakingDevices":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowAdditionalDevices":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleAllowMouseKeyboardMonitorOnly":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowAppsOrBroswerTabs":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowExamContentSharing":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowTextPrediction":{"type":"boolean","readOnly":false,"nullable":false},"access":{"type":"object","readOnly":true,"properties":{"exam":{"type":"object","properties":{"objectId":{"type":"string","nullable":true}}}}},"legalEnabled":{"type":"boolean","readOnly":false},"legalTitle":{"type":"string","readOnly":false,"nullable":true},"legalBody":{"type":"string","readOnly":false,"nullable":true},"legalCheckboxLabel":{"type":"string","readOnly":false,"nullable":true},"legalConfirmationType":{"type":"string","enum":["checkbox","staticText","candidateName"],"readOnly":false,"nullable":true},"legalConfirmationStaticText":{"type":"string","readOnly":false,"nullable":true},"dynamicVariationEnabled":{"type":"boolean","readOnly":false},"dynamicVariationMaxVariants":{"type":"number","minimum":0,"readOnly":false,"nullable":true},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":true},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true},"scheduleSubmissionDueDate":{"type":"string","readOnly":false,"nullable":true},"scheduleRelativeCloseTimeInMs":{"type":"number","minimum":0,"readOnly":false,"nullable":true},"dynamicFiltersWeightingType":{"type":"string","enum":["absolute","percentage"],"nullable":true,"readOnly":false},"dynamicFilterRules":{"nullable":true,"type":"array","minItems":0,"maxItems":125,"description":"Array of filter rules to apply to the dynamic quiz content.","items":{"type":"object","properties":{"weighting":{"type":"number"},"shuffleQuestions":{"type":"boolean","default":false},"matchingRules":{"type":"array","minItems":0,"maxItems":20,"description":"Array of matching rules to apply to the filter rule. Each rule will be treated as an AND operation. Matching rules can not be a mix of tag and EMQ rules.","items":{"oneOf":[{"anyOf":[{"type":"object","required":["tagId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["tagId"],"properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}}}]},{"anyOf":[{"type":"object","required":["emqGroupId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"emqGroupId":{"type":"string","minLength":5,"maxLength":32}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["emqGroupId"],"properties":{"emqGroupId":{"type":"string","minLength":5,"maxLength":32}}}}]},{"anyOf":[{"type":"object","required":["questionId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"questionId":{"type":"string","minLength":5,"maxLength":32}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["questionId"],"properties":{"questionId":{"type":"string","minLength":5,"maxLength":32}}}}]}]}}}}},"isDynamic":{"type":"boolean","readOnly":false},"isSectioned":{"type":"boolean","readOnly":true},"shuffleDynamicFilters":{"type":"boolean","nullable":true,"description":"If true then the dynamic filters will be shuffled for each attempt.","default":false},"shuffleAllDynamicQuestions":{"type":"boolean","nullable":true,"description":"If true then all questions selected accross filter rules will be shuffled. EMQ grouping will be maintained.","default":false},"shuffleSectionsEnabled":{"type":"boolean","readOnly":false,"default":false},"shuffleQuestions":{"type":"string","enum":["disabled","random","enabled"],"readOnly":false,"description":"If true then the questions will be shuffled for each attempt.","default":"disabled"},"version":{"type":"string","readOnly":false},"status":{"type":"string","enum":["draft","published","cancelled","closed"],"readOnly":false,"nullable":false},"isGenerated":{"type":"boolean","readOnly":true,"nullable":true},"isArchived":{"type":"boolean","readOnly":true},"excludeInformationalQuestionsFromCounts":{"type":"boolean","readOnly":false},"sectionGradesEnabled":{"type":"boolean","readOnly":false},"advancedGradingEnabled":{"type":"boolean","readOnly":false},"passFailEnabled":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"questions":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}},"emqGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizEmqGroup"],"example":"QuizEmqGroup"}]}}}}}},"sections":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizSection"],"example":"QuizSection"}]}}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"sourceContentQuizzes":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Quiz"],"example":"Quiz"}]}}}}}},"sourceSettingsQuiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TagSet","enum":["TagSet"]}}}}},"setupValidation":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSetupValidation","enum":["QuizSetupValidation"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Quiz"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/quizzes/{object_id}":{"get":{"summary":"Get Quiz","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Quiz"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Quiz","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Quiz"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Quiz"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete Quiz","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quizzes/{object_id}/relationships/questions":{"patch":{"summary":"Update Quiz Questions","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestionAudioRecording","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionFileUpload","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionSingleCorrect","QuizQuestionShortAnswer","QuizQuestionVideoRecording","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestionAudioRecording"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quizzes/{object_id}/relationships/sections":{"patch":{"summary":"Update Quiz Sections","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizSection"],"example":"QuizSection"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quizzes/{object_id}/relationships/sourceContentQuizzes":{"patch":{"summary":"Update Quiz Content Sources","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":false,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Quiz"],"example":"Quiz"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quizzes/{object_id}/relationships/sourceSettingsQuiz":{"patch":{"summary":"Update Quiz Settings Source","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Quiz"],"example":"Quiz"}]}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Quiz"],"example":"Quiz"}]}}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quizzes/{object_id}/relationships/collaborating-users":{"post":{"summary":"Add Quiz Collaborating Users","description":"Add users as collaborators to this quiz. The request body should contain an array of User resource identifier objects.","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove Quiz Collaborating Users","description":"Remove users as collaborators from this quiz. The request body should contain an array of User resource identifier objects to remove.","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/quizzes/{object_id}/relationships/collaborating-user-groups":{"post":{"summary":"Add Quiz Collaborating User Groups","description":"Add user groups as collaborators to this quiz. The request body should contain an array of UserGroup resource identifier objects.","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove Quiz Collaborating User Groups","description":"Remove user groups as collaborators from this quiz. The request body should contain an array of UserGroup resource identifier objects to remove.","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/scorm-courses":{"post":{"summary":"Create ScormCourse","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ScormCourse","enum":["ScormCourse"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"title":{"type":"string"},"fileName":{"type":"string","readOnly":true},"shortDescription":{"type":"string"},"description":{"type":"string"},"importState":{"type":"string","enum":["pending","completed","failed"],"readOnly":true},"settingsDisplayMode":{"type":"string","enum":["newWindow","embedded"],"readOnly":false},"isArchived":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","required":["scormFile"],"properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"scormFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScormCourse"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/scorm-courses/{object_id}":{"get":{"summary":"Get ScormCourse","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScormCourse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update ScormCourse","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ScormCourse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScormCourse"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete ScormCourse","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/scorm-courses/{object_id}/relationships/collaborating-users":{"post":{"summary":"Add SCORM Course Collaborating Users","description":"Add users as collaborators to this SCORM course. The request body should contain an array of User resource identifier objects.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove SCORM Course Collaborating Users","description":"Remove users as collaborators from this SCORM course. The request body should contain an array of User resource identifier objects to remove.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/scorm-courses/{object_id}/relationships/collaborating-user-groups":{"post":{"summary":"Add SCORM Course Collaborating User Groups","description":"Add user groups as collaborators to this SCORM course. The request body should contain an array of UserGroup resource identifier objects.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove SCORM Course Collaborating User Groups","description":"Remove user groups as collaborators from this SCORM course. The request body should contain an array of UserGroup resource identifier objects to remove.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/search-filter-configs":{"get":{"summary":"List SearchFilterConfigs","tags":["Search"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"target":{"type":"string","enum":["AssignmentGroup","Collection","Course","Exam","LibraryItem","Tag","User","UserGroup"]}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterConfig"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/search-results":{"get":{"summary":"Search","tags":["Search"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"search","in":"query","required":false,"allowReserved":true,"schema":{"type":"string","maxLength":512}},{"name":"filter","in":"query","required":false,"explode":false,"schema":{"type":"object","properties":{"type":{"anyOf":[{"type":"string","deprecated":true,"enum":["tag","user","exam","userGroup","subPortal","assignmentGroup","userType","assignment","tagSet","course","quiz","audio","document","embed","video","zip","image","note","scormCourse","survey","collection"]},{"type":"array","items":{"type":"string","enum":["tag","user","exam","userGroup","subPortal","assignmentGroup","userType","assignment","tagSet","course","quiz","audio","document","embed","video","zip","image","note","scormCourse","survey","collection","studyItem"]}}]},"userId":{"type":"string","minLength":1,"description":"Search on behalf of this user. Only supported when `filter[type]` is `studyItem`. The caller must be permitted to view them; results are the intersection of both users read permissions."},"propertyFilters":{"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]},"operator":{"type":"string","enum":["$eq","$ne","$exists","$gt","$gte","$lt","$lte","$in","$nin","$or"]},"isCore":{"type":"boolean"}}}}}}},{"name":"sort","in":"query","schema":{"type":"string","description":"Comma-separated list of sort keys. Filter keys are only available to select types. Please note that `targetCreatedAt` and `targetUpdatedAt` are deprecated and will be removed in a future release. Use `createdAt` and `updatedAt` instead.","enum":["title","-title","createdAt","-createdAt","updatedAt","-updatedAt","targetCreatedAt","-targetCreatedAt","targetUpdatedAt","-targetUpdatedAt"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"links":{"allOf":[{"type":"object","properties":{"first":{"anyOf":[{"$ref":"#/components/schemas/UrlLink"},{"$ref":"#/components/schemas/UrlString"}]},"prev":{"anyOf":[{"$ref":"#/components/schemas/UrlLink"},{"$ref":"#/components/schemas/UrlString"}]},"next":{"anyOf":[{"$ref":"#/components/schemas/UrlLink"},{"$ref":"#/components/schemas/UrlString"}]},"last":{"anyOf":[{"$ref":"#/components/schemas/UrlLink"},{"$ref":"#/components/schemas/UrlString"}]}}},{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}]},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/session-context":{"get":{"summary":"Get Session Context","tags":["Users"],"security":[],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/SessionContext"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/store-offers/{object_id}":{"get":{"summary":"Get StoreOffer","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/StoreOffer"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/studies/{object_id}":{"get":{"summary":"Get Study","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Study"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Study","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Study"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Study"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/studies":{"get":{"summary":"List Studies","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string"}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Study"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}},"post":{"summary":"Create Study","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Study","enum":["Study"]},"attributes":{"type":"object","properties":{"totalStudyItems":{"type":"number","readOnly":true},"totalQuestions":{"type":"number","readOnly":true},"totalAnsweredQuestions":{"type":"number","readOnly":true},"knowledgeCoverage":{"type":"number","readOnly":true},"competencyScore":{"type":"number","readOnly":true},"masteryLevel":{"type":"string","readOnly":true,"enum":["unseen","weak","moderate","strong","mastered",null],"nullable":true},"studyItemOverviews":{"type":"array","nullable":true,"readOnly":true,"items":{"type":"object","properties":{"studyItemId":{"type":"string"},"type":{"type":"string"},"objectData":{"type":"object","properties":{"className":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"slug":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true}}},"isAttempted":{"type":"boolean"},"totalQuestions":{"type":"number"},"totalAnsweredQuestions":{"type":"number"},"knowledgeCoverage":{"type":"number"},"competencyScore":{"type":"number"},"masteryLevel":{"type":"string","enum":["unseen","weak","moderate","strong","mastered"]},"masteryDivisions":{"type":"array","nullable":true,"readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["unseen","weak","moderate","strong","mastered"]},"label":{"type":"string","minLength":0},"totalQuestions":{"type":"number","minimum":0},"percentageOfTotal":{"type":"number","minimum":0,"maximum":100}}}}}}},"masteryDivisions":{"type":"array","nullable":true,"readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["unseen","weak","moderate","strong","mastered"]},"label":{"type":"string","minLength":0},"totalQuestions":{"type":"number","minimum":0},"percentageOfTotal":{"type":"number","minimum":0,"maximum":100}}}},"studyOverviewUpdatedAt":{"type":"string","readOnly":true,"format":"date-time"},"selfPracticeSetupQuizMode":{"type":"string","readOnly":false,"enum":["practice","exam","timedExam","test"]},"selfPracticeSetupMaxQuestions":{"type":"number","readOnly":false,"minimum":0,"maximum":300},"selfPracticeSetupMasteryLevels":{"type":"array","readOnly":false,"items":{"type":"string","enum":["unseen","weak","moderate","strong","mastered"]}},"selfPracticeSetupTagSetId":{"type":"string","readOnly":false,"nullable":true},"selfPracticeSetupRandomise":{"type":"boolean","readOnly":false},"selfPracticeSetupTagFilters":{"type":"object","readOnly":false,"nullable":true},"spacedLearningIntensityLevel":{"type":"number","readOnly":false,"enum":["Low","Moderate","High",1,2,3],"nullable":false},"spacedLearningNextDue":{"type":"string","readOnly":true,"format":"date-time"},"spacedLearningMissedStreak":{"type":"number","readOnly":true},"spacedLearningLatestTestCreatedAt":{"type":"string","readOnly":true,"format":"date-time"},"spacedLearningStateIsActive":{"type":"boolean","readOnly":false},"spacedLearningStateWaiting":{"type":"boolean","readOnly":true,"nullable":true},"spacedLearningStateTestReady":{"type":"boolean","readOnly":true,"nullable":true},"spacedLearningStateHasAttempt":{"type":"boolean","readOnly":true,"nullable":true},"spacedLearningStateStatusMessage":{"type":"string","readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{"latestQuiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"latestAttempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["StudyItem"],"example":"StudyItem"}]}}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Study"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/studies/{object_id}/relationships/items":{"post":{"summary":"Add StudyItems","tags":["Revision"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["StudyItem"]}]},"attributes":{"type":"object","properties":{"targetId":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","enum":["collection","tag","test"]}}}}}}}}}}},"responses":{"204":{"description":"Success"},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"delete":{"summary":"Remove StudyItems","tags":["Revision"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["StudyItem"]}]}}}}}}}}},"responses":{"204":{"description":"Success"},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/study-items/{object_id}":{"get":{"summary":"Get StudyItem","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/StudyItem"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"delete":{"summary":"Delete StudyItem","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/study-items":{"post":{"summary":"Create StudyItem","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"StudyItem","enum":["StudyItem"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"study":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Study","enum":["Study"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StudyItem"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/sub-portals":{"post":{"summary":"Create SubPortal","tags":["Portals"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","readOnly":false,"minLength":1},"brandPrimary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"brandSecondary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"fontLinkColour":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"buttonColourPrimary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"buttonColourSecondary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"buttonTextColourPrimary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"buttonTextColourSecondary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"chartColourPrimary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"defaultCardImageUrl":{"type":"string","readOnly":false,"nullable":true},"headerLogoUrl":{"type":"string","readOnly":false,"nullable":true},"squareLogoUrl":{"type":"string","readOnly":false,"nullable":true},"faviconUrl":{"type":"string","readOnly":false,"nullable":true},"affiliationTwitterUrl":{"type":"string","readOnly":false,"nullable":true},"affiliationFacebookUrl":{"type":"string","readOnly":false,"nullable":true},"affiliationLinkedInUrl":{"type":"string","readOnly":false,"nullable":true},"affiliationYoutubeUrl":{"type":"string","readOnly":false,"nullable":true},"subdomain":{"type":"string","readOnly":false,"nullable":true},"hostname":{"type":"string","readOnly":true,"nullable":true},"useCustomSubPortalDomain":{"type":"boolean","readOnly":false,"description":"When true, the hostname uses the portal `subPortalDomain` suffix instead of the portal hostname (requires `subPortalDomain` to be set on the portal)."},"registrationBackgroundImageUrl":{"type":"string","readOnly":false,"nullable":true},"registrationHeaderBackgroundColor":{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},"registrationHeaderBorderBottomColor":{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},"registrationPageTitle":{"type":"string","readOnly":false,"nullable":true},"registrationPageDescription":{"type":"string","readOnly":false,"nullable":true},"registrationRegisterMethod":{"type":"string","enum":["open","closed",null],"readOnly":false,"nullable":true,"description":"Registration sign-up method for this sub-portal. When null, the portal-level registration method is used as a fallback."},"emailSettingsFromName":{"type":"string","nullable":true,"readOnly":false},"emailSettingsFromEmail":{"type":"string","format":"email","nullable":true,"readOnly":false},"emailSettingsFooterText":{"type":"string","nullable":true,"readOnly":false},"emailSettingsHeaderLogoUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"emailSettingsWelcomeEmailSubject":{"type":"string","nullable":true,"readOnly":false},"emailSettingsWelcomeEmailBody":{"type":"string","nullable":true,"readOnly":false}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SubPortal"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List SubPortals","tags":["Portals"],"security":[],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"id":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"name":{"type":"object","properties":{"search":{"description":"The partial name to search for.","type":"string"},"eq":{"description":"The exact name to fetch.","type":"string"}}}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SubPortal"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/sub-portals/{object_id}":{"get":{"summary":"Get SubPortal","tags":["Portals"],"security":[],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/SubPortal"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update SubPortal","tags":["Portals"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SubPortal"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SubPortal"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete SubPortal","tags":["Portals"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/subscriptions":{"get":{"summary":"List Subscriptions","tags":["Billing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"owner":{"type":"string","description":"The owner of the subscriptions to filter by. Only available to admins."},"product":{"type":"string","description":"Find a subscription by its product ID. Returned as a single item list."}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/subscriptions/{object_id}":{"get":{"summary":"Get Subscription","tags":["Billing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Subscription"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/survey-items":{"post":{"summary":"Create SurveyItem","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"SurveyItem","enum":["SurveyItem"]},"attributes":{"type":"object","required":["type","question"],"properties":{"type":{"type":"string","enum":["boolean","date","likert","multiChoice","multiText","singleChoice","text","upload"],"readOnly":false},"question":{"type":"string","description":"The question or prompt for the survey item.","minLength":1,"nullable":false},"options":{"type":"array","items":{"required":["value"],"properties":{"label":{"anyOf":[{"type":"string","minLength":1,"nullable":true},{"type":"number","nullable":true}],"description":"The label for the survey item option."},"value":{"anyOf":[{"type":"string","minLength":1},{"type":"number"},{"type":"boolean"}],"description":"The value associated with the survey item option."}}},"description":"The options available for the survey item.","minItems":0,"uniqueItems":true,"nullable":true},"isRequired":{"type":"boolean","readOnly":false},"isHidden":{"type":"boolean","readOnly":false,"deprecated":true,"description":"This field is deprecated and should not be used."},"isReadOnly":{"type":"boolean","readOnly":false,"deprecated":true,"description":"This field is deprecated and should not be used. It is only used with SelfAssessment."},"defaultValue":{"anyOf":[{"type":"string","nullable":true},{"type":"number","nullable":true},{"type":"boolean","nullable":true}],"readOnly":false}}},"relationships":{"type":"object","required":["page"],"properties":{"page":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SurveyPage","enum":["SurveyPage"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SurveyItem"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/survey-items/{object_id}":{"get":{"summary":"Get SurveyItem","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/SurveyItem"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update SurveyItem","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SurveyItem"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SurveyItem"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete SurveyItem","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/survey-pages":{"post":{"summary":"Create SurveyPage","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"SurveyPage","enum":["SurveyPage"]},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","description":"The title of the survey page.","nullable":true},"description":{"type":"string","nullable":true,"description":"The description of the survey page. This can be used to provide additional context or instructions for the survey participants."},"primaryColor":{"type":"string","nullable":true,"description":"The primary colour used in the survey page. This can be used to customize the appearance of the survey to match branding or design guidelines."},"resultDescription":{"type":"string","nullable":true,"description":"The description of the survey results, providing insights or summaries for the participants."},"headerImageUrl":{"type":"string","nullable":true,"format":"uri","description":"The URL of the header image for the survey page. This image is displayed at the top of the survey page to enhance visual appeal."}}},"relationships":{"type":"object","additionalProperties":false,"required":["survey"],"properties":{"survey":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Survey","enum":["Survey"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["SurveyItem"],"example":"SurveyItem"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SurveyPage"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/survey-pages/{object_id}":{"get":{"summary":"Get SurveyPage","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/SurveyPage"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update SurveyPage","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SurveyPage"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SurveyPage"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete SurveyPage","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/survey-pages/{object_id}/relationships/items":{"patch":{"summary":"Update Survey Page Items","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["SurveyItem"],"example":"SurveyItem"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/survey-responses":{"post":{"summary":"Create SurveyResponse","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"SurveyResponse","enum":["SurveyResponse"]},"attributes":{"type":"object","properties":{"responseData":{"type":"object","readOnly":false},"selfAssessmentOutcome":{"type":"object","readOnly":false,"deprecated":true}}},"relationships":{"type":"object","required":["survey"],"properties":{"survey":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Survey","enum":["Survey"]}}}}},"assignmentItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemSurvey","enum":["AssignmentItemSurvey"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SurveyResponse"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/survey-responses/{object_id}":{"patch":{"summary":"Update SurveyResponse","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SurveyResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SurveyResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/surveys":{"post":{"summary":"Create Survey","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Survey","enum":["Survey"]},"attributes":{"type":"object","required":["title"],"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":false},"description":{"type":"string","readOnly":false},"shortDescription":{"type":"string","readOnly":false},"selfAssessment":{"type":"object","readOnly":true,"additionalProperties":true,"deprecated":true,"description":"Only used by legacy client custom code."},"totalItems":{"type":"number","readOnly":true},"isLibraryItem":{"type":"boolean","readOnly":false,"default":true},"isArchived":{"type":"boolean","readOnly":true},"extraInformation":{"type":"object","properties":{"subAction":{"type":"string","readOnly":false}},"readOnly":false,"description":"Additional information about the survey, such as metadata."}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"pages":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["SurveyPage"],"example":"SurveyPage"}]}}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Survey"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/surveys/{object_id}":{"get":{"summary":"Get Survey","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Survey"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Survey","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Survey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Survey"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete Survey","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/surveys/{object_id}/relationships/pages":{"patch":{"summary":"Update Survey Pages","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["SurveyPage"],"example":"SurveyPage"}]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object"}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"links":{"properties":{"self":{"$ref":"#/components/schemas/UrlString"}}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/surveys/{object_id}/relationships/collaborating-users":{"post":{"summary":"Add Survey Collaborating Users","description":"Add users as collaborators to this survey. The request body should contain an array of User resource identifier objects.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove Survey Collaborating Users","description":"Remove users as collaborators from this survey. The request body should contain an array of User resource identifier objects to remove.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/surveys/{object_id}/relationships/collaborating-user-groups":{"post":{"summary":"Add Survey Collaborating User Groups","description":"Add user groups as collaborators to this survey. The request body should contain an array of UserGroup resource identifier objects.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Remove Survey Collaborating User Groups","description":"Remove user groups as collaborators from this survey. The request body should contain an array of UserGroup resource identifier objects to remove.","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/synoptic-ai-reviews":{"get":{"summary":"Find SynopticAiReview","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"session":{"type":"string"}},"required":["session"]}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SynopticAiReview"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/synoptic-captures":{"get":{"summary":"Find SynopticCapture","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"session":{"type":"string"},"type":{"type":"string","enum":["webcam","desktop"]}},"required":["session"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SynopticCapture"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/synoptic-dom-recordings":{"get":{"summary":"Find SynopticDomRecording","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"session":{"type":"string"}},"required":["session"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SynopticDomRecording"}},"meta":{"allOf":[{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}},{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}}]}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/synoptic-event-logs":{"get":{"summary":"Find SynopticEventLog","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"session":{"type":"string"},"type":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"action":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["session"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SynopticEventLog"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/synoptic-sessions/{object_id}":{"get":{"summary":"Get SynopticSession","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/SynopticSession"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/synoptic-sessions":{"post":{"summary":"Create SynopticSession","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"SynopticSession","enum":["SynopticSession"]},"attributes":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"token":{"type":"string","readOnly":true},"status":{"type":"string","enum":["pending","active","closed","completed","disabled"]},"peerConnectionStatus":{"type":"string","enum":["new","connecting","connected","disconnected","failed","closed"]},"processingStatus":{"type":"string","enum":["pending","pendingAi","inProgress","completed","error"]},"processingProgress":{"type":"number","readOnly":true,"minimum":0,"maximum":100},"analysisStatus":{"type":"string","enum":["pending","inProgress","completed","error"]},"aiProgress":{"type":"number","readOnly":true,"minimum":0,"maximum":100},"aiCost":{"type":"number","readOnly":true},"aiEstimatedCompletionDate":{"type":"string","format":"date-time","readOnly":true},"synopticLevel":{"type":"string","enum":["web","browser","desktop"]},"screenMonitoring":{"type":"string","enum":["none","recreation","recreationWithSnapshots","video"]},"webcamMonitoring":{"type":"string","enum":["none","snapshots","audioVideo"]},"keyboardShortcutsEnabled":{"type":"boolean"},"screenshotPrevention":{"type":"boolean"},"aiReview":{"type":"boolean"},"aiFlagCandidateLeftFrame":{"type":"boolean"},"aiFlagMultiplePeopleInFrame":{"type":"boolean"},"aiPrompts":{"type":"array","items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true}}}},"onBreach":{"type":"string","enum":["freeze","silent"],"nullable":true},"liveProctoring":{"type":"boolean"}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"candidate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"desktopFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"avFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"maskFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"avPeaksFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"legacyDomRecordingFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SynopticSession"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"Find SynopticSession","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"attempt":{"type":"string"},"exam":{"type":"string"},"candidate":{"type":"string"},"status":{"type":"array","items":{"type":"string","enum":["pending","active","closed","completed","disabled"]},"description":"Allow-list of session statuses to include. Pass as repeated query params (filter[status][]=pending&filter[status][]=active) or a single value. Each value must be one of: pending, active, closed, completed, disabled."},"peerConnectionStatus":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SynopticSession"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/synoptic-watch-tokens/{object_id}":{"get":{"summary":"Get SynopticWatchToken","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/SynopticWatchToken"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/tag-sets":{"post":{"summary":"Create TagSet","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"TagSet","enum":["TagSet"]},"attributes":{"type":"object","properties":{"label":{"type":"string","readOnly":false,"nullable":false,"minLength":1,"maxLength":300}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TagSet"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List TagSets","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"label":{"type":"object","properties":{"search":{"description":"The partial name to search for.","type":"string"}}}}}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["label","-label"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TagSet"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/tag-sets/{object_id}":{"get":{"summary":"Get TagSet","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/TagSet"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update TagSet","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TagSet"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TagSet"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete TagSet","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/tags":{"post":{"summary":"Create Tag","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"Tag","enum":["Tag"]},"attributes":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":500,"readOnly":false},"facet":{"type":"string","enum":["exam","module","subject","topic","subtopic","difficulty","skill","context",null],"nullable":true,"readOnly":false},"feedback":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":100000},"isVisibleToStudents":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TagSet","enum":["TagSet"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Tag"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List Tags","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["label","-label"]}},{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"label":{"anyOf":[{"type":"object","properties":{"search":{"description":"The partial name to search for.","type":"string"}}},{"type":"object","properties":{"eq":{"description":"The exact name to fetch.","type":"string"}}}]},"tagSet":{"type":"string","description":"The id of the tag set to filter by."}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/tags/{object_id}":{"get":{"summary":"Get Tag","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Tag"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update Tag","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Tag"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Tag"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete Tag","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/templates":{"get":{"summary":"List Templates","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"usage":{"type":"string","enum":["assignment","exam"]}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Template"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/tests/{object_id}":{"get":{"summary":"Get Test","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Test"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"delete":{"summary":"Delete Test","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/tests":{"get":{"summary":"List Tests","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"source":{"type":"object","properties":{"type":{"type":"string","enum":["collection","assignment","study"]},"id":{"type":"string"}}}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Test"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/tip-suggestions":{"post":{"summary":"Create TipSuggestion","tags":["User Feedback"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"TipSuggestion","enum":["TipSuggestion"]},"attributes":{"type":"object","properties":{"tip":{"type":"string","readOnly":false},"createdAt":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TipSuggestion"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List TipSuggestions","tags":["User Feedback"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TipSuggestion"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/tokens/{object_id}":{"get":{"summary":"Get Token","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Token"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/transactional-emails/{object_id}":{"get":{"summary":"Get TransactionalEmail","tags":["Notifications"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/TransactionalEmail"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/transactional-emails":{"get":{"summary":"List TransactionalEmails","tags":["Notifications"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["_created_at","-_created_at"]}},{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"toUser":{"type":"string"}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TransactionalEmail"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/user-accounts/{object_id}":{"get":{"summary":"Get UserAccount","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserAccount"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/user-engagement":{"get":{"summary":"List UserEngagement","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"anyOf":[{"type":"object","properties":{"userGroup":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"}}},{"type":"object","properties":{"userIds":{"type":"array","items":{"type":"string"}},"startDate":{"type":"string"},"endDate":{"type":"string"}}}]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserEngagement"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"allOf":[{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}},{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time"}}}]}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/user-group-exports":{"post":{"summary":"Create UserGroupExport","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroupExport","enum":["UserGroupExport"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroupExport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/user-group-link-accesses":{"post":{"summary":"Create UserGroupLinkAccess","tags":["User Groups"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroupLinkAccess","enum":["UserGroupLinkAccess"]},"attributes":{"type":"object","properties":{"userId":{"type":"string","readOnly":false},"code":{"type":"string","readOnly":false}}},"relationships":{"type":"object","properties":{"userGroupLink":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroupLink","enum":["UserGroupLink"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroupLinkAccess"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/user-group-link-settings":{"get":{"summary":"List UserGroupLinkSettings","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"userGroupId":{"type":"string"}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserGroupLinkSettings"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}},"post":{"summary":"Create UserGroupLinkSetting","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroupLinkSettings","enum":["UserGroupLinkSettings"]},"attributes":{"type":"object","required":["enabled","public"],"properties":{"message":{"type":"string","readOnly":false},"code":{"type":"string","readOnly":false},"enabled":{"type":"boolean","readOnly":false},"public":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroupLinkSettings"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/user-group-link-settings/{object_id}":{"get":{"summary":"Get UserGroupLinkSetting","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroupLinkSettings"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update UserGroupLinkSetting","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/UserGroupLinkSettings"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroupLinkSettings"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/user-group-link-validations":{"post":{"summary":"Validate UserGroupLink","tags":["User Groups"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroupLinkValidation","enum":["UserGroupLinkValidation"]},"attributes":{"type":"object","properties":{"isCodeValid":{"type":"boolean","readOnly":true},"reason":{"type":"string","readOnly":true},"code":{"type":"string","readOnly":false}}},"relationships":{"type":"object","properties":{"userGroupLink":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroupLink","enum":["UserGroupLink"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroupLinkValidation"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/user-group-links/{object_id}":{"get":{"summary":"Get UserGroupLink","tags":["User Groups"],"security":[],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroupLink"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/user-groups":{"post":{"summary":"Create UserGroup","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]},"attributes":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"description":{"type":"string","readOnly":false},"attr":{"type":"object","readOnly":false,"additionalProperties":true},"isDefaultGroup":{"type":"boolean","readOnly":true},"defaultGroupType":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true},"isArchived":{"type":"boolean","readOnly":false},"totalUsers":{"type":"number","readOnly":true},"parentId":{"type":"string","readOnly":false,"nullable":true},"internal":{"type":"boolean","readOnly":false},"membershipExpiryEnabled":{"type":"boolean","readOnly":false},"membershipExpiryTimeToExpireInMs":{"type":"number","readOnly":false,"nullable":true}}},"relationships":{"type":"object","required":["userType"],"properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"userType":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserType","enum":["UserType"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroup"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List UserGroups","tags":["User Groups"],"security":[],"parameters":[{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["_created_at","-_created_at"]}},{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"name":{"type":"object","properties":{"search":{"description":"The partial name to search for.","type":"string"},"eq":{"description":"The exact name to fetch.","type":"string"}}},"userType":{"oneOf":[{"type":"array","items":{"type":"string","enum":["admin","manager","educator","marker","student","guest"]}},{"type":"string"}]},"subPortals":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserGroup"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/user-groups/{object_id}":{"get":{"summary":"Get UserGroup","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroup"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update UserGroup","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/UserGroup"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroup"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete UserGroup","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/user-groups/{object_id}/relationships/users":{"post":{"summary":"Add Users to UserGroup","tags":["User Groups"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"]}]}}},{"type":"object","properties":{"type":{"type":"string","enum":["Invite"]},"attributes":{"type":"object","required":["email"],"properties":{"email":{"type":"string"},"name":{"type":"string"},"attr":{"type":"object"},"personalMessage":{"type":"string","nullable":true}}}}}]}}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["BackgroundJob"]}]}}}}}}}},"204":{"description":"Success"},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"delete":{"summary":"Remove Users from UserGroup","tags":["User Groups"],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"]}]}}}}}}}}},"responses":{"204":{"description":"Success"},"400":{"description":"Bad request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"401":{"description":"Unauthorised","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"404":{"description":"Not found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/user-imports":{"post":{"summary":"Create UserImport","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"UserImport","enum":["UserImport"]},"attributes":{"type":"object","properties":{"dryRun":{"type":"boolean","readOnly":false,"description":"If true, the import will be validated but not executed."},"emails":{"type":"array","readOnly":false,"minItems":1,"description":"List of emails to import. Should not be used with csv import.","items":{"type":"string"}},"personalMessage":{"type":"string","readOnly":false},"generateAccounts":{"type":"boolean","readOnly":false},"allowInauthenticEmails":{"type":"boolean","readOnly":false,"description":"If true, the import will allow missing emails. This is only valid when externalIds are provided and generateAccounts is true."},"disableWelcomeEmail":{"type":"boolean","readOnly":false},"usersInvited":{"type":"array","items":{"type":"string"},"readOnly":true},"invitesUpdated":{"type":"array","items":{"type":"string"},"readOnly":true},"existingUsersAdded":{"type":"array","items":{"type":"string"},"readOnly":true},"existingUsersAttributesUpdated":{"type":"array","items":{"type":"string"},"readOnly":true},"unchangedUsers":{"type":"array","items":{"type":"string"},"readOnly":true},"generatedUsers":{"type":"array","items":{"type":"string"},"readOnly":true}}},"relationships":{"type":"object","required":["userGroup"],"properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"csv":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserImport"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/user-passwords":{"post":{"summary":"Create UserPassword","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"UserPassword","enum":["UserPassword"]},"attributes":{"type":"object","required":["newPassword"],"properties":{"oldPassword":{"type":"string"},"newPassword":{"type":"string"}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserPassword"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/user-registrations":{"post":{"summary":"Create UserRegistration","tags":["Users"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"UserRegistration","enum":["UserRegistration"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false},"emailAddress":{"type":"string","readOnly":false},"password":{"type":"string","readOnly":false,"description":"Minimum 8 characters; 1 upper, 1 lower and 1 digit"},"registrationSource":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["self","externalAuth"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["generated"]},"token":{"type":"string"}}},{"type":"object","required":["type","inviteId"],"properties":{"type":{"type":"string","enum":["invite"]},"inviteId":{"type":"string"}}},{"type":"object","required":["type","productId"],"properties":{"type":{"type":"string","enum":["product"]},"productId":{"type":"string"}}},{"type":"object","required":["type","code"],"properties":{"type":{"type":"string","enum":["examVoucher"]},"code":{"type":"string"}}}]},"welcomeEmailDisabled":{"type":"boolean","readOnly":false,"description":"If true the welcome email will not be sent."},"welcomeEmailCustomMessage":{"type":"string","readOnly":false,"nullable":true,"description":"Custom message to include in generated account notifications"},"marketingEmailsConsent":{"type":"string","readOnly":false,"nullable":true},"locale":{"type":"string","enum":["en","en-GB","de-DE","el-GR","es-ES","fr-FR","it-IT","ja-JP","nl-NL","pt-BR","pt-PT","zh-CN","nb-NO","sl-SI","ar-SA","th-TH","hr-HR","ru-RU","id-ID","lv-LV","et-EE","pl-PL","sq-AL","cy-GB","vi-VN"],"readOnly":false,"nullable":true},"fontSize":{"type":"string","readOnly":false,"nullable":true,"enum":["xSmall","small","medium","large","xLarge"]},"extraTimeMultiplier":{"type":"number","readOnly":false,"nullable":true,"description":"Extra time multiplier for the user (e.g. 1.5 for 50% extra time)"},"timeZone":{"type":"string","readOnly":false,"nullable":true,"description":"IANA Time Zone Format (e.g. Europe/Rome)"},"attr":{"type":"object","readOnly":false,"nullable":true},"utm":{"type":"object","readOnly":false,"nullable":true},"externalId":{"type":"string","readOnly":false,"nullable":true,"description":"External identifier for the user"},"allowInauthenticEmails":{"type":"boolean","readOnly":false,"description":"When true and emailAddress is omitted, a placeholder email is generated from externalId. Only valid for generated accounts. Requires externalId."},"signUpSource":{"type":"string","enum":["Web","Mobile","API"],"readOnly":false,"deprecated":true,"description":"Deprecated. This value will be ignored. This field will be removed in the future."},"registration":{"type":"object","readOnly":false,"nullable":true,"deprecated":true,"description":"Deprecated. Use registrationSource | welcomeEmailDisabled instead. This field will be removed in the future."},"preferences":{"type":"object","readOnly":false,"nullable":true,"deprecated":true,"description":"Deprecated. Use locale | fontSize instead. This field will be removed in the future."}}},"relationships":{"type":"object","properties":{"userGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"generatedAttempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserRegistration"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/user-sessions/me":{"delete":{"summary":"Delete own UserSession","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}}}}},"/user-stats/{object_id}":{"get":{"summary":"Get UserStat","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserStats"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/user-types":{"get":{"summary":"List UserTypes","tags":["User Groups","Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["admin","manager","educator","marker","student","guest"]},{"type":"array","items":{"type":"string","enum":["admin","manager","educator","marker","student","guest"]}}]}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserType"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/user-types/{object_id}":{"get":{"summary":"Get UserType","tags":["User Groups","Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserType"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update UserType","tags":["User Groups","Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/UserType"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserType"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/users":{"get":{"summary":"List Users","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["createdAt","-createdAt"]}},{"name":"filter","in":"query","required":true,"explode":false,"schema":{"type":"object","properties":{"id":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"emailAddress":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"userGroup":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"userGroupType":{"anyOf":[{"type":"array","items":{"type":"string","enum":["admins","managers","educators","markers","students","allUsers"]}},{"type":"string","enum":["admins","managers","educators","markers","students","allUsers"]}]}}}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/users/{object_id}":{"get":{"summary":"Get User","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/User"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update User","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/User"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/User"},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete User","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/webhook-deliveries":{"get":{"summary":"List WebhookDeliveries","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"maxItems":100}]},"status":{"oneOf":[{"type":"string","enum":["pending","sending","sent","failed","exhausted","paused","cancelled"]},{"type":"array","items":{"type":"string","enum":["pending","sending","sent","failed","exhausted","paused","cancelled"]}}]},"eventName":{"type":"string","enum":["assignment.complete","attempt.submitted","attempt.complete","attempt.started","attemptOverride.created","attemptCertificate.generated","exam.userRegistered","exam.submitted","exam.started","exam.complete","exam.released","exam.examCreated","exam.examUpdated","flag.planted","learningRecord.created","learningRecord.updated","learningRecord.deleted","store.purchase","usergroup.userAdded","usergroup.userRemoved","invite.sent","user.registered","user.updated","subPortal.created","subPortal.updated","subPortal.deleted","markingSession.started","markingSession.completed","markingState.updated"]},"subscription":{"type":"string"},"createdAfter":{"type":"string","format":"date-time"},"createdBefore":{"type":"string","format":"date-time"},"responseStatusCode":{"oneOf":[{"type":"integer"},{"type":"array","items":{"type":"integer"}}]}}}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["createdAt","-createdAt","status","-status","attemptCount","-attemptCount","responseStatusCode","-responseStatusCode"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookDelivery"}},"meta":{"type":"object","required":["hasMore","total"],"properties":{"hasMore":{"type":"boolean"},"total":{"type":"number"}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}},"post":{"summary":"Create a test WebhookDelivery (\"send test webhook\")","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","relationships"],"properties":{"type":{"type":"string","enum":["WebhookDelivery"]},"attributes":{"type":"object","additionalProperties":false,"properties":{}},"relationships":{"type":"object","required":["subscription"],"properties":{"subscription":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"WebhookSubscription","enum":["WebhookSubscription"]}}}},"required":["data"]}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookDelivery"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/webhook-deliveries/{object_id}":{"get":{"summary":"Get a WebhookDelivery","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookDelivery"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Pause, resume, resend or cancel a WebhookDelivery","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","enum":["WebhookDelivery"]},"id":{"type":"string"},"attributes":{"type":"object","required":["status"],"additionalProperties":false,"properties":{"status":{"type":"string","enum":["paused","pending","cancelled"]}}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookDelivery"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/webhook-deliveries/operations":{"post":{"summary":"BETA: Atomically apply update operations to WebhookDeliveries","description":"BETA: JSON:API Atomic Operations extension. Send `atomic:operations` with `op: \"update\"` setting `status` to `\"pending\"` (mark up to 100 failed/exhausted deliveries for retry) or `\"cancelled\"` (cancel up to 100 queued/suspended deliveries), all-or-nothing. A single request must target one status. Use the media type `application/vnd.api+json; ext=\"https://jsonapi.org/ext/atomic\"`.","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["atomic:operations"],"additionalProperties":false,"properties":{"atomic:operations":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["op","data"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["update"]},"data":{"type":"object","required":["type","id","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["WebhookDelivery"]},"id":{"type":"string"},"attributes":{"type":"object","required":["status"],"additionalProperties":false,"properties":{"status":{"type":"string","enum":["pending","cancelled"]}}}}}}}}}}},"application/vnd.api+json; ext=\"https://jsonapi.org/ext/atomic\"":{"schema":{"type":"object","required":["atomic:operations"],"additionalProperties":false,"properties":{"atomic:operations":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["op","data"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["update"]},"data":{"type":"object","required":["type","id","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["WebhookDelivery"]},"id":{"type":"string"},"attributes":{"type":"object","required":["status"],"additionalProperties":false,"properties":{"status":{"type":"string","enum":["pending","cancelled"]}}}}}}}}}}}}},"responses":{"200":{"description":"Operations applied atomically","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["atomic:results"],"properties":{"atomic:results":{"type":"array","items":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WebhookDelivery"}}}}}}},"application/vnd.api+json; ext=\"https://jsonapi.org/ext/atomic\"":{"schema":{"type":"object","required":["atomic:results"],"properties":{"atomic:results":{"type":"array","items":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WebhookDelivery"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/webhook-subscriptions":{"post":{"summary":"Create WebhookSubscription","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"WebhookSubscription","enum":["WebhookSubscription"]},"attributes":{"type":"object","required":["eventName","targetUrl"],"properties":{"eventName":{"type":"string","enum":["assignment.complete","attempt.submitted","attempt.complete","attempt.started","attemptOverride.created","attemptCertificate.generated","exam.userRegistered","exam.submitted","exam.started","exam.complete","exam.released","exam.examCreated","exam.examUpdated","flag.planted","learningRecord.created","learningRecord.updated","learningRecord.deleted","store.purchase","usergroup.userAdded","usergroup.userRemoved","invite.sent","user.registered","user.updated","subPortal.created","subPortal.updated","subPortal.deleted","markingSession.started","markingSession.completed","markingState.updated"],"readOnly":false,"nullable":false},"targetUrl":{"type":"string","readOnly":false,"nullable":false},"name":{"type":"string","readOnly":false,"nullable":true},"basicAuth":{"type":"object","required":["username","password"],"properties":{"username":{"type":"string","minLength":1},"password":{"type":"string","minLength":1}},"readOnly":false,"nullable":true},"active":{"type":"boolean","readOnly":false,"nullable":false},"deliveryStats":{"type":"object","readOnly":true,"nullable":false,"properties":{"lastDeliveryAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"lastStatus":{"type":"string","enum":["pending","sending","sent","failed","exhausted","paused","cancelled",null],"readOnly":true,"nullable":true},"lastResponseStatusCode":{"type":"number","readOnly":true,"nullable":true},"lastErrorType":{"type":"string","enum":["timeout","network","http_4xx","http_5xx","gone",null],"readOnly":true,"nullable":true},"recentFailureCount":{"type":"number","readOnly":true,"nullable":false},"recentSuccessCount":{"type":"number","readOnly":true,"nullable":false},"recentTotalCount":{"type":"number","readOnly":true,"nullable":false}}}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookSubscription"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List WebhookSubscriptions","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"eventType":{"oneOf":[{"type":"string","enum":["assignment.complete","attempt.submitted","attempt.complete","attempt.started","attemptOverride.created","attemptCertificate.generated","exam.userRegistered","exam.submitted","exam.started","exam.complete","exam.released","exam.examCreated","exam.examUpdated","flag.planted","learningRecord.created","learningRecord.updated","learningRecord.deleted","store.purchase","usergroup.userAdded","usergroup.userRemoved","invite.sent","user.registered","user.updated","subPortal.created","subPortal.updated","subPortal.deleted","markingSession.started","markingSession.completed","markingState.updated"]},{"type":"array","items":{"type":"string","enum":["assignment.complete","attempt.submitted","attempt.complete","attempt.started","attemptOverride.created","attemptCertificate.generated","exam.userRegistered","exam.submitted","exam.started","exam.complete","exam.released","exam.examCreated","exam.examUpdated","flag.planted","learningRecord.created","learningRecord.updated","learningRecord.deleted","store.purchase","usergroup.userAdded","usergroup.userRemoved","invite.sent","user.registered","user.updated","subPortal.created","subPortal.updated","subPortal.deleted","markingSession.started","markingSession.completed","markingState.updated"]}}]},"source":{"type":"string","enum":["zapier","user"]},"targetUrl":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"active":{"type":"boolean"},"health":{"oneOf":[{"type":"string","enum":["healthy","warning","critical","no-data"]},{"type":"array","items":{"type":"string","enum":["healthy","warning","critical","no-data"]}}]}}}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["url","-url","name","-name","event","-event","enabled","-enabled","health","-health","lastDelivery","-lastDelivery","failures","-failures"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSubscription"}},"meta":{"type":"object","required":["total","targetUrls"],"properties":{"total":{"type":"number"},"targetUrls":{"type":"array","items":{"type":"string"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/webhook-subscriptions/{object_id}":{"get":{"summary":"Get WebhookSubscription","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookSubscription"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"patch":{"summary":"Update WebhookSubscription","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WebhookSubscription"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookSubscription"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete WebhookSubscription","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}},"/webhook-subscriptions/{object_id}/sample-payload":{"get":{"summary":"Get the sample payload a test send for this WebhookSubscription would POST","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookSamplePayload"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}},"/zapier-api-keys":{"post":{"summary":"Create ZapierApiKey","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"ZapierApiKey","enum":["ZapierApiKey"]},"attributes":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"label":{"type":"string","readOnly":false},"createdAt":{"type":"string","readOnly":true},"lastUsed":{"type":"string","readOnly":true},"isRevoked":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ZapierApiKey"}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}}},"get":{"summary":"List ZapierApiKeys","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"object","required":["limit","offset"],"properties":{"limit":{"type":"number","minimum":1},"offset":{"type":"number","minimum":0}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ZapierApiKey"}},"meta":{"type":"object","required":["total","pages","page","offset","limit"],"properties":{"total":{"type":"integer"},"totalWithoutFilters":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"totalCount":{"type":"integer","deprecated":true},"resultCount":{"type":"integer","deprecated":true},"totalPages":{"type":"integer","deprecated":true},"currentPage":{"type":"integer","deprecated":true}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}}}},"/zapier-api-keys/{object_id}":{"patch":{"summary":"Update ZapierApiKey","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ZapierApiKey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ZapierApiKey"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}},"delete":{"summary":"Delete ZapierApiKey","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ObjectId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}}}}},"components":{"securitySchemes":{"LegacySessionAuth":{"type":"apiKey","description":"[Legacy] Authorize the request using a Session Token.","in":"header","name":"X-Syn-Session-Token"},"PATAuth":{"type":"http","scheme":"bearer","description":"Authorise the request using a personal access token.","bearerFormat":"p:"},"SessionAuth":{"type":"http","scheme":"bearer","description":"Authorize the request using a Session Token.","bearerFormat":"r:<token>"}},"parameters":{"ObjectId":{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"}}},"schemas":{"AccessMigration":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AccessMigration","enum":["AccessMigration"]},"attributes":{"type":"object","properties":{"permissions":{"type":"string","enum":["core","all","none"]},"searchData":{"type":"boolean"}}},"relationships":{"type":"object","required":["portal"],"properties":{"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}}}}}},"AccessPolicy":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AccessPolicy","enum":["AccessPolicy"]},"attributes":{"type":"object","properties":{"target":{"type":"string","readOnly":true},"targetLabel":{"type":"string","readOnly":true},"subTarget":{"type":"string","readOnly":true},"subTargetLabel":{"type":"string","readOnly":true},"action":{"type":"string","readOnly":true},"actionLabel":{"type":"string","readOnly":true},"effect":{"type":"string","readOnly":false,"enum":["allow","deny"]},"position":{"type":"number","readOnly":true},"inherited":{"type":"boolean","readOnly":true},"isSpecific":{"type":"boolean","readOnly":true},"isCore":{"type":"boolean","readOnly":true},"targetCondition":{"type":"object","required":["field","operation","value"],"additionalProperties":false,"properties":{"field":{"type":"string"},"operation":{"type":"string","enum":["$eq","$ne","$exists","$in","$gt","$lt"]},"value":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}]}},"readOnly":false}}},"relationships":{"type":"object","properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"inheritedFromUserGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"associations":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["AccessPolicy"],"example":"AccessPolicy"}]}}}}},"deprecated":true},"targetResource":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TargetResource","enum":["TargetResource"]}}}}}}}}},"AccessPolicyReset":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AccessPolicyReset","enum":["AccessPolicyReset"]},"attributes":{"type":"object","properties":{"permissions":{"type":"string","enum":["core","all"]}}},"relationships":{"type":"object","properties":{"userGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}},"AccountClosure":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AccountClosure","enum":["AccountClosure"]},"attributes":{"type":"object","properties":{"confirmationToken":{"type":"string","readOnly":false}}},"relationships":{"type":"object","properties":{}}}},"AccountClosureRequest":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AccountClosureRequest","enum":["AccountClosureRequest"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{}}}},"ActionLog":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ActionLog","enum":["ActionLog"]},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["access","account","attempt","attemptCertificate","attemptOverride","assignment","collection","collectionItem","consent","exam","flag","invite","learningRecord","portal","question","emqGroup","session","store","tag","test","userGroup","subPortal","markingSession","markingState"],"readOnly":true},"action":{"type":"string","enum":["created","updated","deleted","viewed","accessGranted","accessRevoked","registered","accountUpdated","enrolled","started","session","itemCompleted","submitted","approved","rejected","completed","certificateGenerated","certificateDownloaded","attemptCertificateGenerated","started","marketingEmails","marketingEmailsRemoved","examUserRegistered","examActivated","examCancelled","examCompleted","examScheduled","sent","checked","accepted","cancelled","expired","flagPlanted","passkeyLoggedIn","passkeyRegistered","passkeyRevoked","loggedIn","restored","loggedOut","productUnlocked","viewed","questionAnswered","completed","discarded","testSubmitted","testReleased","userAdded","userRemoved","markingSessionStarted","markingSessionCompleted","markingSessionVoided","markingSessionSuspended","markingSessionResumed","markingStateUpdated"],"readOnly":true},"targetId":{"type":"string","readOnly":true},"targetParentId":{"type":"string","readOnly":true},"targetTitle":{"type":"string","readOnly":true},"timestamp":{"type":"string","readOnly":true},"verb":{"type":"string"}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"Annotation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Annotation","enum":["Annotation"]},"attributes":{"type":"object","properties":{"collectionItemId":{"type":"string","readOnly":true},"body":{"type":"string","readOnly":false}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"ApiError":{"type":"object","description":"This is an error response structure. The id, status, code, title and detail will vary based on the error situation.","example":{"id":"ERR100","status":"400","code":"-1","title":"Error","detail":"Something went wrong."},"properties":{"id":{"type":"string","description":"Unique ID of this error occurrence."},"status":{"type":"string","description":"HTTP status code."},"code":{"type":"string","description":"Synap internal error code."},"title":{"type":"string"},"detail":{"type":"string"},"source":{"type":"object","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"}}}}},"Assignment":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"image":{"type":"object","deprecated":true,"description":"Use `coverImage` instead","readOnly":true,"properties":{"url":{"type":"string"}}},"deadline":{"type":"string","format":"date-time","readOnly":false},"status":{"type":"string","enum":["Not started","In progress","Pending review","Failed","Passed","Completed","Missed deadline","Revoked"],"nullable":false,"readOnly":false},"progress":{"type":"number","readOnly":true},"startDate":{"type":"string","readOnly":true},"endDate":{"type":"string","readOnly":true},"setDate":{"type":"string","readOnly":true},"timeSpentInMinutes":{"type":"number","readOnly":true},"totalItems":{"type":"number","readOnly":true},"itemsCompleted":{"type":"number","readOnly":true},"attemptNumber":{"type":"number","readOnly":true},"isReviewRequired":{"type":"boolean","readOnly":true},"certificateShareList":{"type":"array","readOnly":true,"nullable":true,"maxItems":4,"items":{"type":"object","required":["label","urlPrefix"],"properties":{"label":{"type":"string","minLength":1,"maxLength":100},"urlPrefix":{"type":"string"}}}},"isPreview":{"type":"boolean","readOnly":true},"versionNumber":{"type":"number","readOnly":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":false,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["AssignmentItemAudio","AssignmentItemDocument","AssignmentItemEmbed","AssignmentItemNote","AssignmentItemQuiz","AssignmentItemScorm","AssignmentItemSurvey","AssignmentItemTextEntry","AssignmentItemUpload","AssignmentItemVideo","AssignmentItemZip"],"example":"AssignmentItemAudio"}]}}}}}},"folders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["AssignmentFolder"],"example":"AssignmentFolder"}]}}}}}},"certificate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Certificate","enum":["Certificate"]}}}}},"certificateFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}}}}}},"AssignmentFolder":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentFolder","enum":["AssignmentFolder"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","readOnly":true,"minLength":1,"maxLength":150}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":false,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["AssignmentItemAudio","AssignmentItemDocument","AssignmentItemEmbed","AssignmentItemNote","AssignmentItemQuiz","AssignmentItemScorm","AssignmentItemSurvey","AssignmentItemTextEntry","AssignmentItemUpload","AssignmentItemVideo","AssignmentItemZip"],"example":"AssignmentItemAudio"}]}}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"AssignmentGroup":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentGroup","enum":["AssignmentGroup"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false,"minLength":1},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"image":{"type":"object","readOnly":false,"deprecated":true,"description":"This property is deprecated. Use the relation \"coverImage\" instead.","properties":{"url":{"type":"string"}}},"absoluteDeadline":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"relativeDeadline":{"type":"string","readOnly":false,"nullable":true,"deprecated":true,"description":"This property is deprecated. Use the property \"relativeDeadlineMs\" instead."},"relativeDeadlineMs":{"type":"number","minimum":3600000,"maximum":31536000000,"readOnly":false,"nullable":true,"description":"The relative deadline in milliseconds, minimum 1 hour, maximum 1 year"},"deadlineType":{"type":"string","enum":["indefinite","absolute","relative"],"readOnly":false},"progressionType":{"type":"string","enum":["fixed-linear","flexible-linear","flexible-open"],"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false},"isActive":{"deprecated":true,"description":"This property is deprecated. Use the property \"status\" instead.","type":"boolean","readOnly":true},"isPendingActivation":{"deprecated":true,"description":"This property is deprecated. Use the property \"status\" instead.","type":"boolean","readOnly":true},"isCompleted":{"deprecated":true,"description":"This property is deprecated. Use the property \"status\" instead.","type":"boolean","readOnly":true},"isArchived":{"type":"boolean","readOnly":false},"status":{"type":"string","readOnly":false,"enum":["inactive","pendingActivation","active","complete","cancelled","closed"],"nullable":false},"certificateTemplateId":{"type":"string","readOnly":false,"nullable":true},"certificateIgnoreSubPortalBranding":{"type":"boolean","readOnly":false,"nullable":false},"certificateShareList":{"type":"array","readOnly":false,"nullable":true,"maxItems":4,"items":{"type":"object","required":["label","urlPrefix"],"properties":{"label":{"type":"string","minLength":1,"maxLength":100},"urlPrefix":{"type":"string"}}}},"startDate":{"type":"string","nullable":true},"endDate":{"type":"string","nullable":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"sourceCourse":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"reviewers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"AssignmentGroupCourseVersion":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentGroupCourseVersion","enum":["AssignmentGroupCourseVersion"]},"attributes":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"publishStrategy":{"type":"string","enum":["new-enrollees","not-started","incomplete","completed","failed","passed","all"],"readOnly":true},"retainPreviousVersionAssignments":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","required":["assignmentGroup"],"properties":{"assignmentGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentGroup","enum":["AssignmentGroup"]}}}}},"backgroundJob":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BackgroundJob","enum":["BackgroundJob"]}}}}},"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}}}}}},"AssignmentGroupDataExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentGroupDataExport","enum":["AssignmentGroupDataExport"]},"attributes":{"type":"object","required":["type"],"properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true,"enum":["survey-responses"]}}},"relationships":{"type":"object","required":["assignmentGroup"],"properties":{"assignmentGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentGroup","enum":["AssignmentGroup"]}}}}}}}}},"AssignmentGroupHeadlineInsight":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentGroupHeadlineInsight","enum":["AssignmentGroupHeadlineInsight"]},"attributes":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"generated":{"type":"number","readOnly":true},"notStarted":{"type":"number","readOnly":true},"inProgress":{"type":"number","readOnly":true},"pendingReview":{"type":"number","readOnly":true},"submitted":{"type":"number","readOnly":true},"completed":{"type":"number","readOnly":true},"passed":{"type":"number","readOnly":true},"failed":{"type":"number","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"AssignmentHeadlineInsight":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentHeadlineInsight","enum":["AssignmentHeadlineInsight"]},"attributes":{"type":"object","properties":{"courseVersion":{"type":"string","readOnly":true},"isCourseVersionLatest":{"type":"boolean","readOnly":true},"items":{"type":"number","readOnly":true},"completed":{"type":"number","readOnly":true},"pendingReview":{"type":"number","readOnly":true},"meanTimeSpentInMillis":{"type":"number","nullable":true,"readOnly":true},"maxTimeSpentInMillis":{"type":"number","nullable":true,"readOnly":true},"meanAttemptScore":{"type":"number","nullable":true,"readOnly":true},"numAttempts":{"type":"number","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"AssignmentItemAudio":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemAudio","enum":["AssignmentItemAudio"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"startDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"endDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"timeSpentInMinutes":{"type":"number","readOnly":true,"nullable":true},"status":{"type":"string","enum":["notStarted","inProgress","pendingReview","reviewed","reinstated","completed"],"nullable":false,"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"isLocked":{"type":"boolean","readOnly":true,"nullable":false},"type":{"type":"string","readOnly":true,"enum":["AssignmentItemAudio"]},"shouldPreview":{"type":"boolean","readOnly":false,"nullable":false},"allowDownload":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"audio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"AssignmentItemDocument":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemDocument","enum":["AssignmentItemDocument"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"startDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"endDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"timeSpentInMinutes":{"type":"number","readOnly":true,"nullable":true},"status":{"type":"string","enum":["notStarted","inProgress","pendingReview","reviewed","reinstated","completed"],"nullable":false,"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"isLocked":{"type":"boolean","readOnly":true,"nullable":false},"type":{"type":"string","readOnly":true,"enum":["AssignmentItemDocument"]},"shouldPreview":{"type":"boolean","readOnly":true,"nullable":false},"allowDownload":{"type":"boolean","readOnly":true,"nullable":false}}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"AssignmentItemEmbed":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemEmbed","enum":["AssignmentItemEmbed"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"startDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"endDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"timeSpentInMinutes":{"type":"number","readOnly":true,"nullable":true},"status":{"type":"string","enum":["notStarted","inProgress","pendingReview","reviewed","reinstated","completed"],"nullable":false,"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"isLocked":{"type":"boolean","readOnly":true,"nullable":false},"type":{"type":"string","readOnly":true,"enum":["AssignmentItemEmbed"]},"shouldPreview":{"type":"boolean","readOnly":false,"nullable":false},"allowDownload":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"embed":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"AssignmentItemNote":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemNote","enum":["AssignmentItemNote"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"startDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"endDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"timeSpentInMinutes":{"type":"number","readOnly":true,"nullable":true},"status":{"type":"string","enum":["notStarted","inProgress","pendingReview","reviewed","reinstated","completed"],"nullable":false,"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"isLocked":{"type":"boolean","readOnly":true,"nullable":false},"type":{"type":"string","readOnly":true,"enum":["AssignmentItemNote"]}}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"note":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Note","enum":["Note"]}}}}}}}}},"AssignmentItemPulse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemPulse","enum":["AssignmentItemPulse"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"pulseInterval":{"type":"number","readOnly":true,"default":15,"description":"The interval in seconds at which the assignment item is pulsed."}}},"relationships":{"type":"object","required":["assignmentItem"],"additionalProperties":false,"properties":{"assignmentItem":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["AssignmentItemAudio","AssignmentItemDocument","AssignmentItemEmbed","AssignmentItemNote","AssignmentItemQuiz","AssignmentItemScorm","AssignmentItemSurvey","AssignmentItemTextEntry","AssignmentItemUpload","AssignmentItemVideo","AssignmentItemZip"],"example":"AssignmentItemAudio"}]}}}}}}}}},"AssignmentItemQuiz":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemQuiz","enum":["AssignmentItemQuiz"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"startDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"endDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"timeSpentInMinutes":{"type":"number","readOnly":true,"nullable":true},"status":{"type":"string","enum":["notStarted","inProgress","pendingReview","reviewed","reinstated","completed"],"nullable":false,"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"isLocked":{"type":"boolean","readOnly":true,"nullable":false},"type":{"type":"string","readOnly":true,"enum":["AssignmentItemQuiz"]},"passScore":{"type":"number","readOnly":false,"nullable":true},"quizMode":{"type":"string","enum":["practice","exam","timedExam"],"readOnly":false,"nullable":false},"isPassed":{"type":"boolean","readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"firstAttempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"latestAttempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AssignmentItemReview":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]},"attributes":{"type":"object","properties":{"body":{"type":"string","readOnly":false,"nullable":true},"scope":{"type":"string","enum":["shared","internal"],"readOnly":true,"nullable":false}}},"relationships":{"type":"object","properties":{"assignmentItem":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["AssignmentItemAudio","AssignmentItemDocument","AssignmentItemEmbed","AssignmentItemNote","AssignmentItemQuiz","AssignmentItemScorm","AssignmentItemSurvey","AssignmentItemTextEntry","AssignmentItemUpload","AssignmentItemVideo","AssignmentItemZip"],"example":"AssignmentItemAudio"}]}}}}},"supportingContent":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"AssignmentItemScorm":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemScorm","enum":["AssignmentItemScorm"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"startDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"endDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"timeSpentInMinutes":{"type":"number","readOnly":true,"nullable":true},"status":{"type":"string","enum":["notStarted","inProgress","pendingReview","reviewed","reinstated","completed"],"nullable":false,"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"isLocked":{"type":"boolean","readOnly":true,"nullable":false},"type":{"type":"string","readOnly":true,"enum":["AssignmentItemScorm"]},"launchUrl":{"type":"string","format":"uri","description":"The URL to launch the SCORM course. This will only be availble when the item is active.","readOnly":true}}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"scorm":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ScormCourse","enum":["ScormCourse"]}}}}},"result":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentScormResult","enum":["AssignmentScormResult"]}}}}}}}}},"AssignmentItemSelfAssessmentOutcome":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemSelfAssessmentOutcome","enum":["AssignmentItemSelfAssessmentOutcome"]},"attributes":{"type":"object","properties":{"selfAssessmentOutcome":{"type":"object","readOnly":true}}},"relationships":{"type":"object","properties":{"assignmentItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemSurvey","enum":["AssignmentItemSurvey"]}}}}}}}}},"AssignmentItemSurvey":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemSurvey","enum":["AssignmentItemSurvey"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"startDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"endDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"timeSpentInMinutes":{"type":"number","readOnly":true,"nullable":true},"status":{"type":"string","enum":["notStarted","inProgress","pendingReview","reviewed","reinstated","completed"],"nullable":false,"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"isLocked":{"type":"boolean","readOnly":true,"nullable":false},"type":{"type":"string","readOnly":true,"enum":["AssignmentItemSurvey"]}}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"survey":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Survey","enum":["Survey"]}}}}},"response":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SurveyResponse","enum":["SurveyResponse"]}}}}}}}}},"AssignmentItemTextEntry":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemTextEntry","enum":["AssignmentItemTextEntry"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"startDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"endDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"timeSpentInMinutes":{"type":"number","readOnly":true,"nullable":true},"status":{"type":"string","enum":["notStarted","inProgress","pendingReview","reviewed","reinstated","completed"],"nullable":false,"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"isLocked":{"type":"boolean","readOnly":true,"nullable":false},"type":{"type":"string","readOnly":true,"enum":["AssignmentItemTextEntry"]},"wordLimit":{"type":"number","minimum":0,"nullable":true,"readOnly":true},"multiLine":{"type":"boolean","nullable":false,"readOnly":true},"response":{"type":"string","nullable":true,"readOnly":false}}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}}}}}},"AssignmentItemUpload":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemUpload","enum":["AssignmentItemUpload"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"startDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"endDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"timeSpentInMinutes":{"type":"number","readOnly":true,"nullable":true},"status":{"type":"string","enum":["notStarted","inProgress","pendingReview","reviewed","reinstated","completed"],"nullable":false,"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"isLocked":{"type":"boolean","readOnly":true,"nullable":false},"type":{"type":"string","readOnly":true,"enum":["AssignmentItemUpload"]},"allowWebcam":{"type":"boolean","readOnly":true,"description":"Indicates if webcam upload is allowed for this assignment item."},"contentType":{"type":"string","readOnly":true,"enum":["audio","document","video","zip","image"]}}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"upload":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"AssignmentItemVideo":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemVideo","enum":["AssignmentItemVideo"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"startDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"endDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"timeSpentInMinutes":{"type":"number","readOnly":true,"nullable":true},"status":{"type":"string","enum":["notStarted","inProgress","pendingReview","reviewed","reinstated","completed"],"nullable":false,"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"isLocked":{"type":"boolean","readOnly":true,"nullable":false},"type":{"type":"string","readOnly":true,"enum":["AssignmentItemVideo"]},"shouldPreview":{"type":"boolean","readOnly":false,"nullable":false},"allowDownload":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"video":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"AssignmentItemZip":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemZip","enum":["AssignmentItemZip"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"startDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"endDate":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"timeSpentInMinutes":{"type":"number","readOnly":true,"nullable":true},"status":{"type":"string","enum":["notStarted","inProgress","pendingReview","reviewed","reinstated","completed"],"nullable":false,"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"isLocked":{"type":"boolean","readOnly":true,"nullable":false},"type":{"type":"string","readOnly":true,"enum":["AssignmentItemZip"]},"shouldPreview":{"type":"boolean","readOnly":false,"nullable":false},"allowDownload":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemReview","enum":["AssignmentItemReview"]}}}}},"bar":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Bar","enum":["Bar"]}}}}}}}}},"AssignmentManualReview":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentManualReview","enum":["AssignmentManualReview"]},"attributes":{"type":"object","properties":{"isApproved":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}}}}}},"AssignmentReattempt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentReattempt","enum":["AssignmentReattempt"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["assignment"],"properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"newAssignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}}}}}},"AssignmentReset":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentReset","enum":["AssignmentReset"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["assignment"],"properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}}}}}},"AssignmentRevocation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentRevocation","enum":["AssignmentRevocation"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}}}}}},"AssignmentScormResult":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentScormResult","enum":["AssignmentScormResult"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["UNKNOWN","COMPLETED","INCOMPLETE"],"readOnly":true},"result":{"type":"string","enum":["UNKNOWN","PASSED","FAILED"],"readOnly":true},"score":{"type":"number","format":"float","readOnly":true},"timeSpentInSeconds":{"type":"number","readOnly":true}}},"relationships":{"type":"object","properties":{"assignmentItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemScorm","enum":["AssignmentItemScorm"]}}}}}}}}},"AssignmentSelfAssessmentReport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentSelfAssessmentReport","enum":["AssignmentSelfAssessmentReport"]},"attributes":{"type":"object","additionalProperties":false,"properties":{}},"relationships":{"type":"object","properties":{"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}}}}}},"Attempt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]},"attributes":{"type":"object","properties":{"title":{"type":"string","readOnly":true},"loginCode":{"type":"string","readOnly":true,"nullable":true,"description":"The candidate's code-login credential. Only present for requesters who can edit the exam, and only on attempts of exams with code login enabled."},"createdAt":{"type":"string","readOnly":true},"isCompleted":{"type":"boolean","readOnly":true},"timeStarted":{"type":"string","readOnly":true},"timeCompleted":{"type":"string","readOnly":true},"proctor":{"type":"object","readOnly":true,"additionalProperties":true,"deprecated":true,"description":"Deprecated. Use flattened fields such as `proctorEnabled`, `proctorVendor` etc instead."},"resitCount":{"type":"number","readOnly":true,"description":"Can be used to generate a resit attempt. If not provided, the attempt will be a new attempt. All requests by students are determined as resit requests, even if this is omitted."},"attemptsAllowed":{"type":"number","nullable":true,"readOnly":true},"schedule":{"type":"object","readOnly":true,"properties":{"activateAt":{"type":"string"},"deactivateAt":{"type":"string","nullable":true}}},"candidateOpenDate":{"type":"string","readOnly":true,"description":"Earliest date at which candidate could have started their exam. Useful for displaying a \"user friendly\" open date for indefinite/ongoing exams with rolling registrations"},"status":{"type":"string","readOnly":true,"enum":["draft","scheduled","active","completed","cancelled"]},"submissionType":{"type":"string","readOnly":true,"nullable":true,"enum":["user","system","moderator","userTimedOut","abandoned",null]},"settings":{"type":"object","readOnly":true,"additionalProperties":true},"state":{"type":"object","readOnly":true,"additionalProperties":true},"quizSetup":{"type":"object","readOnly":true,"additionalProperties":true},"grade":{"type":"object","readOnly":true,"nullable":true,"additionalProperties":true},"examStatus":{"type":"string","readOnly":true},"proctorStatus":{"type":"string","readOnly":true},"score":{"type":"number","readOnly":true},"marks":{"type":"object","nullable":true,"properties":{"points":{"type":"number","readOnly":true},"maxPoints":{"type":"number","readOnly":true},"credits":{"type":"number","readOnly":true},"penalties":{"type":"number","readOnly":true}}},"isRevoked":{"type":"boolean","readOnly":false},"isArchived":{"type":"boolean","readOnly":false,"description":"Hides the attempt from the candidate's exam list. The result remains valid, unlike revoking."},"isOpen":{"type":"boolean","readOnly":true},"isUpcoming":{"type":"boolean","readOnly":true},"isPast":{"type":"boolean","readOnly":true},"isPreview":{"type":"boolean","readOnly":true},"resultsPageHidden":{"type":"boolean","readOnly":false},"resultsScoreHidden":{"type":"boolean","readOnly":false},"version":{"type":"string","readOnly":true},"resultsStatus":{"type":"string","readOnly":false,"enum":["pending","finalised","released"]},"resultsMarkingStatus":{"type":"string","readOnly":false,"enum":["notStarted","inProgress","readyToFinalise","finalised","completed"]},"resultsPendingMarks":{"type":"number","readOnly":true,"nullable":true},"proctorEnabled":{"type":"boolean","readOnly":false,"nullable":true},"proctorVendor":{"type":"string","readOnly":true,"nullable":true},"proctorSessionId":{"type":"string","readOnly":true,"nullable":true},"proctorIsApproved":{"type":"boolean","readOnly":true,"nullable":true},"proctorReviews":{"type":"array","readOnly":true,"nullable":true,"items":{"type":"object","required":["userId","action","timestamp"],"properties":{"id":{"type":"string","readOnly":true},"userId":{"type":"string"},"action":{"type":"string","enum":["approve","reject","comment"]},"timestamp":{"type":"string"},"body":{"type":"string","nullable":true}}}},"proctorRequiresReview":{"type":"boolean","readOnly":true,"nullable":true},"proctorBreaches":{"type":"integer","minimum":0,"readOnly":true,"nullable":true},"proctorLiveProctoring":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleUsePrivateTestArea":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleVisibleFace":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowInteractionWithOthers":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowOtherMaterials":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowNoiseMakingDevices":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowAdditionalDevices":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleAllowMouseKeyboardMonitorOnly":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowAppsOrBroswerTabs":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowExamContentSharing":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowTextPrediction":{"type":"boolean","readOnly":true,"nullable":true},"proctorSynopticLevel":{"type":"string","enum":["web","browser","desktop",null],"readOnly":true,"nullable":true},"proctorScreenMonitoring":{"type":"string","enum":["none","recreation","recreationWithSnapshots","video",null],"readOnly":true,"nullable":true},"proctorWebcamMonitoring":{"type":"string","enum":["none","snapshots","audioVideo",null],"readOnly":true,"nullable":true},"proctorRequireFullscreen":{"type":"boolean","readOnly":true,"nullable":true},"proctorRestrictTabs":{"type":"boolean","readOnly":true,"nullable":true},"proctorRestrictDisplays":{"type":"boolean","readOnly":true,"nullable":true},"proctorKeyboardShortcutsEnabled":{"type":"boolean","readOnly":true,"nullable":true},"proctorScreenshotPrevention":{"type":"boolean","readOnly":true,"nullable":true},"proctorAiReview":{"type":"boolean","readOnly":true,"nullable":true},"proctorAiFlagCandidateLeftFrame":{"type":"boolean","readOnly":true,"nullable":true},"proctorAiFlagMultiplePeopleInFrame":{"type":"boolean","readOnly":true,"nullable":true},"proctorAiPrompts":{"type":"array","readOnly":true,"nullable":true,"items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true}}}},"proctorOnBreach":{"type":"string","enum":["freeze","silent",null],"readOnly":true,"nullable":true},"proctorBlockedApplicationsPolicy":{"type":"string","enum":["none","default",null],"readOnly":true,"nullable":true},"estrangedMarkers":{"type":"object","readOnly":true,"description":"Ids of assigned markers who are no longer members of the exam's user group for their role, per role. Empty arrays when every assigned marker is still a member. Only present on the exam-scoped attempt search, and only when `withEstrangedMarkers=true` is sent; a role key appears only when its assigned-marker relationship was included and the exam has a user group for that role.","properties":{"provisional":{"type":"array","items":{"type":"string"}},"moderating":{"type":"array","items":{"type":"string"}},"escalating":{"type":"array","items":{"type":"string"}},"backReading":{"type":"array","items":{"type":"string"}},"auditing":{"type":"array","items":{"type":"string"}}}},"ltiLaunch":{"type":"object","readOnly":true,"nullable":true,"additionalProperties":false,"required":["consumerKey","contextId","resourceLinkId"],"properties":{"consumerKey":{"type":"string"},"contextId":{"type":"string","nullable":true},"resourceLinkId":{"type":"string","nullable":true},"launchPresentationReturnUrl":{"type":"string","nullable":true},"lisResultSourcedId":{"type":"string","nullable":true},"lisOutcomeServiceUrl":{"type":"string","nullable":true},"scorePostbackUrl":{"type":"string","nullable":true},"scopes":{"type":"array","items":{"type":"string"},"nullable":true},"vendorData":{"type":"object","additionalProperties":true,"nullable":true},"externalUserId":{"type":"string","nullable":true}}}}},"relationships":{"type":"object","properties":{"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"examVoucher":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamVoucher","enum":["ExamVoucher"]}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}},"assignmentItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItem","enum":["AssignmentItem"]}}}}},"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"collectionItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItem","enum":["CollectionItem"]}}}}},"collectionMock":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionMock","enum":["CollectionMock"]}}}}},"study":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Study","enum":["Study"]}}}}},"studyItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"StudyItem","enum":["StudyItem"]}}}}},"responses":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Response"],"example":"Response"}]}}}}}},"responsesV2":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["PlayerAudioResponse","PlayerVideoResponse","PlayerClozeDragAndDropResponse","PlayerClozeDropDownResponse","PlayerClozeTextResponse","PlayerFileUploadResponse","PlayerFreeTextResponse","PlayerInformationalResponse","PlayerMultipleChoiceResponse","PlayerRankedResponse","PlayerSingleChoiceResponse","PlayerShortAnswerResponse","PlayerSpreadsheetResponse","PlayerImageHotspotResponse","PlayerOffPlatformResponse","PlayerFlashcardResponse","PlayerTrueOrFalseResponse","PlayerDrawingResponse"],"example":"PlayerAudioResponse"}]}}}}}},"marker":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"markingState":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingState","enum":["MarkingState"]}}}}},"assignedMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"assignedProvisionalMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"assignedModeratingMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"assignedEscalatingMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"assignedAuditingMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"assignedBackReadingMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"certificate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Certificate","enum":["Certificate"]}}}}}}}}},"AttemptActiveDuration":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptActiveDuration","enum":["AttemptActiveDuration"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"activeTime":{"type":"object","writeOnly":true,"required":["sittingMs"],"additionalProperties":false,"description":"Cumulative active-millisecond counters, never deltas, in the same shape the attempt stores them. The server merges every counter with max(), so resending is always safe. Send only counters that grew.","properties":{"sittingMs":{"type":"object","description":"Exactly one entry: the syncing sitting's id mapped to its own cumulative total. Keys must match ^[A-Za-z0-9_-]{1,64}$, at most 100 per request.","maxProperties":1,"additionalProperties":{"type":"integer","minimum":0,"maximum":2592000000},"minProperties":1},"sectionMs":{"type":"object","description":"Sparse map of sectionId to cumulative active milliseconds for the attempt. Keys that are not real sections of the attempt are ignored. Keys must match ^[A-Za-z0-9_-]{1,64}$, at most 100 per request.","maxProperties":100,"additionalProperties":{"type":"integer","minimum":0,"maximum":2592000000}},"sectionInstructionsMs":{"type":"object","description":"Sparse map of sectionId to cumulative active milliseconds spent on that section's instructions screen, a subset of sectionMs. Keys must match ^[A-Za-z0-9_-]{1,64}$, at most 100 per request.","maxProperties":100,"additionalProperties":{"type":"integer","minimum":0,"maximum":2592000000}},"sectionOutroMs":{"type":"object","description":"Sparse map of sectionId to cumulative active milliseconds spent on that section's outro screen, a subset of sectionMs. Keys must match ^[A-Za-z0-9_-]{1,64}$, at most 100 per request.","maxProperties":100,"additionalProperties":{"type":"integer","minimum":0,"maximum":2592000000}},"attemptInstructionsMs":{"type":"integer","minimum":0,"maximum":2592000000,"description":"Cumulative active milliseconds on the attempt's own instructions screen, which precedes every section and so belongs to none of them."},"questionMs":{"type":"object","description":"Sparse map of questionId to cumulative active milliseconds for the attempt. Keys must match ^[A-Za-z0-9_-]{1,64}$, at most 100 per request.","maxProperties":100,"additionalProperties":{"type":"integer","minimum":0,"maximum":2592000000}}}},"totalMs":{"type":"integer","minimum":0,"readOnly":true,"description":"The attempt-wide merged lifetime total after this sync."}}},"relationships":{"type":"object","required":["attempt"],"additionalProperties":false,"properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttemptChart":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptChart","enum":["AttemptChart"]},"attributes":{"type":"object","properties":{"chartType":{"type":"string","enum":["individualStudentVsCohortBellCurve","subjectBreakdown","topicBreakdown","subtopicBreakdown","skillBreakdown","difficultyBreakdown","subjectProgress","topicProgress","subtopicProgress","overallProgress"],"readOnly":true},"series":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"label":{"type":"string"},"dataset":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"category":{"anyOf":[{"type":"string"},{"type":"number"}]},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}}}}},"xAxes":{"type":"object","readOnly":true,"properties":{"type":{"type":"string","enum":["category","date","value"]},"title":{"type":"string"},"min":{"type":"number"},"max":{"type":"number"}}},"yAxes":{"type":"object","readOnly":true,"properties":{"type":{"type":"string","enum":["category","date","value"]},"title":{"type":"string"},"min":{"type":"number"},"max":{"type":"number"}}},"markers":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"axis":{"type":"string"},"axisValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"label":{"type":"string"}}}},"ranges":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"startCategory":{"anyOf":[{"type":"string"},{"type":"number"}]},"endCategory":{"anyOf":[{"type":"string"},{"type":"number"}]},"type":{"type":"string","enum":["standardDeviation","cohortAverage","usersScore"]},"tooltipText":{"type":"string"}}}},"error":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"dataAnnotation":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttemptCodeLogin":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptCodeLogin","enum":["AttemptCodeLogin"]},"attributes":{"type":"object","properties":{"verifyWith":{"type":"string","enum":["none","surname","externalId"],"readOnly":true,"deprecated":true,"description":"Superseded by requiredDatapoints."},"requiredDatapoints":{"type":"array","readOnly":true,"description":"Every detail the candidate must submit alongside their code. Only the resolved exam knows what it asks for, so this arrives with the datapointRequired outcome.","items":{"type":"string","enum":["none","surname","externalId"]}},"outcome":{"type":"string","enum":["active","submitted","noActiveAttempt","datapointRequired","invalid"],"readOnly":true},"sessionToken":{"type":"string","readOnly":true},"expiresAt":{"type":"string","readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttemptInsight":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptInsight","enum":["AttemptInsight"]},"attributes":{"type":"object","properties":{"insightType":{"type":"string","enum":["microOutcomeCorrect","microOutcomeIncorrect","microOutcomePartial","miniIndividualTimeSpent","miniIndividualAttemptImprovement","miniIndividualStudentVsCohortAverage","miniIndividualPercentile","miniIndividualAttemptGrade"],"readOnly":true},"value":{"type":"string","readOnly":true},"label":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"highlightType":{"type":"string","enum":["user","cohort","neutral","positive","negative","info","warning"],"readOnly":true},"secondaryValue":{"type":"string","readOnly":true},"secondaryVariant":{"type":"string","enum":["positive","negative","neutral"],"readOnly":true},"secondaryTooltip":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttemptLock":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptLock","enum":["AttemptLock"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttemptMarking":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptMarking","enum":["AttemptMarking"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttemptMarksSubmission":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptMarksSubmission","enum":["AttemptMarksSubmission"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["attempt"],"properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttemptOverride":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptOverride","enum":["AttemptOverride"]},"attributes":{"type":"object","properties":{"overrides":{"type":"array","items":{"type":"string","enum":["score","points","credits","penalties","grade"]},"nullable":true},"comment":{"type":"string","readOnly":true},"grade":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"score":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"points":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"credits":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"penalties":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"reverted":{"type":"boolean"}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"AttemptPlayerState":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptPlayerState","enum":["AttemptPlayerState"]},"attributes":{"type":"object","properties":{"isLocked":{"type":"boolean","readOnly":true},"isStarted":{"type":"boolean","readOnly":true},"isCompleted":{"type":"boolean","readOnly":true},"isResultReady":{"type":"boolean","readOnly":true},"isRevoked":{"type":"boolean","readOnly":true},"isProctorReviewRejected":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttemptResultConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptResultConfig","enum":["AttemptResultConfig"]},"attributes":{"type":"object","properties":{"chartConfigList":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"string"},"cloudModule":{"type":"string"},"paramList":{"type":"array","items":{"type":"string"}},"viewOptions":{"type":"object","properties":{"tab":{"type":"string"}}},"chartType":{"type":"string"},"size":{"type":"string"}}}},"microInsightConfigList":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"string"},"cloudModule":{"type":"string"},"paramList":{"type":"array","items":{"type":"string"}},"viewOptions":{"type":"object","properties":{"tab":{"type":"string"}}}}}},"miniInsightConfigList":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"string"},"cloudModule":{"type":"string"},"paramList":{"type":"array","items":{"type":"string"}},"viewOptions":{"type":"object","properties":{"tab":{"type":"string"}}}}}},"sectionBreakdownEnabled":{"type":"boolean"},"sectionBreakdownGradeEnabled":{"type":"boolean"},"sectionBreakdownScoreEnabled":{"type":"boolean"},"educatorsViewAsAdminEnabled":{"type":"boolean"},"detailedViewEnabled":{"type":"boolean"},"tabs":{"type":"object","properties":{"overview":{"type":"object","properties":{"microInsights":{"type":"array","items":{"type":"string"}},"miniInsights":{"type":"array","items":{"type":"string"}},"charts":{"type":"array","items":{"type":"string"}}}},"results":{"type":"object","properties":{"microInsights":{"type":"array","items":{"type":"string"}},"miniInsights":{"type":"array","items":{"type":"string"}},"charts":{"type":"array","items":{"type":"string"}}}},"breakdown":{"type":"object","properties":{"microInsights":{"type":"array","items":{"type":"string"}},"miniInsights":{"type":"array","items":{"type":"string"}},"charts":{"type":"array","items":{"type":"string"}}}},"progress":{"type":"object","properties":{"microInsights":{"type":"array","items":{"type":"string"}},"miniInsights":{"type":"array","items":{"type":"string"}},"charts":{"type":"array","items":{"type":"string"}}}},"questions":{"type":"object","properties":{"microInsights":{"type":"array","items":{"type":"string"}},"miniInsights":{"type":"array","items":{"type":"string"}},"charts":{"type":"array","items":{"type":"string"}}}}}},"meta":{"type":"object","properties":{"facetLabels":{"type":"object","properties":{"exam":{"type":"string"},"module":{"type":"string"},"subject":{"type":"string"},"topic":{"type":"string"},"subtopic":{"type":"string"},"difficulty":{"type":"string"},"skill":{"type":"string"},"context":{"type":"string"}}}}}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttemptRevokeReversal":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptRevokeReversal","enum":["AttemptRevokeReversal"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttemptSchedule":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptSchedule","enum":["AttemptSchedule"]},"attributes":{"type":"object","properties":{"activateAt":{"type":"string","readOnly":false},"deactivateAt":{"type":"string","readOnly":false,"nullable":true},"isExpired":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttemptSitting":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptSitting","enum":["AttemptSitting"]},"attributes":{"type":"object","properties":{"sessionId":{"type":"string","readOnly":true},"timeStarted":{"type":"string","readOnly":true},"ip":{"type":"string","readOnly":true},"userAgent":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttemptSubmission":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptSubmission","enum":["AttemptSubmission"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttemptTagLabel":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptTagLabel","enum":["AttemptTagLabel"]},"attributes":{"type":"object","properties":{"label":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"parent":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptTagLabel","enum":["AttemptTagLabel"]}}}}}}}}},"AttemptTimer":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptTimer","enum":["AttemptTimer"]},"attributes":{"type":"object","properties":{"standardTimeInMs":{"type":"number","readOnly":true},"extraTimeMultiplier":{"type":"number","nullable":true,"readOnly":false}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttemptTimerReset":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptTimerReset","enum":["AttemptTimerReset"]},"attributes":{"type":"object","properties":{"sectionId":{"type":"string","readOnly":true,"nullable":true,"description":"Section to activate. Leave as empty string to reset to first section."},"timeAddedInMins":{"type":"number","readOnly":true,"description":"Time added in minutes, set to 0 to grant reset to default."}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"AttributeConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttributeConfig","enum":["AttributeConfig"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"customId":{"type":"string","readOnly":true,"maxLength":100},"target":{"type":"string","readOnly":true,"enum":["User","Collection","CollectionItem","Exam","LearningRecord","Response","Attempt","Question","SubPortal","UserGroup","AssignmentGroup","Test","Note","Content"]},"type":{"type":"string","enum":["boolean","date","multiChoice","multiText","number","singleChoice","text","link","file"],"readOnly":false},"label":{"type":"string","readOnly":false,"minLength":1,"maxLength":200},"sublabel":{"type":"string","readOnly":false,"maxLength":100,"nullable":true},"description":{"type":"string","readOnly":false,"maxLength":500,"nullable":true},"options":{"type":"array","readOnly":false,"nullable":true,"minItems":1,"maxItems":1000,"items":{"type":"object","properties":{"value":{"anyOf":[{"type":"string","minLength":1},{"type":"number"},{"type":"boolean"}]},"label":{"type":"string"}}}},"labelQuestion":{"type":"string","readOnly":false,"maxLength":500,"nullable":true},"registration":{"type":"object","properties":{"collect":{"type":"boolean"}},"nullable":true,"readOnly":false},"required":{"type":"boolean","readOnly":false},"editPermission":{"type":"number","enum":[0,1,2],"readOnly":false},"viewPermission":{"type":"number","enum":[0,1,2],"readOnly":false},"settings":{"type":"object","nullable":true,"properties":{"link":{"type":"object","properties":{"display":{"type":"object","properties":{"asButton":{"type":"boolean"}}},"authenticated":{"type":"boolean"},"clickBehavior":{"type":"string","enum":["newWindow","sameWindow","modal","modalWithDownload","download","action"],"readOnly":false,"nullable":false}}}}},"inUse":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"AuthenticationOption":{"anyOf":[{"$ref":"#/components/schemas/AuthenticationOptionLocal"},{"$ref":"#/components/schemas/AuthenticationOptionAuth0"},{"$ref":"#/components/schemas/AuthenticationOptionAdfs"},{"$ref":"#/components/schemas/AuthenticationOptionJwt"},{"$ref":"#/components/schemas/AuthenticationOptionLti1p1"},{"$ref":"#/components/schemas/AuthenticationOptionLti1p3"},{"$ref":"#/components/schemas/AuthenticationOptionSaml"}]},"AuthenticationOptionAdfs":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AuthenticationOptionAdfs","enum":["AuthenticationOptionAdfs"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"label":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"isActive":{"type":"boolean","readOnly":false},"preventRegistration":{"type":"boolean","readOnly":false},"authProviderId":{"type":"string","readOnly":true},"type":{"type":"string","enum":["adfs"],"readOnly":true},"domain":{"type":"string","readOnly":true},"tenantId":{"type":"string","readOnly":true},"federationMetadataUrl":{"type":"string","readOnly":true},"spEntityId":{"type":"string","readOnly":true},"isUsingRetiredCertificate":{"type":"boolean","readOnly":true,"description":"Warning: true when SAML assertions are being decrypted with the retired SP certificate."}}},"relationships":{"type":"object","properties":{}}}},"AuthenticationOptionAuth0":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AuthenticationOptionAuth0","enum":["AuthenticationOptionAuth0"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"label":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"isActive":{"type":"boolean","readOnly":false},"preventRegistration":{"type":"boolean","readOnly":false},"authProviderId":{"type":"string","readOnly":true},"type":{"type":"string","enum":["auth0"],"readOnly":true},"domain":{"type":"string","readOnly":true},"clientId":{"type":"string","readOnly":true},"callbackUrl":{"type":"string","readOnly":true},"scope":{"type":"array","items":{"type":"string"},"readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"AuthenticationOptionJwt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AuthenticationOptionJwt","enum":["AuthenticationOptionJwt"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"label":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"isActive":{"type":"boolean","readOnly":false},"preventRegistration":{"type":"boolean","readOnly":false},"authProviderId":{"type":"string","readOnly":true},"type":{"type":"string","enum":["jwt"],"readOnly":true},"secret":{"type":"string","readOnly":true},"loginPageUrl":{"type":"string","readOnly":false,"nullable":true},"embedLoginPage":{"type":"boolean","readOnly":false},"callbackUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"AuthenticationOptionLocal":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AuthenticationOptionLocal","enum":["AuthenticationOptionLocal"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"label":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"isActive":{"type":"boolean","readOnly":false},"preventRegistration":{"type":"boolean","readOnly":false},"type":{"type":"string","enum":["local"],"readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"AuthenticationOptionLti1p1":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AuthenticationOptionLti1p1","enum":["AuthenticationOptionLti1p1"]},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["lti_1p1"],"readOnly":true},"name":{"type":"string","readOnly":false,"minLength":1},"label":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"isActive":{"type":"boolean","readOnly":false},"preventRegistration":{"type":"boolean","readOnly":false},"clientId":{"type":"string","readOnly":true},"clientSecret":{"type":"string","readOnly":true},"launchUrl":{"type":"string","readOnly":true},"launchType":{"type":"string","enum":["collection","exam"],"readOnly":true},"outcomeServiceUrl":{"type":"string","readOnly":false,"nullable":true}}},"relationships":{"type":"object","properties":{}}}},"AuthenticationOptionLti1p3":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AuthenticationOptionLti1p3","enum":["AuthenticationOptionLti1p3"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"label":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"isActive":{"type":"boolean","readOnly":false},"preventRegistration":{"type":"boolean","readOnly":false},"type":{"type":"string","enum":["lti_1p3"],"readOnly":true},"issuer":{"type":"string","minimum":1,"readOnly":true},"clientId":{"type":"string","minimum":1,"readOnly":true},"deploymentId":{"type":"string","minimum":1,"readOnly":true},"jwksUrl":{"type":"string","format":"uri","readOnly":true},"oidcAuthUrl":{"type":"string","format":"uri","readOnly":true},"authTokenUrl":{"type":"string","format":"uri","readOnly":true},"toolJwksUrl":{"type":"string","format":"uri","readOnly":true,"description":"Synap public keyset URL for the platform to verify our JWTs"},"toolLoginUrl":{"type":"string","format":"uri","readOnly":true,"description":"Synap OIDC login initiation URL"},"toolRedirectUrl":{"type":"string","format":"uri","readOnly":true,"description":"Synap redirect URI where the platform posts the ID token"}}},"relationships":{"type":"object","properties":{}}}},"AuthenticationOptionSaml":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AuthenticationOptionSaml","enum":["AuthenticationOptionSaml"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"label":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"isActive":{"type":"boolean","readOnly":false},"preventRegistration":{"type":"boolean","readOnly":false},"authProviderId":{"type":"string","readOnly":true},"type":{"type":"string","enum":["saml"],"readOnly":true},"idpLoginUrl":{"type":"string","readOnly":true},"metadataUrl":{"type":"string","readOnly":true},"spEntityId":{"type":"string","readOnly":true},"attributeFirstName":{"type":"string","readOnly":true,"nullable":true},"attributeLastName":{"type":"string","readOnly":true,"nullable":true},"attributeEmail":{"type":"string","readOnly":true,"nullable":true},"attributeSubPortalId":{"type":"string","readOnly":true,"nullable":true},"isUsingRetiredCertificate":{"type":"boolean","readOnly":true,"description":"Warning: true when SAML assertions are being decrypted with the retired SP certificate."}}},"relationships":{"type":"object","properties":{}}}},"AvailableAccessPolicy":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AvailableAccessPolicy","enum":["AvailableAccessPolicy"]},"attributes":{"type":"object","properties":{"target":{"type":"string","readOnly":true},"targetLabel":{"type":"string","readOnly":true},"subTarget":{"type":"string","readOnly":true},"subTargetLabel":{"type":"string","readOnly":true},"action":{"type":"string","readOnly":true},"actionLabel":{"type":"string","readOnly":true},"position":{"type":"number","readOnly":true},"applicableUserGroupTypes":{"type":"array","items":{"type":"string"},"readOnly":true}}},"relationships":{"type":"object","properties":{"applicableUserTypes":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserType"],"example":"UserType"}]}}}}}}}}}},"BackgroundJob":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BackgroundJob","enum":["BackgroundJob"]},"attributes":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"createdAt":{"type":"string","readOnly":true},"timeStarted":{"type":"string","readOnly":true},"timeCompleted":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"status":{"type":"string","enum":["queued","delayed","started","stalled","successful","failed","panic"],"readOnly":true},"progress":{"type":"number","readOnly":true},"message":{"type":"string","readOnly":true},"data":{"type":"array","readOnly":true,"items":{"type":"array","readOnly":true,"items":{"oneOf":[{"type":"string"},{"type":"object"}],"maxItems":2}}},"params":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true},"result":{"type":"object","readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{}}}},"BadRequestApiError":{"type":"object","description":"The request was invalid.","example":{"id":"ERR_000","title":"UserInputException","status":"400","code":"102","detail":"The request was invalid."},"properties":{"id":{"type":"string","description":"Unique ID of this error occurrence."},"status":{"type":"string","description":"HTTP status code."},"code":{"type":"string","description":"Synap internal error code."},"title":{"type":"string"},"detail":{"type":"string"},"source":{"type":"object","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"}}}}},"BillingInfo":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BillingInfo","enum":["BillingInfo"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"state":{"type":"string","enum":["ok","singleInvoiceReminder","multipleInvoiceReminders","singleInvoiceWarning","mixedReminderAndWarning","multipleInvoiceWarnings","frozen"],"readOnly":true,"description":"The current billing state of the organisation. This indicates if there are any billing issues that need attention."},"oldestUnpaidInvoiceDueDate":{"type":"string","format":"date-time","readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{"invoices":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Invoice"],"example":"Invoice"}]}}}}}}}}}},"BotSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BotSession","enum":["BotSession"]},"attributes":{"type":"object","required":["sessionToken"],"properties":{"apiKeyToken":{"type":"string","readOnly":true},"sessionToken":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"botUser":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BotUser","enum":["BotUser"]}}}}}}}}},"BotUser":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BotUser","enum":["BotUser"]},"attributes":{"type":"object","required":["name","vendorIdentifier"],"properties":{"name":{"type":"string","readOnly":false},"vendorIdentifier":{"type":"string","readOnly":false,"enum":["rosalyn"]}}},"relationships":{"type":"object","properties":{"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}}}}}},"Certificate":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Certificate","enum":["Certificate"]},"attributes":{"type":"object","properties":{"html":{"type":"string","readOnly":true},"documentKey":{"type":"string","readOnly":true},"expiryDate":{"type":"string","readOnly":true},"validationUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Document","enum":["Document"]}}}}},"template":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Template","enum":["Template"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Assignment","enum":["Assignment"]}}}}}}}}},"ChartJs":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ChartJs","enum":["ChartJs"]},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["portal-activity","engagement","sl-overview"]},"chart":{"type":"object","properties":{"type":{"type":"string","enum":["line","pie","scatter","bar"]},"options":{"type":"object"},"data":{"type":"object","properties":{"labels":{"type":"array","items":{"type":"string"}},"datasets":{"type":"array","items":{"type":"object"}}}}}}}},"relationships":{"type":"object","properties":{}}}},"CheckoutSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CheckoutSession","enum":["CheckoutSession"]},"attributes":{"type":"object","required":["isCheckoutCompleted"],"properties":{"productIdentifier":{"type":"string","readOnly":true,"description":"Deprecated on create — send the `product` relationship instead, as an identifier is not unique across portals. One of the two is required."},"currency":{"type":"string","enum":["gbp","eur","usd"],"readOnly":true,"description":"The currency to charge in. Defaults to the product's default currency. Must be one of the currencies the product is priced in, otherwise the request is rejected."},"customerData":{"type":"object","nullable":true,"properties":{"id":{"type":"string","nullable":true,"description":"The external payment gateway customer ID"},"email":{"type":"string","nullable":true,"description":"Can be used to link the payment gateway Customer."}}},"paymentGatewayToken":{"type":"string","readOnly":true,"nullable":true,"description":"The payment gateway token, only for paid products."},"paymentGatewayUrl":{"type":"string","readOnly":true,"nullable":true,"description":"The hosted payment gateway Checkout URL, only returned when creating a paid Checkout Session."},"isCheckoutCompleted":{"type":"boolean","readOnly":false,"nullable":false,"description":"Indicates if the user has completed the checkout form and is ready for processing."},"isPaymentSuccessful":{"type":"boolean","readOnly":true,"nullable":true,"description":"Indicates if the payment gateway checkout was successful."},"processedAt":{"type":"string","readOnly":true,"nullable":true,"description":"The date and time the subscription was processed."},"processingError":{"type":"string","nullable":true,"readOnly":true,"description":"If the payment was successful but the subscription was not created, this will contain the error message."}}},"relationships":{"type":"object","properties":{"storeOffer":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"StoreOffer","enum":["StoreOffer"]}}}}},"product":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Product","enum":["Product"]}}}}},"subscription":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Subscription","enum":["Subscription"]}}}}}}}}},"CloneJob":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CloneJob","enum":["CloneJob"]},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["quiz","course","collection","exam","exam-template"],"readOnly":true},"sourceId":{"type":"string","readOnly":true},"state":{"type":"string","enum":["pending","started","completed","failed"],"readOnly":true},"cloneId":{"type":"string","readOnly":true},"label":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"Collection":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false,"nullable":false,"minLength":1},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"settings":{"type":"object","deprecated":true,"properties":{"takeTest":{"type":"object","additionalProperties":true},"playerView":{"type":"object","properties":{"enabled":{"type":"boolean"},"hideOverviewPage":{"type":"boolean"}}},"trackedProgress":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"annotations":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"export":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"generatedAttempts":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"mocks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string","nullable":true},"filters":{"type":"object","additionalProperties":true},"quizLength":{"type":"number","minimum":1},"passScore":{"type":"number","minimum":0,"maximum":100,"nullable":true},"examSittingAttrs":{"type":"object","additionalProperties":true}}}},"restrictedAccess":{"type":"object","properties":{"label":{"type":"string"}}},"sorting":{"type":"object","properties":{"prioritise":{"type":"boolean"}}}}},"attr":{"type":"object","readOnly":false,"nullable":true},"extraInformation":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"isArchived":{"type":"boolean","readOnly":false,"nullable":true},"generatedAttemptsEnabled":{"type":"boolean","readOnly":false},"mocks":{"type":"array","nullable":true,"items":{"type":"object","required":["id","filters","quizLength"],"properties":{"id":{"type":"string"},"title":{"type":"string","nullable":true,"minLength":1,"maxLength":120},"filters":{"type":"object","additionalProperties":true,"properties":{"weightingType":{"type":"string","enum":["absolute","percentage"]},"filterRules":{"type":"array","minItems":0,"maxItems":125,"description":"Array of filter rules to apply to the dynamic quiz content.","items":{"type":"object","properties":{"weighting":{"type":"number"},"matchingRules":{"type":"array","minItems":0,"maxItems":20,"description":"Array of matching rules to apply to the filter rule. Each rule will be treated as an AND operation. Matching rules can not be a mix of tag and EMQ rules.","items":{"anyOf":[{"type":"object","required":["tagId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["tagId"],"properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}}}]}}}}}}},"quizLength":{"type":"number","minimum":1},"passScore":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"examSittingAttrs":{"type":"object","nullable":true,"additionalProperties":true},"timeInMs":{"type":"number","nullable":true,"minimum":1}}}},"annotationsEnabled":{"type":"boolean","readOnly":false},"exportEnabled":{"type":"boolean","readOnly":false},"playerViewEnabled":{"type":"boolean","readOnly":false},"playerViewHideOverviewPage":{"type":"boolean","readOnly":false},"restrictedAccessLabel":{"type":"string","readOnly":false,"nullable":true},"sortingPrioritise":{"type":"boolean","readOnly":false},"takeTestSettings":{"type":"object","nullable":true,"additionalProperties":true,"deprecated":true,"description":"deprecated, use top level setting fields instead"},"allowedModes":{"type":"array","nullable":true,"items":{"type":"string","enum":["practice","exam","timedExam"]},"minItems":1,"maxItems":3},"allowedLengths":{"type":"array","items":{"type":"string","enum":["default","quick","medium","long","extraLong"]}},"allowedPlayers":{"type":"array","items":{"type":"string","enum":["default","ucat","usmle"]}},"allowedTagSets":{"type":"array","nullable":true,"items":{"type":"string"}},"allowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","skill","difficulty","context"]}},"calculatorEnabled":{"type":"boolean","readOnly":false},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"],"readOnly":false},"allowMultipleTagSelection":{"type":"boolean","readOnly":false},"excludeUntaggedQuestions":{"type":"boolean","readOnly":false},"showMasteryFilters":{"type":"boolean","readOnly":false},"calculatorType":{"type":"string","enum":["basic","scientific"]},"notepadEnabled":{"type":"boolean","readOnly":false},"strikethroughEnabled":{"type":"boolean","readOnly":false},"highlightingEnabled":{"type":"boolean","readOnly":false},"bookmarkingEnabled":{"type":"boolean","readOnly":false},"labValuesEnabled":{"type":"boolean","readOnly":false},"labValuesHtml":{"type":"string","readOnly":false},"flaggingEnabled":{"type":"boolean","readOnly":false},"resultsMessageCompleted":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageSettingHideTitle":{"type":"boolean","readOnly":false},"resultsMetricScoreEnabled":{"type":"boolean","readOnly":false},"resultsMetricTimeSpentEnabled":{"type":"boolean","readOnly":false},"resultsMetricGradeEnabled":{"type":"boolean","readOnly":false},"resultsMetricQuestionBreakdownDisplayLevel":{"type":"string","enum":["full","hideStemAndOptions","hideCorrectOptions","incorrectOnlyHideCorrectOptions","none"],"readOnly":false},"resultsMetricAnalyticsCohort":{"type":"string","enum":["exam","test","sourceTest"]},"resultsMetricCohortAverageEnabled":{"type":"boolean","readOnly":false},"resultsMetricCohortPercentileEnabled":{"type":"boolean","readOnly":false},"resultsMetricCohortScoreDistributionEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagBreakdownEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagProgressEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagProgressFacetsEnabled":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"subject":{"type":"boolean","readOnly":false},"topic":{"type":"boolean","readOnly":false},"subtopic":{"type":"boolean","readOnly":false},"skill":{"type":"boolean","readOnly":false},"difficulty":{"type":"boolean","readOnly":false}}},"resultsEducatorViewAsAdminEnabled":{"type":"boolean","readOnly":false},"trackedProgressEnabled":{"type":"boolean","readOnly":false},"accessLevel":{"type":"string","enum":["editor","none","full","restricted"],"readOnly":true},"totalItems":{"type":"number","readOnly":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionItem","CollectionItemAudio","CollectionItemDocument","CollectionItemEmbed","CollectionItemNote","CollectionItemQuiz","CollectionItemVideo","CollectionItemZip"],"example":"CollectionItem"}]}}}}}},"lockedItems":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionItem","CollectionItemAudio","CollectionItemDocument","CollectionItemEmbed","CollectionItemNote","CollectionItemQuiz","CollectionItemVideo","CollectionItemZip"],"example":"CollectionItem"}]}}}}}},"folders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionFolder"],"example":"CollectionFolder"}]}}}}}},"icon":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"collectionAccess":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionAccess"],"example":"CollectionAccess"}]}}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"CollectionAccess":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionAccess","enum":["CollectionAccess"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"level":{"type":"string","readOnly":false,"nullable":false,"enum":["editor","none","full","restricted"]},"upgradeInstructionsType":{"type":"string","readOnly":true,"nullable":false,"enum":["product","storeOffer"]},"upgradeInstructionsData":{"readOnly":true,"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}},"relationships":{"type":"object","properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}}}}}},"CollectionFolder":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","readOnly":false,"minLength":1,"maxLength":150}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionSubFolder","CollectionItem","CollectionItemAudio","CollectionItemDocument","CollectionItemEmbed","CollectionItemNote","CollectionItemQuiz","CollectionItemVideo","CollectionItemZip"],"example":"CollectionSubFolder"}]}}}}}}}}}},"CollectionItem":{"anyOf":[{"$ref":"#/components/schemas/CollectionItemAudio"},{"$ref":"#/components/schemas/CollectionItemDocument"},{"$ref":"#/components/schemas/CollectionItemEmbed"},{"$ref":"#/components/schemas/CollectionItemNote"},{"$ref":"#/components/schemas/CollectionItemQuiz"},{"$ref":"#/components/schemas/CollectionItemVideo"},{"$ref":"#/components/schemas/CollectionItemZip"}]},"CollectionItemAudio":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemAudio","enum":["CollectionItemAudio"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["audio"]},"releaseStatus":{"type":"string","enum":["available","previewOnly"],"readOnly":false,"nullable":false},"studyEnabled":{"type":"boolean","readOnly":false,"nullable":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":false,"format":"date-time"},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true,"format":"date-time"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"audio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"CollectionItemDocument":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemDocument","enum":["CollectionItemDocument"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["document"]},"releaseStatus":{"type":"string","enum":["available","previewOnly"],"readOnly":false,"nullable":false},"studyEnabled":{"type":"boolean","readOnly":false,"nullable":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":false,"format":"date-time"},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true,"format":"date-time"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true,"nullable":false},"startAtPage":{"readOnly":false,"type":"number","nullable":true}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"CollectionItemEmbed":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemEmbed","enum":["CollectionItemEmbed"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["embed"]},"releaseStatus":{"type":"string","enum":["available","previewOnly"],"readOnly":false,"nullable":false},"studyEnabled":{"type":"boolean","readOnly":false,"nullable":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":false,"format":"date-time"},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true,"format":"date-time"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"embed":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"CollectionItemNote":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemNote","enum":["CollectionItemNote"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["note"]},"releaseStatus":{"type":"string","enum":["available","previewOnly"],"readOnly":false,"nullable":false},"studyEnabled":{"type":"boolean","readOnly":false,"nullable":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":false,"format":"date-time"},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true,"format":"date-time"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"note":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Note","enum":["Note"]}}}}}}}}},"CollectionItemPdfExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemPdfExport","enum":["CollectionItemPdfExport"]},"attributes":{"type":"object","properties":{"url":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"collectionItem":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionItem","CollectionItemAudio","CollectionItemDocument","CollectionItemEmbed","CollectionItemNote","CollectionItemQuiz","CollectionItemVideo","CollectionItemZip"],"example":"CollectionItem"}]}}}}}}}}},"CollectionItemQuiz":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemQuiz","enum":["CollectionItemQuiz"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["quiz"]},"releaseStatus":{"type":"string","enum":["available","previewOnly"],"readOnly":false,"nullable":false},"studyEnabled":{"type":"boolean","readOnly":false,"nullable":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":false,"format":"date-time"},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true,"format":"date-time"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true,"nullable":false},"totalQuestions":{"type":"number","readOnly":true}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"quizAttemptSetupConfig":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizAttemptSetupConfig","enum":["QuizAttemptSetupConfig"]}}}}}}}}},"CollectionItemVideo":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemVideo","enum":["CollectionItemVideo"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["video"]},"releaseStatus":{"type":"string","enum":["available","previewOnly"],"readOnly":false,"nullable":false},"studyEnabled":{"type":"boolean","readOnly":false,"nullable":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":false,"format":"date-time"},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true,"format":"date-time"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"video":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"CollectionItemZip":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionItemZip","enum":["CollectionItemZip"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["zip"]},"releaseStatus":{"type":"string","enum":["available","previewOnly"],"readOnly":false,"nullable":false},"studyEnabled":{"type":"boolean","readOnly":false,"nullable":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":false,"format":"date-time"},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true,"format":"date-time"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionFolder","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"zip":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"CollectionMock":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionMock","enum":["CollectionMock"]},"attributes":{"type":"object","properties":{"title":{"type":"string","nullable":true},"filters":{"type":"object","additionalProperties":true},"quizLength":{"type":"number","minimum":1},"passScore":{"type":"number","minimum":0,"maximum":100,"nullable":true},"examSittingAttrs":{"type":"object","nullable":true,"additionalProperties":true}}},"relationships":{"type":"object","properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}}}}}},"CollectionPdfExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionPdfExport","enum":["CollectionPdfExport"]},"attributes":{"type":"object","properties":{"url":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}}}}}},"CollectionProgress":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionProgress","enum":["CollectionProgress"]},"attributes":{"type":"object","properties":{"percentageSeen":{"type":"number","readOnly":true},"tally":{"type":"object","readOnly":true,"properties":{"unseen":{"type":"number","readOnly":true},"seen":{"type":"number","readOnly":true},"updated":{"type":"number","readOnly":true},"new":{"type":"number","readOnly":true}}},"progress":{"type":"array","readOnly":true,"required":["collectionItemId","status"],"items":{"type":"object","properties":{"collectionItemId":{"type":"string"},"targetId":{"type":"string"},"targetType":{"type":"string","enum":["test","note","content"]},"status":{"type":"string"},"lastSeen":{"type":"string","nullable":true},"firstSeen":{"type":"string","nullable":true},"timesSeen":{"type":"number"}}}}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}}}}}},"CollectionSubFolder":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionSubFolder","enum":["CollectionSubFolder"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","readOnly":true,"enum":["sub-folder"]},"name":{"type":"string","readOnly":false,"minLength":1,"maxLength":150}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CollectionItem","CollectionItemAudio","CollectionItemDocument","CollectionItemEmbed","CollectionItemNote","CollectionItemQuiz","CollectionItemVideo","CollectionItemZip"],"example":"CollectionItem"}]}}}}}}}}}},"CollectionTagBreakdown":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionTagBreakdown","enum":["CollectionTagBreakdown"]},"attributes":{"type":"object","properties":{"totalQuestions":{"type":"number","readOnly":true},"tagDataList":{"type":"array","items":{"type":"object"}}}},"relationships":{"type":"object","properties":{"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}}}}}},"Content":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":false,"minLength":1},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","enum":["audio","document","embed","video","zip","image"],"readOnly":true},"attachmentMimeType":{"type":"string","readOnly":true,"nullable":true},"isLibraryItem":{"type":"boolean","readOnly":true},"isArchived":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"attachment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"embedData":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ContentEmbedDatum","enum":["ContentEmbedDatum"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}},"ContentEmbedDatum":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ContentEmbedDatum","enum":["ContentEmbedDatum"]},"attributes":{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["iframe","video"],"readOnly":false},"source":{"type":"string","readOnly":false},"url":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"thumbnailUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"Course":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false,"nullable":false,"minLength":1},"description":{"type":"string","readOnly":false,"nullable":true},"isArchived":{"type":"boolean","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"versionNumber":{"type":"number","readOnly":true},"publishedAt":{"type":"string","readOnly":true},"totalItems":{"type":"number","readOnly":true}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CourseItem","CourseItemAudio","CourseItemDocument","CourseItemEmbed","CourseItemNote","CourseItemQuiz","CourseItemScorm","CourseItemSurvey","CourseItemTextEntry","CourseItemUpload","CourseItemVideo","CourseItemZip"],"example":"CourseItem"}]}}}}}},"folders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CourseFolder"],"example":"CourseFolder"}]}}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"CourseFolder":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","readOnly":false,"minLength":1,"maxLength":150},"imageUrl":{"type":"string","readOnly":false,"nullable":true}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["CourseItemAudio","CourseItemDocument","CourseItemEmbed","CourseItemNote","CourseItemQuiz","CourseItemScorm","CourseItemSurvey","CourseItemTextEntry","CourseItemUpload","CourseItemVideo","CourseItemZip"],"example":"CourseItemAudio"}]}}}}}}}}}},"CourseItem":{"anyOf":[{"$ref":"#/components/schemas/CourseItemAudio"},{"$ref":"#/components/schemas/CourseItemDocument"},{"$ref":"#/components/schemas/CourseItemEmbed"},{"$ref":"#/components/schemas/CourseItemNote"},{"$ref":"#/components/schemas/CourseItemQuiz"},{"$ref":"#/components/schemas/CourseItemScorm"},{"$ref":"#/components/schemas/CourseItemSurvey"},{"$ref":"#/components/schemas/CourseItemTextEntry"},{"$ref":"#/components/schemas/CourseItemUpload"},{"$ref":"#/components/schemas/CourseItemVideo"},{"$ref":"#/components/schemas/CourseItemZip"}]},"CourseItemAudio":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemAudio","enum":["CourseItemAudio"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["audio"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"shouldPreview":{"type":"boolean","readOnly":false,"nullable":false},"allowDownload":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"audio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"CourseItemDocument":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemDocument","enum":["CourseItemDocument"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["document"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"shouldPreview":{"type":"boolean","readOnly":false,"nullable":false},"allowDownload":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"CourseItemEmbed":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemEmbed","enum":["CourseItemEmbed"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["embed"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"shouldPreview":{"type":"boolean","readOnly":false,"nullable":false},"allowDownload":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"embed":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"CourseItemNote":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemNote","enum":["CourseItemNote"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["note"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"note":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Note","enum":["Note"]}}}}}}}}},"CourseItemQuiz":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemQuiz","enum":["CourseItemQuiz"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["quiz"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"passScore":{"type":"number","readOnly":false,"nullable":true},"quizMode":{"type":"string","enum":["practice","exam","timedExam"],"readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}}}}}},"CourseItemScorm":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemScorm","enum":["CourseItemScorm"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["scorm"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"scorm":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ScormCourse","enum":["ScormCourse"]}}}}}}}}},"CourseItemSurvey":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemSurvey","enum":["CourseItemSurvey"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["survey"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"survey":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Survey","enum":["Survey"]}}}}}}}}},"CourseItemTextEntry":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemTextEntry","enum":["CourseItemTextEntry"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["textEntry"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"wordLimit":{"type":"number","minimum":0,"nullable":true,"readOnly":false},"multiLine":{"type":"boolean","nullable":false,"readOnly":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}}}}}},"CourseItemUpload":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemUpload","enum":["CourseItemUpload"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["upload"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"contentType":{"type":"string","readOnly":false,"enum":["audio","document","video","zip","image"]}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}}}}}},"CourseItemVideo":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemVideo","enum":["CourseItemVideo"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["video"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"shouldPreview":{"type":"boolean","readOnly":false,"nullable":false},"allowDownload":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"video":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"CourseItemZip":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseItemZip","enum":["CourseItemZip"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"nullable":false},"description":{"type":"string","readOnly":false,"nullable":true},"customLabel":{"type":"string","readOnly":false,"nullable":true},"type":{"type":"string","readOnly":true,"enum":["zip"]},"isReviewRequired":{"type":"boolean","readOnly":false,"nullable":false},"shouldPreview":{"type":"boolean","readOnly":false,"nullable":false},"allowDownload":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Course","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CourseFolder","enum":["CourseFolder"]}}}}},"zip":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Content","enum":["Content"]}}}}}}}}},"CustomInsight":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CustomInsight","enum":["CustomInsight"]},"attributes":{"type":"object","properties":{"insightType":{"type":"string","readOnly":true,"enum":["studentProgress"]},"insightData":{"type":"array","items":{}}}},"relationships":{"type":"object","properties":{}}}},"Document":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Document","enum":["Document"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":true},"contentType":{"type":"string","enum":["certificate","exam-paper","exam-result","report"],"readOnly":true},"targetType":{"type":"string","enum":["Exam","User","UserGroup"],"readOnly":true},"targetId":{"type":"string","readOnly":true},"key":{"type":"string","readOnly":true},"url":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"EmailVerification":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"EmailVerification","enum":["EmailVerification"]},"attributes":{"type":"object","properties":{"verified":{"type":"boolean","enum":[true],"readOnly":false}}},"relationships":{"type":"object","properties":{}}}},"EmqGroupExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"EmqGroupExport","enum":["EmqGroupExport"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["quiz"],"properties":{"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}}}}}},"EmqGroupImport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"EmqGroupImport","enum":["EmqGroupImport"]},"attributes":{"type":"object","properties":{"csvUrl":{"type":"string","readOnly":true},"fieldMap":{"type":"object","readOnly":true}}},"relationships":{"type":"object","properties":{"backgroundJob":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BackgroundJob","enum":["BackgroundJob"]}}}}},"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}}}}}},"EmqGroupImportValidation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"EmqGroupImportValidation","enum":["EmqGroupImportValidation"]},"attributes":{"type":"object","properties":{"toCreate":{"type":"number","readOnly":true},"toUpdate":{"type":"number","readOnly":true},"toDelete":{"type":"number","readOnly":true}}},"relationships":{"type":"object","properties":{"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}}}}}},"EnrichedAttempt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"EnrichedAttempt","enum":["EnrichedAttempt"]},"attributes":{"type":"object","properties":{"testId":{"type":"string"},"testName":{"type":"string"},"examId":{"type":"string","nullable":true},"examName":{"type":"string","nullable":true},"examStatus":{"type":"string","nullable":true,"enum":["enrolled","expired","notified","preflight","revoked","started","submitted","cancelled"]},"submissionType":{"type":"string","nullable":true,"enum":["user","system","moderator","userTimedOut","abandoned",null]},"schedule":{"type":"object","properties":{"activateAt":{"type":"string"},"deactivateAt":{"type":"string","nullable":true}}},"certificateLink":{"type":"string"},"grade":{"nullable":true,"type":"object","properties":{"label":{"type":"string"},"isPass":{"type":"boolean"}}},"marks":{"nullable":true,"readOnly":true,"type":"object","properties":{"points":{"type":"number"},"maxPoints":{"type":"number"},"credits":{"type":"number"},"penalties":{"type":"number"}}},"createdAt":{"type":"string","nullable":true,"readOnly":true},"timeStarted":{"type":"string","nullable":true},"timeCompleted":{"type":"string","nullable":true},"timeTaken":{"type":"number","nullable":true},"proctorStatus":{"type":"string","nullable":true,"enum":["disabled","enabled","failed","inReview","passed","readyForReview","reviewNotRequired","error"]},"proctorVendor":{"type":"string","nullable":true,"enum":["internal","rosalyn","synopticV2"]},"proctorSessionId":{"type":"string","nullable":true},"proctorBreaches":{"type":"number","nullable":true},"markingStatus":{"type":"string","nullable":true,"enum":["completed","inProgress","notStarted","readyToFinalise","finalised"]},"resultsStatus":{"type":"string","nullable":true,"enum":["finalised","pending","released"]},"resultsPageHidden":{"type":"boolean","nullable":true},"resultsScoreHidden":{"type":"boolean","nullable":true},"score":{"type":"number","nullable":true},"passFailEnabled":{"type":"boolean","nullable":true},"releasedBy":{"type":"string","nullable":true},"finalisedBy":{"type":"string","nullable":true},"finalisedAt":{"type":"string","nullable":true},"releasedAt":{"type":"string","nullable":true},"version":{"type":"string","readOnly":true},"loginCode":{"type":"string","readOnly":true,"nullable":true,"description":"The candidate's code-login credential. Only present for requesters who can edit the exam, and only on attempts of exams with code login enabled."}}},"relationships":{"type":"object","properties":{"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"finalisedBy":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"releasedBy":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"assignedMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"assignedModeratingMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"assignedProvisionalMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}}}}}},"EnrichedAttemptOption":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"EnrichedAttemptOption","enum":["EnrichedAttemptOption"]},"attributes":{"type":"object","properties":{"type":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"readOnly":true},"options":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}}}},"relationships":{"type":"object","properties":{}}}},"Exam-V-2":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string"},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true},"directUserRegistrationEnabled":{"type":"boolean","readOnly":true,"description":"If true, the exam will created with an implicit user group and users can be registered directly into the exam without the need for user group management."},"isDynamic":{"type":"boolean","readOnly":true},"isSectioned":{"type":"boolean","readOnly":true},"shortDescription":{"type":"string","nullable":true},"preExamInstructions":{"type":"string","nullable":true},"markingDoubleEnabled":{"type":"boolean"},"markingDoubleAllocation":{"type":"string","enum":["manual","roundRobin"],"nullable":true},"markingDoubleMinMarkers":{"type":"number","nullable":true},"markingDoubleSequence":{"type":"string","enum":["parallel","serial"],"nullable":true},"markingBlindProvisionalMarker":{"type":"boolean"},"markingBlindModeratingMarker":{"type":"boolean"},"markingBlindEscalationMarker":{"type":"boolean"},"markingBlindBackReadingMarker":{"type":"boolean"},"markingBlindAuditingMarker":{"type":"boolean"},"markingBlindIsolate":{"type":"boolean"},"markerConcealmentProvisional":{"type":"boolean"},"markerConcealmentModerating":{"type":"boolean"},"markerConcealmentEscalation":{"type":"boolean"},"markerConcealmentAuditing":{"type":"boolean"},"markingEscalationEnabled":{"type":"boolean"},"markingEscalationModeratorsCanEscalate":{"type":"boolean"},"markingEscalationReasons":{"type":"array","minItems":1,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}},"markingBackReadingEnabled":{"type":"boolean"},"markingAuditingEnabled":{"type":"boolean"},"markingResolutionEnabled":{"type":"boolean"},"notificationAutomateEmails":{"type":"boolean"},"notificationResultsEmailEnabled":{"type":"boolean"},"hideFromCandidateList":{"type":"boolean"},"markingModeratingMarkerAllocation":{"type":"string","enum":["manual","roundRobin"],"nullable":true},"markingProvisionalMarkerAllocation":{"type":"string","enum":["manual","roundRobin"],"nullable":true},"markingEscalationMarkerAllocation":{"type":"string","enum":["manual","roundRobin"],"nullable":true},"ipAllowList":{"type":"array","readOnly":false,"nullable":true,"minItems":1,"items":{"type":"string"}},"lockedByDefault":{"type":"boolean","readOnly":false,"nullable":true},"resumeSameSession":{"type":"boolean","readOnly":false,"nullable":true},"resumeAllowed":{"type":"boolean","readOnly":false,"nullable":true},"passcodeEnabled":{"type":"boolean","readOnly":false,"nullable":false},"passcodeValue":{"type":"string","readOnly":false,"nullable":true},"codeLoginEnabled":{"type":"boolean","readOnly":false,"nullable":false},"codeLoginVerifyWith":{"type":"string","enum":["none","surname","externalId"],"readOnly":false,"nullable":true},"codeLoginSharedCode":{"type":"boolean","readOnly":false,"nullable":false,"description":"Every candidate sitting the exam signs in with the exam's id as their code, identifying themselves with both their external ID and their surname. Ignores codeLoginVerifyWith."},"codeLoginGenerateMissingAttempt":{"type":"boolean","readOnly":false,"nullable":false,"description":"Create an attempt during a shared-code sign-in for a student on the portal who does not have one yet."},"attr":{"type":"object"},"isArchived":{"type":"boolean"},"mutexLockKey":{"type":"string","nullable":true,"readOnly":true},"mutexLockExpiresAt":{"type":"string","nullable":true,"readOnly":true},"mutexLockType":{"type":"string","enum":["full","write"],"readOnly":true},"testVersions":{"type":"object","readOnly":true,"properties":{"DRAFT":{"type":"string"}},"additionalProperties":{"oneOf":[{"type":"string"},{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"publishedBy":{"type":"string"},"publishedAt":{"type":"string"},"status":{"type":"string","enum":["draft","published","closed","cancelled"]},"scheduleOpenDate":{"type":"string","nullable":true},"scheduleCloseDate":{"type":"string","nullable":true},"previousVersionId":{"type":"string","nullable":true}}}]}},"resultEducatorsViewAsAdminEnabled":{"type":"boolean"},"resultDetailedViewEnabled":{"type":"boolean"}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"markers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"moderatingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"escalatingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"auditingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"backReadingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"setupJob":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BackgroundJob","enum":["BackgroundJob"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"publishedVersion":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"currentVersion":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}},"ExamAttemptHeadlineInsight":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamAttemptHeadlineInsight","enum":["ExamAttemptHeadlineInsight"]},"attributes":{"type":"object","properties":{"generated":{"type":"number","readOnly":true},"notStarted":{"type":"number","readOnly":true},"inProgress":{"type":"number","readOnly":true},"submitted":{"type":"number","readOnly":true},"passCount":{"type":"number","readOnly":true},"passPercentage":{"type":"number","readOnly":true},"averageScore":{"type":"number","readOnly":true},"candidateCount":{"type":"number","readOnly":true},"passedCandidateCount":{"type":"number","readOnly":true}}},"relationships":{"type":"object","properties":{"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}}}}}},"ExamCandidateExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamCandidateExport","enum":["ExamCandidateExport"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}}}}}},"ExamHall":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamHall","enum":["ExamHall"]},"attributes":{"type":"object","properties":{"ip":{"type":"object","properties":{"address":{"type":"string"},"allowed":{"type":"boolean"}}},"resume":{"type":"object","properties":{"allowed":{"type":"boolean"},"sessionMismatch":{"type":"boolean"}}},"includesAudioQuestions":{"type":"boolean","readOnly":true,"nullable":false},"includesVideoQuestions":{"type":"boolean","readOnly":true,"nullable":false},"includesWebcamCaptureQuestions":{"type":"boolean","readOnly":true,"nullable":false},"includesAudioStems":{"type":"boolean","readOnly":true,"nullable":false},"questionsSettings":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"questionId":{"type":"string","readOnly":true},"questionSettings":{"type":"object","properties":{"timerTimeInMs":{"type":"number","readOnly":true,"nullable":true}}}}}},"extraTimeMultiplier":{"type":"number","readOnly":true,"nullable":true},"title":{"type":"string","readOnly":true},"status":{"type":"string","enum":["draft","published","cancelled","closed"],"readOnly":true},"scheduleOpenDate":{"type":"string","readOnly":true,"nullable":true},"scheduleCloseDate":{"type":"string","readOnly":true,"nullable":true},"scheduleSubmissionDueDate":{"type":"string","readOnly":true,"nullable":true},"resitType":{"type":"string","enum":["continuous","fixedDate","onDemand","rolling",null],"readOnly":true,"nullable":true},"resitMode":{"type":"string","enum":["standard","fixed","progressive","preferUnseen",null],"readOnly":true,"nullable":true},"resitGradeIndependent":{"type":"boolean","readOnly":true,"nullable":true},"resitAllowedAttempts":{"type":"number","readOnly":true,"nullable":true},"legalEnabled":{"type":"boolean","readOnly":true},"legalTitle":{"type":"string","readOnly":true,"nullable":true},"legalBody":{"type":"string","readOnly":true,"nullable":true},"legalCheckboxLabel":{"type":"string","readOnly":true,"nullable":true},"legalConfirmationType":{"type":"string","enum":["checkbox","staticText","candidateName"],"readOnly":true,"nullable":true},"legalConfirmationStaticText":{"type":"string","readOnly":true,"nullable":true},"proctorEnabled":{"type":"boolean","readOnly":true},"proctorVendor":{"type":"string","enum":["internal","rosalyn","synopticV2",null],"readOnly":true,"nullable":true},"proctorRequireFullscreen":{"type":"boolean","readOnly":true},"proctorRestrictTabs":{"type":"boolean","readOnly":true},"proctorRestrictDisplays":{"type":"boolean","readOnly":true},"proctorRecordSession":{"type":"boolean","readOnly":true},"proctorRecordSnapshots":{"type":"boolean","readOnly":true},"proctorRecordDesktop":{"type":"boolean","readOnly":true},"proctorSynopticLevel":{"type":"string","enum":["web","browser","desktop"],"readOnly":true},"proctorScreenMonitoring":{"type":"string","enum":["none","recreation","recreationWithSnapshots","video"],"readOnly":true},"proctorWebcamMonitoring":{"type":"string","enum":["none","snapshots","audioVideo"],"readOnly":true},"proctorRestrictKeyboardShortcuts":{"type":"boolean","readOnly":true},"proctorScreenshotPrevention":{"type":"boolean","readOnly":true,"nullable":true},"proctorAiReview":{"type":"boolean","readOnly":true},"proctorAiFlagCandidateLeftFrame":{"type":"boolean","readOnly":true},"proctorAiFlagMultiplePeopleInFrame":{"type":"boolean","readOnly":true},"proctorAiPrompts":{"type":"array","readOnly":true,"nullable":true,"items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true}}}},"proctorOnBreach":{"type":"string","enum":["freeze","silent",null],"readOnly":true,"nullable":true},"proctorLiveProctoring":{"type":"boolean","readOnly":true},"proctorBlockedApplicationsPolicy":{"type":"string","enum":["none","default",null],"readOnly":true,"nullable":true},"proctorReviewOptional":{"type":"boolean","readOnly":true},"proctorReviewMode":{"type":"string","enum":["always","never","onBreach",null],"readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"attemptLock":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptLock","enum":["AttemptLock"]}}}}}}}}},"ExamineeNotification":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamineeNotification","enum":["ExamineeNotification"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam","enum":["Exam"]}}}}},"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"ExamPreview":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamPreview","enum":["ExamPreview"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}}}}}},"ExamQuestionStats":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamQuestionStats","enum":["ExamQuestionStats"]},"attributes":{"type":"object","properties":{"averageCredits":{"type":"number","readOnly":true},"averageScore":{"type":"number","readOnly":true},"totalResponses":{"type":"number","readOnly":true},"correctResponses":{"type":"number","readOnly":true},"incorrectResponses":{"type":"number","readOnly":true},"partiallyCorrectResponses":{"type":"number","readOnly":true},"skippedResponses":{"type":"number","readOnly":true},"totalOptions":{"type":"number","readOnly":true},"correctOptions":{"type":"number","readOnly":true},"itemDifficultyChance":{"type":"number","readOnly":true,"nullable":true},"itemDifficultyPValue":{"type":"number","readOnly":true},"itemDiscriminationType":{"type":"string","readOnly":true,"nullable":true},"itemDiscriminationValue":{"type":"number","readOnly":true,"nullable":true},"optionsBreakdown":{"type":"object","readOnly":true},"examTestVersion":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"question":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}},"sourceQuestion":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"EmqGroup","enum":["EmqGroup"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Section","enum":["Section"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}}}}}},"ExamQuestionStatsExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamQuestionStatsExport","enum":["ExamQuestionStatsExport"]},"attributes":{"type":"object","properties":{"examId":{"type":"string"},"version":{"type":"string","pattern":"^[0-9]+$"},"versions":{"type":"array","items":{"type":"string","pattern":"^[0-9]+$"}}}},"relationships":{"type":"object","properties":{}}}},"ExamSchedule":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamSchedule","enum":["ExamSchedule"]},"attributes":{"type":"object","required":["activateAt"],"properties":{"activateAt":{"type":"string","readOnly":false},"deactivateAt":{"type":"string","nullable":true,"readOnly":false},"status":{"type":"string","enum":["draft","scheduled","active","completed","cancelled"],"readOnly":true}}},"relationships":{"type":"object","properties":{"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam","enum":["Exam"]}}}}}}}}},"ExamStats":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamStats","enum":["ExamStats"]},"attributes":{"type":"object","properties":{"cronbachAlpha":{"type":"number","readOnly":true,"nullable":true},"kr20":{"type":"number","readOnly":true,"nullable":true},"isDichotomous":{"type":"boolean","readOnly":true},"totalCandidates":{"type":"number","readOnly":true},"submittedAttempts":{"type":"number","readOnly":true},"averageScore":{"type":"number","readOnly":true},"passCount":{"type":"number","readOnly":true},"passPercentage":{"type":"number","readOnly":true},"meanScore":{"type":"number","readOnly":true},"meanScorePercentage":{"type":"number","readOnly":true},"itemCount":{"type":"number","readOnly":true},"scoreDistribution":{"type":"object","readOnly":true,"description":"Score-distribution counts keyed by 1% score bands such as band0_1 and band99_100.","additionalProperties":{"type":"number"}},"outcomeCounts":{"type":"object","readOnly":true,"properties":{"correct":{"type":"number"},"incorrect":{"type":"number"},"partial":{"type":"number"},"skipped":{"type":"number"},"excluded":{"type":"number"}}},"gradeBreakdown":{"type":"object","readOnly":true,"description":"For graded exams, grade label to count of users achieving that grade.","additionalProperties":{"type":"number"}},"gradeOverrideCount":{"type":"number","readOnly":true,"description":"For graded exams, the number of submitted attempts with a manual grade override applied."},"revokedCount":{"type":"number","readOnly":true,"description":"Number of revoked attempts included in the exam stats aggregates."},"resitGradeBreakdown":{"type":"object","readOnly":true,"description":"For graded exams, grade label to count across submitted resit attempts in scope.","additionalProperties":{"type":"number"}},"lifecycle":{"type":"object","readOnly":true,"description":"Attempt lifecycle counts: generated, not started, in progress, and submitted.","properties":{"generated":{"type":"number"},"notStarted":{"type":"number"},"inProgress":{"type":"number"},"submitted":{"type":"number"}}},"resits":{"type":"object","readOnly":true,"description":"First-sit vs resit attempt counts.","properties":{"firstSit":{"type":"number"},"resit":{"type":"number"}}}}},"relationships":{"type":"object","properties":{"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}}}}}},"ExamTemplate":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamTemplate","enum":["ExamTemplate"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","minLength":1,"maxLength":255},"description":{"type":"string","nullable":true},"isDynamic":{"type":"boolean","readOnly":true},"dynamicIsSectioned":{"type":"boolean","nullable":true},"lockedByDefault":{"type":"boolean","nullable":true},"ipAllowList":{"type":"array","items":{"type":"string"},"nullable":true},"resumeAllowed":{"type":"boolean","nullable":true},"resumeSameSession":{"type":"boolean","nullable":true},"passcodeEnabled":{"type":"boolean","nullable":true},"passcodeValue":{"type":"string","nullable":true},"hideFromCandidateList":{"type":"boolean","nullable":true},"allowedMode":{"type":"string","nullable":true},"allowedPlayers":{"type":"array","items":{"type":"string"},"nullable":true},"passFailEnabled":{"type":"boolean","nullable":true},"calculatorEnabled":{"type":"boolean","nullable":true},"calculatorType":{"type":"string","nullable":true},"notepadEnabled":{"type":"boolean","nullable":true},"resizableQuestionPanelsEnabled":{"type":"boolean","nullable":true},"strikethroughEnabled":{"type":"boolean","nullable":true},"highlightingEnabled":{"type":"boolean","nullable":true},"bookmarkingEnabled":{"type":"boolean","nullable":true},"flaggingEnabled":{"type":"boolean","nullable":true},"micEnabled":{"type":"boolean","nullable":true},"resumeLaterButtonEnabled":{"type":"boolean","nullable":true},"labValuesEnabled":{"type":"boolean","nullable":true},"labValuesHtml":{"type":"string","nullable":true},"additionalInformationEnabled":{"type":"boolean","nullable":true},"additionalInformationHtml":{"type":"string","nullable":true},"additionalInformationTitle":{"type":"string","nullable":true},"additionalInformationIcon":{"type":"string","nullable":true},"externalPlayerType":{"type":"string","nullable":true},"deferResultEnabled":{"type":"boolean","nullable":true},"deferResultAlwaysRelease":{"type":"boolean","nullable":true},"deferResultMessage":{"type":"string","nullable":true},"optionShuffling":{"type":"string","nullable":true},"questionShuffling":{"type":"string","nullable":true},"sectionShufflingEnabled":{"type":"boolean","nullable":true},"softSectionsEnabled":{"type":"boolean","nullable":true},"sectionGradesEnabled":{"type":"boolean","nullable":true},"advancedGradingEnabled":{"type":"boolean","nullable":true},"availableMarksEnabled":{"type":"boolean","nullable":true},"pinnedMessageDuringTest":{"type":"string","nullable":true},"excludeInformationalQuestionsFromCounts":{"type":"boolean","nullable":true},"timerEnabled":{"type":"boolean","nullable":true},"timerTimeInMs":{"type":"number","nullable":true},"timerUseSections":{"type":"boolean","nullable":true},"timerUseQuestions":{"type":"boolean","nullable":true},"timerEnforceFullTime":{"type":"boolean","nullable":true},"timerExtraTimeMultiplier":{"type":"number","nullable":true},"timerSoftTimer":{"type":"boolean","nullable":true},"disableCopying":{"type":"boolean","nullable":true},"disablePasting":{"type":"boolean","nullable":true},"disableRightClick":{"type":"boolean","nullable":true},"disableNavigation":{"type":"boolean","nullable":true},"disableControlPanel":{"type":"boolean","nullable":true},"disableNotifications":{"type":"boolean","nullable":true},"styleTheme":{"type":"string","nullable":true},"styleFontSize":{"type":"string","nullable":true},"creditsPerQuestion":{"type":"number","nullable":true},"enablePenalties":{"type":"boolean","nullable":true},"penaltiesPerQuestion":{"type":"number","nullable":true},"partialCreditsPerQuestion":{"type":"number","nullable":true},"grades":{"type":"array","nullable":true,"items":{"type":"object","required":["label","minScore"],"properties":{"label":{"type":"string"},"description":{"type":"string","nullable":true},"minScore":{"type":"number","nullable":true},"isPass":{"type":"boolean","nullable":true},"advancedCriteria":{"type":"object","nullable":true,"properties":{"sectionRequirements":{"type":"object","nullable":true,"properties":{"type":{"type":"string"},"count":{"type":"number","nullable":true},"sectionIds":{"type":"array","items":{"type":"string"},"nullable":true}}},"excludeFromResitAttempts":{"type":"boolean","nullable":true}}}}}},"instructionsEnabled":{"type":"boolean","nullable":true},"instructionsTitle":{"type":"string","nullable":true},"instructionsBody":{"type":"string","nullable":true},"instructionsTimerDurationMs":{"type":"number","nullable":true},"instructionsEnforcedTimer":{"type":"string","nullable":true},"instructionsAudioAutoAdvance":{"type":"string","nullable":true},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","minimum":0,"maximum":3600000,"nullable":true},"instructionsAudioAutoPlay":{"type":"boolean","nullable":true},"instructionsDisableAudioControls":{"type":"boolean","nullable":true},"resultDetailedViewEnabled":{"type":"boolean","nullable":true},"resultEducatorsViewAsAdminEnabled":{"type":"boolean","nullable":true},"resultHideResultsPage":{"type":"boolean","nullable":true},"resultGlobalHideScore":{"type":"boolean","nullable":true},"resultScoreEnabled":{"type":"boolean","nullable":true},"resultTimeSpentEnabled":{"type":"boolean","nullable":true},"resultGradeEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownGradeEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownScoreEnabled":{"type":"boolean","nullable":true},"resultQuestionBreakdownDisplay":{"type":"string","nullable":true},"resultAnalyticsCohort":{"type":"string","nullable":true},"resultCohortAverageEnabled":{"type":"boolean","nullable":true},"resultPercentileEnabled":{"type":"boolean","nullable":true},"resultScoreDistributionEnabled":{"type":"boolean","nullable":true},"resultTagBreakdownEnabled":{"type":"boolean","nullable":true},"resultProgressEnabled":{"type":"boolean","nullable":true},"resultFacetSubjectEnabled":{"type":"boolean","nullable":true},"resultFacetTopicEnabled":{"type":"boolean","nullable":true},"resultFacetSubtopicEnabled":{"type":"boolean","nullable":true},"resultFacetSkillEnabled":{"type":"boolean","nullable":true},"resultFacetDifficultyEnabled":{"type":"boolean","nullable":true},"resultMessagePassed":{"type":"string","nullable":true},"resultMessageFailed":{"type":"string","nullable":true},"resultMessageResitsRemaining":{"type":"string","nullable":true},"resultMessageNoResitsRemaining":{"type":"string","nullable":true},"resultMessageCompleted":{"type":"string","nullable":true},"resultMessageSettingHideTitle":{"type":"boolean","nullable":true},"resultHiddenMessage":{"type":"string","nullable":true},"resultHiddenSettingHideTitle":{"type":"boolean","nullable":true},"resultOverviewWhenPassedMessage":{"type":"string","nullable":true},"resultOverviewWhenFailedHasResitsMessage":{"type":"string","nullable":true},"resultOverviewWhenFailedNoResitsMessage":{"type":"string","nullable":true},"resultOverviewWhenCompleteNoGradesMessage":{"type":"string","nullable":true},"resultOverviewWhenCompletedNeutralGradesMessage":{"type":"string","nullable":true},"markingDoubleEnabled":{"type":"boolean","nullable":true},"markingDoubleAllocation":{"type":"string","nullable":true},"markingDoubleMinMarkers":{"type":"number","nullable":true},"markingDoubleSequence":{"type":"string","nullable":true},"markingBlindProvisionalMarker":{"type":"boolean","nullable":true},"markingBlindModeratingMarker":{"type":"boolean","nullable":true},"markingBlindEscalationMarker":{"type":"boolean","nullable":true},"markingBlindBackReadingMarker":{"type":"boolean","nullable":true},"markingBlindAuditingMarker":{"type":"boolean","nullable":true},"markingBlindIsolate":{"type":"boolean","nullable":true},"markerConcealmentProvisional":{"type":"boolean","nullable":true},"markerConcealmentModerating":{"type":"boolean","nullable":true},"markerConcealmentEscalation":{"type":"boolean","nullable":true},"markerConcealmentAuditing":{"type":"boolean","nullable":true},"markingEscalationEnabled":{"type":"boolean","nullable":true},"markingEscalationModeratorsCanEscalate":{"type":"boolean","nullable":true},"markingEscalationReasons":{"type":"array","nullable":true,"items":{"type":"object","required":["label","description"],"properties":{"slug":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}},"markingBackReadingEnabled":{"type":"boolean","nullable":true},"markingAuditingEnabled":{"type":"boolean","nullable":true},"markingResolutionEnabled":{"type":"boolean","nullable":true},"markingProvisionalMarkerAllocation":{"type":"string","nullable":true},"markingModeratingMarkerAllocation":{"type":"string","nullable":true},"markingEscalationMarkerAllocation":{"type":"string","nullable":true},"preExamInstructions":{"type":"string","nullable":true},"notificationAutomateEmails":{"type":"boolean","nullable":true},"notificationResultsEmailEnabled":{"type":"boolean","nullable":true},"certificatesEnabled":{"type":"boolean","nullable":true},"certificatesIssueOnFail":{"type":"boolean","nullable":true},"certificatesTemplateId":{"type":"string","nullable":true},"certificatesQrCode":{"type":"boolean","nullable":true},"certificatesResultsPage":{"type":"boolean","nullable":true},"certificatesTtl":{"type":"number","nullable":true},"certificatesIgnoreSubPortalBranding":{"type":"boolean","nullable":true},"certificatesSharingImageUrl":{"type":"string","nullable":true},"resitEnabled":{"type":"boolean","nullable":true},"resitType":{"type":"string","nullable":true},"resitMode":{"type":"string","nullable":true},"resitAllowedAttempts":{"type":"number","nullable":true},"resitGradeIndependent":{"type":"boolean","nullable":true},"resitDelay":{"type":"number","nullable":true},"resitCloseDelay":{"type":"number","nullable":true},"legalEnabled":{"type":"boolean","nullable":true},"legalConfirmationType":{"type":"string","nullable":true},"legalTitle":{"type":"string","nullable":true},"legalBody":{"type":"string","nullable":true},"legalCheckboxLabel":{"type":"string","nullable":true},"legalConfirmationStaticText":{"type":"string","nullable":true},"proctorEnabled":{"type":"boolean","nullable":true},"proctorVendor":{"type":"string","nullable":true},"proctorRequireFullscreen":{"type":"boolean","nullable":true},"proctorRestrictTabs":{"type":"boolean","nullable":true},"proctorRestrictDisplays":{"type":"boolean","nullable":true},"proctorWebcamMonitoring":{"type":"string","nullable":true},"proctorScreenMonitoring":{"type":"string","nullable":true},"proctorSynopticLevel":{"type":"string","nullable":true},"proctorScreenshotPrevention":{"type":"boolean","nullable":true},"proctorRecordSession":{"type":"boolean","nullable":true},"proctorRecordSnapshots":{"type":"boolean","nullable":true},"proctorRecordDesktop":{"type":"boolean","nullable":true},"proctorAiReview":{"type":"boolean","nullable":true},"proctorAiPrompts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true}}}},"proctorOnBreach":{"type":"string","nullable":true},"proctorReviewMode":{"type":"string","enum":["always","never","onBreach",null],"nullable":true},"proctorLiveProctoring":{"type":"boolean","nullable":true},"proctorBlockedApplicationsPolicy":{"type":"string","enum":["none","default",null],"nullable":true},"shuffleDynamicFilters":{"type":"boolean","nullable":true},"shuffleAllDynamicQuestions":{"type":"boolean","nullable":true},"dynamicTagSetId":{"type":"string","nullable":true},"dynamicVariationEnabled":{"type":"boolean","nullable":true},"dynamicVariantsMax":{"type":"number","nullable":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}},"globalDefaultSettings":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"GlobalExamTemplate","enum":["GlobalExamTemplate"]}}}}},"sections":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["ExamTemplateSection"],"example":"ExamTemplateSection"}]}}}}}},"markers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"moderatingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"escalatingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"backReadingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"auditingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}}}}}},"ExamTemplateSection":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamTemplateSection","enum":["ExamTemplateSection"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"minLength":1,"maxLength":100},"isDynamic":{"type":"boolean","readOnly":true},"doi":{"type":"string","readOnly":false,"nullable":false,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"instructionsEnabled":{"type":"boolean","readOnly":false},"instructionsTitle":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":100},"instructionsBody":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":25000},"instructionsTimerEnabled":{"type":"boolean","readOnly":false,"nullable":true},"instructionsTimerHidden":{"type":"boolean","readOnly":false,"nullable":true},"instructionsTimerDurationMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1,"maximum":86400000},"instructionsAudioAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"instructionsAudioAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"instructionsDisableAudioControls":{"type":"boolean","readOnly":false,"nullable":true},"outroEnabled":{"type":"boolean","readOnly":false},"outroTitle":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":100},"outroBody":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":25000},"outroTimerEnabled":{"type":"boolean","readOnly":false,"nullable":true},"outroTimerHidden":{"type":"boolean","readOnly":false,"nullable":true},"outroTimerDurationMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1,"maximum":86400000},"outroAudioAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"outroAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"outroAudioAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"outroDisableAudioControls":{"type":"boolean","readOnly":false,"nullable":true},"timerEnabled":{"type":"boolean","readOnly":false},"timerHidden":{"type":"boolean","readOnly":false},"timerDurationMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1},"timerInferFromQuestions":{"type":"boolean","readOnly":false,"nullable":true},"index":{"type":"number","readOnly":true},"navigationDisableNavigation":{"type":"boolean","readOnly":false,"nullable":true},"navigationDisableControlPanel":{"type":"boolean","readOnly":false,"nullable":true},"navigationDisableNotifications":{"type":"boolean","readOnly":false,"nullable":true},"grades":{"type":"array","nullable":true,"items":{"type":"object","required":["label"],"properties":{"label":{"type":"string","readOnly":false},"minScore":{"description":"A default failing grade should have minScore set to `null`","type":"number","readOnly":false,"nullable":true},"isPass":{"type":"boolean","readOnly":false},"description":{"type":"string","readOnly":false,"nullable":true}}}},"scoreModifiers":{"type":"array","nullable":true,"readOnly":false,"items":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"type":"string","enum":["omitLowestScoringQuestionPerSection"]}}}}}},"relationships":{"type":"object","properties":{"examTemplate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamTemplate","enum":["ExamTemplate"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"outroAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"ExamVoucher":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamVoucher","enum":["ExamVoucher"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"code":{"type":"string","readOnly":true,"minLength":1,"maxLength":255},"batch":{"type":"string","readOnly":true,"nullable":true,"minLength":1,"maxLength":255},"expiresAt":{"type":"string","nullable":true,"readOnly":false},"isRedeemed":{"type":"boolean","readOnly":true},"isRevoked":{"type":"boolean","readOnly":false},"redeemedAt":{"type":"string","readOnly":true,"nullable":true},"examName":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"redeemedBy":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"ExamVoucherBatchJob":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamVoucherBatchJob","enum":["ExamVoucherBatchJob"]},"attributes":{"type":"object","required":["count"],"properties":{"batch":{"type":"string","minLength":1,"maxLength":255,"description":"Batch identifier to prefix voucher codes with"},"count":{"type":"integer","minimum":1,"maximum":1000,"description":"Number of vouchers to create"},"expiresAt":{"type":"string","format":"date-time","nullable":true,"description":"Optional expiration date for all vouchers in the batch"}}},"relationships":{"type":"object","required":["exam"],"properties":{"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}}}}}},"ExamVoucherExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamVoucherExport","enum":["ExamVoucherExport"]},"attributes":{"type":"object","properties":{"batch":{"type":"string","minLength":1,"maxLength":255,"description":"Optional batch name to filter vouchers by"}}},"relationships":{"type":"object","required":["exam"],"properties":{"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}}}}}},"ExportEnrichedAttempt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExportEnrichedAttempt","enum":["ExportEnrichedAttempt"]},"attributes":{"type":"object","properties":{"backgroundJobId":{"type":"string"},"filter":{"type":"object","properties":{"portalId":{"type":"string"},"origin":{"type":"object","properties":{"type":{"type":"string","enum":["assignmentGroup","assignment","collection","collectionItem","exam","test"]},"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"propertyFilters":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["assignedMarker","assignedModeratingMarker","assignedProvisionalMarker","attemptStatus","examStatus","grade","markingStatus","proctorStatus","quiz","quizVersion","resultsStatus","user","userGroup"]},"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}},"dateFilter":{"type":"object","properties":{"type":{"type":"string","enum":["completedAt","createdAt","finalisedAt","releasedAt","startedAt"]},"start":{"type":"string"},"end":{"type":"string"}}},"sort":{"type":"object","properties":{"type":{"type":"string","enum":["createdAt","finalisedAt","releasedAt","timeCompleted","timeStarted","score"]},"order":{"type":"string","enum":["ascending","descending"]}}}}},"breakdown":{"type":"string","enum":["question","score","none"]},"includes":{"type":"array","items":{"type":"string","enum":["sections","userAttributes","examAttributes","attemptAttributes"]}},"useSource":{"type":"boolean"}}},"relationships":{"type":"object","properties":{}}}},"ExternalExamSitting":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExternalExamSitting","enum":["ExternalExamSitting"]},"attributes":{"type":"object","properties":{"score":{"type":"number","readOnly":false,"minimum":0,"maximum":100},"date":{"type":"string","readOnly":false},"isPassed":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{"mock":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"CollectionMock","enum":["CollectionMock"]}}}}}}}}},"ExternalProctorSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExternalProctorSession","enum":["ExternalProctorSession"]},"attributes":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"reference":{"type":"string","description":"External proctor vendor reference for this session.","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"ExternalProctorSessionResults":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExternalProctorSessionResults","enum":["ExternalProctorSessionResults"]},"attributes":{"type":"object","properties":{"resultsUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"FacetConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"FacetConfig","enum":["FacetConfig"]},"attributes":{"type":"object","properties":{"label":{"type":"string","readOnly":true},"facet":{"type":"string","enum":["exam","module","subject","topic","subtopic","difficulty","skill","context"],"readOnly":true},"description":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TagSet","enum":["TagSet"]}}}}}}}}},"File":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]},"attributes":{"type":"object","properties":{"path":{"type":"string","readOnly":true,"description":"Fingerprinted on create. Use returned value in Parse.File as `name`."},"s3Path":{"type":"string","readOnly":true,"description":"Actual path within S3 bucket. Usually same as `path` except for public files."},"signedUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"Flag":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Flag","enum":["Flag"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"comment":{"type":"string","readOnly":false,"nullable":true},"source":{"type":"string","readOnly":true,"nullable":false},"issue":{"type":"string","readOnly":true,"nullable":false},"isReviewed":{"type":"boolean","readOnly":false,"nullable":false,"description":"Whether the flag has been reviewed by a moderator, when a flag is created this is automatically set to false"}}},"relationships":{"type":"object","properties":{"planter":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"question":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}},"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}}}}}},"FlagExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"FlagExport","enum":["FlagExport"]},"attributes":{"type":"object","properties":{"isReviewed":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}},"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}}}}}},"ForbiddenApiError":{"type":"object","description":"Forbidden request.","example":{"id":"ERR_000","title":"UserActionException","status":"403","code":"119","detail":"You are not permitted to perform this action."},"properties":{"id":{"type":"string","description":"Unique ID of this error occurrence."},"status":{"type":"string","description":"HTTP status code."},"code":{"type":"string","description":"Synap internal error code."},"title":{"type":"string"},"detail":{"type":"string"},"source":{"type":"object","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"}}}}},"GeneratedAccount":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"GeneratedAccount","enum":["GeneratedAccount"]},"attributes":{"type":"object","deprecated":true,"properties":{"name":{"type":"string","readOnly":true},"email":{"type":"string","readOnly":true},"externalId":{"type":"string","readOnly":true},"password":{"type":"string","readOnly":true},"timezone":{"type":"string","readOnly":true},"attr":{"type":"object","readOnly":true},"disableWelcomeEmail":{"type":"boolean","readOnly":true},"customMessage":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}}}}}},"GeneratedTest":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"GeneratedTest","enum":["GeneratedTest"]},"attributes":{"type":"object","properties":{"source":{"type":"object","readOnly":false,"properties":{"type":{"type":"string","enum":["collection"]},"objectId":{"type":"string"}}},"length":{"type":"number"},"tagFilters":{"type":"object"},"tagSetId":{"deprecated":true,"type":"string"}}},"relationships":{"type":"object","properties":{"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TagSet","enum":["TagSet"]}}}}}}}}},"GenerateTestJob":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"GenerateTestJob","enum":["GenerateTestJob"]},"attributes":{"type":"object","properties":{"source":{"type":"object","readOnly":false,"properties":{"type":{"type":"string","enum":["collection"]},"objectId":{"type":"string"}}},"length":{"type":"number","readOnly":false},"tagFilters":{"type":"object","readOnly":false,"properties":{"weightingType":{"type":"string","enum":["percentage","absolute"]},"filterRules":{"type":"array","maxItems":125,"items":{"type":"object","properties":{"weighting":{"type":"number"},"matchingRules":{"type":"array","minItems":1,"items":{"anyOf":[{"type":"object"},{"type":"array","items":{"type":"object"}}]}}}}}}},"masteryLevels":{"type":"array","items":{"type":"string","enum":["unseen","weak","moderate","strong","mastered"]},"readOnly":false},"randomise":{"type":"boolean","readOnly":false},"state":{"type":"string","enum":["pending","started","completed","failed"],"readOnly":true}}},"relationships":{"type":"object","properties":{"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TagSet","enum":["TagSet"]}}}}}}}}},"GenericNotification":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"GenericNotification","enum":["GenericNotification"]},"attributes":{"type":"object","properties":{"subject":{"type":"string","readOnly":true},"body":{"type":"string","readOnly":true},"previewText":{"type":"string","readOnly":true},"replyTo":{"type":"string","readOnly":true},"ccSender":{"type":"boolean","readOnly":true},"bcc":{"type":"array","readOnly":true,"items":{"type":"object","required":["email"],"properties":{"name":{"type":"string","readOnly":true},"email":{"type":"string","readOnly":true}}}},"attachments":{"type":"array","readOnly":true,"items":{"type":"object","required":["filename","content","type"],"properties":{"filename":{"type":"string","readOnly":true},"content":{"type":"string","readOnly":true},"type":{"type":"string","enum":["application/pdf","application/json","text/csv","text/html","text/plain"],"readOnly":true}}}}}},"relationships":{"type":"object","properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"attempts":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Attempt"],"example":"Attempt"}]}}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"users":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"GenericResource":{"type":"object","description":"The structure of a any Resource returned by, or expected in, all requests.","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"$ref":"#/components/schemas/ResourceType"},"attributes":{"type":"object","additionalProperties":true},"relationships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Relationship"}}}},"GlobalExamTemplate":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"GlobalExamTemplate","enum":["GlobalExamTemplate"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"lockedByDefault":{"type":"boolean","nullable":true},"ipAllowList":{"type":"array","items":{"type":"string"},"nullable":true},"resumeAllowed":{"type":"boolean","nullable":true},"resumeSameSession":{"type":"boolean","nullable":true},"passcodeEnabled":{"type":"boolean","nullable":true},"passcodeValue":{"type":"string","nullable":true},"hideFromCandidateList":{"type":"boolean","nullable":true},"allowedMode":{"type":"string","nullable":true},"allowedPlayers":{"type":"array","items":{"type":"string"},"nullable":true},"passFailEnabled":{"type":"boolean","nullable":true},"calculatorEnabled":{"type":"boolean","nullable":true},"calculatorType":{"type":"string","nullable":true},"notepadEnabled":{"type":"boolean","nullable":true},"resizableQuestionPanelsEnabled":{"type":"boolean","nullable":true},"strikethroughEnabled":{"type":"boolean","nullable":true},"highlightingEnabled":{"type":"boolean","nullable":true},"bookmarkingEnabled":{"type":"boolean","nullable":true},"flaggingEnabled":{"type":"boolean","nullable":true},"micEnabled":{"type":"boolean","nullable":true},"resumeLaterButtonEnabled":{"type":"boolean","nullable":true},"labValuesEnabled":{"type":"boolean","nullable":true},"labValuesHtml":{"type":"string","nullable":true},"additionalInformationEnabled":{"type":"boolean","nullable":true},"additionalInformationHtml":{"type":"string","nullable":true},"additionalInformationTitle":{"type":"string","nullable":true},"additionalInformationIcon":{"type":"string","nullable":true},"externalPlayerType":{"type":"string","nullable":true},"deferResultEnabled":{"type":"boolean","nullable":true},"deferResultAlwaysRelease":{"type":"boolean","nullable":true},"deferResultMessage":{"type":"string","nullable":true},"optionShuffling":{"type":"string","nullable":true},"questionShuffling":{"type":"string","nullable":true},"sectionShufflingEnabled":{"type":"boolean","nullable":true},"softSectionsEnabled":{"type":"boolean","nullable":true},"sectionGradesEnabled":{"type":"boolean","nullable":true},"advancedGradingEnabled":{"type":"boolean","nullable":true},"availableMarksEnabled":{"type":"boolean","nullable":true},"pinnedMessageDuringTest":{"type":"string","nullable":true},"excludeInformationalQuestionsFromCounts":{"type":"boolean","nullable":true},"timerEnabled":{"type":"boolean","nullable":true},"timerTimeInMs":{"type":"number","nullable":true},"timerUseSections":{"type":"boolean","nullable":true},"timerUseQuestions":{"type":"boolean","nullable":true},"timerEnforceFullTime":{"type":"boolean","nullable":true},"timerExtraTimeMultiplier":{"type":"number","nullable":true},"timerSoftTimer":{"type":"boolean","nullable":true},"disableCopying":{"type":"boolean","nullable":true},"disablePasting":{"type":"boolean","nullable":true},"disableRightClick":{"type":"boolean","nullable":true},"disableNavigation":{"type":"boolean","nullable":true},"disableControlPanel":{"type":"boolean","nullable":true},"disableNotifications":{"type":"boolean","nullable":true},"styleTheme":{"type":"string","nullable":true},"styleFontSize":{"type":"string","nullable":true},"creditsPerQuestion":{"type":"number","nullable":true},"enablePenalties":{"type":"boolean","nullable":true},"penaltiesPerQuestion":{"type":"number","nullable":true},"partialCreditsPerQuestion":{"type":"number","nullable":true},"grades":{"type":"array","nullable":true,"items":{"type":"object","required":["label","minScore"],"properties":{"label":{"type":"string"},"description":{"type":"string","nullable":true},"minScore":{"type":"number","nullable":true},"isPass":{"type":"boolean","nullable":true},"advancedCriteria":{"type":"object","nullable":true,"properties":{"sectionRequirements":{"type":"object","nullable":true,"properties":{"type":{"type":"string"},"count":{"type":"number","nullable":true},"sectionIds":{"type":"array","items":{"type":"string"},"nullable":true}}},"excludeFromResitAttempts":{"type":"boolean","nullable":true}}}}}},"instructionsEnabled":{"type":"boolean","nullable":true},"instructionsTitle":{"type":"string","nullable":true},"instructionsBody":{"type":"string","nullable":true},"instructionsTimerDurationMs":{"type":"number","nullable":true},"instructionsEnforcedTimer":{"type":"string","nullable":true},"instructionsAudioAutoAdvance":{"type":"string","nullable":true},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","minimum":0,"maximum":3600000,"nullable":true},"instructionsAudioAutoPlay":{"type":"boolean","nullable":true},"instructionsDisableAudioControls":{"type":"boolean","nullable":true},"resultDetailedViewEnabled":{"type":"boolean","nullable":true},"resultEducatorsViewAsAdminEnabled":{"type":"boolean","nullable":true},"resultHideResultsPage":{"type":"boolean","nullable":true},"resultGlobalHideScore":{"type":"boolean","nullable":true},"resultScoreEnabled":{"type":"boolean","nullable":true},"resultTimeSpentEnabled":{"type":"boolean","nullable":true},"resultGradeEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownGradeEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownScoreEnabled":{"type":"boolean","nullable":true},"resultQuestionBreakdownDisplay":{"type":"string","nullable":true},"resultAnalyticsCohort":{"type":"string","nullable":true},"resultCohortAverageEnabled":{"type":"boolean","nullable":true},"resultPercentileEnabled":{"type":"boolean","nullable":true},"resultScoreDistributionEnabled":{"type":"boolean","nullable":true},"resultTagBreakdownEnabled":{"type":"boolean","nullable":true},"resultProgressEnabled":{"type":"boolean","nullable":true},"resultFacetSubjectEnabled":{"type":"boolean","nullable":true},"resultFacetTopicEnabled":{"type":"boolean","nullable":true},"resultFacetSubtopicEnabled":{"type":"boolean","nullable":true},"resultFacetSkillEnabled":{"type":"boolean","nullable":true},"resultFacetDifficultyEnabled":{"type":"boolean","nullable":true},"resultMessagePassed":{"type":"string","nullable":true},"resultMessageFailed":{"type":"string","nullable":true},"resultMessageResitsRemaining":{"type":"string","nullable":true},"resultMessageNoResitsRemaining":{"type":"string","nullable":true},"resultMessageCompleted":{"type":"string","nullable":true},"resultMessageSettingHideTitle":{"type":"boolean","nullable":true},"resultHiddenMessage":{"type":"string","nullable":true},"resultHiddenSettingHideTitle":{"type":"boolean","nullable":true},"resultOverviewWhenPassedMessage":{"type":"string","nullable":true},"resultOverviewWhenFailedHasResitsMessage":{"type":"string","nullable":true},"resultOverviewWhenFailedNoResitsMessage":{"type":"string","nullable":true},"resultOverviewWhenCompleteNoGradesMessage":{"type":"string","nullable":true},"resultOverviewWhenCompletedNeutralGradesMessage":{"type":"string","nullable":true},"markingDoubleEnabled":{"type":"boolean","nullable":true},"markingDoubleAllocation":{"type":"string","nullable":true},"markingDoubleMinMarkers":{"type":"number","nullable":true},"markingDoubleSequence":{"type":"string","nullable":true},"markingBlindProvisionalMarker":{"type":"boolean","nullable":true},"markingBlindModeratingMarker":{"type":"boolean","nullable":true},"markingBlindEscalationMarker":{"type":"boolean","nullable":true},"markingBlindBackReadingMarker":{"type":"boolean","nullable":true},"markingBlindAuditingMarker":{"type":"boolean","nullable":true},"markingBlindIsolate":{"type":"boolean","nullable":true},"markerConcealmentProvisional":{"type":"boolean","nullable":true},"markerConcealmentModerating":{"type":"boolean","nullable":true},"markerConcealmentEscalation":{"type":"boolean","nullable":true},"markerConcealmentAuditing":{"type":"boolean","nullable":true},"markingEscalationEnabled":{"type":"boolean","nullable":true},"markingEscalationModeratorsCanEscalate":{"type":"boolean","nullable":true},"markingEscalationReasons":{"type":"array","nullable":true,"items":{"type":"object","required":["label","description"],"properties":{"slug":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}},"markingBackReadingEnabled":{"type":"boolean","nullable":true},"markingAuditingEnabled":{"type":"boolean","nullable":true},"markingResolutionEnabled":{"type":"boolean","nullable":true},"markingProvisionalMarkerAllocation":{"type":"string","nullable":true},"markingModeratingMarkerAllocation":{"type":"string","nullable":true},"markingEscalationMarkerAllocation":{"type":"string","nullable":true},"preExamInstructions":{"type":"string","nullable":true},"notificationAutomateEmails":{"type":"boolean","nullable":true},"notificationResultsEmailEnabled":{"type":"boolean","nullable":true},"certificatesEnabled":{"type":"boolean","nullable":true},"certificatesIssueOnFail":{"type":"boolean","nullable":true},"certificatesTemplateId":{"type":"string","nullable":true},"certificatesQrCode":{"type":"boolean","nullable":true},"certificatesResultsPage":{"type":"boolean","nullable":true},"certificatesTtl":{"type":"number","nullable":true},"certificatesIgnoreSubPortalBranding":{"type":"boolean","nullable":true},"certificatesSharingImageUrl":{"type":"string","nullable":true},"resitEnabled":{"type":"boolean","nullable":true},"resitType":{"type":"string","nullable":true},"resitMode":{"type":"string","nullable":true},"resitAllowedAttempts":{"type":"number","nullable":true},"resitGradeIndependent":{"type":"boolean","nullable":true},"resitDelay":{"type":"number","nullable":true},"resitCloseDelay":{"type":"number","nullable":true},"legalEnabled":{"type":"boolean","nullable":true},"legalConfirmationType":{"type":"string","nullable":true},"legalTitle":{"type":"string","nullable":true},"legalBody":{"type":"string","nullable":true},"legalCheckboxLabel":{"type":"string","nullable":true},"legalConfirmationStaticText":{"type":"string","nullable":true},"proctorEnabled":{"type":"boolean","nullable":true},"proctorVendor":{"type":"string","nullable":true},"proctorRequireFullscreen":{"type":"boolean","nullable":true},"proctorRestrictTabs":{"type":"boolean","nullable":true},"proctorRestrictDisplays":{"type":"boolean","nullable":true},"proctorWebcamMonitoring":{"type":"string","nullable":true},"proctorScreenMonitoring":{"type":"string","nullable":true},"proctorSynopticLevel":{"type":"string","nullable":true},"proctorScreenshotPrevention":{"type":"boolean","nullable":true},"proctorRecordSession":{"type":"boolean","nullable":true},"proctorRecordSnapshots":{"type":"boolean","nullable":true},"proctorRecordDesktop":{"type":"boolean","nullable":true},"proctorAiReview":{"type":"boolean","nullable":true},"proctorAiPrompts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true}}}},"proctorOnBreach":{"type":"string","nullable":true},"proctorReviewMode":{"type":"string","enum":["always","never","onBreach",null],"nullable":true},"proctorLiveProctoring":{"type":"boolean","nullable":true},"proctorBlockedApplicationsPolicy":{"type":"string","enum":["none","default",null],"nullable":true},"shuffleDynamicFilters":{"type":"boolean","nullable":true},"shuffleAllDynamicQuestions":{"type":"boolean","nullable":true},"dynamicTagSetId":{"type":"string","nullable":true},"dynamicVariationEnabled":{"type":"boolean","nullable":true},"dynamicVariantsMax":{"type":"number","nullable":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"Highlight":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Highlight","enum":["Highlight"]},"attributes":{"type":"object","properties":{"collectionItemId":{"type":"string","readOnly":true},"color":{"type":"string","readOnly":true},"range":{"type":"string","readOnly":true},"summary":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"IceCandidate":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"IceCandidate","enum":["IceCandidate"]},"attributes":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string"},"readOnly":true},"username":{"type":"string","readOnly":true},"credential":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"InsightsTagBreakdown":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"InsightsTagBreakdown","enum":["InsightsTagBreakdown"]},"attributes":{"type":"object","properties":{"subject":{"type":"string","readOnly":true},"topic":{"type":"string","readOnly":true},"subtopic":{"type":"string","readOnly":true},"skill":{"type":"string","readOnly":true},"difficulty":{"type":"string","readOnly":true},"responseCount":{"type":"number","readOnly":true},"sumScore":{"type":"number","readOnly":true},"maxScore":{"type":"number","readOnly":true},"timeFrameStart":{"type":"string","format":"date-time","readOnly":true},"timeFrameEnd":{"type":"string","format":"date-time","readOnly":true}}},"relationships":{"type":"object","properties":{"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TagSet","enum":["TagSet"]}}}}}}}}},"Integration":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Integration","enum":["Integration"]},"attributes":{"type":"object","required":["credentials","vendorIdentifier"],"properties":{"credentials":{"type":"object","writeOnly":true,"description":"The credentials for the integration. Please check the docs for the desired Integration. Credentials are never returned - use `configuredCredentialKeys` and `publicCredentials` instead.","additionalProperties":{"type":"string"}},"configuredCredentialKeys":{"type":"array","readOnly":true,"description":"Names of the credential keys that are set on this integration, without their values.","items":{"type":"string"}},"publicCredentials":{"type":"object","readOnly":true,"description":"Credential values that the vendor publishes to browsers, e.g. a Stripe publishable key. Secrets are never included.","additionalProperties":{"type":"string"}},"vendorIdentifier":{"type":"string","enum":["rosalyn","skilljar","stripe"],"readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"Invite":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Invite","enum":["Invite"]},"attributes":{"type":"object","properties":{"emailAddress":{"type":"string","readOnly":true},"name":{"type":"string","nullable":true,"readOnly":true},"personalMessage":{"type":"string","readOnly":true,"nullable":true},"expiryDate":{"type":"string","readOnly":true},"valid":{"type":"boolean","readOnly":true},"status":{"type":"string","enum":["pending","accepted","cancelled","expired"],"readOnly":false,"nullable":false},"lastSent":{"type":"string","description":"The last time the invite was sent. Delete this field to resend a pending invite.","readOnly":false,"nullable":true},"externalId":{"type":"string","description":"The external ID of the invitee.","readOnly":true,"nullable":true},"extraTimeMultiplier":{"type":"number","readOnly":true,"nullable":true},"attr":{"type":"object","description":"The attributes of the invitee.","readOnly":true,"nullable":true,"additionalProperties":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"invitee":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}}}}}},"InviteExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"InviteExport","enum":["InviteExport"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}}}}}},"Invoice":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Invoice","enum":["Invoice"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"billingType":{"type":"string","enum":["enterprise","invoiced","card","directDebit","trial"],"readOnly":true},"isPaid":{"type":"boolean","readOnly":true},"paymentGracePeriod":{"type":"number","description":"An optional grace period in days after the due date during which the invoice can still be paid without penalty.","nullable":true,"readOnly":true},"issueDate":{"type":"string","format":"date-time","description":"The date when the invoice was issued.","readOnly":true},"dueDate":{"type":"string","format":"date-time","description":"The date when the invoice is due.","readOnly":true},"failedPaymentAttempts":{"type":"number","description":"The number of failed payment attempts for this invoice.","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"LearningRecord":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"LearningRecord","enum":["LearningRecord"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"score":{"type":"number","readOnly":false,"nullable":true,"minimum":0,"maximum":100},"achievedOn":{"type":"string"},"visibleToStudent":{"type":"boolean","readOnly":false},"attr":{"type":"object","readOnly":false}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"LearningRecordExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"LearningRecordExport","enum":["LearningRecordExport"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["user"],"properties":{"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"LegacyAccessUpgradeOption":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"LegacyAccessUpgradeOption","enum":["LegacyAccessUpgradeOption"]},"attributes":{"type":"object","properties":{"accessUntilDate":{"type":"string"},"description":{"type":"string"},"isClaimable":{"type":"boolean"},"isClaimed":{"type":"boolean"},"message":{"type":"string","nullable":true},"offerItems":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"productIdentifier":{"type":"string"},"priceTag":{"type":"string"},"imageUrl":{"type":"string","nullable":true}}}},"selectedOfferItemIndex":{"type":"integer"},"title":{"type":"string"},"userPromoCode":{"type":"string","nullable":true}},"additionalProperties":false},"relationships":{"type":"object","properties":{}}}},"LoginQrCode":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"LoginQrCode","enum":["LoginQrCode"]},"attributes":{"type":"object","properties":{"qrCode":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"ManageBillingSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ManageBillingSession","enum":["ManageBillingSession"]},"attributes":{"type":"object","required":["type"],"properties":{"type":{"type":"string","readOnly":true,"enum":["manage-billing","manage-payment-sources","upgrade-trial"],"description":"The type of billing session to create. Use the `id` as the Chargebee token."},"chargebeeHostedPage":{"type":"object","readOnly":true,"nullable":true,"description":"Data used by the Chargebee hosted pages SDK to render the page. Only present if the type is not `manage-billing`."}}},"relationships":{"type":"object","properties":{}}}},"MarketingConsent":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MarketingConsent","enum":["MarketingConsent"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{}}}},"MarkingEntry":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingEntry","enum":["MarkingEntry"]},"attributes":{"type":"object","properties":{"rubricAreas":{"type":"array","items":{"type":"object"},"readOnly":true},"rubricMarks":{"type":"object","readOnly":false},"maxPoints":{"type":"number","readOnly":true},"points":{"type":"number","description":"The sum of credits and penalites.","readOnly":true,"nullable":true},"credits":{"type":"number","description":"The postivie credits awarded for the candidates answer","readOnly":false,"nullable":true},"penalties":{"type":"number","description":"The deduction of credits for the candidates answer","readOnly":false,"nullable":true},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"],"readOnly":true},"status":{"type":"string","enum":["pending","inProgress","submitted","completed","escalated","systemMarked"],"readOnly":false},"escalationReason":{"type":"object","properties":{"slug":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"comment":{"type":"string"}},"readOnly":false},"escalationResponse":{"type":"string","readOnly":false,"nullable":true},"disabled":{"type":"boolean","readOnly":true},"conflict":{"type":"boolean","readOnly":true},"timeMarked":{"type":"string","readOnly":true},"final":{"type":"boolean","readOnly":true},"candidateFeedback":{"type":"string","readOnly":false,"nullable":true},"notes":{"type":"string","readOnly":false,"nullable":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"candidate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"response":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Response","enum":["Response"]}}}}},"question":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}},"markingSession":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingSession","enum":["MarkingSession"]}}}}}}}}},"MarkingSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingSession","enum":["MarkingSession"]},"attributes":{"type":"object","properties":{"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"mode":{"type":"string","enum":["attempt","question"]},"status":{"type":"string","enum":["pending","locked","inProgress","inConflict","escalated","completed","rejected","finalised","voided","suspended"]},"suspendedFromStatus":{"type":"string","enum":["pending","locked","inProgress","inConflict","escalated","completed","rejected","finalised","voided","suspended"]},"suspendedAt":{"type":"string"},"createdAt":{"type":"string"},"timeStarted":{"type":"string"},"timeCompleted":{"type":"string"},"responseCount":{"type":"number"}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"candidate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"markingEntries":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["MarkingEntry"],"example":"MarkingEntry"}]}}}}}},"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}},"responses":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Response"],"example":"Response"}]}}}}}},"questions":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}}},"MarkingState":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingState","enum":["MarkingState"]},"attributes":{"type":"object","properties":{"status":{"type":"string"},"statusDetail":{"type":"object"},"provisionalScore":{"type":"number"}}},"relationships":{"type":"object","properties":{}}}},"MAUPortalUsage":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MAUPortalUsage","enum":["MAUPortalUsage"]},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["mau"],"readOnly":true},"billingPeriodStart":{"type":"string","readOnly":true},"billingPeriodEnd":{"type":"string","readOnly":true},"mauCount":{"type":"number","readOnly":true},"synopticRecordingCount":{"type":"number","readOnly":true},"rosalynLiveCount":{"type":"number","readOnly":true}}},"relationships":{"type":"object","properties":{"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}}}}}},"MfaActivation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MfaActivation","enum":["MfaActivation"]},"attributes":{"type":"object","properties":{"enabled":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"MfaConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MfaConfig","enum":["MfaConfig"]},"attributes":{"type":"object","properties":{"enabled":{"type":"boolean","readOnly":false},"qrCode":{"type":"string","readOnly":true},"recoveryCodes":{"type":"array","items":{"type":"string"},"readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"MfaDeactivation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MfaDeactivation","enum":["MfaDeactivation"]},"attributes":{"type":"object","properties":{"code":{"type":"number","readOnly":false},"recoveryCode":{"type":"string","readOnly":false}}},"relationships":{"type":"object","properties":{}}}},"MobileAttempt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileAttempt","enum":["MobileAttempt"]},"attributes":{"type":"object","properties":{"title":{"type":"string"},"status":{"type":"string"},"quizLength":{"type":"string"},"quizMode":{"type":"string"},"testId":{"type":"string"},"masteryLevels":{"type":"array","items":{"type":"string"},"nullable":true},"timeStarted":{"type":"string"},"timeCompleted":{"type":"string"},"timerEnabled":{"type":"boolean"},"timerDuration":{"type":"number"},"score":{"type":"number","nullable":true}}},"relationships":{"type":"object","properties":{"responses":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["MobileResponse"],"example":"MobileResponse"}]}}}}}}}}}},"MobileAudioContent":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileAudioContent","enum":["MobileAudioContent"]},"attributes":{"type":"object","properties":{"path":{"type":"string","nullable":false,"readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"MobileCollection":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileCollection","enum":["MobileCollection"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"coverImageUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"folders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["MobileCollectionFolder"],"example":"MobileCollectionFolder"}]}}}}}},"collectionItems":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["MobileCollectionItem"],"example":"MobileCollectionItem"}]}}}}}}}}}},"MobileCollectionFolder":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileCollectionFolder","enum":["MobileCollectionFolder"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"imageUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"collectionItems":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["MobileCollectionItem"],"example":"MobileCollectionItem"}]}}}}}},"subFolders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["MobileCollectionSubFolder"],"example":"MobileCollectionSubFolder"}]}}}}}}}}}},"MobileCollectionItem":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileCollectionItem","enum":["MobileCollectionItem"]},"attributes":{"type":"object","properties":{"title":{"type":"string","nullable":false,"readOnly":true},"collectionItemType":{"type":"string","nullable":false,"readOnly":true,"enum":["audio","document","embed","note","quiz","video","zip"]},"description":{"type":"string","nullable":false,"readOnly":true},"imageUrl":{"type":"string","nullable":false,"readOnly":true},"isPreviewOnly":{"type":"boolean","nullable":false,"readOnly":true},"canStudy":{"type":"boolean","readOnly":true,"nullable":false}}},"relationships":{"type":"object","properties":{"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileQuiz","enum":["MobileQuiz"]}}}}},"note":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileNote","enum":["MobileNote"]}}}}},"audio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileAudioContent","enum":["MobileAudioContent"]}}}}},"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileDocumentContent","enum":["MobileDocumentContent"]}}}}},"embed":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileHtmlEmbedContent","enum":["MobileHtmlEmbedContent"]}}}}}}}}},"MobileCollectionSubFolder":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileCollectionSubFolder","enum":["MobileCollectionSubFolder"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"imageUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"collectionItems":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["MobileCollectionItem"],"example":"MobileCollectionItem"}]}}}}}}}}}},"MobileConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileConfig","enum":["MobileConfig"]},"attributes":{"type":"object","properties":{"portals":{"type":"array","readOnly":true,"items":{"type":"object","required":["portalId","name"],"properties":{"portalId":{"type":"string"},"name":{"type":"string"},"hostname":{"type":"string","nullable":true},"whitelabelAppiOSUrl":{"type":"string","nullable":true},"whitelabelAppAndroidUrl":{"type":"string","nullable":true}},"additionalProperties":false}}}},"relationships":{"type":"object","properties":{}}}},"MobileNote":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileNote","enum":["MobileNote"]},"attributes":{"type":"object","properties":{"title":{"type":"string","nullable":false,"readOnly":true},"description":{"type":"string","nullable":false,"readOnly":true},"body":{"type":"string","nullable":false,"readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"MobileQuiz":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileQuiz","enum":["MobileQuiz"]},"attributes":{"type":"object","properties":{"title":{"type":"string"},"totalQuestions":{"type":"number"},"allowedModes":{"type":"array","items":{"type":"string","enum":["practice","exam","timedExam","test"]}},"allowedLengths":{"type":"array","items":{"type":"string","enum":["default","quick","medium","long","extraLong"]}},"hasSections":{"type":"boolean","nullable":true},"sectionCount":{"type":"number","nullable":true}}},"relationships":{"type":"object","properties":{}}}},"MobileResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileResponse","enum":["MobileResponse"]},"attributes":{"type":"object","properties":{"questionType":{"type":"string","enum":["audioRecording","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"nullable":true},"status":{"type":"string","nullable":false},"leadIn":{"type":"string","nullable":true},"stem":{"type":"string","nullable":true},"feedback":{"type":"string","nullable":true},"emqInstructions":{"type":"string","nullable":true},"emqFeedback":{"type":"string","nullable":true},"options":{"type":"array","items":{"type":"object"}},"chosenOptions":{"type":"array","items":{"type":"object"},"nullable":true},"correctOptions":{"type":"array","items":{"type":"object"}},"outcome":{"type":"string","nullable":true}}},"relationships":{}}},"MobileSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileSession","enum":["MobileSession"]},"attributes":{"type":"object","properties":{"sessionToken":{"type":"string"}}},"relationships":{"type":"object","properties":{}}}},"MobileSpacedLearning":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileSpacedLearning","enum":["MobileSpacedLearning"]},"attributes":{"type":"object","properties":{"enabled":{"type":"boolean"},"intensityLevel":{"type":"number"},"totalStudyItems":{"type":"number"},"totalQuestions":{"type":"number"},"totalAnsweredQuestions":{"type":"number"},"competencyScore":{"type":"number"},"masteryLevel":{"type":"string"},"spacedRepetitionDueDate":{"type":"string"},"spacedRepetitionStatus":{"type":"string"},"masteryDivisions":{"type":"array","items":{"type":"object"}},"studyItemsOverview":{"type":"array","items":{"type":"object"}}}},"relationships":{"type":"object","properties":{"spacedRepetitionLatestQuiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileQuiz","enum":["MobileQuiz"]}}}}}}}}},"MobileStudyItem":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileStudyItem","enum":["MobileStudyItem"]},"attributes":{"type":"object","properties":{"studyItemId":{"type":"string"},"itemType":{"type":"string"},"label":{"type":"string"},"totalQuestions":{"type":"number"},"totalAnsweredQuestions":{"type":"number"},"competencyScore":{"type":"number"},"masteryLevel":{"type":"string"},"masteryDivisions":{"type":"array","items":{"type":"object"}}}},"relationships":{"type":"object","properties":{}}}},"MobileUser":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MobileUser","enum":["MobileUser"]},"attributes":{"type":"object","properties":{"name":{"type":"string","nullable":true,"readOnly":false},"emailAddress":{"type":"string","nullable":true,"readOnly":false},"profilePicture":{"type":"string","nullable":true,"readOnly":false},"timeZone":{"type":"string","nullable":true,"readOnly":false},"portalId":{"type":"string","nullable":true,"readOnly":false},"attemptCount":{"type":"number","nullable":true},"questionsAnswered":{"type":"number","nullable":true}}},"relationships":{"type":"object","properties":{}}}},"Note":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Note","enum":["Note"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":false},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"slug":{"type":"string","readOnly":true},"privacy":{"type":"string","readOnly":false},"description":{"type":"string","readOnly":false},"shortDescription":{"type":"string","readOnly":false},"body":{"type":"string","readOnly":false},"isArchived":{"type":"boolean","readOnly":false},"isLegalDoc":{"type":"boolean","readOnly":false},"isLibraryItem":{"type":"boolean","readOnly":true},"settings":{"deprecated":true,"description":"Deprecated. Use settingsDisplaySize and settingsPaddingEnabled instead.","type":"object","readOnly":false},"settingsDisplaySize":{"type":"string","readOnly":false,"enum":["narrow","fullWidth"]},"settingsPaddingEnabled":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}},"NotFoundApiError":{"type":"object","description":"The request resource could not be found.","example":{"id":"ERR_000","title":"ObjectNotFoundException","status":"404","code":"101","detail":"The requested resource could not be found."},"properties":{"id":{"type":"string","description":"Unique ID of this error occurrence."},"status":{"type":"string","description":"HTTP status code."},"code":{"type":"string","description":"Synap internal error code."},"title":{"type":"string"},"detail":{"type":"string"},"source":{"type":"object","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"}}}}},"NotificationGroup":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"NotificationGroup","enum":["NotificationGroup"]},"attributes":{"type":"object","required":["groupId","label","defaultValue","description"],"properties":{"groupId":{"type":"string","enum":["AssignmentAdmin","Assignments","Exams","ExamResults","ExamAdmin","Products","SpacedLearning","Flags","System"],"readOnly":true},"label":{"type":"string","readOnly":true},"defaultValue":{"type":"boolean","readOnly":true},"description":{"type":"string","readOnly":true},"recipientType":{"type":"array","items":{"type":"string","enum":["portal","admin","moderator","student"]},"readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource.","example":"FID001"},"Passkey":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Passkey","enum":["Passkey"]},"attributes":{"type":"object","properties":{"name":{"type":"string","maxLength":64,"readOnly":false},"rpId":{"type":"string","readOnly":true},"deviceType":{"type":"string","readOnly":true,"nullable":true},"backedUp":{"type":"boolean","readOnly":true,"nullable":true},"createdAt":{"type":"string","readOnly":true,"nullable":true},"lastUsedAt":{"type":"string","readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{}}}},"PasskeyAuthentication":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PasskeyAuthentication","enum":["PasskeyAuthentication"]},"attributes":{"type":"object","properties":{"sessionToken":{"type":"string","readOnly":true},"subPortalId":{"type":"string","readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{}}}},"PasskeyAuthenticationOptions":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PasskeyAuthenticationOptions","enum":["PasskeyAuthenticationOptions"]},"attributes":{"type":"object","properties":{"options":{"type":"object","readOnly":true,"additionalProperties":true}}},"relationships":{"type":"object","properties":{}}}},"PasskeyEnrolmentDeferral":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PasskeyEnrolmentDeferral","enum":["PasskeyEnrolmentDeferral"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{}}}},"PasskeyRegistrationOptions":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PasskeyRegistrationOptions","enum":["PasskeyRegistrationOptions"]},"attributes":{"type":"object","properties":{"options":{"type":"object","readOnly":true,"additionalProperties":true}}},"relationships":{"type":"object","properties":{}}}},"PasskeyRevocation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PasskeyRevocation","enum":["PasskeyRevocation"]},"attributes":{"type":"object","properties":{"passkeyId":{"type":"string","readOnly":false}}},"relationships":{"type":"object","properties":{}}}},"PasswordReset":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PasswordReset","enum":["PasswordReset"]},"attributes":{"type":"object","properties":{"emailAddress":{"type":"string","readOnly":false},"instant":{"type":"boolean","description":"Resets password immediately. Only available to admins.","readOnly":false},"newPassword":{"type":"string","description":"The users new password.","readOnly":false}}},"relationships":{"type":"object","properties":{"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}}}}}},"PasswordResetRequest":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PasswordResetRequest","enum":["PasswordResetRequest"]},"attributes":{"type":"object","required":["emailAddress"],"properties":{"emailAddress":{"type":"string","readOnly":false},"instant":{"type":"boolean","description":"Resets password immediately. Only available to admins.","readOnly":false},"newPassword":{"type":"string","description":"New password for the user. Only available if instant is true.","readOnly":true}}},"relationships":{"type":"object","properties":{"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}}}}}},"PAYGPortalUsage":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PAYGPortalUsage","enum":["PAYGPortalUsage"]},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["payg"],"readOnly":true},"creditsAllocated":{"type":"number","readOnly":true},"creditsUsed":{"type":"number","readOnly":true},"creditsRemaining":{"type":"number","readOnly":true},"overage":{"type":"number","readOnly":true},"usageByBillingPeriod":{"type":"array","items":{"type":"object","properties":{"billingPeriodStart":{"type":"string"},"billingPeriodEnd":{"type":"string"},"creditsUsed":{"type":"number"},"examRosalynReview":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}},"assignment":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}},"examRosalynLockdown":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}},"examSynopticLockdown":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}},"examRosalynLive":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}},"examSynopticRecorded":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}},"study":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}},"examUnproctored":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}}}},"readOnly":true}}},"relationships":{"type":"object","properties":{"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}}}}}},"PdfAnnotation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PdfAnnotation","enum":["PdfAnnotation"]},"attributes":{"type":"object","properties":{"collectionItemId":{"type":"string","readOnly":true},"pageNumber":{"type":"integer","readOnly":true},"body":{"type":"object","description":"JSON blob containing strokes and text annotations for the page","properties":{"strokes":{"type":"array","items":{"type":"object","properties":{"points":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}}}},"color":{"type":"string"},"width":{"type":"number"},"mode":{"type":"string","enum":["pen","highlighter","eraser"]},"textSnapMode":{"type":"boolean"},"textSnapData":{"type":"object","properties":{"baseline":{"type":"number"},"height":{"type":"number"},"lineEndX":{"type":"number"}}}}}},"textAnnotations":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"text":{"type":"string"},"color":{"type":"string"},"fontSize":{"type":"number"}}}},"pageWidth":{"type":"number"},"pageHeight":{"type":"number"}}}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"PersonalAccessToken":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PersonalAccessToken","enum":["PersonalAccessToken"]},"attributes":{"type":"object","properties":{"label":{"type":"string","maxLength":100,"readOnly":true},"createdAt":{"type":"string","readOnly":true},"lastUsedAt":{"type":"string","readOnly":true},"isRevoked":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{}}}},"PlayerAttempt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerAttempt","enum":["PlayerAttempt"]},"attributes":{"type":"object","properties":{"title":{"type":"string","readOnly":true},"quizMode":{"type":"string","enum":["exam","practice","timedExam"],"readOnly":true},"timeStarted":{"type":"string","readOnly":false},"activeTime":{"type":"object","readOnly":true,"additionalProperties":false,"description":"Recorded cumulative active-millisecond counters, for seeding the player ledgers on resume. The maps are keyed by sectionId; attemptInstructionsMs covers the attempt-level instructions screen.","properties":{"sectionMs":{"type":"object","additionalProperties":{"type":"integer","minimum":0}},"sectionInstructionsMs":{"type":"object","additionalProperties":{"type":"integer","minimum":0}},"sectionOutroMs":{"type":"object","additionalProperties":{"type":"integer","minimum":0}},"attemptInstructionsMs":{"type":"integer","minimum":0}}},"timeCompleted":{"type":"string","readOnly":false},"theme":{"type":"string","enum":["default","ucat"],"readOnly":true},"fontSize":{"type":"string","enum":["xLarge","large","medium","small","xSmall"],"readOnly":true},"pinnedMessage":{"type":"string","readOnly":true},"disableNavigation":{"type":"boolean","readOnly":true},"disableControlPanel":{"type":"boolean","readOnly":true},"disableNotifications":{"type":"boolean","readOnly":true},"proctorEnabled":{"type":"boolean","readOnly":true},"proctorVendor":{"type":"string","enum":["internal","synopticV2","rosalyn"],"readOnly":true},"proctorSessionId":{"type":"string","readOnly":true},"examStatus":{"type":"string","enum":["enrolled","expired","notified","preflight","revoked","started","submitted","cancelled"],"readOnly":false},"status":{"type":"string","readOnly":false,"enum":["completed","inProgress","instructionsInProgress","instructionsCompleted","locked","notStarted","revoked","scheduled"]},"submissionType":{"type":"string","readOnly":false,"nullable":true,"enum":["user","system","moderator","userTimedOut","abandoned",null]},"scheduleStatus":{"type":"string","enum":["active","cancelled","completed","draft","scheduled"],"readOnly":true},"attr":{"type":"object","readOnly":true},"openTime":{"type":"string","readOnly":true},"closeTime":{"type":"string","readOnly":true},"certificateStatus":{"type":"string","nullable":true,"readOnly":true,"enum":["pending","generated","notEligible",null]},"credits":{"type":"number","readOnly":true},"penalties":{"type":"number","readOnly":true},"maxPoints":{"type":"number","readOnly":true},"points":{"type":"number","readOnly":true},"showAvailableMarks":{"type":"boolean","readOnly":true},"score":{"type":"number","readOnly":true},"questionBreakdownDisplay":{"type":"string","readOnly":true,"enum":["full","hideStemAndOptions","hideCorrectOptions","incorrectOnlyHideCorrectOptions","none"]},"resultsEducatorViewAsAdminEnabled":{"type":"boolean","readOnly":true},"resultsDetailedViewEnabled":{"type":"boolean","readOnly":true},"resultsHiddenMessage":{"type":"string","nullable":true,"readOnly":true},"resultsHiddenSettingHideTitle":{"type":"boolean","readOnly":true},"isDynamic":{"type":"boolean","readOnly":true},"timerEnabled":{"type":"boolean","readOnly":true},"timerDuration":{"type":"number","readOnly":true},"timerType":{"type":"string","enum":["questions","sections","default"],"readOnly":true},"enforceFullTime":{"type":"boolean","readOnly":true},"softTimer":{"type":"boolean","readOnly":true},"extraTimeMultiplier":{"type":"number","readOnly":true},"features":{"type":"array","items":{"type":"string","enum":["bookmarking","resizableQuestionPanels","strikeThrough","highlighting","notepad","calculator","scientificCalculator","flagging","resumeLater","softSections","micSettings"]},"readOnly":true},"externalPlayer":{"type":"string","enum":["default","ucat","usmle"],"readOnly":true},"disableCopying":{"type":"boolean","readOnly":true,"nullable":false},"disablePasting":{"type":"boolean","readOnly":true,"nullable":false},"disableRightClick":{"type":"boolean","readOnly":true,"nullable":false},"labValues":{"type":"string","readOnly":true,"nullable":true},"additionalInformation":{"type":"string","readOnly":true,"nullable":true},"additionalInformationTitle":{"type":"string","readOnly":true,"nullable":true},"additionalInformationIcon":{"type":"string","readOnly":true,"nullable":true},"markingPenaltiesEnabled":{"type":"boolean","readOnly":true,"nullable":false},"instructionsEnabled":{"type":"boolean","readOnly":true,"nullable":false},"instructionsTitle":{"type":"string","nullable":true,"readOnly":true,"minLength":1,"maxLength":300},"instructionsBody":{"type":"string","nullable":true,"readOnly":true,"minLength":1,"maxLength":25000},"instructionsTimeStarted":{"type":"string","readOnly":true},"instructionsTimeCompleted":{"type":"string","readOnly":true},"instructionsTimerDurationMs":{"type":"number","nullable":true,"readOnly":true,"minimum":1,"maximum":86400000},"instructionsEnforcedTimer":{"type":"string","readOnly":true,"enum":["afterAudioStarts","immediately"]},"instructionsAudioAutoAdvance":{"type":"string","readOnly":true,"enum":["disabled","afterDefinedTime","immediately"]},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":true,"minimum":0,"maximum":3600000},"instructionsAudioAutoPlay":{"type":"boolean","readOnly":true,"nullable":true},"instructionsDisableAudioControls":{"type":"boolean","readOnly":true,"nullable":true},"excludeInformationalQuestionsFromCounts":{"type":"boolean","readOnly":true,"nullable":true},"isPreview":{"type":"boolean","readOnly":true,"nullable":true},"ltiLaunch":{"type":"object","readOnly":true,"nullable":true,"required":["consumerKey","contextId","resourceLinkId"],"description":"LTI launch parameters","properties":{"consumerKey":{"type":"string","readOnly":true},"contextId":{"type":"string","readOnly":true},"resourceLinkId":{"type":"string","readOnly":true},"lisResultSourcedId":{"type":"string","readOnly":true},"lisOutcomeServiceUrl":{"type":"string","readOnly":true},"launchPresentationReturnUrl":{"type":"string","readOnly":true}}},"resitCloseDelay":{"type":"number","readOnly":true},"resitDelay":{"type":"number","readOnly":true},"resitEnabled":{"type":"boolean","readOnly":true},"resitGradeIndependent":{"type":"boolean","readOnly":true},"resitMode":{"type":"string","enum":["standard","fixed","progressive","preferUnseen"],"nullable":true,"readOnly":true},"resitScheduleActivatedAt":{"type":"string","readOnly":true},"resitScheduleDeactivatedAt":{"type":"string","nullable":true,"readOnly":true},"resitType":{"type":"string","enum":["continuous","rolling","fixedDate","onDemand"],"nullable":true,"readOnly":true}}},"relationships":{"type":"object","properties":{"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}},"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"audioInstructions":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"responses":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["PlayerAudioResponse","PlayerVideoResponse","PlayerClozeDragAndDropResponse","PlayerClozeDropDownResponse","PlayerClozeTextResponse","PlayerFileUploadResponse","PlayerFreeTextResponse","PlayerInformationalResponse","PlayerMultipleChoiceResponse","PlayerRankedResponse","PlayerSingleChoiceResponse","PlayerShortAnswerResponse","PlayerSpreadsheetResponse","PlayerImageHotspotResponse","PlayerOffPlatformResponse","PlayerFlashcardResponse","PlayerTrueOrFalseResponse","PlayerDrawingResponse"],"example":"PlayerAudioResponse"}]}}}}}},"sections":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["PlayerSection"],"example":"PlayerSection"}]}}}}}},"certificate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Certificate","enum":["Certificate"]}}}}}}}}},"PlayerAudioResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerAudioResponse","enum":["PlayerAudioResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"label":{"type":"string","readOnly":true},"allowDelete":{"type":"boolean","readOnly":true},"allowPause":{"type":"boolean","readOnly":true},"allowRerecord":{"type":"boolean","readOnly":true},"maximumRecordingTimeInMs":{"type":"number","maximum":3600000,"readOnly":true},"autoRecording":{"type":"boolean","readOnly":true},"autoRecordingAllowEarlySubmission":{"type":"boolean","readOnly":true},"autoRecordingDelayMs":{"type":"number","maximum":3600000,"readOnly":true},"autoAdvance":{"type":"string","enum":["disabled","afterDefinedTime","afterAudioCompletion"],"readOnly":true},"autoAdvanceDelayMs":{"type":"number","maximum":3600000,"readOnly":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"answer":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"PlayerClozeDragAndDropResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerClozeDragAndDropResponse","enum":["PlayerClozeDragAndDropResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"template":{"type":"string","readOnly":true,"nullable":true},"canReusePossibleResponses":{"type":"boolean","readOnly":true},"shareCorrectResponses":{"type":"boolean","readOnly":false},"blanks":{"type":"array","items":{"type":"object","properties":{"blankId":{"type":"string","readOnly":true},"value":{"type":"string","readOnly":true},"optionId":{"type":"string","readOnly":true}}},"readOnly":true},"answers":{"type":"array","items":{"type":"object","properties":{"blankId":{"type":"string","readOnly":false},"value":{"type":"string","readOnly":false},"optionId":{"type":"string","readOnly":false}}},"readOnly":false,"nullable":true},"correctAnswers":{"type":"array","readOnly":true,"nullable":true,"items":{"type":"object","readOnly":true,"properties":{"blankId":{"type":"string"},"optionId":{"type":"string"},"value":{"type":"string"},"credits":{"type":"number"}}}}},"anyOf":[{"description":"canReusePossibleResponses can be false when shareCorrectResponses is true","properties":{"canReusePossibleResponses":{"enum":[false]},"shareCorrectResponses":{"enum":[true]}}},{"description":"shareCorrectResponses can be false when canReusePossibleResponses is true","properties":{"canReusePossibleResponses":{"enum":[true]},"shareCorrectResponses":{"enum":[false]}}},{"description":"both canReusePossibleResponses and shareCorrectResponses can be false","properties":{"canReusePossibleResponses":{"enum":[false]},"shareCorrectResponses":{"enum":[false]}}}]},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}},"PlayerClozeDropDownResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerClozeDropDownResponse","enum":["PlayerClozeDropDownResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"template":{"type":"string","readOnly":true,"nullable":true},"canReusePossibleResponses":{"type":"boolean","readOnly":true},"blanks":{"type":"array","items":{"type":"object","properties":{"blankId":{"type":"string","readOnly":true},"value":{"type":"string","readOnly":true}}},"readOnly":true},"answers":{"type":"array","items":{"type":"object","properties":{"blankId":{"type":"string","readOnly":false},"value":{"type":"string","readOnly":false,"minLength":1}}},"readOnly":false,"nullable":true},"correctAnswers":{"type":"array","readOnly":true,"nullable":true,"items":{"type":"object","readOnly":true,"properties":{"blankId":{"type":"string"},"value":{"type":"string"},"credits":{"type":"number"}}}}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}},"PlayerClozeTextResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerClozeTextResponse","enum":["PlayerClozeTextResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"template":{"type":"string","readOnly":true,"nullable":true},"caseMatch":{"type":"boolean","readOnly":true},"disableSpellcheck":{"type":"boolean","readOnly":true},"canReusePossibleResponses":{"type":"boolean","readOnly":true},"blanks":{"type":"array","items":{"type":"object","properties":{"blankId":{"type":"string"},"type":{"type":"string","enum":["text","number"]}}},"readOnly":true},"answers":{"type":"array","items":{"type":"object","properties":{"blankId":{"type":"string"},"type":{"type":"string","enum":["text","number"]},"value":{"anyOf":[{"type":"string","nullable":true},{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}}]}}},"readOnly":false,"nullable":true},"correctAnswers":{"type":"array","items":{"type":"object","properties":{"blankId":{"type":"string"},"type":{"type":"string","enum":["text","number"]},"value":{"anyOf":[{"type":"string","nullable":true},{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}}]},"credits":{"type":"number"}}},"readOnly":true,"nullable":true},"decimalEnforcement":{"type":"number","readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}},"PlayerDrawingResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerDrawingResponse","enum":["PlayerDrawingResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"answer":{"type":"string","nullable":true,"readOnly":false,"maxLength":400000},"eraserEnabled":{"type":"boolean","nullable":true,"readOnly":true},"colourPickerEnabled":{"type":"boolean","nullable":true,"readOnly":true},"strokeWidthPickerEnabled":{"type":"boolean","nullable":true,"readOnly":true},"freehandPenEnabled":{"type":"boolean","nullable":true,"readOnly":true},"drawRectEnabled":{"type":"boolean","nullable":true,"readOnly":true},"drawEllipseEnabled":{"type":"boolean","nullable":true,"readOnly":true},"drawLineEnabled":{"type":"boolean","nullable":true,"readOnly":true},"drawArrowEnabled":{"type":"boolean","nullable":true,"readOnly":true},"drawTextEnabled":{"type":"boolean","nullable":true,"readOnly":true},"canvasWidth":{"type":"number","nullable":true,"readOnly":true},"canvasHeight":{"type":"number","nullable":true,"readOnly":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"backgroundImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"PlayerEmqGroup":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]},"attributes":{"type":"object","properties":{"instructions":{"type":"string","readOnly":true},"feedback":{"type":"string","nullable":true,"readOnly":true},"hideQuestionStem":{"type":"boolean","readOnly":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioPlaybackLimit":{"type":"number","readOnly":true},"audioAutoPlay":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"audioInstructions":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"PlayerFileUploadResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerFileUploadResponse","enum":["PlayerFileUploadResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"label":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"answers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["File"],"example":"File"}]}}}}}}}}}},"PlayerFlashcardResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerFlashcardResponse","enum":["PlayerFlashcardResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"answer":{"type":"string","enum":["correct","incorrect","skipped","unsure",null],"readOnly":false,"nullable":true},"isAnswerRevealed":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}},"PlayerFreeTextResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerFreeTextResponse","enum":["PlayerFreeTextResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"label":{"type":"string","readOnly":true},"wordCount":{"type":"number","readOnly":true},"showWordCount":{"type":"boolean","readOnly":true},"maxWordCount":{"type":"number","readOnly":true,"nullable":true,"minimum":0},"enforcePlainTextInput":{"type":"boolean","readOnly":true},"enableWebcamSnapshots":{"type":"boolean","readOnly":true},"enableEquationEditor":{"type":"boolean","readOnly":true},"disableSpellcheck":{"type":"boolean","readOnly":true},"answer":{"type":"string","readOnly":false},"answerTemplate":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}},"PlayerImageHotspotResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerImageHotspotResponse","enum":["PlayerImageHotspotResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"answer":{"type":"object","required":["x","y"],"properties":{"x":{"type":"number"},"y":{"type":"number"},"matchedHotspotSlug":{"type":"string","nullable":true}},"additionalProperties":false},"answers":{"type":"array","nullable":true,"items":{"type":"object","required":["x","y"],"properties":{"x":{"type":"number"},"y":{"type":"number"},"matchedHotspotSlug":{"type":"string","nullable":true}},"additionalProperties":false}},"correctAnswers":{"type":"array","items":{"type":"object","required":["slug","shape","coords"],"properties":{"slug":{"type":"string","minLength":1,"maxLength":100},"label":{"type":"string"},"shape":{"type":"string","enum":["rect","ellipse","polygon"]},"coords":{"oneOf":[{"type":"object","properties":{"centerX":{"type":"number"},"centerY":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"rotation":{"type":"number","nullable":true}},"required":["centerX","centerY","width","height"],"additionalProperties":false},{"type":"object","properties":{"points":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"additionalProperties":false},"minItems":3,"maxItems":50}},"required":["points"],"additionalProperties":false}]},"credits":{"type":"number"},"penalties":{"type":"number"},"isCorrect":{"type":"boolean"}},"additionalProperties":false},"readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"hotspotImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"PlayerInformationalResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerInformationalResponse","enum":["PlayerInformationalResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}},"PlayerMultipleChoiceResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerMultipleChoiceResponse","enum":["PlayerMultipleChoiceResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"multiCorrectLimitType":{"type":"string","enum":["any","exact","max"],"readOnly":true},"multiCorrectLimit":{"type":"number","readOnly":true,"nullable":true},"answers":{"type":"array","items":{"type":"object","readOnly":false},"readOnly":false,"nullable":true},"availableAnswers":{"type":"array","items":{"type":"object","readOnly":true},"readOnly":true},"correctAnswers":{"type":"array","items":{"type":"object","readOnly":true},"readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}},"PlayerOffPlatformResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerOffPlatformResponse","enum":["PlayerOffPlatformResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"offPlatformHideFromPlayer":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}},"PlayerRankedResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerRankedResponse","enum":["PlayerRankedResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"answers":{"type":"array","items":{"type":"object","readOnly":false},"readOnly":false,"nullable":true},"availableAnswers":{"type":"array","items":{"type":"object","readOnly":true},"readOnly":true},"correctAnswers":{"type":"array","items":{"type":"object","readOnly":true},"readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}},"PlayerSection":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["completed","inProgress","instructionsComplete","instructionsInProgress","locked","open","outroInProgress","outroComplete"]},"doi":{"type":"string","readOnly":true},"position":{"type":"number","readOnly":true},"title":{"type":"string","readOnly":true},"questionsCompleted":{"type":"number","readOnly":true},"questionsSkipped":{"type":"number","readOnly":true},"timeStarted":{"type":"string","readOnly":true},"timeCompleted":{"type":"string","readOnly":true},"timeSpent":{"type":"number","readOnly":true},"timerDuration":{"type":"number","readOnly":true},"timerEnforced":{"type":"boolean","readOnly":true},"timerHidden":{"type":"boolean","readOnly":true},"instructionsTitle":{"type":"string","readOnly":true},"instructionsBody":{"type":"string","readOnly":true},"instructionsTimerDuration":{"type":"number","readOnly":true},"instructionsTimerHidden":{"type":"boolean","readOnly":true},"instructionsEnforcedTimer":{"type":"string","enum":["afterAudioStarts","immediately"],"readOnly":true},"instructionsTimeStarted":{"type":"string","readOnly":true},"instructionsTimeCompleted":{"type":"string","readOnly":true},"instructionsTimeSpentMs":{"type":"number","readOnly":true},"outroTitle":{"type":"string","readOnly":true},"outroBody":{"type":"string","readOnly":true},"outroTimerDuration":{"type":"number","readOnly":true},"outroTimerHidden":{"type":"boolean","readOnly":true},"outroEnforcedTimer":{"type":"string","enum":["afterAudioStarts","immediately"],"readOnly":true},"outroTimeStarted":{"type":"string","readOnly":true},"outroTimeCompleted":{"type":"string","readOnly":true},"outroTimeSpentMs":{"type":"number","readOnly":true},"instructionsAudioAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"instructionsAudioAutoAdvanceDelay":{"type":"number","readOnly":true},"instructionsAudioAutoPlay":{"type":"boolean","readOnly":true},"instructionsAudioControlsDisabled":{"type":"boolean","readOnly":true},"outroAudioAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"outroAudioAutoAdvanceDelay":{"type":"number","readOnly":true},"outroAudioAutoPlay":{"type":"boolean","readOnly":true},"outroAudioControlsDisabled":{"type":"boolean","readOnly":true},"disableNavigation":{"type":"boolean","readOnly":true,"nullable":true},"disableControlPanel":{"type":"boolean","readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{"responses":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["PlayerAudioResponse","PlayerClozeDragAndDropResponse","PlayerClozeDropDownResponse","PlayerClozeTextResponse","PlayerFileUploadResponse","PlayerFreeTextResponse","PlayerInformationalResponse","PlayerMultipleChoiceResponse","PlayerRankedResponse","PlayerSingleChoiceResponse","PlayerShortAnswerResponse","PlayerSpreadsheetResponse","PlayerImageHotspotResponse","PlayerVideoResponse","PlayerOffPlatformResponse","PlayerFlashcardResponse","PlayerTrueOrFalseResponse","PlayerDrawingResponse"],"example":"PlayerAudioResponse"}]}}}}}},"instructionsAudioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"outroAudioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"PlayerShortAnswerResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerShortAnswerResponse","enum":["PlayerShortAnswerResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"answer":{"type":"string","readOnly":false},"caseMatch":{"type":"boolean","readOnly":true},"disableSpellcheck":{"type":"number","readOnly":true},"correctAnswers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"credits":{"type":"number"}}},"nullable":true,"readOnly":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}},"PlayerSingleChoiceResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSingleChoiceResponse","enum":["PlayerSingleChoiceResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"answer":{"type":"object","readOnly":false,"nullable":true},"availableAnswers":{"type":"array","items":{"type":"object","readOnly":true},"readOnly":true,"nullable":true},"correctAnswer":{"type":"object","readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}},"PlayerSpreadsheetResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSpreadsheetResponse","enum":["PlayerSpreadsheetResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"label":{"type":"string","readOnly":true},"answer":{"type":"string","readOnly":false},"answerTemplate":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}},"PlayerTrueOrFalseResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerTrueOrFalseResponse","enum":["PlayerTrueOrFalseResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"answer":{"type":"boolean","nullable":true,"readOnly":false},"correctAnswer":{"type":"boolean","readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}},"PlayerVideoResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerVideoResponse","enum":["PlayerVideoResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"hideFromQuizResults":{"type":"boolean","readOnly":true},"credit":{"type":"number","readOnly":true,"nullable":false},"penalty":{"type":"number","readOnly":true,"nullable":false},"maxPoints":{"type":"number","readOnly":true,"nullable":false},"points":{"type":"number","readOnly":true,"nullable":false},"markingOutcome":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure","marked"],"readOnly":true,"nullable":false},"markSchemeCriteria":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxCredits":{"type":"number"},"credit":{"type":"number"}}},"nullable":true,"readOnly":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":true},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":true},"label":{"type":"string","readOnly":true},"allowDelete":{"type":"boolean","readOnly":true},"allowPause":{"type":"boolean","readOnly":true},"allowRerecord":{"type":"boolean","readOnly":true},"maximumRecordingTimeInMs":{"type":"number","maximum":3600000,"readOnly":true},"autoRecording":{"type":"boolean","readOnly":true},"autoRecordingAllowEarlySubmission":{"type":"boolean","readOnly":true},"autoRecordingDelayMs":{"type":"number","maximum":3600000,"readOnly":true},"autoAdvance":{"type":"string","enum":["disabled","afterDefinedTime","afterAudioCompletion"],"readOnly":true},"autoAdvanceDelayMs":{"type":"number","maximum":3600000,"readOnly":true}}},"relationships":{"type":"object","properties":{"feedbackImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerSection","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerEmqGroup","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"answer":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"Portal":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"subdomain":{"type":"string","readOnly":true},"hostname":{"type":"string","readOnly":true},"subPortalDomain":{"type":"string","readOnly":false,"nullable":true,"maxLength":253,"description":"Optional suffix for sub-portal hostnames (slug.suffix). When unset, sub-portals use the portal hostname as the suffix."},"entitlements":{"type":"object","readOnly":true,"properties":{"branding":{"type":"boolean"},"doubleBlindMarking":{"type":"boolean"},"marking":{"type":"string","enum":["basic","standard","advanced"]},"textVariables":{"type":"boolean"},"integration":{"type":"boolean"},"userGroupAdvanced":{"type":"boolean"},"sso":{"type":"boolean"},"whiteLabeling":{"type":"boolean"},"mobileApp":{"type":"boolean"},"recordOfLearning":{"type":"boolean"},"subPortal":{"type":"boolean"},"zapier":{"type":"boolean"},"tagSets":{"type":"boolean"},"webhooks":{"type":"boolean"},"permissions":{"type":"string","enum":["basic","advanced","legacy"]},"synoptic":{"type":"string","enum":["lockdown","full"]},"personalAccessToken":{"type":"boolean"},"customAttributes":{"type":"number"},"equationEditor":{"type":"boolean"},"advancedGrading":{"type":"boolean"},"examVoucher":{"type":"boolean"},"codeLogin":{"type":"boolean"}}},"isActive":{"type":"boolean","readOnly":true},"headerIcon":{"type":"object","readOnly":false,"nullable":true,"properties":{"__type":{"type":"string","enum":["File"]},"name":{"type":"string"},"url":{"type":"string"}}},"favicon":{"type":"object","readOnly":false,"nullable":true,"properties":{"__type":{"type":"string","enum":["File"]},"name":{"type":"string"},"url":{"type":"string"}}},"squareIcon":{"type":"object","readOnly":false,"nullable":true,"properties":{"__type":{"type":"string","enum":["File"]},"name":{"type":"string"},"url":{"type":"string"}}},"extraInformation":{"type":"object","deprecated":true,"readOnly":false,"additionalProperties":true},"emailSettings":{"type":"object","deprecated":true,"readOnly":false,"properties":{"fromEmail":{"type":"string","format":"email"},"fromName":{"type":"string"},"marketingEmailsConsent":{"type":"object","properties":{"enabled":{"type":"boolean"},"requireEmailConfirmation":{"type":"boolean"},"defaultAgree":{"type":"boolean"},"customLabel":{"type":"string"}}},"isDisabled":{"type":"boolean"},"welcomeEmail":{"type":"object","properties":{"subject":{"type":"string","maxLength":100,"nullable":true},"body":{"type":"string","maxLength":5000,"nullable":true}}},"header":{"type":"object","properties":{"logoUrl":{"type":"string","format":"uri","nullable":true,"maxLength":500}}},"maxPerWeek":{"type":"integer","minimum":0},"address":{"type":"string"}}},"externalApi":{"type":"object","deprecated":true,"readOnly":false,"properties":{"intercom":{"type":"object","properties":{"idvKey":{"type":"string","maxLength":1000,"writeOnly":true,"externalDocs":{"url":"https://www.intercom.com/help/en/articles/7946878-what-is-identity-verification"}}}},"segment":{"type":"object","properties":{"apiKey":{"type":"string"},"webKey":{"type":"string"},"trackMiniEvents":{"type":"boolean"},"ingestionRegion":{"type":"string","enum":["us_oregon","eu_dublin"]},"cookieConsentEnabled":{"type":"boolean"}}},"googleAnalytics":{"type":"object","properties":{"webKey":{"type":"string"}}}}},"hostnameWhitelist":{"type":"array","readOnly":false,"maxItems":50,"items":{"type":"string","maxLength":100}},"registrationSettings":{"type":"object","deprecated":true,"readOnly":false,"properties":{"pageTitle":{"type":"string","maxLength":200},"pageDescription":{"type":"string","minLength":0,"maxLength":2000},"registerMethod":{"type":"string","enum":["open","closed"]},"collectAttrs":{"type":"array","nullable":true,"items":{"type":"string","maxLength":20},"maxItems":10},"selectUserGroup":{"type":"object","properties":{"label":{"type":"string"},"options":{"type":"array","maxItems":20,"items":{"type":"string","minLength":1,"maxLength":20}}}},"emailVerification":{"type":"boolean"},"headerBackgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{3,6}$"},"headerBorderBottomColor":{"type":"string","pattern":"^#[0-9a-fA-F]{3,6}$"},"backgroundImageUrl":{"type":"string","format":"uri","maxLength":300},"domainWhitelist":{"type":"array","maxItems":200,"items":{"type":"string","maxLength":60}},"localeConfig":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"externalAuth":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"label":{"type":"string"}}}}},"affiliation":{"type":"object","deprecated":true,"readOnly":false,"properties":{"twitter":{"type":"object","properties":{"url":{"type":"string","nullable":true}}},"facebook":{"type":"object","properties":{"url":{"type":"string","nullable":true}}},"linkedIn":{"type":"object","properties":{"url":{"type":"string","nullable":true}}},"youtube":{"type":"object","properties":{"url":{"type":"string","nullable":true}}}}},"webMetaInfo":{"type":"object","deprecated":true,"readOnly":false,"properties":{"site":{"type":"object","properties":{"siteName":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true,"maxLength":300},"imageUrl":{"type":"string","format":"uri","nullable":true}}}}},"styleConfig":{"type":"object","deprecated":true,"readOnly":false,"properties":{"brand":{"type":"object","properties":{"primary":{"type":"string"},"secondary":{"type":"string"}}},"font":{"type":"object","properties":{"color":{"type":"object","properties":{"link":{"type":"string"}}}}},"button":{"type":"object","properties":{"color":{"type":"object","properties":{"primary":{"type":"string"},"secondary":{"type":"string"}}},"text":{"type":"object","properties":{"primary":{"type":"string"},"secondary":{"type":"string"}}}}},"chart":{"type":"object","properties":{"color":{"type":"object","properties":{"primary":{"type":"string"}}}}},"navigationBar":{"type":"object","properties":{"background":{"type":"string"},"border":{"type":"string"}}},"ui":{"type":"object","properties":{"defaultCardImageUrl":{"type":"string","format":"uri","nullable":true}}}}},"notificationConfig":{"type":"object","readOnly":false,"properties":{"enabled":{"type":"boolean"},"groups":{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean"},"config":{"type":"object","additionalProperties":{"type":"boolean"}},"overrides":{"type":"array","items":{"type":"object","properties":{"enabled":{"type":"boolean"},"id":{"type":"string"},"config":{"type":"object","additionalProperties":{"type":"boolean"}}},"required":["enabled","id"]}}}}}}},"legalLinks":{"type":"object","deprecated":true,"readOnly":false,"properties":{"terms":{"type":"object","required":["hidden"],"properties":{"hidden":{"type":"boolean"},"url":{"type":"string","format":"uri","nullable":true},"noteId":{"type":"string","nullable":true}}},"privacy":{"type":"object","required":["hidden"],"properties":{"hidden":{"type":"boolean"},"url":{"type":"string","format":"uri","nullable":true},"noteId":{"type":"string","nullable":true}}}}},"generalSettings":{"type":"object","readOnly":false,"properties":{"availableExternalPlayers":{"type":"array","items":{"type":"string","enum":["default","ucat","usmle"]}},"defaultExternalPlayer":{"type":"object","properties":{"type":{"type":"string","enum":["default","ucat","usmle"]}}},"defaultFontSize":{"type":"string","enum":["xSmall","small","medium","large","xLarge"],"deprecated":true,"description":"Use generalSettingsDefaultFontSize instead"},"customGlossary":{"type":"object","properties":{"quizModePractice":{"type":"string","enum":["practice","tutor"],"nullable":true},"tagSetNoTagSet":{"type":"string","nullable":true}}},"mobileApp":{"type":"object","properties":{"appStoreLinks":{"type":"object","properties":{"android":{"type":"string"},"ios":{"type":"string"}}},"name":{"type":"string"},"image":{"type":"string"}}},"study":{"type":"object","deprecated":true,"properties":{"allowedFacets":{"type":"array","deprecated":true,"items":{"type":"string","enum":["subject","topic","subtopic","difficulty","skill","context"]}},"takeTest":{"type":"object","properties":{"flagging":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"calculator":{"type":"object","properties":{"enabled":{"type":"boolean"},"type":{"type":"string","enum":["basic","scientific"]}}},"notepad":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"strikethrough":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"highlighting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"bookmarking":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"labValues":{"type":"object","properties":{"enabled":{"type":"boolean"},"html":{"type":"string","nullable":true}}},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"]},"allowMultipleTagSelection":{"type":"boolean"},"excludeUntaggedQuestions":{"type":"boolean"}},"deprecated":true},"studyControls":{"type":"boolean","deprecated":true}}},"style":{"type":"object","properties":{"availableQuizThemes":{"type":"array","items":{"type":"string","enum":["default","ucat"]}}}},"takeTest":{"type":"object","properties":{"flagging":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"calculator":{"type":"object","properties":{"enabled":{"type":"boolean"},"type":{"type":"string","enum":["basic","scientific"]}}},"notepad":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"strikethrough":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"highlighting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"bookmarking":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"labValues":{"type":"object","properties":{"enabled":{"type":"boolean"},"html":{"type":"string","nullable":true}}},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"]},"allowMultipleTagSelection":{"type":"boolean"},"excludeUntaggedQuestions":{"type":"boolean"}},"deprecated":true},"userAccountManagement":{"type":"object","deprecated":true,"description":"Use generalSettingsUserAccountManagement(fields) instead","properties":{"preventUserAccountDeletion":{"type":"boolean"},"preventUserEmailEditing":{"type":"boolean"},"preventUserNameEditing":{"type":"boolean"}}},"logoutUrl":{"type":"string","format":"uri","nullable":true,"deprecated":true,"description":"Use generalSettingsLogoutUrl instead"}}},"localeConfig":{"type":"object","deprecated":true,"readOnly":false,"properties":{"defaultLocale":{"type":"string"},"defaultTimezone":{"type":"string"},"userPreferences":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}},"homepage":{"type":"string","readOnly":false},"affiliationFacebookUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"affiliationLinkedInUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"affiliationTwitterUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"affiliationYoutubeUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"emailSettingsFromName":{"type":"string","nullable":true,"readOnly":false},"emailSettingsFromEmail":{"type":"string","format":"email","nullable":true,"readOnly":false},"emailSettingsFooterText":{"type":"string","nullable":true,"readOnly":false},"emailSettingsHeaderLogoUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"emailSettingsWelcomeEmailEnabled":{"type":"boolean","readOnly":false},"emailSettingsWelcomeEmailSubject":{"type":"string","nullable":true,"readOnly":false},"emailSettingsWelcomeEmailBody":{"type":"string","nullable":true,"readOnly":false},"emailSettingsMarketingEmailsConsentEnabled":{"type":"boolean","readOnly":false},"emailSettingsMarketingEmailsConsentDefaultAgree":{"type":"boolean","readOnly":false},"emailSettingsMarketingEmailsConsentCustomLabel":{"type":"string","nullable":true,"readOnly":false},"emailSettingsMarketingEmailsConsentRequireEmailConfirmation":{"type":"boolean","readOnly":false},"externalApiGoogleAnalyticsWebKey":{"type":"string","nullable":true,"readOnly":false},"externalApiIntercomIdvKey":{"type":"string","nullable":true,"writeOnly":true},"externalApiIntercomIdvKeyIsSet":{"type":"boolean","readOnly":true},"externalApiSegmentApiKey":{"type":"string","nullable":true,"readOnly":false},"externalApiSegmentCookieConsentEnabled":{"type":"boolean","readOnly":false},"externalApiSegmentIngestionRegion":{"type":"string","enum":["us_oregon","eu_dublin"],"nullable":true,"readOnly":false},"externalApiSegmentTrackMiniEvents":{"type":"boolean","readOnly":false},"extraInformationDisplayMobileAppLink":{"type":"boolean","readOnly":false},"extraInformationHideFooter":{"type":"boolean","readOnly":false},"generalSettingsDefaultFontSize":{"type":"string","enum":["xSmall","small","medium","large","xLarge"],"nullable":true,"readOnly":false},"generalSettingsLogoutUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"generalSettingsUserAccountManagementPreventUserAccountDeletion":{"type":"boolean","readOnly":false},"generalSettingsUserAccountManagementPreventUserEmailEditing":{"type":"boolean","readOnly":false},"generalSettingsUserAccountManagementPreventUserNameEditing":{"type":"boolean","readOnly":false},"generalSettingsSubPortalSimplifiedExamManagement":{"type":"boolean","readOnly":false},"generalSettingsStudyAllowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","difficulty","skill","context"]}},"legalLinksPrivacyHidden":{"type":"boolean"},"legalLinksPrivacyNoteId":{"type":"string","nullable":true,"readOnly":false},"legalLinksPrivacyUrl":{"type":"string","nullable":true,"readOnly":false},"legalLinksTermsHidden":{"type":"boolean"},"legalLinksTermsNoteId":{"type":"string","nullable":true,"readOnly":false},"legalLinksTermsUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"localeConfigDefaultLocale":{"type":"string","readOnly":false,"nullable":true},"localeConfigDefaultTimezone":{"type":"string","readOnly":false,"nullable":true},"localeConfigUserPreferencesEnabled":{"type":"boolean","readOnly":false},"localeConfigCustomGlossaryQuizModePractice":{"type":"string","nullable":true,"readOnly":false},"localeConfigCustomGlossaryTagSetNoTagSet":{"type":"string","nullable":true,"readOnly":false},"localeConfigCustomGlossaryExternalId":{"type":"string","nullable":true,"readOnly":false,"description":"What this portal calls a user's external ID (e.g. ULN, SID), shown wherever the field appears."},"mobileAppAndroidStoreLink":{"type":"string","format":"uri","nullable":true,"readOnly":false},"mobileAppIosStoreLink":{"type":"string","format":"uri","nullable":true,"readOnly":false},"mobileAppName":{"type":"string","nullable":true,"readOnly":false},"mobileAppImageUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"mobileAppDisplayLink":{"type":"boolean","readOnly":false},"registrationSettingsLocaleConfigEnabled":{"type":"boolean","readOnly":false},"registrationSettingsExamVoucherLoginEnabled":{"type":"boolean","readOnly":false},"registrationSettingsRegisterMethod":{"type":"string","enum":["open","closed"]},"registrationSettingsDomainWhitelist":{"type":"array","maxItems":200,"items":{"type":"string","maxLength":60}},"registrationSettingsPageTitle":{"type":"string","maxLength":200},"registrationSettingsPageDescription":{"type":"string","minLength":0,"maxLength":2000,"nullable":true},"registrationSettingsBackgroundImageUrl":{"type":"string","format":"uri","maxLength":300,"nullable":true},"registrationSettingsHeaderBackgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{3,6}$","nullable":true},"registrationSettingsHeaderBorderBottomColor":{"type":"string","pattern":"^#[0-9a-fA-F]{3,6}$","nullable":true},"registrationSettingsSelectUserGroup":{"type":"object","nullable":true,"properties":{"label":{"type":"string"},"options":{"type":"array","items":{"type":"string"}}}},"securitySettingsMfaEnforcementAdmins":{"type":"boolean","readOnly":false},"securitySettingsMfaEnforcementModerators":{"type":"boolean","readOnly":false},"securitySettingsMfaEnforcementStudents":{"type":"boolean","readOnly":false},"securitySettingsPasskeysEnabled":{"type":"boolean","readOnly":false},"styleConfigBrandPrimary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"styleConfigBrandSecondary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"styleConfigButtonColorPrimary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"styleConfigButtonColorSecondary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"styleConfigChartColorPrimary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"styleConfigFontColorLink":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"styleConfigUiDefaultCardImageUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"studyConfigAllowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","difficulty","skill","context"]}},"studyConfigAvailableExternalPlayers":{"type":"array","nullable":true,"items":{"type":"string","enum":["default","ucat","usmle"]}},"studyConfigAvailableQuizThemes":{"type":"array","nullable":true,"items":{"type":"string","enum":["default","ucat"]}},"studyConfigDefaultExternalPlayer":{"type":"string","nullable":true,"enum":["default","ucat","usmle"]},"studyConfigStudyControls":{"type":"boolean","readOnly":false},"studyConfigTakeTest":{"type":"object","properties":{"flagging":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"calculator":{"type":"object","properties":{"enabled":{"type":"boolean"},"type":{"type":"string","enum":["basic","scientific"]}}},"notepad":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"strikethrough":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"highlighting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"bookmarking":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"labValues":{"type":"object","properties":{"enabled":{"type":"boolean"},"html":{"type":"string","nullable":true}}},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"]},"allowMultipleTagSelection":{"type":"boolean"},"excludeUntaggedQuestions":{"type":"boolean"}}},"studyConfigSelfPracticeTakeTest":{"type":"object","properties":{"flagging":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"calculator":{"type":"object","properties":{"enabled":{"type":"boolean"},"type":{"type":"string","enum":["basic","scientific"]}}},"notepad":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"strikethrough":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"highlighting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"bookmarking":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"labValues":{"type":"object","properties":{"enabled":{"type":"boolean"},"html":{"type":"string","nullable":true}}},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"]},"allowMultipleTagSelection":{"type":"boolean"},"excludeUntaggedQuestions":{"type":"boolean"}}},"webMetaInfoDescription":{"type":"string","nullable":true,"maxLength":300,"readOnly":false},"webMetaInfoImageUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"webMetaInfoSiteName":{"type":"string","nullable":true,"maxLength":100,"readOnly":false}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"adminsGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"managersGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"educatorsGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"markersGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"studentsGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"allUsersGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"subscription":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Subscription","enum":["Subscription"]}}}}}}}}},"PortalStore":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PortalStore","enum":["PortalStore"]},"attributes":{"type":"object","properties":{"name":{"type":"string","minLength":1,"readOnly":false},"description":{"type":"string","nullable":true,"readOnly":false},"pageControls":{"type":"object","readOnly":false},"requiresAuth":{"type":"boolean","readOnly":false},"headerTitle":{"type":"string","nullable":true,"readOnly":false},"headerSubtitle":{"type":"string","nullable":true,"readOnly":false},"headerImageUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"headerCoverImageUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"headerCoverImageBackground":{"type":"string","nullable":true,"readOnly":false},"headerTextColour":{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$","nullable":true,"readOnly":false}}},"relationships":{"type":"object","properties":{"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}}}}}},"PortalUsage":{"anyOf":[{"$ref":"#/components/schemas/PAYGPortalUsage"},{"$ref":"#/components/schemas/MAUPortalUsage"}]},"ProctorCapture":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ProctorCapture","enum":["ProctorCapture"]},"attributes":{"type":"object","anyOf":[{"properties":{"desktop":{"type":"string","readOnly":true},"start":{"type":"string","readOnly":true},"end":{"type":"string","readOnly":true},"duration":{"type":"number","readOnly":true}}},{"properties":{"webcam":{"type":"string","readOnly":true},"start":{"type":"string","readOnly":true},"end":{"type":"string","readOnly":true},"duration":{"type":"number","readOnly":true}}},{"properties":{"webcam":{"type":"string","readOnly":true},"desktop":{"type":"string","readOnly":true},"start":{"type":"string","readOnly":true},"end":{"type":"string","readOnly":true},"duration":{"type":"number","readOnly":true}}}]},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"proctorSession":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ProctorSession","enum":["ProctorSession"]}}}}}}}}},"ProctorEventLog":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ProctorEventLog","enum":["ProctorEventLog"]},"attributes":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true},"action":{"type":"string","readOnly":true},"delta":{"type":"object","readOnly":true,"properties":{"before":{"type":"object","readOnly":true,"properties":{"numberOfDisplays":{"readOnly":true,"type":"number"},"fullscreen":{"readOnly":true,"type":"boolean"},"focus":{"readOnly":true,"type":"boolean"},"numberOfTabs":{"readOnly":true,"type":"number"},"injectedToken":{"readOnly":true,"type":"string"},"examConnected":{"readOnly":true,"type":"boolean"},"questionData":{"readOnly":true,"type":"object","properties":{"questionId":{"readOnly":true,"type":"string"},"questionDoi":{"readOnly":true,"type":"string"},"sectionId":{"readOnly":true,"type":"string"},"sectionDoi":{"readOnly":true,"type":"string"}}}}},"after":{"type":"object","readOnly":true,"properties":{"numberOfDisplays":{"readOnly":true,"type":"number"},"fullscreen":{"readOnly":true,"type":"boolean"},"focus":{"readOnly":true,"type":"boolean"},"numberOfTabs":{"readOnly":true,"type":"number"},"injectedToken":{"readOnly":true,"type":"string"},"examConnected":{"readOnly":true,"type":"boolean"},"questionData":{"readOnly":true,"type":"object","properties":{"questionId":{"readOnly":true,"type":"string"},"questionDoi":{"readOnly":true,"type":"string"},"sectionId":{"readOnly":true,"type":"string"},"sectionDoi":{"readOnly":true,"type":"string"}}}}}}},"message":{"type":"string","readOnly":true},"questionData":{"readOnly":true,"type":"object","properties":{"questionId":{"readOnly":true,"type":"string"},"questionDoi":{"readOnly":true,"type":"string"},"sectionId":{"readOnly":true,"type":"string"},"sectionDoi":{"readOnly":true,"type":"string"}}},"timestamp":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"ProctorReview":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ProctorReview","enum":["ProctorReview"]},"attributes":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"body":{"type":"string","readOnly":false},"action":{"type":"string","readOnly":true},"timestamp":{"type":"string","readOnly":true},"anchoredAt":{"type":"string","format":"date-time","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"ProctorSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ProctorSession","enum":["ProctorSession"]},"attributes":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"sessionId":{"type":"string","readOnly":true},"token":{"type":"string","readOnly":true},"enabled":{"type":"boolean","readOnly":true},"breaches":{"type":"number","readOnly":true},"requiresReview":{"type":"boolean","readOnly":true},"isApproved":{"type":"boolean","readOnly":true},"url":{"type":"string","readOnly":true},"isFinalised":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"Product":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Product","enum":["Product"]},"attributes":{"type":"object","allOf":[{"not":{"allOf":[{"required":["defaultCurrency"],"properties":{"defaultCurrency":{"enum":["gbp"]}}},{"required":["prices"],"properties":{"prices":{"type":"array","items":{"not":{"required":["currency"],"properties":{"currency":{"enum":["gbp"]}}}}}}}]}},{"not":{"allOf":[{"required":["defaultCurrency"],"properties":{"defaultCurrency":{"enum":["eur"]}}},{"required":["prices"],"properties":{"prices":{"type":"array","items":{"not":{"required":["currency"],"properties":{"currency":{"enum":["eur"]}}}}}}}]}},{"not":{"allOf":[{"required":["defaultCurrency"],"properties":{"defaultCurrency":{"enum":["usd"]}}},{"required":["prices"],"properties":{"prices":{"type":"array","items":{"not":{"required":["currency"],"properties":{"currency":{"enum":["usd"]}}}}}}}]}}],"properties":{"title":{"type":"string","readOnly":false},"isActive":{"type":"boolean","readOnly":false},"productIdentifier":{"type":"string","description":"Internal reference for the product, unique within the portal.","readOnly":false},"description":{"type":"string","nullable":true,"readOnly":false},"shortDescription":{"type":"string","nullable":true,"readOnly":false},"purchaseMethod":{"type":"string","enum":["product","subscription","free"],"readOnly":false},"requirements":{"type":"array","readOnly":false,"nullable":true,"maxItems":5,"items":{"type":"object","properties":{"type":{"type":"string","enum":["promoCode","storeOffer"]},"promoCode":{"type":"object","nullable":true,"required":["prefix"],"properties":{"prefix":{"type":"string"},"redemptions":{"type":"number"}}},"storeOffer":{"type":"object","nullable":true,"properties":{"id":{"type":"string"}}},"message":{"type":"string","description":"Store signposting message for the requirement.","readOnly":true,"nullable":true}}}},"unlockActions":{"type":"array","readOnly":false,"items":{"type":"object","properties":{"type":{"type":"string","enum":["userGroup","collection"]},"targetId":{"type":"string","nullable":true},"accessLevel":{"type":"string","nullable":true,"enum":["full","restricted"]},"config":{"type":"object","nullable":true},"fullAccessProductIdentifier":{"type":"string","nullable":true}}}},"marketingFeatures":{"type":"object","readOnly":false,"nullable":true,"required":["items"],"properties":{"heading":{"type":"string","nullable":true},"items":{"type":"array","maxItems":15,"items":{"type":"object","required":["label"],"not":{"allOf":[{"required":["iconUrl"],"properties":{"iconUrl":{"type":"string"}}},{"required":["icon"],"properties":{"icon":{"type":"string"}}}]},"properties":{"label":{"type":"string","minLength":1,"maxLength":200},"iconUrl":{"type":"string","description":"Uploaded custom image.","nullable":true},"icon":{"type":"string","description":"Picked icon class, an alternative to `iconUrl`.","minLength":1,"maxLength":60,"pattern":"^[a-z0-9]+(?: [a-z0-9]+)*$","nullable":true},"iconColour":{"type":"string","description":"Foreground colour of `icon`.","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$","nullable":true},"backgroundColour":{"type":"string","description":"Tint behind the icon.","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$","nullable":true}}}}}},"allowPromoCodes":{"type":"boolean","readOnly":false},"prices":{"type":"array","readOnly":false,"nullable":true,"description":"At most one price per currency; currency identifies a price within its product.","maxItems":3,"items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"string","enum":["gbp","eur","usd"]},"amount":{"type":"integer","description":"Minor units, e.g. 47500 for £475.00. At least 100 — one whole unit of the currency.","minimum":100},"taxBehavior":{"type":"string","description":"Whether `amount` already includes tax.","enum":["inclusive","exclusive",null],"nullable":true}}}},"defaultCurrency":{"type":"string","description":"Currency the storefront offers first. Must match one of `prices`.","enum":["gbp","eur","usd",null],"nullable":true,"readOnly":false},"amount":{"type":"number","nullable":true,"readOnly":true},"priceTag":{"type":"string","nullable":true,"readOnly":true},"currency":{"type":"string","nullable":true,"readOnly":true},"skuId":{"type":"string","nullable":true,"readOnly":true},"checkoutConfig":{"type":"object","nullable":true,"readOnly":true,"properties":{"type":{"type":"string","enum":["chargebee","stripe"]},"appId":{"type":"string","nullable":true},"publicKey":{"type":"string","nullable":true}},"required":["type"]},"isCheckoutConfigured":{"type":"boolean","description":"Whether the payment route this product needs is in place: always true for a free product, and for a paid one only while the portal holds usable Stripe integration credentials. Says nothing about the product being priced.","readOnly":true},"accessDetails":{"type":"object","nullable":true,"readOnly":true,"properties":{"accessUntilDate":{"type":"string","format":"date-time"},"accessLengthInMonths":{"type":"number","format":"int32","minimum":1,"nullable":true}},"required":["accessUntilDate"]}}},"relationships":{"type":"object","properties":{"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"ProductList":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ProductList","enum":["ProductList"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"description":{"type":"string","readOnly":false,"nullable":true}}},"relationships":{"type":"object","properties":{"products":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Product"],"example":"Product"}]}}}}}}}}}},"PublicAttributeConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PublicAttributeConfig","enum":["PublicAttributeConfig"]},"attributes":{"type":"object","properties":{"customId":{"type":"string","readOnly":true},"type":{"type":"string","enum":["boolean","date","multiChoice","multiText","number","singleChoice","text","link"],"readOnly":false},"label":{"type":"string","readOnly":false},"sublabel":{"type":"string","readOnly":false,"nullable":true},"description":{"type":"string","readOnly":false,"nullable":true},"options":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"label":{"type":"string"}}}},"labelQuestion":{"type":"string","readOnly":false,"nullable":true},"editPermission":{"type":"number","enum":[0,1,2],"readOnly":false},"viewPermission":{"type":"number","enum":[0,1,2],"readOnly":false},"settings":{"type":"object","nullable":true,"properties":{"link":{"type":"object","properties":{"display":{"type":"object","properties":{"asButton":{"type":"boolean"}}},"authenticated":{"type":"boolean"},"clickBehavior":{"type":"string","enum":["newWindow","sameWindow","modal","modalWithDownload","download","action"],"readOnly":false,"nullable":false}}}}}}},"relationships":{"type":"object","properties":{}}}},"PublicAuthenticationOption":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PublicAuthenticationOption","enum":["PublicAuthenticationOption"]},"attributes":{"type":"object","properties":{"label":{"type":"string","readOnly":true},"authProvider":{"anyOf":[{"type":"object","readOnly":true,"properties":{"type":{"type":"string","enum":["local"]},"passkeysEnabled":{"type":"boolean","readOnly":true,"nullable":true}}},{"type":"object","readOnly":true,"properties":{"type":{"type":"string","enum":["auth0"]},"domain":{"type":"string","readOnly":true},"clientId":{"type":"string","readOnly":true},"scope":{"type":"array","readOnly":true,"items":{"type":"string"}}}},{"type":"object","readOnly":true,"properties":{"type":{"type":"string","enum":["adfs"]},"domain":{"type":"string","readOnly":true},"spEntityId":{"type":"string","readOnly":true}}},{"type":"object","readOnly":true,"properties":{"type":{"type":"string","enum":["saml"]},"domain":{"type":"string","readOnly":true},"spEntityId":{"type":"string","readOnly":true}}},{"type":"object","readOnly":true,"properties":{"type":{"type":"string","enum":["jwt"]},"loginPageUrl":{"type":"string","readOnly":true},"embedLoginPage":{"type":"boolean","readOnly":true}}}]}}},"relationships":{"type":"object","properties":{}}}},"PublicCertificate":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PublicCertificate","enum":["PublicCertificate"]},"attributes":{"type":"object","properties":{"html":{"type":"string","readOnly":true},"documentKey":{"type":"string","readOnly":true},"expiryDate":{"type":"string","readOnly":true},"validationUrl":{"type":"string","readOnly":true},"sharingImageUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Document","enum":["Document"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}}}}}},"QuestionExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuestionExport","enum":["QuestionExport"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["quiz"],"properties":{"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}}}}}},"QuestionImport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuestionImport","enum":["QuestionImport"]},"attributes":{"type":"object","properties":{"csvUrl":{"type":"string","readOnly":true},"fieldMap":{"type":"object","readOnly":true},"appendToTest":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{"backgroundJob":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BackgroundJob","enum":["BackgroundJob"]}}}}},"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}}}}}},"QuestionImportValidation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuestionImportValidation","enum":["QuestionImportValidation"]},"attributes":{"type":"object","properties":{"newTags":{"type":"number","readOnly":true},"toCreate":{"type":"number","readOnly":true},"toUpdate":{"type":"number","readOnly":true},"toDelete":{"type":"number","readOnly":true},"appendToTest":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]}}}}}}}}},"QuestionSummary":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuestionSummary","enum":["QuestionSummary"]},"attributes":{"type":"object","properties":{"masteryLevel":{"type":"string","readOnly":true,"enum":["unseen","weak","moderate","strong","mastered",null],"nullable":true}}},"relationships":{"type":"object","properties":{"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"tagSets":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["TagSet"],"example":"TagSet"}]}}}}}}}}}},"Quiz":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":false,"minLength":1,"maxLength":300},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"description":{"type":"string","nullable":true,"readOnly":false,"maxLength":50000},"shortDescription":{"type":"string","nullable":true,"readOnly":false,"minLength":0,"maxLength":1500},"totalQuestions":{"type":"number","nullable":false,"readOnly":true},"instructionsEnabled":{"type":"boolean","readOnly":false,"nullable":false},"instructionsTitle":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":300},"instructionsBody":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":25000},"instructionsTimerDurationMs":{"type":"number","nullable":true,"readOnly":false,"minimum":1,"maximum":86400000},"instructionsEnforcedTimer":{"type":"string","readOnly":false,"enum":["afterAudioStarts","immediately"]},"instructionsAudioAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"instructionsAudioAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"instructionsDisableAudioControls":{"type":"boolean","readOnly":false,"nullable":true},"markingCreditsPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0},"markingPartialCreditsPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0},"markingPenaltiesPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0},"markingPenaltiesEnabled":{"type":"boolean","nullable":true,"readOnly":false},"grades":{"type":"array","nullable":true,"items":{"type":"object","properties":{"label":{"type":"string","readOnly":false},"minScore":{"type":"number","readOnly":false},"isPass":{"type":"boolean","readOnly":false,"nullable":true},"description":{"type":"string","readOnly":false,"nullable":true},"advancedCriteria":{"type":"object","readOnly":false,"nullable":true,"properties":{"sectionRequirements":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","enum":["none","requiredCount","allPass","selectedPass"],"readOnly":false,"nullable":true},"count":{"type":"number","readOnly":false,"nullable":true},"sectionIds":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"string","readOnly":false,"nullable":true}}}},"excludeFromResitAttempts":{"type":"boolean","readOnly":false,"nullable":true}}}}}},"allowedModes":{"type":"array","nullable":true,"items":{"type":"string","enum":["practice","exam","timedExam"]},"minItems":1,"maxItems":3},"allowedLengths":{"type":"array","items":{"type":"string","enum":["default","quick","medium","long","extraLong"]}},"allowedPlayers":{"type":"array","items":{"type":"string","enum":["default","ucat","usmle"]}},"allowedTagSets":{"type":"array","nullable":true,"items":{"type":"string"}},"allowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","skill","difficulty","context"]}},"calculatorEnabled":{"type":"boolean","readOnly":false},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"],"readOnly":false},"allowMultipleTagSelection":{"type":"boolean","readOnly":false},"excludeUntaggedQuestions":{"type":"boolean","readOnly":false},"showMasteryFilters":{"type":"boolean","readOnly":false},"calculatorType":{"type":"string","enum":["basic","scientific"]},"securityDisableCopying":{"type":"boolean","readOnly":false},"securityDisablePasting":{"type":"boolean","readOnly":false},"securityDisableRightClick":{"type":"boolean","readOnly":false},"navigationDisableNavigation":{"type":"boolean","readOnly":false},"navigationDisableControlPanel":{"type":"boolean","readOnly":false},"navigationDisableNotifications":{"type":"boolean","readOnly":false},"softSectionsEnabled":{"type":"boolean","readOnly":false},"notepadEnabled":{"type":"boolean","readOnly":false},"resizableQuestionPanelsEnabled":{"type":"boolean","readOnly":false},"strikethroughEnabled":{"type":"boolean","readOnly":false},"highlightingEnabled":{"type":"boolean","readOnly":false},"bookmarkingEnabled":{"type":"boolean","readOnly":false},"micSettingsEnabled":{"type":"boolean","readOnly":false},"labValuesEnabled":{"type":"boolean","readOnly":false},"labValuesHtml":{"type":"string","readOnly":false},"additionalInformationEnabled":{"type":"boolean","readOnly":false},"additionalInformationTitle":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":120},"additionalInformationIcon":{"type":"string","readOnly":false,"nullable":true},"additionalInformationHtml":{"type":"string","readOnly":false},"resumeLaterButtonEnabled":{"type":"boolean","readOnly":false},"flaggingEnabled":{"type":"boolean","readOnly":false},"showAvailableMarks":{"type":"boolean","readOnly":false},"playerType":{"type":"string","enum":["default","ucat","usmle"]},"theme":{"type":"string"},"fontSize":{"type":"string","enum":["xSmall","small","medium","large","xLarge"]},"pinnedMessageDuringTest":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":1500},"deferResultsEnabled":{"type":"boolean","readOnly":false},"deferResultsMessage":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":25000},"deferResultsAlwaysRelease":{"type":"boolean","readOnly":false},"whenCompleteNoGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000,"deprecated":true},"completedMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000,"deprecated":true},"resultsHideResults":{"type":"boolean","readOnly":false},"resultsGlobalHideScore":{"type":"boolean","readOnly":false},"resultsDetailedViewEnabled":{"type":"boolean","readOnly":false},"resultsOverviewWhenPassedMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenFailedHasResitsMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenFailedNoResitsMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenCompleteNoGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenCompletedNeutralGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessagePassed":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageFailed":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageResitsRemaining":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageNoResitsRemaining":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageCompleted":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageSettingHideTitle":{"type":"boolean","readOnly":false},"resultsHiddenMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsHiddenSettingHideTitle":{"type":"boolean","readOnly":false},"resultsMetricScoreEnabled":{"type":"boolean","readOnly":false},"resultsMetricTimeSpentEnabled":{"type":"boolean","readOnly":false},"resultsMetricGradeEnabled":{"type":"boolean","readOnly":false},"resultsMetricProgressEnabled":{"type":"boolean","readOnly":false,"deprecated":true,"description":"Use resultsMetricTagProgressEnabled instead"},"resultsMetricQuestionBreakdownDisplayLevel":{"type":"string","enum":["full","hideStemAndOptions","hideCorrectOptions","incorrectOnlyHideCorrectOptions","none"],"readOnly":false},"resultsMetricAnalyticsCohort":{"type":"string","enum":["exam","test","sourceTest"]},"resultsMetricCohortAverageEnabled":{"type":"boolean","readOnly":false},"resultsMetricCohortPercentileEnabled":{"type":"boolean","readOnly":false},"resultsMetricCohortScoreDistributionEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagBreakdownEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagProgressEnabled":{"type":"boolean","readOnly":false},"resultsMetricSectionBreakdownEnabled":{"type":"boolean","readOnly":false},"resultsMetricSectionBreakdownGradeEnabled":{"type":"boolean","readOnly":false},"resultsMetricSectionBreakdownScoreEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagProgressFacetsEnabled":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"subject":{"type":"boolean","readOnly":false},"topic":{"type":"boolean","readOnly":false},"subtopic":{"type":"boolean","readOnly":false},"skill":{"type":"boolean","readOnly":false},"difficulty":{"type":"boolean","readOnly":false}}},"resultsEducatorViewAsAdminEnabled":{"type":"boolean","readOnly":false},"timerEnabled":{"type":"boolean","readOnly":false},"timerHidden":{"type":"boolean","readOnly":false},"timerUseQuestions":{"type":"boolean","readOnly":false},"timerUseSections":{"type":"boolean","readOnly":false},"timerEnforceFullTime":{"type":"boolean","readOnly":false},"timerTimeInMs":{"type":"number","nullable":true,"readOnly":false,"minimum":1,"maximum":86400000},"timerExtraTimeMultiplier":{"type":"number","readOnly":false,"nullable":true},"timerSoftTimer":{"type":"boolean","readOnly":false},"mutexLockKey":{"type":"string","readOnly":true,"nullable":true},"mutexLockExpiresAt":{"type":"string","readOnly":true,"nullable":true},"mutexLockType":{"type":"string","enum":["write","full",null],"readOnly":true,"nullable":true},"certificatesEnabled":{"type":"boolean","readOnly":false},"certificatesTemplateId":{"type":"string","nullable":true,"readOnly":false},"certificatesQrCode":{"type":"boolean","nullable":true,"readOnly":false},"certificatesTtl":{"type":"number","nullable":true,"readOnly":false},"certificatesIgnoreSubPortalBranding":{"type":"boolean","nullable":true,"readOnly":false},"certificatesIssueOnFail":{"type":"boolean","nullable":true,"readOnly":false},"certificatesResultsPage":{"type":"boolean","nullable":true,"readOnly":false},"certificatesSharingImageUrl":{"type":"string","nullable":true,"readOnly":false},"resitEnabled":{"type":"boolean","nullable":false,"readOnly":false},"resitType":{"type":"string","enum":["continuous","fixedDate","onDemand","rolling",null],"nullable":true,"readOnly":false},"resitMode":{"type":"string","enum":["standard","fixed","progressive","preferUnseen",null],"readOnly":false,"nullable":true},"resitGradeIndependent":{"type":"boolean","nullable":true,"readOnly":false},"resitAllowedAttempts":{"type":"number","nullable":true,"readOnly":false},"resitDelay":{"type":"number","nullable":true,"readOnly":false},"resitCloseDelay":{"type":"number","nullable":true,"readOnly":false},"resitScheduleActivateAt":{"type":"string","nullable":true,"readOnly":false},"resitScheduleDeactivateAt":{"type":"string","nullable":true,"readOnly":false},"proctorEnabled":{"type":"boolean","readOnly":false,"nullable":false},"proctorVendor":{"type":"string","readOnly":false,"enum":["internal","rosalyn","synopticV2",null],"nullable":true},"proctorRequireFullscreen":{"type":"boolean","readOnly":false,"nullable":false},"proctorRestrictTabs":{"type":"boolean","readOnly":false,"nullable":false},"proctorRestrictDisplays":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordSession":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordSnapshots":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordDesktop":{"type":"boolean","readOnly":false,"nullable":false},"proctorSynopticLevel":{"type":"string","readOnly":false,"nullable":false,"enum":["web","browser","desktop"]},"proctorScreenMonitoring":{"type":"string","readOnly":false,"nullable":false,"enum":["none","recreation","recreationWithSnapshots","video"]},"proctorWebcamMonitoring":{"type":"string","readOnly":false,"nullable":false,"enum":["none","snapshots","audioVideo"]},"proctorRestrictKeyboardShortcuts":{"type":"boolean","readOnly":false,"nullable":false},"proctorScreenshotPrevention":{"type":"boolean","readOnly":false,"nullable":true},"proctorAiReview":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiFlagCandidateLeftFrame":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiFlagMultiplePeopleInFrame":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiPrompts":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"prompt":{"type":"string","readOnly":false},"level":{"type":"string","readOnly":false,"enum":["info","warning","breach"]},"colour":{"type":"string","readOnly":false,"nullable":true}}}},"proctorOnBreach":{"type":"string","enum":["freeze","silent",null],"readOnly":false,"nullable":true},"proctorReviewOptional":{"type":"boolean","readOnly":false,"nullable":false},"proctorReviewMode":{"type":"string","enum":["always","never","onBreach",null],"readOnly":false,"nullable":true},"proctorLiveProctoring":{"type":"boolean","readOnly":false,"nullable":false},"proctorBlockedApplicationsPolicy":{"type":"string","readOnly":false,"nullable":true,"enum":["none","default",null]},"proctorRosalynRuleUsePrivateTestArea":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleVisibleFace":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowInteractionWithOthers":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowOtherMaterials":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowNoiseMakingDevices":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowAdditionalDevices":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleAllowMouseKeyboardMonitorOnly":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowAppsOrBroswerTabs":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowExamContentSharing":{"type":"boolean","readOnly":false,"nullable":false},"proctorRosalynRuleDoNotAllowTextPrediction":{"type":"boolean","readOnly":false,"nullable":false},"access":{"type":"object","readOnly":true,"properties":{"exam":{"type":"object","properties":{"objectId":{"type":"string","nullable":true}}}}},"legalEnabled":{"type":"boolean","readOnly":false},"legalTitle":{"type":"string","readOnly":false,"nullable":true},"legalBody":{"type":"string","readOnly":false,"nullable":true},"legalCheckboxLabel":{"type":"string","readOnly":false,"nullable":true},"legalConfirmationType":{"type":"string","enum":["checkbox","staticText","candidateName"],"readOnly":false,"nullable":true},"legalConfirmationStaticText":{"type":"string","readOnly":false,"nullable":true},"dynamicVariationEnabled":{"type":"boolean","readOnly":false},"dynamicVariationMaxVariants":{"type":"number","minimum":0,"readOnly":false,"nullable":true},"scheduleOpenDate":{"type":"string","readOnly":false,"nullable":true},"scheduleCloseDate":{"type":"string","readOnly":false,"nullable":true},"scheduleSubmissionDueDate":{"type":"string","readOnly":false,"nullable":true},"scheduleRelativeCloseTimeInMs":{"type":"number","minimum":0,"readOnly":false,"nullable":true},"dynamicFiltersWeightingType":{"type":"string","enum":["absolute","percentage"],"nullable":true,"readOnly":false},"dynamicFilterRules":{"nullable":true,"type":"array","minItems":0,"maxItems":125,"description":"Array of filter rules to apply to the dynamic quiz content.","items":{"type":"object","properties":{"weighting":{"type":"number"},"shuffleQuestions":{"type":"boolean"},"matchingRules":{"type":"array","minItems":0,"maxItems":20,"description":"Array of matching rules to apply to the filter rule. Each rule will be treated as an AND operation. Matching rules can not be a mix of tag and EMQ rules.","items":{"oneOf":[{"anyOf":[{"type":"object","required":["tagId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["tagId"],"properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}}}]},{"anyOf":[{"type":"object","required":["emqGroupId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"emqGroupId":{"type":"string","minLength":5,"maxLength":32}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["emqGroupId"],"properties":{"emqGroupId":{"type":"string","minLength":5,"maxLength":32}}}}]},{"anyOf":[{"type":"object","required":["questionId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"questionId":{"type":"string","minLength":5,"maxLength":32}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["questionId"],"properties":{"questionId":{"type":"string","minLength":5,"maxLength":32}}}}]}]}}}}},"isDynamic":{"type":"boolean","readOnly":true},"isSectioned":{"type":"boolean","readOnly":true},"shuffleDynamicFilters":{"type":"boolean","nullable":true,"description":"If true then the dynamic filters will be shuffled for each attempt."},"shuffleAllDynamicQuestions":{"type":"boolean","nullable":true,"description":"If true then all questions selected accross filter rules will be shuffled. EMQ grouping will be maintained."},"shuffleSectionsEnabled":{"type":"boolean","readOnly":false},"shuffleQuestions":{"type":"string","enum":["disabled","random","enabled"],"readOnly":false,"description":"If true then the questions will be shuffled for each attempt."},"version":{"type":"string","readOnly":true},"status":{"type":"string","enum":["draft","published","cancelled","closed"],"readOnly":false,"nullable":false},"isGenerated":{"type":"boolean","readOnly":true,"nullable":true},"isArchived":{"type":"boolean","readOnly":false},"excludeInformationalQuestionsFromCounts":{"type":"boolean","readOnly":false},"sectionGradesEnabled":{"type":"boolean","readOnly":false},"advancedGradingEnabled":{"type":"boolean","readOnly":false},"passFailEnabled":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"questions":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}},"emqGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizEmqGroup"],"example":"QuizEmqGroup"}]}}}}}},"sections":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizSection"],"example":"QuizSection"}]}}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"sourceContentQuizzes":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Quiz"],"example":"Quiz"}]}}}}}},"sourceSettingsQuiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TagSet","enum":["TagSet"]}}}}},"setupValidation":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSetupValidation","enum":["QuizSetupValidation"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}},"QuizAttemptSetupConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizAttemptSetupConfig","enum":["QuizAttemptSetupConfig"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"allowMultipleTagSelection":{"type":"boolean"},"allowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","skill","difficulty","context",null]}},"allowedLengths":{"type":"array","nullable":true,"items":{"type":"string","enum":["default","quick","medium","long","extraLong",null]}},"allowedModes":{"type":"array","nullable":true,"items":{"type":"string","enum":["practice","exam","timedExam",null]}},"allowedPlayers":{"type":"array","nullable":true,"items":{"type":"string","enum":["default","ucat","usmle",null]}},"allowedTagSets":{"type":"array","nullable":true,"items":{"type":"string"}},"deferResultsEnabled":{"type":"boolean"},"description":{"type":"string"},"excludeUntaggedQuestions":{"type":"boolean"},"inProgressAttempt":{"type":"object","additionalProperties":false,"description":"The in-progress attempt at this quiz for the requesting user, if there is one.","properties":{"id":{"type":"string"},"timeStarted":{"type":"string","format":"date-time"},"quizMode":{"type":"string","enum":["practice","exam","timedExam","test"]},"questionsAnswered":{"type":"number"},"questionsTotal":{"type":"number"},"timeSpentMs":{"type":"number","description":"Active time on the attempt in milliseconds. Omitted when none has been recorded."},"savedAt":{"type":"string","format":"date-time","description":"When the student last left this attempt. Omitted when that cannot be derived."}}},"instructionsEnabled":{"type":"boolean"},"isGenerated":{"type":"boolean"},"questionIdList":{"type":"array","items":{"type":"string"}},"sectionCount":{"type":"number"},"sectionList":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"title":{"type":"string","nullable":true},"questionCount":{"type":"number"},"instructionsEnabled":{"type":"boolean"},"timerInferFromQuestions":{"type":"boolean"},"timerDurationMs":{"type":"number","nullable":true},"instructionsTimerDurationMs":{"type":"number","nullable":true}}}},"showMasteryFilters":{"type":"boolean"},"softSectionsEnabled":{"type":"boolean"},"tagSelectionDisplayMode":{"type":"string"},"timeAllowedForInstructionsMs":{"type":"number","nullable":true,"description":"Total time allowed for all instructions, including that of any sections."},"timeAllowedForQuestionsMs":{"type":"number","nullable":true,"description":"Total time allowed for all questions in a non-sectioned quiz. Excludes instruction timers."},"timeAllowedForSectionsMs":{"type":"number","nullable":true,"description":"Total time allowed for all questions in a sectioned quiz. Excludes instruction timers."},"timeAllowedOverallMs":{"type":"number","nullable":true,"description":"Total time allowed for setup, including instruction/section/question allocations."},"timerEnabled":{"type":"boolean"},"timerEnforceFullTime":{"type":"boolean"},"timerTimeInMs":{"type":"number","nullable":true},"timerUseQuestions":{"type":"boolean"},"timerUseSections":{"type":"boolean"},"title":{"type":"string"},"totalQuestions":{"type":"number"}}},"relationships":{"type":"object","properties":{}}}},"QuizEmqGroup":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"label":{"type":"string","readOnly":false,"minLength":1,"maxLength":300},"instructionsBody":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":100000},"feedback":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"audioPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioAutoPlay":{"type":"boolean","readOnly":false,"nullable":false},"hideQuestionStem":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","properties":{"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"audioInstructions":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}}}}}},"QuizPdfAttemptExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizPdfAttemptExport","enum":["QuizPdfAttemptExport"]},"attributes":{"type":"object","properties":{"url":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"QuizPdfExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizPdfExport","enum":["QuizPdfExport"]},"attributes":{"type":"object","properties":{"url":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}}}}}},"QuizQuestionAudioRecording":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionAudioRecording","enum":["QuizQuestionAudioRecording"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["audioRecording"]},"inputLabel":{"type":"string","readOnly":false,"maxLength":30000},"audioRecordingMaximumTimeMs":{"type":"number","readOnly":false,"minimum":1,"maximum":3600000},"audioRecordingAllowDelete":{"type":"boolean","readOnly":false},"audioRecordingAllowReRecord":{"type":"boolean","readOnly":false},"audioRecordingAllowPause":{"type":"boolean","readOnly":false},"audioRecordingAllowEarlySubmission":{"type":"boolean","readOnly":false},"audioRecordingAutoRecording":{"type":"boolean","readOnly":false},"audioRecordingAutoRecordingDelayMs":{"type":"number","readOnly":false,"minimum":0,"maximum":3600000},"audioRecordingAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","afterAudioCompletion"]},"audioRecordingAutoAdvanceDelayMs":{"type":"number","readOnly":false,"minimum":0,"maximum":3600000}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionClozeDragAndDrop":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionClozeDragAndDrop","enum":["QuizQuestionClozeDragAndDrop"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["clozeDragAndDrop"]},"clozeTemplate":{"type":"string","readOnly":false,"minLength":1},"scoring":{"type":"string","enum":["exactMatch","partialMatch","matchPerBlank"]},"pointPerBlank":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"canReusePossibleResponses":{"type":"boolean","readOnly":false},"shareCorrectResponses":{"type":"boolean","readOnly":false},"blanks":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","readOnly":false},"correctResponseKey":{"type":"string","readOnly":false}}}},"possibleResponses":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","readOnly":false},"value":{"type":"string","readOnly":false},"credits":{"type":"array","items":{"type":"object","properties":{"blankKey":{"type":"string","readOnly":false},"value":{"type":"number","minimum":0,"readOnly":false}}},"readOnly":false,"nullable":true,"minItems":1},"penalties":{"type":"array","items":{"type":"object","properties":{"blankKey":{"type":"string","readOnly":false},"value":{"type":"number","minimum":0,"readOnly":false}}},"readOnly":false,"nullable":true,"minItems":1}}}},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"]},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false,"nullable":true}},"anyOf":[{"description":"canReusePossibleResponses can be false when shareCorrectResponses is true","properties":{"canReusePossibleResponses":{"enum":[false]},"shareCorrectResponses":{"enum":[true]}}},{"description":"shareCorrectResponses can be false when canReusePossibleResponses is true","properties":{"canReusePossibleResponses":{"enum":[true]},"shareCorrectResponses":{"enum":[false]}}},{"description":"both canReusePossibleResponses and shareCorrectResponses can be false","properties":{"canReusePossibleResponses":{"enum":[false]},"shareCorrectResponses":{"enum":[false]}}}]},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionClozeDropDown":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionClozeDropDown","enum":["QuizQuestionClozeDropDown"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["clozeDropDown"]},"clozeTemplate":{"type":"string","readOnly":false,"minLength":1},"scoring":{"type":"string","enum":["exactMatch","partialMatch","matchPerBlank"]},"pointPerBlank":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"blanks":{"type":"array","minItems":1,"items":{"type":"object","properties":{"key":{"type":"string","readOnly":false},"possibleResponses":{"type":"array","minItems":1,"items":{"type":"object","properties":{"isCorrect":{"type":"boolean","readOnly":false},"value":{"type":"string","readOnly":false},"credits":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"penalties":{"type":"number","readOnly":false,"nullable":true,"minimum":0}}}}}}},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"]},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false,"nullable":true}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionClozeText":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionClozeText","enum":["QuizQuestionClozeText"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["clozeText"]},"clozeTemplate":{"type":"string","readOnly":false,"minLength":1},"scoring":{"type":"string","enum":["exactMatch","partialMatch","matchPerBlank"]},"pointPerBlank":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"blanks":{"type":"array","minItems":1,"items":{"type":"object","properties":{"key":{"type":"string","readOnly":false},"type":{"type":"string","readOnly":false,"enum":["text","number"]},"possibleResponses":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"properties":{"value":{"anyOf":[{"type":"string","readOnly":false},{"type":"object","required":["min","max"],"properties":{"min":{"type":"number","readOnly":false},"max":{"type":"number","readOnly":false}},"readOnly":false}]},"credits":{"type":"number","readOnly":false,"nullable":true,"minimum":0}},"readOnly":false}}}}},"caseMatch":{"type":"boolean","readOnly":false},"disableSpellcheck":{"type":"boolean","readOnly":false},"decimalEnforcement":{"type":"number","readOnly":false,"nullable":true,"enum":[0,1,2,3,4,5,null]},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markingAllowManualMarkingForUnmatchedResponses":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionDrawing":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionDrawing","enum":["QuizQuestionDrawing"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["drawing"]},"eraserEnabled":{"type":"boolean","readOnly":false,"nullable":true},"colourPickerEnabled":{"type":"boolean","readOnly":false,"nullable":true},"strokeWidthPickerEnabled":{"type":"boolean","readOnly":false,"nullable":true},"freehandPenEnabled":{"type":"boolean","readOnly":false,"nullable":true},"drawRectEnabled":{"type":"boolean","readOnly":false,"nullable":true},"drawEllipseEnabled":{"type":"boolean","readOnly":false,"nullable":true},"drawLineEnabled":{"type":"boolean","readOnly":false,"nullable":true},"drawArrowEnabled":{"type":"boolean","readOnly":false,"nullable":true},"drawTextEnabled":{"type":"boolean","readOnly":false,"nullable":true}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionDrawing","enum":["QuizQuestionDrawing"]}}}}},"backgroundImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"QuizQuestionFileUpload":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionFileUpload","enum":["QuizQuestionFileUpload"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["fileUpload"]},"inputLabel":{"type":"string","readOnly":false,"minLength":1,"maxLength":30000}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionFlashcard":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionFlashcard","enum":["QuizQuestionFlashcard"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["flashcard"]}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionFreeText":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionFreeText","enum":["QuizQuestionFreeText"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["freeText"]},"inputLabel":{"type":"string","readOnly":false,"minLength":1,"maxLength":30000},"showWordCount":{"type":"boolean","readOnly":false},"maxWordCount":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"enableWebcamSnapshots":{"type":"boolean","readOnly":false},"enableEquationEditor":{"type":"boolean","readOnly":false},"disableSpellcheck":{"type":"boolean","readOnly":false},"enforcePlainTextInput":{"type":"boolean","readOnly":false},"answerTemplate":{"type":"string","readOnly":false,"nullable":true,"minLength":1}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionImageHotspot":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionImageHotspot","enum":["QuizQuestionImageHotspot"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["imageHotspot"]},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false},"maximumClicks":{"type":"number","readOnly":false,"nullable":true},"markingStrategy":{"type":"string","enum":["exactMatch","partialMatch","matchPerBlank","proportionate"],"readOnly":false},"clickLimitType":{"type":"string","enum":["any","max","exact"],"readOnly":false},"definedAreas":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["slug","shape","coords"],"properties":{"slug":{"type":"string","minLength":1,"maxLength":100,"readOnly":false},"shape":{"type":"string","enum":["rect","ellipse","polygon"],"readOnly":false},"coords":{"oneOf":[{"type":"object","properties":{"centerX":{"type":"number"},"centerY":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"rotation":{"type":"number","nullable":true}},"required":["centerX","centerY","width","height"],"additionalProperties":false},{"type":"object","properties":{"points":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"additionalProperties":false},"minItems":3,"maxItems":50}},"required":["points"],"additionalProperties":false}]},"label":{"type":"string","readOnly":false},"credits":{"type":"number","readOnly":false},"penalties":{"type":"number","readOnly":false},"isCorrect":{"type":"boolean","readOnly":false}},"readOnly":false}}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionImageHotspot","enum":["QuizQuestionImageHotspot"]}}}}},"hotspotImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"QuizQuestionInformational":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionInformational","enum":["QuizQuestionInformational"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["informational"]}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionMultipleCorrect":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionMultipleCorrect","enum":["QuizQuestionMultipleCorrect"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["multipleCorrect"]},"scoring":{"type":"string","enum":["exactMatch","partialMatch","proportionate"]},"options":{"allOf":[{"type":"array","items":{"type":"object","additionalProperties":false,"required":["isCorrect"],"properties":{"isCorrect":{"type":"boolean","readOnly":false},"phrase":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"image":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"credits":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"penalties":{"type":"number","readOnly":false,"nullable":true,"minimum":0}}},"anyOf":[{"type":"array","items":{"type":"object","required":["phrase"]}},{"type":"array","items":{"type":"object","required":["image"]}}]}]},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random","alphaNumeric"]},"multiCorrectLimitType":{"type":"string","enum":["any","max","exact",null],"readOnly":false,"nullable":true},"multiCorrectLimit":{"type":"number","readOnly":false,"nullable":true},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false,"nullable":true}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionOffPlatform":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionOffPlatform","enum":["QuizQuestionOffPlatform"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["offPlatform"]},"hideFromPlayer":{"type":"boolean","readOnly":false,"nullable":false}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionRanked":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionRanked","enum":["QuizQuestionRanked"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["ranked"]},"options":{"type":"array","items":{"type":"object","properties":{"phrase":{"type":"string","readOnly":false,"minLength":1},"rank":{"type":"number","readOnly":false,"minimum":0}}}},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random","alphaNumeric"]}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionShortAnswer":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionShortAnswer","enum":["QuizQuestionShortAnswer"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["shortAnswer"]},"options":{"type":"array","maxItems":100,"items":{"type":"object","properties":{"value":{"type":"string","readOnly":false},"correctness":{"type":"number","readOnly":false}},"readOnly":false}},"disableSpellcheck":{"type":"boolean","readOnly":false},"caseMatch":{"type":"boolean","readOnly":false},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false},"markingAllowManualMarkingForUnmatchedResponses":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionSingleCorrect":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionSingleCorrect","enum":["QuizQuestionSingleCorrect"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["singleCorrect"]},"options":{"allOf":[{"type":"array","items":{"type":"object","additionalProperties":false,"required":["isCorrect"],"properties":{"isCorrect":{"type":"boolean","readOnly":false},"phrase":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"feedback":{"type":"string","readOnly":false,"nullable":true},"image":{"type":"string","readOnly":false,"nullable":true,"minLength":1},"credits":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"penalties":{"type":"number","readOnly":false,"nullable":true,"minimum":0}}},"anyOf":[{"type":"array","items":{"type":"object","required":["phrase"]}},{"type":"array","items":{"type":"object","required":["image"]}}]}]},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random","alphaNumeric"]},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false,"nullable":true}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionSpreadsheet":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionSpreadsheet","enum":["QuizQuestionSpreadsheet"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["spreadsheet"]},"inputLabel":{"type":"string","readOnly":false,"minLength":1,"maxLength":30000},"answerTemplate":{"type":"string","readOnly":false,"nullable":true,"minLength":1}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionTrueOrFalse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionTrueOrFalse","enum":["QuizQuestionTrueOrFalse"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"questionType":{"type":"string","readOnly":true,"enum":["trueOrFalse"]},"correctAnswer":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionVideoRecording":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionVideoRecording","enum":["QuizQuestionVideoRecording"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"stem":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false,"nullable":true,"maxLength":150},"leadIn":{"type":"string","readOnly":false,"nullable":true},"doi":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"feedback":{"type":"string","readOnly":false,"nullable":true},"attr":{"type":"object","readOnly":false},"timerMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":7200000},"layout":{"type":"string","readOnly":false,"nullable":true,"enum":["topDown","swimLane",null]},"markingCredit":{"type":"number","readOnly":false,"nullable":true,"minimum":0},"markingPartialCredit":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"markingPenalty":{"type":"number","readOnly":false,"minimum":0,"nullable":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":false,"nullable":true},"audioStemAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"audioStemAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","nullable":true,"readOnly":false},"disableAudioStemControls":{"type":"boolean","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":false,"minimum":1,"nullable":true},"audioStemAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"audioStemDisableProgression":{"type":"boolean","readOnly":false,"nullable":true},"audioStemHideOptions":{"type":"boolean","readOnly":false,"nullable":true},"hideStemMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1000,"maximum":3600000},"unreviewedFlags":{"type":"number","readOnly":true},"markingAdditionalInfo":{"type":"string","readOnly":false,"nullable":true},"markingResolutionEnabled":{"type":"boolean","readOnly":false},"markingResolutionStrategy":{"type":"string","readOnly":false,"enum":["average","highest","lowest","median"]},"markingAgreementThresholdType":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"markingAgreementThresholdValue":{"type":"number","readOnly":false},"markSchemeEnabled":{"type":"boolean","readOnly":false,"nullable":true},"markSchemeCustomMarkingEnabled":{"type":"boolean","readOnly":false,"nullable":false},"markSchemeCustomMarkingMaxCredits":{"type":"number","readOnly":false,"nullable":true},"markSchemeCustomMarkingstrategy":{"type":"string","enum":["scale","cap"],"readOnly":false,"nullable":true},"markSchemeCriterion":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"object","properties":{"slug":{"type":"string","readOnly":false},"label":{"type":"string","readOnly":false},"maxCredits":{"type":"number","readOnly":false,"minimum":0},"description":{"type":"string","readOnly":false,"nullable":true},"agreementThreshold":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","readOnly":false,"enum":["percentageDiff","points"]},"value":{"type":"number","readOnly":false}}}}}},"questionType":{"type":"string","readOnly":true,"enum":["videoRecording"]},"inputLabel":{"type":"string","readOnly":false,"maxLength":30000},"videoRecordingMaximumTimeMs":{"type":"number","readOnly":false,"minimum":1,"maximum":3600000},"videoRecordingAllowDelete":{"type":"boolean","readOnly":false},"videoRecordingAllowReRecord":{"type":"boolean","readOnly":false},"videoRecordingAllowPause":{"type":"boolean","readOnly":false},"videoRecordingAllowEarlySubmission":{"type":"boolean","readOnly":false},"videoRecordingAutoRecording":{"type":"boolean","readOnly":false},"videoRecordingAutoRecordingDelayMs":{"type":"number","readOnly":false,"minimum":0,"maximum":3600000},"videoRecordingAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","afterAudioCompletion"]},"videoRecordingAutoAdvanceDelayMs":{"type":"number","readOnly":false,"minimum":0,"maximum":3600000}}},"relationships":{"type":"object","properties":{"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizEmqGroup","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionVideoRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}}}}},"QuizSection":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSection","enum":["QuizSection"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","readOnly":false,"minLength":1,"maxLength":100},"isDynamic":{"type":"boolean","readOnly":true},"doi":{"type":"string","readOnly":false,"nullable":false,"minLength":0,"maxLength":200,"pattern":"^[^\\s'\"`]*$"},"instructionsEnabled":{"type":"boolean","readOnly":false},"instructionsTitle":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":100},"instructionsBody":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":25000},"instructionsTimerEnabled":{"type":"boolean","readOnly":false,"nullable":true},"instructionsTimerHidden":{"type":"boolean","readOnly":false,"nullable":true},"instructionsTimerDurationMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1,"maximum":86400000},"instructionsAudioAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"instructionsAudioAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"instructionsDisableAudioControls":{"type":"boolean","readOnly":false,"nullable":true},"outroEnabled":{"type":"boolean","readOnly":false},"outroTitle":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":100},"outroBody":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":25000},"outroTimerEnabled":{"type":"boolean","readOnly":false,"nullable":true},"outroTimerHidden":{"type":"boolean","readOnly":false,"nullable":true},"outroTimerDurationMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1,"maximum":86400000},"outroAudioAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"outroAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"outroAudioAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"outroDisableAudioControls":{"type":"boolean","readOnly":false,"nullable":true},"timerEnabled":{"type":"boolean","readOnly":false},"timerHidden":{"type":"boolean","readOnly":false},"timerDurationMs":{"type":"number","readOnly":false,"nullable":true,"minimum":1},"timerInferFromQuestions":{"type":"boolean","readOnly":false,"nullable":true},"index":{"type":"number","readOnly":false},"filterRules":{"type":"array","minItems":0,"maxItems":125,"description":"Array of filter rules to apply to the dynamic quiz content.","items":{"type":"object","properties":{"weighting":{"type":"number"},"shuffleQuestions":{"type":"boolean"},"matchingRules":{"type":"array","minItems":0,"maxItems":20,"description":"Array of matching rules to apply to the filter rule. Each rule will be treated as an AND operation. Matching rules can not be a mix of tag and EMQ rules.","items":{"oneOf":[{"anyOf":[{"type":"object","required":["tagId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["tagId"],"properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}}}]},{"anyOf":[{"type":"object","required":["emqGroupId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"emqGroupId":{"type":"string","minLength":5,"maxLength":32}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["emqGroupId"],"properties":{"emqGroupId":{"type":"string","minLength":5,"maxLength":32}}}}]},{"anyOf":[{"type":"object","required":["questionId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"questionId":{"type":"string","minLength":5,"maxLength":32}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["questionId"],"properties":{"questionId":{"type":"string","minLength":5,"maxLength":32}}}}]}]}}}}},"navigationDisableNavigation":{"type":"boolean","readOnly":false,"nullable":true},"navigationDisableControlPanel":{"type":"boolean","readOnly":false,"nullable":true},"grades":{"type":"array","nullable":true,"items":{"type":"object","required":["label"],"properties":{"label":{"type":"string","readOnly":false},"minScore":{"description":"A default failing grade should have minScore set to `null`","type":"number","readOnly":false,"nullable":true},"isPass":{"type":"boolean","readOnly":false},"description":{"type":"string","readOnly":false,"nullable":true}}}},"scoreModifiers":{"type":"array","nullable":true,"readOnly":false,"items":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"type":"string","enum":["omitLowestScoringQuestionPerSection"]}}}}}},"relationships":{"type":"object","properties":{"questions":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["QuizQuestion","QuizQuestionAudioRecording","QuizQuestionFileUpload","QuizQuestionSingleCorrect","QuizQuestionMultipleCorrect","QuizQuestionRanked","QuizQuestionFreeText","QuizQuestionInformational","QuizQuestionClozeDragAndDrop","QuizQuestionClozeDropDown","QuizQuestionClozeText","QuizQuestionShortAnswer","QuizQuestionSpreadsheet","QuizQuestionVideoRecording","QuizQuestionImageHotspot","QuizQuestionOffPlatform","QuizQuestionFlashcard","QuizQuestionTrueOrFalse","QuizQuestionDrawing"],"example":"QuizQuestion"}]}}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"outroAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"setupValidation":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSetupValidation","enum":["QuizSetupValidation"]}}}}}}}}},"QuizSetupValidation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizSetupValidation","enum":["QuizSetupValidation"]},"attributes":{"type":"object","properties":{"valid":{"type":"boolean","readOnly":true},"invalidReason":{"type":"string","nullable":true},"filterValidations":{"type":"array","nullable":true,"items":{"type":"object","properties":{"index":{"type":"number"},"invalidReason":{"type":"string"}}}},"sectionValidations":{"type":"array","nullable":true,"items":{"type":"object","properties":{"sectionIndex":{"type":"number"},"invalidReason":{"type":"string"},"filterValidations":{"type":"array","nullable":true,"items":{"type":"object","properties":{"index":{"type":"number"},"invalidReason":{"type":"string"}}}}}}},"gradeValidations":{"type":"array","nullable":true,"items":{"type":"object","properties":{"invalidReason":{"type":"string"},"path":{"type":"string"},"invalidSectionIds":{"type":"array","nullable":true,"items":{"type":"string"}}}}}}},"relationships":{"type":"object","required":["quiz"],"properties":{"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}}}}}},"QuizTagBreakdown":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizTagBreakdown","enum":["QuizTagBreakdown"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"totalQuestions":{"type":"number","readOnly":true,"nullable":false},"tagDataList":{"type":"array","nullable":false,"readOnly":true,"items":{"type":"object","properties":{"tagId":{"type":"string","nullable":false,"readOnly":true},"tagSetId":{"type":"string","nullable":true,"readOnly":true},"label":{"type":"string","nullable":false,"readOnly":true},"facet":{"type":"string","nullable":true,"readOnly":true},"totalQuestions":{"type":"number","nullable":false,"readOnly":true}}}}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}}}}}},"RelationLink":{"type":"object","properties":{"self":{"type":"string","externalDocs":{"url":"https://jsonapi.org/format/#document-links"}},"related":{"type":"string","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-related-resource-links"}}}},"Relationship":{"type":"object","description":"Describes a relationship object that references the related resource.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-relationships"},"properties":{"data":{"anyOf":[{"$ref":"#/components/schemas/ResourceIdentifierObject"},{"$ref":"#/components/schemas/ResourceIdentifierArray"}]},"links":{"$ref":"#/components/schemas/RelationLink"},"meta":{"type":"object","additionalProperties":true,"externalDocs":{"url":"https://jsonapi.org/format/#document-meta"}}}},"ResourceIdentifierArray":{"type":"array","description":"This is a resource linkage for a to-many relationship. It is like a list of Parse Pointers.","nullable":true,"items":{"$ref":"#/components/schemas/ResourceIdentifierObject"}},"ResourceIdentifierObject":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"$ref":"#/components/schemas/ResourceType"}}},"ResourceType":{"type":"string","description":"Identifies the Resource.","example":"_User"},"Response":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Response","enum":["Response"]},"attributes":{"type":"object","properties":{"questionData":{"type":"object","readOnly":true},"options":{"type":"array","items":{"type":"object"}},"chosenOptions":{"type":"array","items":{"type":"object"}},"correctOptions":{"type":"array","items":{"type":"object"}},"marks":{"type":"object"},"hideFromPlayer":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"ScormCourse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ScormCourse","enum":["ScormCourse"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"title":{"type":"string"},"fileName":{"type":"string","readOnly":true},"shortDescription":{"type":"string"},"description":{"type":"string"},"importState":{"type":"string","enum":["pending","completed","failed"],"readOnly":true},"settingsDisplayMode":{"type":"string","enum":["newWindow","embedded"],"readOnly":false},"isArchived":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"scormFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}},"SearchFilterConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SearchFilterConfig","enum":["SearchFilterConfig"]},"attributes":{"type":"object","required":["target","attribute","label","options"],"properties":{"target":{"type":"string","description":"The target resource to filter on.","readOnly":true,"enum":["AssignmentGroup","Collection","Course","Exam","LibraryItem","Tag","User","UserGroup"]},"attribute":{"type":"string","readOnly":true},"label":{"type":"string","readOnly":true},"options":{"type":"array","items":{"type":"object","required":["label","value"],"properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"string","nullable":true},{"type":"number","nullable":true},{"type":"boolean","nullable":true}]},"thumbnail":{"type":"string","description":"Optional thumbnail URL for visual display (e.g. user profile picture)."}}}},"placeholder":{"type":"string","readOnly":true},"explanation":{"type":"string","readOnly":true},"search":{"type":"object","properties":{"className":{"type":"string"},"labelPath":{"type":"string"}}},"single":{"type":"boolean","readOnly":true,"description":"Legacy: true when only one option can be selected. Prefer capabilities.cardinality."},"capabilities":{"type":"object","readOnly":true,"required":["kind","cardinality","valueEncoding"],"properties":{"kind":{"type":"string","enum":["option","text","number","date"],"description":"Input / value kind: option, text, number, or date."},"cardinality":{"type":"string","enum":["one","many"],"description":"How many values the user can pick: one or many."},"valueEncoding":{"type":"string","enum":["scalar","range"],"description":"How the value is encoded for the operator: scalar or range (e.g. for number/date ranges)."}}}}},"relationships":{"type":"object","properties":{}}}},"SearchResult":{"anyOf":[{"$ref":"#/components/schemas/Tag"},{"$ref":"#/components/schemas/User"},{"$ref":"#/components/schemas/Exam-V-2"},{"$ref":"#/components/schemas/UserGroup"},{"$ref":"#/components/schemas/SubPortal"},{"$ref":"#/components/schemas/AssignmentGroup"},{"$ref":"#/components/schemas/UserType"},{"$ref":"#/components/schemas/Assignment"},{"$ref":"#/components/schemas/Course"},{"$ref":"#/components/schemas/TagSet"},{"$ref":"#/components/schemas/Content"},{"$ref":"#/components/schemas/Note"},{"$ref":"#/components/schemas/Quiz"},{"$ref":"#/components/schemas/ScormCourse"},{"$ref":"#/components/schemas/Survey"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/CollectionItemQuiz"}]},"SessionContext":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SessionContext","enum":["SessionContext"]},"attributes":{"type":"object","properties":{"locale":{"type":"string","readOnly":true,"description":"Short-form language code. The current users language preference"},"caslPolicies":{"type":"array","items":{"type":"array","items":{"type":"object","readOnly":true,"properties":{"group":{"type":"string"},"subject":{"type":"string"},"version":{"type":"integer"},"action":{"oneOf":[{"type":"string","enum":["create","read","update","delete","execute","manage"]},{"type":"array","items":{"type":"string","enum":["create","read","update","delete","execute","manage"]}}]},"actions":{"oneOf":[{"type":"string","enum":["create","read","update","delete","execute","manage"]},{"type":"array","items":{"type":"string","enum":["create","read","update","delete","execute","manage"]}}]},"inverted":{"type":"boolean"},"fields":{"type":"array","items":{"type":"string"}},"conditions":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"$ne":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"$in":{"type":"array","items":{}}}}]}}}}},"readOnly":true},"isPortalOwner":{"type":"boolean","readOnly":true,"description":"Whether the current user is the owner of the portal."},"intercomHash":{"type":"string","readOnly":true,"description":"Hash used to identify the user in Intercom."},"gitbookToken":{"type":"string","readOnly":true,"description":"Signed JWT identifying the user to the embedded GitBook docs. Only issued for staff user types."},"apiHostname":{"type":"string","readOnly":true,"description":"[Deprecated: use  regionalApiUrl] Region specific API hostname.","deprecated":true},"region":{"type":"string","readOnly":true,"description":"Data hosting region of the organisation.","example":"eu-west-1"},"regionalApiUrl":{"type":"string","readOnly":true,"description":"Region specific API endpoint.","example":"https://use1.prod.api.synap.ac"},"shouldPromptPasskeyEnrolment":{"type":"boolean","readOnly":true,"nullable":true,"description":"True when the user should be offered passkey enrolment after login. Dismissible via /v3/passkey-enrolment-deferrals."},"scope":{"type":"object","readOnly":true,"nullable":true,"description":"Restricts the session to a single resource. Set for email-less code-login sessions, binding the session to one exam attempt.","required":["type","id","expiresAt"],"properties":{"type":{"type":"string","enum":["attempt-code-login"]},"id":{"type":"string"},"expiresAt":{"type":"string","description":"ISO date the scoped session expires."}}}}},"relationships":{"type":"object","properties":{"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"userType":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserType","enum":["UserType"]}}}}},"studyType":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserType","enum":["UserType"]}}}}},"pinnedNotes":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Note"],"example":"Note"}]}}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}}}}}},"StoreOffer":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"StoreOffer","enum":["StoreOffer"]},"attributes":{"type":"object","properties":{"title":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"externalId":{"type":"string","readOnly":true},"offerItems":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"targetId":{"type":"string"},"productIdentifier":{"type":"string"}}}},"offerSettings":{"type":"object","readOnly":true,"properties":{"selectionType":{"type":"string","enum":["all","selectOne"],"readOnly":true},"maxRedemptionsPerUser":{"type":"number","readOnly":true},"promoCodePrefix":{"type":"string","readOnly":true},"accessInstructions":{"type":"object","properties":{"accessUntilDate":{"type":"string","format":"date-time","readOnly":true}}},"conflictHandling":{"type":"object","properties":{"disableIfClaimed":{"type":"array","items":{"type":"string"},"readOnly":true}}}}}}},"relationships":{"type":"object","properties":{"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"Study":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Study","enum":["Study"]},"attributes":{"type":"object","properties":{"totalStudyItems":{"type":"number","readOnly":true},"totalQuestions":{"type":"number","readOnly":true},"totalAnsweredQuestions":{"type":"number","readOnly":true},"knowledgeCoverage":{"type":"number","readOnly":true},"competencyScore":{"type":"number","readOnly":true},"masteryLevel":{"type":"string","readOnly":true,"enum":["unseen","weak","moderate","strong","mastered",null],"nullable":true},"studyItemOverviews":{"type":"array","nullable":true,"readOnly":true,"items":{"type":"object","properties":{"studyItemId":{"type":"string"},"type":{"type":"string"},"objectData":{"type":"object","properties":{"className":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"slug":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true}}},"isAttempted":{"type":"boolean"},"totalQuestions":{"type":"number"},"totalAnsweredQuestions":{"type":"number"},"knowledgeCoverage":{"type":"number"},"competencyScore":{"type":"number"},"masteryLevel":{"type":"string","enum":["unseen","weak","moderate","strong","mastered"]},"masteryDivisions":{"type":"array","nullable":true,"readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["unseen","weak","moderate","strong","mastered"]},"label":{"type":"string","minLength":0},"totalQuestions":{"type":"number","minimum":0},"percentageOfTotal":{"type":"number","minimum":0,"maximum":100}}}}}}},"masteryDivisions":{"type":"array","nullable":true,"readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["unseen","weak","moderate","strong","mastered"]},"label":{"type":"string","minLength":0},"totalQuestions":{"type":"number","minimum":0},"percentageOfTotal":{"type":"number","minimum":0,"maximum":100}}}},"studyOverviewUpdatedAt":{"type":"string","readOnly":true,"format":"date-time"},"selfPracticeSetupQuizMode":{"type":"string","readOnly":false,"enum":["practice","exam","timedExam","test"]},"selfPracticeSetupMaxQuestions":{"type":"number","readOnly":false,"minimum":0,"maximum":300},"selfPracticeSetupMasteryLevels":{"type":"array","readOnly":false,"items":{"type":"string","enum":["unseen","weak","moderate","strong","mastered"]}},"selfPracticeSetupTagSetId":{"type":"string","readOnly":false,"nullable":true},"selfPracticeSetupRandomise":{"type":"boolean","readOnly":false},"selfPracticeSetupTagFilters":{"type":"object","readOnly":false,"nullable":true},"spacedLearningIntensityLevel":{"type":"number","readOnly":false,"enum":["Low","Moderate","High",1,2,3],"nullable":false},"spacedLearningNextDue":{"type":"string","readOnly":true,"format":"date-time"},"spacedLearningMissedStreak":{"type":"number","readOnly":true},"spacedLearningLatestTestCreatedAt":{"type":"string","readOnly":true,"format":"date-time"},"spacedLearningStateIsActive":{"type":"boolean","readOnly":false},"spacedLearningStateWaiting":{"type":"boolean","readOnly":true,"nullable":true},"spacedLearningStateTestReady":{"type":"boolean","readOnly":true,"nullable":true},"spacedLearningStateHasAttempt":{"type":"boolean","readOnly":true,"nullable":true},"spacedLearningStateStatusMessage":{"type":"string","readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{"latestQuiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"latestAttempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["StudyItem"],"example":"StudyItem"}]}}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"StudyItem":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"StudyItem","enum":["StudyItem"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Quiz","enum":["Quiz"]}}}}},"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Collection","enum":["Collection"]}}}}},"study":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Study","enum":["Study"]}}}}}}}}},"SubPortal":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":false,"minLength":1},"brandPrimary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"brandSecondary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"fontLinkColour":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"buttonColourPrimary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"buttonColourSecondary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"buttonTextColourPrimary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"buttonTextColourSecondary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"chartColourPrimary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"defaultCardImageUrl":{"type":"string","readOnly":false,"nullable":true},"headerLogoUrl":{"type":"string","readOnly":false,"nullable":true},"squareLogoUrl":{"type":"string","readOnly":false,"nullable":true},"faviconUrl":{"type":"string","readOnly":false,"nullable":true},"affiliationTwitterUrl":{"type":"string","readOnly":false,"nullable":true},"affiliationFacebookUrl":{"type":"string","readOnly":false,"nullable":true},"affiliationLinkedInUrl":{"type":"string","readOnly":false,"nullable":true},"affiliationYoutubeUrl":{"type":"string","readOnly":false,"nullable":true},"subdomain":{"type":"string","readOnly":false,"nullable":true},"hostname":{"type":"string","readOnly":true,"nullable":true},"useCustomSubPortalDomain":{"type":"boolean","readOnly":false,"description":"When true, the hostname uses the portal `subPortalDomain` suffix instead of the portal hostname (requires `subPortalDomain` to be set on the portal)."},"registrationBackgroundImageUrl":{"type":"string","readOnly":false,"nullable":true},"registrationHeaderBackgroundColor":{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},"registrationHeaderBorderBottomColor":{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},"registrationPageTitle":{"type":"string","readOnly":false,"nullable":true},"registrationPageDescription":{"type":"string","readOnly":false,"nullable":true},"registrationRegisterMethod":{"type":"string","enum":["open","closed",null],"readOnly":false,"nullable":true,"description":"Registration sign-up method for this sub-portal. When null, the portal-level registration method is used as a fallback."},"emailSettingsFromName":{"type":"string","nullable":true,"readOnly":false},"emailSettingsFromEmail":{"type":"string","format":"email","nullable":true,"readOnly":false},"emailSettingsFooterText":{"type":"string","nullable":true,"readOnly":false},"emailSettingsHeaderLogoUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"emailSettingsWelcomeEmailSubject":{"type":"string","nullable":true,"readOnly":false},"emailSettingsWelcomeEmailBody":{"type":"string","nullable":true,"readOnly":false}}},"relationships":{"type":"object","properties":{}}}},"Subscription":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Subscription","enum":["Subscription"]},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["chargebeeSubscription","stripeSubscription","stripeOrder","free","manual"],"readOnly":true},"isActive":{"type":"boolean","readOnly":true},"inTrial":{"type":"boolean","readOnly":true},"trialEndDate":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"trialDaysLeft":{"type":"integer","nullable":true,"readOnly":true,"description":"Number of days remaining in trial period"},"isTrialUpgradable":{"type":"boolean","readOnly":true,"description":"Indicates if the trial subscription should prompt for upgrade"},"isTrialCheckoutEnabled":{"type":"boolean","readOnly":true,"description":"Indicates if trial checkout is enabled"},"startDate":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"endDate":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"currentBillingPeriodStart":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"currentBillingPeriodEnd":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"nextInvoiceDate":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"isBillingPortalEnabled":{"type":"boolean","readOnly":true,"description":"Indicates if the billing portal is available for this subscription"},"customerFirstName":{"type":"string","nullable":true,"readOnly":true},"customerLastName":{"type":"string","nullable":true,"readOnly":true},"customerCardState":{"type":"string","enum":["expired","expiring","noCard","valid"],"nullable":true,"readOnly":true},"customerPreferredCurrencyCode":{"type":"string","nullable":true,"readOnly":true},"customerCardType":{"type":"string","nullable":true,"readOnly":true},"customerCardLastFour":{"type":"string","nullable":true,"readOnly":true},"customerCardExpiryMonth":{"type":"integer","nullable":true,"readOnly":true},"customerCardExpiryYear":{"type":"integer","nullable":true,"readOnly":true},"planName":{"type":"string","nullable":true,"readOnly":true},"planAmount":{"type":"number","nullable":true,"readOnly":true},"planPriceTag":{"type":"string","nullable":true,"readOnly":true},"planIsFree":{"type":"boolean","nullable":true,"readOnly":true},"planImageUrl":{"type":"string","nullable":true,"readOnly":true}}},"relationships":{"type":"object","properties":{"product":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Product","enum":["Product"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"Survey":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Survey","enum":["Survey"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":false},"description":{"type":"string","readOnly":false},"shortDescription":{"type":"string","readOnly":false},"selfAssessment":{"type":"object","readOnly":true,"additionalProperties":true,"deprecated":true,"description":"Only used by legacy client custom code."},"totalItems":{"type":"number","readOnly":true},"isLibraryItem":{"type":"boolean","readOnly":true},"isArchived":{"type":"boolean","readOnly":false},"extraInformation":{"type":"object","properties":{"subAction":{"type":"string","readOnly":false}},"readOnly":false,"description":"Additional information about the survey, such as metadata."}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"pages":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["SurveyPage"],"example":"SurveyPage"}]}}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["User"],"example":"User"}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}},"SurveyItem":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SurveyItem","enum":["SurveyItem"]},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["boolean","date","likert","multiChoice","multiText","singleChoice","text","upload"],"readOnly":true},"question":{"type":"string","description":"The question or prompt for the survey item.","minLength":1,"nullable":false},"options":{"type":"array","items":{"required":["value"],"properties":{"label":{"anyOf":[{"type":"string","minLength":1,"nullable":true},{"type":"number","nullable":true}],"description":"The label for the survey item option."},"value":{"anyOf":[{"type":"string","minLength":1},{"type":"number"},{"type":"boolean"}],"description":"The value associated with the survey item option."}}},"description":"The options available for the survey item.","minItems":0,"uniqueItems":true,"nullable":true},"isRequired":{"type":"boolean","readOnly":false},"isHidden":{"type":"boolean","readOnly":false,"deprecated":true,"description":"This field is deprecated and should not be used."},"isReadOnly":{"type":"boolean","readOnly":false,"deprecated":true,"description":"This field is deprecated and should not be used. It is only used with SelfAssessment."},"defaultValue":{"anyOf":[{"type":"string","nullable":true},{"type":"number","nullable":true},{"type":"boolean","nullable":true}],"readOnly":false}}},"relationships":{"type":"object","properties":{"page":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SurveyPage","enum":["SurveyPage"]}}}}}}}}},"SurveyPage":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SurveyPage","enum":["SurveyPage"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","description":"The title of the survey page.","nullable":true},"description":{"type":"string","nullable":true,"description":"The description of the survey page. This can be used to provide additional context or instructions for the survey participants."},"primaryColor":{"type":"string","nullable":true,"description":"The primary colour used in the survey page. This can be used to customize the appearance of the survey to match branding or design guidelines."},"resultDescription":{"type":"string","nullable":true,"description":"The description of the survey results, providing insights or summaries for the participants."},"headerImageUrl":{"type":"string","nullable":true,"format":"uri","description":"The URL of the header image for the survey page. This image is displayed at the top of the survey page to enhance visual appeal."}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"survey":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Survey","enum":["Survey"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":true,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["SurveyItem"],"example":"SurveyItem"}]}}}}}}}}}},"SurveyResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SurveyResponse","enum":["SurveyResponse"]},"attributes":{"type":"object","properties":{"responseData":{"type":"object","readOnly":false},"selfAssessmentOutcome":{"type":"object","readOnly":true,"deprecated":true}}},"relationships":{"type":"object","properties":{"survey":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Survey","enum":["Survey"]}}}}},"assignmentItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AssignmentItemSurvey","enum":["AssignmentItemSurvey"]}}}}}}}}},"SynopticAiReview":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SynopticAiReview","enum":["SynopticAiReview"]},"attributes":{"type":"object","properties":{"analysisStatus":{"type":"string","enum":["pending","inProgress","completed","error"],"readOnly":true},"analysisProgress":{"type":"number","readOnly":true},"fps":{"type":"number","readOnly":true},"width":{"type":"number","readOnly":true},"height":{"type":"number","readOnly":true},"frameCount":{"type":"number","readOnly":true},"prompts":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"prompt":{"type":"string"},"slug":{"type":"string"},"colour":{"type":"array","items":{"type":"number"}},"presence":{"type":"object","properties":{"framesPresent":{"type":"number"},"totalDurationS":{"type":"number"},"coverageRatio":{"type":"number"},"intervals":{"type":"array","items":{"type":"object","properties":{"startFrame":{"type":"number"},"endFrame":{"type":"number"},"startS":{"type":"number"},"endS":{"type":"number"},"durationS":{"type":"number"}}}}}}}}}}},"relationships":{"type":"object","properties":{"session":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SynopticSession","enum":["SynopticSession"]}}}}}}}}},"SynopticCapture":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SynopticCapture","enum":["SynopticCapture"]},"attributes":{"type":"object","properties":{"source":{"type":"string","readOnly":true},"timestamp":{"type":"string","readOnly":true},"createdAt":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"session":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SynopticSession","enum":["SynopticSession"]}}}}},"file":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"SynopticDomRecording":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SynopticDomRecording","enum":["SynopticDomRecording"]},"attributes":{"type":"object","properties":{"data":{"type":"string","readOnly":true},"timestamp":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"session":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SynopticSession","enum":["SynopticSession"]}}}}}}}}},"SynopticEventLog":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SynopticEventLog","enum":["SynopticEventLog"]},"attributes":{"type":"object","properties":{"type":{"type":"string","readOnly":true},"action":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"questionData":{"readOnly":true,"type":"object","properties":{"questionId":{"readOnly":true,"type":"string"},"questionDoi":{"readOnly":true,"type":"string"},"sectionId":{"readOnly":true,"type":"string"},"sectionDoi":{"readOnly":true,"type":"string"}}},"timestamp":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"session":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SynopticSession","enum":["SynopticSession"]}}}}},"sender":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"SynopticSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SynopticSession","enum":["SynopticSession"]},"attributes":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"token":{"type":"string","readOnly":true},"status":{"type":"string","enum":["pending","active","closed","completed","disabled"]},"peerConnectionStatus":{"type":"string","enum":["new","connecting","connected","disconnected","failed","closed"]},"processingStatus":{"type":"string","enum":["pending","pendingAi","inProgress","completed","error"]},"processingProgress":{"type":"number","readOnly":true,"minimum":0,"maximum":100},"analysisStatus":{"type":"string","enum":["pending","inProgress","completed","error"]},"aiProgress":{"type":"number","readOnly":true,"minimum":0,"maximum":100},"aiCost":{"type":"number","readOnly":true},"aiEstimatedCompletionDate":{"type":"string","format":"date-time","readOnly":true},"synopticLevel":{"type":"string","enum":["web","browser","desktop"]},"screenMonitoring":{"type":"string","enum":["none","recreation","recreationWithSnapshots","video"]},"webcamMonitoring":{"type":"string","enum":["none","snapshots","audioVideo"]},"keyboardShortcutsEnabled":{"type":"boolean"},"screenshotPrevention":{"type":"boolean"},"aiReview":{"type":"boolean"},"aiFlagCandidateLeftFrame":{"type":"boolean"},"aiFlagMultiplePeopleInFrame":{"type":"boolean"},"aiPrompts":{"type":"array","items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true}}}},"onBreach":{"type":"string","enum":["freeze","silent"],"nullable":true},"liveProctoring":{"type":"boolean"}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}},"candidate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"desktopFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"avFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"maskFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"avPeaksFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}},"legacyDomRecordingFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"SynopticWatchToken":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SynopticWatchToken","enum":["SynopticWatchToken"]},"attributes":{"type":"object","properties":{"jwt":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"session":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SynopticSession","enum":["SynopticSession"]}}}}},"iceCandidate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"IceCandidate","enum":["IceCandidate"]}}}}},"candidate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"Tag":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Tag","enum":["Tag"]},"attributes":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":500,"readOnly":false},"facet":{"type":"string","enum":["exam","module","subject","topic","subtopic","difficulty","skill","context",null],"nullable":true,"readOnly":false},"feedback":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":100000},"isVisibleToStudents":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TagSet","enum":["TagSet"]}}}}}}}}},"TagSet":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TagSet","enum":["TagSet"]},"attributes":{"type":"object","properties":{"label":{"type":"string","readOnly":false,"nullable":false,"minLength":1,"maxLength":300}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Tag"],"example":"Tag"}]}}}}}}}}}},"Template":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Template","enum":["Template"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"htmlTemplate":{"type":"string","readOnly":true},"isDefault":{"type":"boolean","readOnly":true},"orientation":{"type":"string","readOnly":true,"enum":["portrait","landscape"]},"preview":{"type":"object","readOnly":true,"properties":{"svg":{"type":"string"},"image":{"type":"string"}}}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"Test":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Test","enum":["Test"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"title":{"type":"string"},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"totalQuestions":{"type":"number"},"settings":{"type":"object","nullable":true},"sectionSettings":{"type":"array","items":{"type":"object"},"nullable":true},"resitAllowedAttempts":{"type":"number","nullable":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"questions":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Question"],"example":"Question"}]}}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Image","enum":["Image"]}}}}}}}}},"TipSuggestion":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TipSuggestion","enum":["TipSuggestion"]},"attributes":{"type":"object","properties":{"tip":{"type":"string","readOnly":true},"createdAt":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"Token":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Token","enum":["Token"]},"attributes":{"type":"object","properties":{"type":{"type":"string","readOnly":true,"enum":["closeAccount","checkoutSession","oidcState","verifyEmail","lti1p1Launch","lti1p3DeepLink"]}}},"relationships":{"type":"object","properties":{}}}},"TransactionalEmail":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TransactionalEmail","enum":["TransactionalEmail"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"toEmail":{"type":"string","readOnly":true},"success":{"type":"boolean","readOnly":true},"recipientData":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"}}},"readOnly":true},"globalData":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"content":{"type":"string"}}},"readOnly":true},"templateName":{"type":"string","readOnly":true},"error":{"type":"string","readOnly":true},"subject":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true},"fromName":{"type":"string","readOnly":true},"fromEmail":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}},"toUser":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"sendingUser":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"UnauthorizedApiError":{"type":"object","description":"Unauthorized request.","example":{"id":"ERR_000","title":"SessionTokenException","status":"401","code":"209","detail":"Unauthorized request."},"properties":{"id":{"type":"string","description":"Unique ID of this error occurrence."},"status":{"type":"string","description":"HTTP status code."},"code":{"type":"string","description":"Synap internal error code."},"title":{"type":"string"},"detail":{"type":"string"},"source":{"type":"object","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"}}}}},"UrlLink":{"type":"object","description":"This field should be a valid Link.","example":"https://some-url.com/path?query=true","nullable":true},"UrlString":{"type":"string","description":"This field should be a valid URL.","example":"https://some-url.com/path?query=true"},"User":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"emailAddress":{"type":"string","readOnly":false},"externalId":{"type":"string","readOnly":false},"profilePicture":{"type":"object","readOnly":false,"nullable":true,"properties":{"__type":{"type":"string","enum":["File"]},"name":{"type":"string"},"url":{"type":"string","readOnly":false}}},"preferences":{"type":"object","readOnly":false},"featureRollouts":{"type":"object","readOnly":false,"additionalProperties":{"type":"string","enum":["on","off"]}},"accessibility":{"type":"object","readOnly":false,"properties":{"extraTimeMultiplier":{"type":"number","readOnly":false,"nullable":true}}},"attr":{"type":"object","readOnly":false},"timeZone":{"type":"string","readOnly":false},"notificationConfig":{"type":"object","readOnly":false},"marketingEmailsConsent":{"type":"string","readOnly":false,"nullable":true},"lastSeen":{"type":"string","readOnly":true},"emailVerified":{"type":"boolean","readOnly":true},"isDisabled":{"type":"boolean","readOnly":false},"authData":{"type":"object","readOnly":true},"firstName":{"type":"string","readOnly":true},"lastName":{"type":"string","readOnly":true},"userGroupsMetadata":{"type":"object","readOnly":true,"additionalProperties":{"type":"object","properties":{"dateJoined":{"type":"string","format":"date-time"}}}}}},"relationships":{"type":"object","properties":{"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"userAttributes":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserAttribute"],"example":"UserAttribute"}]}}}}}},"userGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}}}}}},"UserAccount":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserAccount","enum":["UserAccount"]},"attributes":{"type":"object","properties":{"hasExternalAuth":{"type":"boolean","readOnly":true},"canChangePassword":{"type":"boolean","readOnly":true},"canSetNewPassword":{"type":"boolean","readOnly":true},"canUsePasskeys":{"type":"boolean","readOnly":true},"shouldVerifyEmail":{"type":"boolean","readOnly":true},"name":{"type":"string","readOnly":false,"deprecated":true},"emailAddress":{"type":"string","readOnly":false,"deprecated":true},"profilePicture":{"type":"object","readOnly":false,"nullable":true,"deprecated":true,"properties":{"__type":{"type":"string","enum":["File"]},"name":{"type":"string"},"url":{"type":"string"}}},"preferences":{"type":"object","readOnly":false,"deprecated":true},"attr":{"type":"object","readOnly":false,"deprecated":true},"timeZone":{"type":"string","readOnly":false,"deprecated":true},"notificationConfig":{"type":"object","readOnly":false,"deprecated":true}}},"relationships":{"type":"object","properties":{}}}},"UserAttribute":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserAttribute","enum":["UserAttribute"]},"attributes":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}}},"relationships":{"type":"object","properties":{"attributeConfig":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttributeConfig","enum":["AttributeConfig"]}}}}}}}}},"UserEngagement":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserEngagement","enum":["UserEngagement"]},"attributes":{"type":"object","properties":{"startDate":{"type":"string","format":"date","readOnly":true},"endDate":{"type":"string","format":"date","readOnly":true},"totalResponses":{"type":"number","readOnly":true},"correctResponses":{"type":"number","readOnly":true},"averageScore":{"type":"number","readOnly":true},"attemptCount":{"type":"number","readOnly":true},"uniqueQuestionCount":{"type":"number","readOnly":true}}},"relationships":{"type":"object","properties":{"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Portal","enum":["Portal"]}}}}}}}}},"UserGroup":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"description":{"type":"string","readOnly":false},"attr":{"type":"object","readOnly":false,"additionalProperties":true},"isDefaultGroup":{"type":"boolean","readOnly":true},"defaultGroupType":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true},"isArchived":{"type":"boolean","readOnly":false},"totalUsers":{"type":"number","readOnly":true},"parentId":{"type":"string","readOnly":true,"nullable":true},"internal":{"type":"boolean","readOnly":true},"membershipExpiryEnabled":{"type":"boolean","readOnly":false},"membershipExpiryTimeToExpireInMs":{"type":"number","readOnly":false,"nullable":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}},"userType":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserType","enum":["UserType"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}}}}}},"UserGroupExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroupExport","enum":["UserGroupExport"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}}}}}},"UserGroupLink":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroupLink","enum":["UserGroupLink"]},"attributes":{"type":"object","properties":{"message":{"type":"string","readOnly":true},"public":{"type":"boolean","readOnly":true},"requiresCode":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}}}}}},"UserGroupLinkAccess":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroupLinkAccess","enum":["UserGroupLinkAccess"]},"attributes":{"type":"object","properties":{"userId":{"type":"string","readOnly":false},"code":{"type":"string","readOnly":false}}},"relationships":{"type":"object","properties":{"userGroupLink":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroupLink","enum":["UserGroupLink"]}}}}}}}}},"UserGroupLinkSettings":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroupLinkSettings","enum":["UserGroupLinkSettings"]},"attributes":{"type":"object","properties":{"message":{"type":"string","readOnly":false},"code":{"type":"string","readOnly":false},"enabled":{"type":"boolean","readOnly":false},"public":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}}}}}},"UserGroupLinkValidation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroupLinkValidation","enum":["UserGroupLinkValidation"]},"attributes":{"type":"object","properties":{"isCodeValid":{"type":"boolean","readOnly":true},"reason":{"type":"string","readOnly":true},"code":{"type":"string","readOnly":false}}},"relationships":{"type":"object","properties":{"userGroupLink":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroupLink","enum":["UserGroupLink"]}}}}}}}}},"UserImport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserImport","enum":["UserImport"]},"attributes":{"type":"object","properties":{"dryRun":{"type":"boolean","readOnly":true,"description":"If true, the import will be validated but not executed."},"emails":{"type":"array","readOnly":true,"minItems":1,"description":"List of emails to import. Should not be used with csv import.","items":{"type":"string"}},"personalMessage":{"type":"string","readOnly":true},"generateAccounts":{"type":"boolean","readOnly":true},"allowInauthenticEmails":{"type":"boolean","readOnly":true,"description":"If true, the import will allow missing emails. This is only valid when externalIds are provided and generateAccounts is true."},"disableWelcomeEmail":{"type":"boolean","readOnly":true},"usersInvited":{"type":"array","items":{"type":"string"},"readOnly":true},"invitesUpdated":{"type":"array","items":{"type":"string"},"readOnly":true},"existingUsersAdded":{"type":"array","items":{"type":"string"},"readOnly":true},"existingUsersAttributesUpdated":{"type":"array","items":{"type":"string"},"readOnly":true},"unchangedUsers":{"type":"array","items":{"type":"string"},"readOnly":true},"generatedUsers":{"type":"array","items":{"type":"string"},"readOnly":true}}},"relationships":{"type":"object","required":["userGroup"],"properties":{"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserGroup","enum":["UserGroup"]}}}}},"csv":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"File","enum":["File"]}}}}}}}}},"UserPassword":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserPassword","enum":["UserPassword"]},"attributes":{"type":"object","properties":{"oldPassword":{"type":"string"},"newPassword":{"type":"string"}}},"relationships":{"type":"object","properties":{}}}},"UserRegistration":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserRegistration","enum":["UserRegistration"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"emailAddress":{"type":"string","readOnly":true},"password":{"type":"string","readOnly":true,"description":"Minimum 8 characters; 1 upper, 1 lower and 1 digit"},"registrationSource":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["self","externalAuth"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["generated"]},"token":{"type":"string"}}},{"type":"object","required":["type","inviteId"],"properties":{"type":{"type":"string","enum":["invite"]},"inviteId":{"type":"string"}}},{"type":"object","required":["type","productId"],"properties":{"type":{"type":"string","enum":["product"]},"productId":{"type":"string"}}},{"type":"object","required":["type","code"],"properties":{"type":{"type":"string","enum":["examVoucher"]},"code":{"type":"string"}}}]},"welcomeEmailDisabled":{"type":"boolean","readOnly":true,"description":"If true the welcome email will not be sent."},"welcomeEmailCustomMessage":{"type":"string","readOnly":true,"nullable":true,"description":"Custom message to include in generated account notifications"},"marketingEmailsConsent":{"type":"string","readOnly":true,"nullable":true},"locale":{"type":"string","enum":["en","en-GB","de-DE","el-GR","es-ES","fr-FR","it-IT","ja-JP","nl-NL","pt-BR","pt-PT","zh-CN","nb-NO","sl-SI","ar-SA","th-TH","hr-HR","ru-RU","id-ID","lv-LV","et-EE","pl-PL","sq-AL","cy-GB","vi-VN"],"readOnly":true,"nullable":true},"fontSize":{"type":"string","readOnly":true,"nullable":true,"enum":["xSmall","small","medium","large","xLarge"]},"extraTimeMultiplier":{"type":"number","readOnly":true,"nullable":true,"description":"Extra time multiplier for the user (e.g. 1.5 for 50% extra time)"},"timeZone":{"type":"string","readOnly":true,"nullable":true,"description":"IANA Time Zone Format (e.g. Europe/Rome)"},"attr":{"type":"object","readOnly":true,"nullable":true},"utm":{"type":"object","readOnly":true,"nullable":true},"externalId":{"type":"string","readOnly":true,"nullable":true,"description":"External identifier for the user"},"allowInauthenticEmails":{"type":"boolean","readOnly":true,"description":"When true and emailAddress is omitted, a placeholder email is generated from externalId. Only valid for generated accounts. Requires externalId."},"signUpSource":{"type":"string","enum":["Web","Mobile","API"],"readOnly":true,"deprecated":true,"description":"Deprecated. This value will be ignored. This field will be removed in the future."},"registration":{"type":"object","readOnly":true,"nullable":true,"deprecated":true,"description":"Deprecated. Use registrationSource | welcomeEmailDisabled instead. This field will be removed in the future."},"preferences":{"type":"object","readOnly":true,"nullable":true,"deprecated":true,"description":"Deprecated. Use locale | fontSize instead. This field will be removed in the future."}}},"relationships":{"type":"object","properties":{"userGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"array","nullable":true,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["UserGroup"],"example":"UserGroup"}]}}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"SubPortal","enum":["SubPortal"]}}}}},"generatedAttempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Attempt","enum":["Attempt"]}}}}}}}}},"UserSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserSession","enum":["UserSession"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{}}}},"UserStats":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserStats","enum":["UserStats"]},"attributes":{"type":"object","properties":{"attemptSubmittedCount":{"type":"number","readOnly":true},"attemptCount":{"type":"number","readOnly":true},"responseCount":{"type":"number","readOnly":true},"correctResponseCount":{"type":"number","readOnly":true},"assignmentsComplete":{"type":"number","readOnly":true},"latestStreak":{"type":"object","readOnly":true,"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"length":{"type":"number"}}},"longestStreak":{"type":"object","readOnly":true,"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"length":{"type":"number"}}}}},"relationships":{"type":"object","properties":{"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"User","enum":["User"]}}}}}}}}},"UserType":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"UserType","enum":["UserType"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true},"pageControls":{"type":"object","readOnly":false}}},"relationships":{"type":"object","properties":{}}}},"WebhookDelivery":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"WebhookDelivery","enum":["WebhookDelivery"]},"attributes":{"type":"object","properties":{"eventName":{"type":"string","enum":["assignment.complete","attempt.submitted","attempt.complete","attempt.started","attemptOverride.created","attemptCertificate.generated","exam.userRegistered","exam.submitted","exam.started","exam.complete","exam.released","exam.examCreated","exam.examUpdated","flag.planted","learningRecord.created","learningRecord.updated","learningRecord.deleted","store.purchase","usergroup.userAdded","usergroup.userRemoved","invite.sent","user.registered","user.updated","subPortal.created","subPortal.updated","subPortal.deleted","markingSession.started","markingSession.completed","markingState.updated"],"readOnly":true,"nullable":false},"status":{"type":"string","enum":["pending","sending","sent","failed","exhausted","paused","cancelled"],"readOnly":true,"nullable":false},"targetUrl":{"type":"string","readOnly":true,"nullable":false},"source":{"type":"string","enum":["zapier","user"],"readOnly":true,"nullable":false},"isTest":{"type":"boolean","readOnly":true,"nullable":false},"attemptCount":{"type":"number","readOnly":true,"nullable":false},"totalAttemptCount":{"type":"number","readOnly":true,"nullable":false},"maxAttempts":{"type":"number","readOnly":true,"nullable":false},"nextAttemptAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"lastAttemptedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"deliveredAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"responseStatusCode":{"type":"number","readOnly":true,"nullable":true},"lastErrorType":{"type":"string","enum":["timeout","network","http_4xx","http_5xx","gone",null],"readOnly":true,"nullable":true},"errorMessage":{"type":"string","readOnly":true,"nullable":true},"payload":{"type":"object","additionalProperties":true,"readOnly":true,"nullable":true},"responseBody":{"type":"string","readOnly":true,"nullable":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false}}},"relationships":{"type":"object","properties":{"subscription":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"WebhookSubscription","enum":["WebhookSubscription"]}}}}}}}}},"WebhookSamplePayload":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"WebhookSamplePayload","enum":["WebhookSamplePayload"]},"attributes":{"type":"object","properties":{"eventName":{"type":"string","enum":["assignment.complete","attempt.submitted","attempt.complete","attempt.started","attemptOverride.created","attemptCertificate.generated","exam.userRegistered","exam.submitted","exam.started","exam.complete","exam.released","exam.examCreated","exam.examUpdated","flag.planted","learningRecord.created","learningRecord.updated","learningRecord.deleted","store.purchase","usergroup.userAdded","usergroup.userRemoved","invite.sent","user.registered","user.updated","subPortal.created","subPortal.updated","subPortal.deleted","markingSession.started","markingSession.completed","markingState.updated"],"readOnly":true,"nullable":false},"payload":{"type":"object","additionalProperties":true,"readOnly":true,"nullable":false}}},"relationships":{"type":"object","properties":{}}}},"WebhookSubscription":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"WebhookSubscription","enum":["WebhookSubscription"]},"attributes":{"type":"object","properties":{"eventName":{"type":"string","enum":["assignment.complete","attempt.submitted","attempt.complete","attempt.started","attemptOverride.created","attemptCertificate.generated","exam.userRegistered","exam.submitted","exam.started","exam.complete","exam.released","exam.examCreated","exam.examUpdated","flag.planted","learningRecord.created","learningRecord.updated","learningRecord.deleted","store.purchase","usergroup.userAdded","usergroup.userRemoved","invite.sent","user.registered","user.updated","subPortal.created","subPortal.updated","subPortal.deleted","markingSession.started","markingSession.completed","markingState.updated"],"readOnly":true,"nullable":false},"targetUrl":{"type":"string","readOnly":true,"nullable":false},"name":{"type":"string","readOnly":false,"nullable":true},"basicAuth":{"type":"object","required":["username","password"],"properties":{"username":{"type":"string","minLength":1},"password":{"type":"string","minLength":1}},"readOnly":false,"nullable":true},"active":{"type":"boolean","readOnly":false,"nullable":false},"deliveryStats":{"type":"object","readOnly":true,"nullable":false,"properties":{"lastDeliveryAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"lastStatus":{"type":"string","enum":["pending","sending","sent","failed","exhausted","paused","cancelled",null],"readOnly":true,"nullable":true},"lastResponseStatusCode":{"type":"number","readOnly":true,"nullable":true},"lastErrorType":{"type":"string","enum":["timeout","network","http_4xx","http_5xx","gone",null],"readOnly":true,"nullable":true},"recentFailureCount":{"type":"number","readOnly":true,"nullable":false},"recentSuccessCount":{"type":"number","readOnly":true,"nullable":false},"recentTotalCount":{"type":"number","readOnly":true,"nullable":false}}}}},"relationships":{"type":"object","properties":{}}}},"ZapierApiKey":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ZapierApiKey","enum":["ZapierApiKey"]},"attributes":{"type":"object","properties":{"label":{"type":"string","readOnly":true},"createdAt":{"type":"string","readOnly":true},"lastUsed":{"type":"string","readOnly":true},"isRevoked":{"type":"boolean","readOnly":false}}},"relationships":{"type":"object","properties":{}}}}}},"tags":[{"name":"Access Policies","description":"Access policies define what actions a specific user or group is permitted to perform."},{"name":"Assignments"},{"name":"Attempts","description":"Endpoints related to managing attempts for a quiz, whether it's a self-practice attempt or a high-stakes exam."},{"name":"Auditing","description":"Endpoints related to auditing user actions."},{"name":"Authentication","description":"Endpoints related to user authentication."},{"name":"Billing","description":"Endpoints related to Billing."},{"name":"Certificates","description":"Endpoints related to Certificates."},{"name":"Collections","description":"Endpoints related to the creation and management of Collections."},{"name":"Content Metadata","description":"Endpoints related to the Content metadata, such as Tags and Attributes.."},{"name":"Courses","description":"Endpoints related to Course creation and management."},{"name":"Exams","description":"Endpoints related to Exam creation and management."},{"name":"Insights"},{"name":"Integrations","description":"Endpoints related to Integrations."},{"name":"Library","description":"Endpoints related to the creation and management of Library content, such as Documents, Notes, Surveys, SCORM, etc."},{"name":"Marking","description":"Endpoints related to Marking exams."},{"name":"Mobile","description":"Endpoints used by the Synap Mobile App."},{"name":"Notifications","description":"Endpoints related to Notifications."},{"name":"Portals","description":"Endpoints related to the creation and management of Portals and Sub-Portals."},{"name":"Proctoring","description":"Endpoints related to configuring and reviewing proctored exam sessions."},{"name":"Quizzes","description":"Endpoints related to Quiz creation and management."},{"name":"Revision","description":"Endpoints related to user study."},{"name":"Search","description":"Endpoints related to Search."},{"name":"Shop","description":"Endpoints related to the Shop."},{"name":"User Feedback","description":"Endpoints related to User Feedback."},{"name":"User Groups","description":"Endpoints related to the creation and management of User Groups."},{"name":"Users","description":"Endpoints related to User creation, invitation and management."}]}