{"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"}}}}}}}},"operationId":"accessMigrations.createAccessMigration"}},"/access-policies":{"post":{"summary":"Create AccessPolicy","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"accessPolicies.createAccessPolicy"},"get":{"summary":"List AccessPolicies","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"accessPolicies.findAccessPolicies"}},"/access-policies/{object_id}":{"get":{"summary":"Get AccessPolicy","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AccessPolicy"]},{"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"}}}}}}}},"operationId":"accessPolicies.getAccessPolicy"},"patch":{"summary":"Update AccessPolicy","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AccessPolicy"]}],"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"}}}}}}}},"operationId":"accessPolicies.updateAccessPolicy"},"delete":{"summary":"Delete AccessPolicy","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AccessPolicy"]}],"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"}}}}}}}},"operationId":"accessPolicies.deleteAccessPolicy"}},"/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":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"accessPolicies.applyAccessPolicyOperations"}},"/access-policy-resets":{"post":{"summary":"Create AccessPolicyReset","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"accessPolicyResets.createAccessPolicyReset"}},"/account-closure-requests":{"post":{"summary":"Create AccountClosureRequest","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"accountClosureRequests.createAccountClosureRequest"}},"/account-closures":{"post":{"summary":"Create AccountClosure","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"accountClosures.createAccountClosure"}},"/account-closures/{object_id}":{"patch":{"summary":"Update AccountClosure","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AccountClosure"]}],"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"}}}}}}}},"operationId":"accountClosures.updateAccountClosure"}},"/action-logs":{"get":{"summary":"List ActionLogs","tags":["Auditing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"actionLogs.findActionLogs"}},"/action-logs/{object_id}":{"get":{"summary":"Get ActionLog","tags":["Auditing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ActionLog"]}],"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"}}}}}}}},"operationId":"actionLogs.getActionLog"}},"/annotations":{"post":{"summary":"Create Annotation","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"annotations.createAnnotation"},"get":{"summary":"List Annotations","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"annotations.findAnnotations"}},"/annotations/{object_id}":{"get":{"summary":"Get Annotation","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Annotation"]}],"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"}}}}}}}},"operationId":"annotations.getAnnotation"},"patch":{"summary":"Update Annotation","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Annotation"]}],"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"}}}}}}}},"operationId":"annotations.updateAnnotation"},"delete":{"summary":"Delete Annotation","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Annotation"]}],"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"}}}}}}}},"operationId":"annotations.deleteAnnotation"}},"/assignment-group-course-versions":{"post":{"summary":"Create AssignmentGroupCourseVersion","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"assignmentGroupCourseVersions.createCourseVersion"},"get":{"summary":"List AssignmentGroupCourseVersions","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"assignmentGroupCourseVersions.findCourseVersions"}},"/assignment-group-data-exports":{"post":{"summary":"Create AssignmentGroupDataExport","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"assignmentGroupExportData.createDataExport"}},"/assignment-group-headline-insights/{object_id}":{"get":{"summary":"Get AssignmentGroupHeadlineInsight","tags":["Assignments"],"security":[{},{"SessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentGroupHeadlineInsight"]}],"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"}}}}}}}},"operationId":"assignmentGroupHeadlineInsight.getAssignmentGroupHeadlineInsight"}},"/assignment-groups":{"post":{"summary":"Create AssignmentGroup","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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},"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"}}}}}}}},"operationId":"assignmentGroups.createAssignmentGroup"}},"/assignment-groups/{object_id}":{"get":{"summary":"Get AssignmentGroup","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentGroup"]},{"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"}}}}}}}},"operationId":"assignmentGroups.getAssignmentGroup"},"patch":{"summary":"Update AssignmentGroup","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentGroup"]}],"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"}}}}}}}},"operationId":"assignmentGroups.updateAssignmentGroup"},"delete":{"summary":"Delete AssignmentGroup","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentGroup"]}],"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"}}}}}}}},"operationId":"assignmentGroups.deleteAssignmentGroup"}},"/assignment-headline-insights/{object_id}":{"get":{"summary":"Get AssignmentHeadlineInsight","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentHeadlineInsight"]}],"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"}}}}}}}},"operationId":"assignmentHeadlineInsights.getAssignmentHeadlineInsight"}},"/assignment-item-audios/{object_id}":{"get":{"summary":"Get AssignmentItemAudio","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemAudio"]},{"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"}}}}}}}},"operationId":"assignmentItemAudios.getAssignmentItemAudio"},"patch":{"summary":"Update AssignmentItemAudio","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemAudio"]}],"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"}}}}}}}},"operationId":"assignmentItemAudios.updateAssignmentItemAudio"}},"/assignment-item-documents/{object_id}":{"get":{"summary":"Get AssignmentItemDocument","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemDocument"]},{"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"}}}}}}}},"operationId":"assignmentItemDocuments.getAssignmentItemDocument"},"patch":{"summary":"Update AssignmentItemDocument","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemDocument"]}],"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"}}}}}}}},"operationId":"assignmentItemDocuments.updateAssignmentItemDocument"}},"/assignment-item-embeds/{object_id}":{"get":{"summary":"Get AssignmentItemEmbed","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemEmbed"]},{"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"}}}}}}}},"operationId":"assignmentItemEmbeds.getAssignmentItemEmbed"},"patch":{"summary":"Update AssignmentItemEmbed","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemEmbed"]}],"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"}}}}}}}},"operationId":"assignmentItemEmbeds.updateAssignmentItemEmbed"}},"/assignment-item-notes/{object_id}":{"get":{"summary":"Get AssignmentItemNote","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemNote"]},{"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"}}}}}}}},"operationId":"assignmentItemNotes.getAssignmentItemNote"},"patch":{"summary":"Update AssignmentItemNote","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemNote"]}],"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"}}}}}}}},"operationId":"assignmentItemNotes.updateAssignmentItemNote"}},"/assignment-item-pulses":{"post":{"summary":"Create AssignmentItemPulse","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"assignmentItemPulses.createAssignmentItemPulse"}},"/assignment-item-quizzes/{object_id}":{"get":{"summary":"Get AssignmentItemQuiz","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemQuiz"]},{"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"}}}}}}}},"operationId":"assignmentItemQuizzes.getAssignmentItemQuiz"},"patch":{"summary":"Update AssignmentItemQuiz","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemQuiz"]}],"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"}}}}}}}},"operationId":"assignmentItemQuizzes.updateAssignmentItemQuiz"}},"/assignment-item-reviews/{object_id}":{"get":{"summary":"Get AssignmentItemReview","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemReview"]},{"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"}}}}}}}},"operationId":"assignmentItemReviews.getAssignmentItemReview"},"patch":{"summary":"Update AssignmentItemReview","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemReview"]}],"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"}}}}}}}},"operationId":"assignmentItemReviews.updateAssignmentItemReview"},"delete":{"summary":"Delete AssignmentItemReview","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemReview"]}],"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"}}}}}}}},"operationId":"assignmentItemReviews.deleteAssignmentItemReview"}},"/assignment-item-reviews":{"post":{"summary":"Create AssignmentItemReview","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"assignmentItemReviews.createAssignmentItemReview"}},"/assignment-item-scorms/{object_id}":{"get":{"summary":"Get AssignmentItemScorm","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemScorm"]},{"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"}}}}}}}},"operationId":"assignmentItemScorms.getAssignmentItemScorm"},"patch":{"summary":"Update AssignmentItemScorm","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemScorm"]}],"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"}}}}}}}},"operationId":"assignmentItemScorms.updateAssignmentItemScorm"}},"/assignment-item-self-assessment-outcomes":{"post":{"summary":"Create AssignmentItemSelfAssessmentOutcome","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"assignmentItemSelfAssessmentOutcomes.createAssignmentItemSelfAssessmentOutcome"}},"/assignment-item-surveys/{object_id}":{"get":{"summary":"Get AssignmentItemSurvey","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemSurvey"]},{"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"}}}}}}}},"operationId":"assignmentItemSurveys.getAssignmentItemSurvey"},"patch":{"summary":"Update AssignmentItemSurvey","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemSurvey"]}],"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"}}}}}}}},"operationId":"assignmentItemSurveys.updateAssignmentItemSurvey"}},"/assignment-item-text-entries/{object_id}":{"get":{"summary":"Get AssignmentItemTextEntry","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemTextEntry"]},{"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"}}}}}}}},"operationId":"assignmentItemTextEntries.getAssignmentItemTextEntry"},"patch":{"summary":"Update AssignmentItemTextEntry","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemTextEntry"]}],"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"}}}}}}}},"operationId":"assignmentItemTextEntries.updateAssignmentItemTextEntry"}},"/assignment-item-uploads/{object_id}":{"get":{"summary":"Get AssignmentItemUpload","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemUpload"]},{"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"}}}}}}}},"operationId":"assignmentItemUploads.getAssignmentItemUpload"},"patch":{"summary":"Update AssignmentItemUpload","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemUpload"]}],"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"}}}}}}}},"operationId":"assignmentItemUploads.updateAssignmentItemUpload"}},"/assignment-item-videos/{object_id}":{"get":{"summary":"Get AssignmentItemVideo","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemVideo"]},{"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"}}}}}}}},"operationId":"assignmentItemVideos.getAssignmentItemVideo"},"patch":{"summary":"Update AssignmentItemVideo","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemVideo"]}],"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"}}}}}}}},"operationId":"assignmentItemVideos.updateAssignmentItemVideo"}},"/assignment-item-zips/{object_id}":{"get":{"summary":"Get AssignmentItemZip","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemZip"]},{"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"}}}}}}}},"operationId":"assignmentItemZips.getAssignmentItemZip"},"patch":{"summary":"Update AssignmentItemZip","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentItemZip"]}],"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"}}}}}}}},"operationId":"assignmentItemZips.updateAssignmentItemZip"}},"/assignment-manual-reviews":{"post":{"summary":"Create AssignmentManualReview","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"assignmentManualReviews.createAssignmentManualReview"}},"/assignment-reattempts":{"post":{"summary":"Create AssignmentReattempt","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"assignmentReattempts.createAssignmentReattempt"}},"/assignment-resets":{"post":{"summary":"Create AssignmentReset","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"assignmentResets.createAssignmentReset"}},"/assignment-revocations":{"post":{"summary":"Create AssignmentRevocation","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"assignmentRevocations.createAssignmentRevocation"}},"/assignment-revocations/{object_id}":{"delete":{"summary":"Delete AssignmentRevocation","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentRevocation"]}],"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"}}}}}}}},"operationId":"assignmentRevocations.deleteAssignmentRevocation"}},"/assignment-scorm-results/{object_id}":{"get":{"summary":"Get AssignmentScormResult","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AssignmentScormResult"]}],"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"}}}}}}}},"operationId":"assignmentScormResults.getAssignmentScormResult"}},"/assignment-scorm-results":{"post":{"summary":"Create AssignmentScormResult","description":"Triggers a fetch of the SCORM result from SCORM Cloud.","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"assignmentScormResults.createAssignmentScormResult"}},"/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":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"assignmentSelfAssessmentReports.createAssignmentSelfAssessmentReport"}},"/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":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"assignment.createAssignment"},"get":{"summary":"List Assignments","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"assignment.findAssignments"}},"/assignments/{object_id}":{"get":{"summary":"Get Assignment","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Assignment"]},{"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"}}}}}}}},"operationId":"assignment.getAssignment"},"patch":{"summary":"Update Assignment","tags":["Assignments"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Assignment"]}],"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"}}}}}}}},"operationId":"assignment.updateAssignment"}},"/attempt-active-durations":{"post":{"summary":"Report cumulative active time for an attempt sitting","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptActiveDurations.createAttemptActiveDuration"}},"/attempt-charts":{"get":{"summary":"List AttemptCharts","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptCharts.findAttemptCharts"}},"/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 shared exam code requires surname and externalId; a per-attempt code takes the details 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"}}}}}}}},"operationId":"attemptCodeLogin.createAttemptCodeLogin"}},"/attempt-insights":{"get":{"summary":"List AttemptInsights","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptInsight.findAttemptInsights"}},"/attempt-locks":{"post":{"summary":"Create AttemptLock","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptLocks.createAttemptLock"}},"/attempt-locks/{object_id}":{"patch":{"summary":"Update AttemptLock","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Attempt"]}],"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"}}}}}}}},"operationId":"attemptLocks.updateAttemptLock"},"delete":{"summary":"Delete AttemptLock","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Attempt"]}],"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"}}}}}}}},"operationId":"attemptLocks.deleteAttemptLock"}},"/attempt-markings":{"post":{"summary":"Create AttemptMarking","description":"Unstable / experimental — do not adopt externally, this may be withdrawn without notice.","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"},"meta":{"type":"object","properties":{"responseIdsWithMaxPointsOverride":{"type":"array","items":{"type":"string"}}}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"meta":{"type":"object","properties":{"responseIdsWithMaxPointsOverride":{"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"}}}}}}},"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"}}}}}}}},"operationId":"attemptMarkings.createAttemptMarking"}},"/attempt-overrides":{"post":{"summary":"Create AttemptOverride","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","schedule"]},"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},"schedule":{"type":"object","properties":{"oldValue":{"type":"object","properties":{"activateAt":{"type":"string","format":"date-time","nullable":true},"deactivateAt":{"type":"string","format":"date-time","nullable":true}},"nullable":true},"newValue":{"type":"object","properties":{"activateAt":{"type":"string","format":"date-time","nullable":true},"deactivateAt":{"type":"string","format":"date-time","nullable":true}}},"isOriginal":{"type":"boolean"}},"nullable":true,"readOnly":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"}}}}}}}},"operationId":"attemptOverrides.createAttemptOverride"},"get":{"summary":"List AttemptOverrides","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptOverrides.findAttemptOverrides"}},"/attempt-player-states/{object_id}":{"get":{"summary":"Get AttemptPlayerState","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AttemptPlayerState"]}],"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"}}}}}}}},"operationId":"attemptPlayerStates.getAttemptPlayerState"}},"/attempt-regrades":{"post":{"summary":"Create AttemptRegrade","description":"Re-grades a completed exam attempt against the grade boundaries its exam version carries now: the attempt's grading settings are refreshed from that version, its score, section grades and grade are recalculated from the marks that already stand, and the certificate is reissued when the outcome changed. The marks themselves are not changed. Requires the override-marking grant and a finalised (or never marked) attempt; refused while the attempt is being sat, while marking is open, and when the version carries no grade boundaries. The boundaries are the exam's live (published) test's; an open draft's unpublished boundaries are not applied, publish it first. Boundaries that already match write nothing. Not available (501) unless post-submission attempt management is enabled for the portal.","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"AttemptRegrade","enum":["AttemptRegrade"]},"attributes":{"type":"object","properties":{"notifyCandidate":{"type":"boolean","default":false,"description":"Email the candidate a short notice that their results were updated, with a link to them and no marks. Sent only when the grade, pass or score moved and the result is released; the exam’s results-email setting and hidden-results page still apply."}}},"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/AttemptRegrade"},"meta":{"type":"object","properties":{"certificate":{"type":"object","required":["action"],"properties":{"action":{"type":"string","enum":["unchanged","reissued","notIssued","deferred","failed"]},"certificateId":{"type":"string"},"reason":{"type":"string"}}},"notification":{"type":"object","required":["action"],"description":"The candidate email this write asked for. `requested` means it was handed to the notification queue after the exam’s own rules passed; it confirms neither that an email was queued nor that one was sent.","properties":{"action":{"type":"string","enum":["requested","skipped","failed"]},"reason":{"type":"string","description":"Why it was skipped (notRequested, outcomeUnchanged, notReleased, marksNotFinal, notExam, resultsEmailDisabled, resultsHidden) or failed."}}}}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"meta":{"type":"object","properties":{"certificate":{"type":"object","required":["action"],"properties":{"action":{"type":"string","enum":["unchanged","reissued","notIssued","deferred","failed"]},"certificateId":{"type":"string"},"reason":{"type":"string"}}},"notification":{"type":"object","required":["action"],"description":"The candidate email this write asked for. `requested` means it was handed to the notification queue after the exam’s own rules passed; it confirms neither that an email was queued nor that one was sent.","properties":{"action":{"type":"string","enum":["requested","skipped","failed"]},"reason":{"type":"string","description":"Why it was skipped (notRequested, outcomeUnchanged, notReleased, marksNotFinal, notExam, resultsEmailDisabled, resultsHidden) or failed."}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"attemptRegrades.createAttemptRegrade"}},"/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":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptResultConfig.findAttemptResultConfigs"}},"/attempt-result-notifications":{"post":{"summary":"Create AttemptResultNotification","description":"Sends a released exam attempt's results email to its candidate again, the same email the release sent. The exam's notification settings and hidden-results rules still apply, and an attempt whose result is not released is skipped rather than refused (`meta.notification`), so a bulk loop can count it. When the email is handed over the request is recorded on the attempt's `state.notifications` with trigger `manual`. Requires the exam's send-message grant. Refused for a preview, a non-exam or a revoked attempt. Not available (501) unless post-submission attempt management is enabled for the portal.","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"AttemptResultNotification","enum":["AttemptResultNotification"]},"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/AttemptResultNotification"},"meta":{"type":"object","properties":{"notification":{"type":"object","required":["action"],"description":"The candidate email this write asked for. `requested` means it was handed to the notification queue after the exam’s own rules passed; it confirms neither that an email was queued nor that one was sent.","properties":{"action":{"type":"string","enum":["requested","skipped","failed"]},"reason":{"type":"string","description":"Why it was skipped (notRequested, outcomeUnchanged, notReleased, marksNotFinal, notExam, resultsEmailDisabled, resultsHidden) or failed."}}}}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"meta":{"type":"object","properties":{"notification":{"type":"object","required":["action"],"description":"The candidate email this write asked for. `requested` means it was handed to the notification queue after the exam’s own rules passed; it confirms neither that an email was queued nor that one was sent.","properties":{"action":{"type":"string","enum":["requested","skipped","failed"]},"reason":{"type":"string","description":"Why it was skipped (notRequested, outcomeUnchanged, notReleased, marksNotFinal, notExam, resultsEmailDisabled, resultsHidden) or failed."}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}},"501":{"description":"Not enabled for this portal","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"operationId":"attemptResultNotifications.createAttemptResultNotification"}},"/attempt-revoke-reversals":{"post":{"summary":"Create AttemptRevokeReversal","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptRevokeReversals.createAttemptRevokeReversal"},"get":{"summary":"List AttemptRevokeReversals","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptRevokeReversals.findAttemptRevokeReversals"}},"/attempt-revoke-reversals/{object_id}":{"get":{"summary":"Get AttemptRevokeReversal","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AttemptRevokeReversal"]}],"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"}}}}}}}},"operationId":"attemptRevokeReversals.getAttemptRevokeReversal"},"patch":{"summary":"Update AttemptRevokeReversal","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AttemptRevokeReversal"]}],"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"}}}}}}}},"operationId":"attemptRevokeReversals.updateAttemptRevokeReversal"},"delete":{"summary":"Delete AttemptRevokeReversal","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AttemptRevokeReversal"]}],"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"}}}}}}}},"operationId":"attemptRevokeReversals.deleteAttemptRevokeReversal"}},"/attempt-schedules":{"get":{"summary":"List AttemptSchedules","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptSchedules.findAttemptSchedules"}},"/attempt-schedules/{object_id}":{"get":{"summary":"Get AttemptSchedule","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AttemptSchedule"]}],"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"}}}}}}}},"operationId":"attemptSchedules.getAttemptSchedule"},"patch":{"summary":"Update AttemptSchedule","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AttemptSchedule"]}],"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"}}}}}}}},"operationId":"attemptSchedules.updateAttemptSchedule"}},"/attempt-sittings":{"post":{"summary":"Create AttemptSitting","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptSittings.createAttemptSitting"}},"/attempt-submissions":{"post":{"summary":"Create AttemptSubmission","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptSubmissions.createAttemptSubmission"}},"/attempt-tag-labels":{"get":{"summary":"List AttemptTagLabels","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptTagLabel.findAttemptTagLabels"}},"/attempt-timer-resets":{"post":{"summary":"Create AttemptTimerReset","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptTimerResets.createAttemptTimerReset"}},"/attempt-timers":{"get":{"summary":"List AttemptTimers","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptTimers.findAttemptTimers"}},"/attempt-timers/{object_id}":{"get":{"summary":"Get AttemptTimer","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AttemptTimer"]}],"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"}}}}}}}},"operationId":"attemptTimers.getAttemptTimer"},"patch":{"summary":"Update AttemptTimer","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AttemptTimer"]}],"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"}}}}}}}},"operationId":"attemptTimers.updateAttemptTimer"}},"/attempts":{"post":{"summary":"Create Attempt","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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},"timeRemainingInMs":{"type":"number","readOnly":true,"minimum":0,"description":"Time remaining in milliseconds at the time of the request. Present only for in-progress attempts with a visible whole-attempt timer that has started."},"proctor":{"type":"object","readOnly":true,"additionalProperties":true,"deprecated":true,"description":"Deprecated. Use flattened fields such as `proctorEnabled`, `proctorVendor` etc instead."},"registration":{"type":"object","readOnly":true,"description":"How this attempt was created, with its initiating trigger when known. Absent on attempts whose origin was not recorded.","required":["method"],"properties":{"method":{"type":"string","enum":["userGroup","direct","examWindow","resit"]},"trigger":{"type":"string","enum":["lti","voucher","examCode"]}}},"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},"candidateFeedback":{"type":"string","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."},"questionsTotal":{"type":"number","readOnly":true,"description":"Questions in the attempt."},"setupTags":{"type":"array","readOnly":true,"description":"The tags the attempt was set up to draw from (`quizSetup.filters`), with their current labels; tags deleted since are left out. Only on the attempt list, and omitted when `fields[Attempt]` is sent without it.","items":{"type":"object","required":["id","label"],"properties":{"id":{"type":"string"},"label":{"type":"string"}}}},"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},"unlockedAt":{"type":"string","readOnly":true,"description":"When the attempt was last unlocked. Only present for staff viewers."},"unlockedMethod":{"type":"string","readOnly":true,"enum":["staff","passcode"],"description":"How the attempt was last unlocked. Only present for staff viewers."},"corrections":{"type":"object","readOnly":true,"description":"Post-hoc corrections to the result (overrides, re-grades, exam-version re-marks). Absent when the result was never corrected, or was corrected before this was recorded. Only present for staff viewers.","required":["count","lastAt","lastKind"],"properties":{"count":{"type":"integer","minimum":1},"lastAt":{"type":"string","format":"date-time"},"lastKind":{"type":"string","enum":["markingEntryOverride","maxPointsOverride","regrade","questionRemark","attemptOverride"]}}},"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},"resultsDeferredLocked":{"type":"boolean","readOnly":true,"description":"Whether the owner is not yet allowed to see this deferred result."},"proctorEnabled":{"type":"boolean","readOnly":true,"nullable":true},"proctorVendor":{"type":"string","enum":["synopticV2","rosalyn",null],"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},"proctorAiAnalysisStatus":{"type":"string","enum":["pending","completed","error"],"readOnly":true,"nullable":true},"proctorAiAnalysisPrompts":{"type":"array","readOnly":true,"nullable":true,"items":{"type":"object","properties":{"prompt":{"type":"string"},"slug":{"type":"string"},"colour":{"type":"string","nullable":true},"coverageRatio":{"type":"number","minimum":0,"maximum":1},"totalDurationS":{"type":"number","minimum":0,"nullable":true}}}},"proctorLiveProctoring":{"type":"boolean","readOnly":true,"nullable":true},"proctorRoomScanCoverage":{"type":"string","enum":["off","workspace","full",null],"nullable":true},"proctorRoomScanDevice":{"type":"string","enum":["phone","webcam","either",null],"nullable":true},"identityCheckRequired":{"type":"boolean","readOnly":true,"nullable":true},"identityCheckFailureAction":{"type":"string","enum":["flag","block",null],"readOnly":true,"nullable":true},"identityCheckVendor":{"type":"string","enum":["stripe","entrust","internal",null],"readOnly":true,"nullable":true},"identityCheckAutomaticFaceMatch":{"type":"boolean","readOnly":true,"nullable":true},"identityCheckNameAction":{"type":"string","enum":["record","flag","block",null],"readOnly":true,"nullable":true},"identityCheck":{"type":"object","readOnly":true,"nullable":true,"properties":{"status":{"type":"string","enum":["created","processing","verified","failed","cancelled","awaiting_review"],"readOnly":true},"checkId":{"type":"string","readOnly":true,"nullable":true},"sessionRef":{"type":"string","readOnly":true,"nullable":true},"checkedAt":{"type":"string","readOnly":true,"nullable":true},"failureCode":{"type":"string","readOnly":true,"nullable":true},"attemptsUsed":{"type":"integer","minimum":0,"readOnly":true},"redactedAt":{"type":"string","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},"proctorRequireSecondCamera":{"type":"boolean","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},"proctorLiveAiDetection":{"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},"enabled":{"type":"boolean","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"]}}}}},"examWindow":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamWindow","enum":["ExamWindow"]}}}}},"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","PlayerMatchingResponse","PlayerImageLabellingDragAndDropResponse","PlayerImageLabellingDropDownResponse","PlayerImageLabellingTextResponse","PlayerClassificationResponse","PlayerChoiceMatrixResponse","PlayerTextSelectionResponse","PlayerCodingResponse","PlayerBowTieResponse","PlayerLikertResponse","PlayerNumericAnswerResponse"],"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"]}}}}},"unlockedBy":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"}}}}}}}},"operationId":"attempts.createAttempt"},"get":{"summary":"List Attempts","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","in":"query","required":false,"explode":false,"schema":{"type":"object","properties":{"propertyFilters":{"type":"array","description":"Candidate attribute filters. Each attribute may appear only once.","items":{"type":"object","required":["attribute","value"],"properties":{"attribute":{"type":"string","pattern":"^filter\\.attr\\.[a-z0-9_-]+$"},"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"]}}}},"isExam":{"type":"boolean"},"examId":{"type":"string"},"testId":{"type":"string"},"mockId":{"type":"string"},"collectionId":{"type":"string","description":"Attempts taken inside the collection: its mocks and its quiz items."},"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","autoApproved","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"}},"subPortals":{"type":"array","items":{"type":"string"}},"examWindows":{"type":"array","description":"Only attempts issued through one of these exam windows. Include null for attempts without a window.","items":{"type":"string","nullable":true}},"lockStatus":{"type":"array","items":{"type":"string","enum":["unlocked","locked","none"]}},"systemsCheckStatus":{"type":"array","description":"Where the candidate's systems check stands. Not run, in progress, and the result of the last finished check (passed or attention). A candidate re-running a check can match in progress and a result at once. Values are OR'd.","items":{"type":"string","enum":["notRun","inProgress","passed","attention"]}},"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."},"isCorrected":{"type":"boolean","description":"Whether the result was corrected after the fact: a marking-entry or max-points override, a re-grade, an exam-version re-mark or a legacy results override. `true` returns corrected attempts only; `false` excludes them. Corrections made before this was recorded are not counted."},"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","isCompleted","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"}}},{"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/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"}}}}}}}},"operationId":"attempts.findAttempts"}},"/attempts/{object_id}":{"get":{"summary":"Get Attempt","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Attempt"]},{"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"}}}}}}}},"operationId":"attempts.getAttempt"},"patch":{"summary":"Update Attempt","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Attempt"]}],"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"}}}}}}}},"operationId":"attempts.updateAttempt"}},"/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":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Attempt"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attempts.addAssignedModeratinglMarkers"},"delete":{"summary":"Unassign Moderating Markers","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Attempt"]}],"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"}}}}}}}},"operationId":"attempts.removeAssignedModeratingMarkesr"}},"/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":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Attempt"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attempts.addAssignedBackReadingMarkers"},"delete":{"summary":"Unassign Backreaders","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Attempt"]}],"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"}}}}}}}},"operationId":"attempts.removeAssignedBackReadingMarkesr"}},"/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":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Attempt"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attempts.addAssignedEscalatingMarkers"},"delete":{"summary":"Unassign Escalating Markers","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Attempt"]}],"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"}}}}}}}},"operationId":"attempts.removeAssignedEscalatingMarkesr"}},"/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":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Attempt"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attempts.addAssignedAuditingMarkers"},"delete":{"summary":"Unassign Auditing Markers","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Attempt"]}],"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"}}}}}}}},"operationId":"attempts.removeAssignedAuditingMarkesr"}},"/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":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Attempt"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attempts.addAssignedProvisionalMarkers"},"delete":{"summary":"Unassign Provisional Markers","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Attempt"]}],"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"}}}}}}}},"operationId":"attempts.removeAssignedProvisionalMarkesr"}},"/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":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attemptOperations.applyAttemptOperations"}},"/attribute-configs":{"post":{"summary":"Create AttributeConfig","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","required":["label"],"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"}}}}}}}},"operationId":"attributeConfig.createAttributeConfig"},"get":{"summary":"List AttributeConfigs","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"attributeConfig.findAttributeConfigs"}},"/attribute-configs/{object_id}":{"get":{"summary":"Get AttributeConfig","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AttributeConfig"]}],"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"}}}}}}}},"operationId":"attributeConfig.getAttributeConfig"},"patch":{"summary":"Update AttributeConfig","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AttributeConfig"]}],"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"}}}}}}}},"operationId":"attributeConfig.updateAttributeConfig"},"delete":{"summary":"Delete AttributeConfig","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AttributeConfig"]}],"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"}}}}}}}},"operationId":"attributeConfig.deleteAttributeConfig"}},"/audit-logs":{"get":{"summary":"List AuditLogs","tags":["Auditing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","additionalProperties":false,"properties":{"createdAfter":{"type":"string","format":"date-time"},"createdBefore":{"type":"string","format":"date-time"},"actor":{"type":"string"},"actorType":{"oneOf":[{"type":"string","enum":["user","personalAccessToken","apiKey","anonymous","automation"]},{"type":"array","items":{"type":"string","enum":["user","personalAccessToken","apiKey","anonymous","automation"]}}]},"targetId":{"type":"string","minLength":1},"targetType":{"type":"string","minLength":1},"resource":{"oneOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string","minLength":1}}]},"method":{"oneOf":[{"type":"string","enum":["delete","get","head","options","patch","post","put","trace"]},{"type":"array","items":{"type":"string","enum":["delete","get","head","options","patch","post","put","trace"]}}]},"route":{"type":"string","minLength":1},"outcome":{"oneOf":[{"type":"string","enum":["success","clientError","serverError","aborted"]},{"type":"array","items":{"type":"string","enum":["success","clientError","serverError","aborted"]}}]},"statusCode":{"oneOf":[{"type":"integer"},{"type":"array","items":{"type":"integer"}}]},"subPortal":{"type":"string"},"requestId":{"type":"string","minLength":1}}}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["-createdAt","createdAt"]}},{"name":"page","in":"query","required":false,"schema":{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"maximum":200},"offset":{"type":"integer","minimum":0}}}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["actor","subjectUser"]}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AuditLog"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/GenericResource"}},"meta":{"type":"object","required":["hasMore","total","storageTier"],"properties":{"hasMore":{"type":"boolean"},"total":{"type":"number","nullable":true},"storageTier":{"type":"string","enum":["hot"]}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}},"operationId":"auditLogs.findAuditLogs"}},"/audit-logs/{object_id}":{"get":{"summary":"Get an AuditLog","tags":["Auditing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuditLog"]},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["actor","subjectUser"]}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuditLog"},"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"}}}}}}}},"operationId":"auditLogs.getAuditLog"}},"/authentication-option-adfs":{"post":{"summary":"Create ADFS AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"authenticationOptionAdfs.createAuthenticationOptionAdfs"}},"/authentication-option-adfs/{object_id}":{"get":{"summary":"Get ADFS AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionAdfs"]}],"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"}}}}}}}},"operationId":"authenticationOptionAdfs.getAuthenticationOptionAdfs"},"patch":{"summary":"Update ADFS AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionAdfs"]}],"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"}}}}}}}},"operationId":"authenticationOptionAdfs.updateAuthenticationOptionAdfs"},"delete":{"summary":"Delete ADFS AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionAdfs"]}],"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"}}}}}}}},"operationId":"authenticationOptionAdfs.deleteAuthenticationOptionAdfs"}},"/authentication-option-auth0":{"post":{"summary":"Create Auth0 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"authenticationOptionAuth0.createAuthenticationOptionAuth0"}},"/authentication-option-auth0/{object_id}":{"get":{"summary":"Get Auth0 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionAuth0"]}],"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"}}}}}}}},"operationId":"authenticationOptionAuth0.getAuthenticationOptionAuth0"},"patch":{"summary":"Update Auth0 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionAuth0"]}],"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"}}}}}}}},"operationId":"authenticationOptionAuth0.updateAuthenticationOptionAuth0"},"delete":{"summary":"Delete Auth0 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionAuth0"]}],"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"}}}}}}}},"operationId":"authenticationOptionAuth0.deleteAuthenticationOptionAuth0"}},"/authentication-option-jwt":{"post":{"summary":"Create JWT AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"authenticationOptionJwt.createAuthenticationOptionJwt"}},"/authentication-option-jwt/{object_id}":{"get":{"summary":"Get JWT AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionJwt"]}],"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"}}}}}}}},"operationId":"authenticationOptionJwt.getAuthenticationOptionJwt"},"patch":{"summary":"Update JWT AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionJwt"]}],"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"}}}}}}}},"operationId":"authenticationOptionJwt.updateAuthenticationOptionJwt"},"delete":{"summary":"Delete JWT AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionJwt"]}],"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"}}}}}}}},"operationId":"authenticationOptionJwt.deleteAuthenticationOptionJwt"}},"/authentication-option-local/{object_id}":{"get":{"summary":"Get Local AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionLocal"]}],"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"}}}}}}}},"operationId":"authenticationOptionLocal.getAuthenticationOptionLocal"},"patch":{"summary":"Update Local AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionLocal"]}],"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"}}}}}}}},"operationId":"authenticationOptionLocal.updateAuthenticationOptionLocal"}},"/authentication-option-lti1p1":{"post":{"summary":"Create LTI1.1 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"authenticationOptionLti1p1.createAuthenticationOptionLti1p1"}},"/authentication-option-lti1p1/{object_id}":{"get":{"summary":"Get LTI1.1 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionLti1p1"]}],"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"}}}}}}}},"operationId":"authenticationOptionLti1p1.getAuthenticationOptionLti1p1"},"patch":{"summary":"Update LTI1.1 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionLti1p1"]}],"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"}}}}}}}},"operationId":"authenticationOptionLti1p1.updateAuthenticationOptionLti1p1"},"delete":{"summary":"Delete LTI1.1 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionLti1p1"]}],"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"}}}}}}}},"operationId":"authenticationOptionLti1p1.deleteAuthenticationOptionLti1p1"}},"/authentication-option-lti1p3":{"post":{"summary":"Create LTI1.3 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"authenticationOptionLti1p3.createAuthenticationOptionLti1p3"}},"/authentication-option-lti1p3/{object_id}":{"get":{"summary":"Get LTI1.3 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionLti1p3"]}],"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"}}}}}}}},"operationId":"authenticationOptionLti1p3.getAuthenticationOptionLti1p3"},"patch":{"summary":"Update LTI1.3 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionLti1p3"]}],"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"}}}}}}}},"operationId":"authenticationOptionLti1p3.updateAuthenticationOptionLti1p3"},"delete":{"summary":"Delete LTI1.3 AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionLti1p3"]}],"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"}}}}}}}},"operationId":"authenticationOptionLti1p3.deleteAuthenticationOptionLti1p3"}},"/authentication-option-saml":{"post":{"summary":"Create SAML AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"authenticationOptionSaml.createAuthenticationOptionSaml"}},"/authentication-option-saml/{object_id}":{"get":{"summary":"Get SAML AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionSaml"]}],"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"}}}}}}}},"operationId":"authenticationOptionSaml.getAuthenticationOptionSaml"},"patch":{"summary":"Update SAML AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionSaml"]}],"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"}}}}}}}},"operationId":"authenticationOptionSaml.updateAuthenticationOptionSaml"},"delete":{"summary":"Delete SAML AuthenticationOption","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AuthenticationOptionSaml"]}],"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"}}}}}}}},"operationId":"authenticationOptionSaml.deleteAuthenticationOptionSaml"}},"/authentication-options":{"get":{"summary":"List AuthenticationOptions","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"authenticationOption.findAuthenticationOptions"}},"/automation-catalogue":{"get":{"summary":"Fetch the automation catalogue","description":"The catalogue of blocks, triggers, pickers and operations the workflow builder and the automations engine work from. The body is the plain catalogue document described by `CatalogueSchema` in `@synap-ac/automations-contracts`, not a JSON:API document. Its `version` identifies the catalogue a workflow was built against.","tags":["Automation"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"The catalogue document: parse it with `CatalogueSchema` from `@synap-ac/automations-contracts`.","required":["version","resources","blocks","operations","pickers","triggers","steps"],"properties":{"version":{"type":"string"},"resources":{"type":"object"},"blocks":{"type":"object"},"operations":{"type":"object"},"pickers":{"type":"object"},"triggers":{"type":"object"},"steps":{"type":"object"}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"automationCatalogue.getAutomationCatalogue"}},"/automation-runs/{object_id}":{"get":{"summary":"Get Automation Run","description":"A single run with its full step log and the definition snapshot it executes.","tags":["Automation"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["AutomationRun"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/AutomationRun"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"automationRun.getAutomationRun"}},"/automation-runs/operations":{"post":{"summary":"Cancel or retry Automation Runs","description":"JSON:API Atomic Operations extension. Each `update` operation names a run and carries exactly one of `status: \"cancelled\"` (cancel) or `requestedRetryOfStepId` (retry from that failed step). Malformed operations reject the whole batch before anything is written, each reported with a `source.pointer` of `/atomic:operations/{index}`. Well-formed operations are applied in order and independently; one that cannot be applied (for example a run that is no longer cancellable) stops the batch at that index, and the runs before it stay changed. Use the media type `application/vnd.api+json; ext=\"https://jsonapi.org/ext/atomic\"`.","tags":["Automation"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","description":"Identifies the Resource.","example":"AutomationRun","enum":["AutomationRun"]},"id":{"$ref":"#/components/schemas/ObjectId"},"attributes":{"type":"object","additionalProperties":false,"properties":{"status":{"type":"string","enum":["cancelled"],"description":"Cancel the run (`cancelledReason: manual`). Pending, waiting, paused and failed runs can be cancelled."},"requestedRetryOfStepId":{"type":"string","minLength":1,"description":"Retry a failed or exhausted run from this failed step: the run goes back to `pending` and the engine resumes at the step."}}}}}}}}}}},"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","description":"Identifies the Resource.","example":"AutomationRun","enum":["AutomationRun"]},"id":{"$ref":"#/components/schemas/ObjectId"},"attributes":{"type":"object","additionalProperties":false,"properties":{"status":{"type":"string","enum":["cancelled"],"description":"Cancel the run (`cancelledReason: manual`). Pending, waiting, paused and failed runs can be cancelled."},"requestedRetryOfStepId":{"type":"string","minLength":1,"description":"Retry a failed or exhausted run from this failed step: the run goes back to `pending` and the engine resumes at the step."}}}}}}}}}}}}},"responses":{"200":{"description":"Operations applied","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/AutomationRun"}}}}}}},"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/AutomationRun"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"automationRunOperations.applyAutomationRunOperations"}},"/automations":{"post":{"summary":"Create Automation","description":"Creates a disabled automation at version 1 from a name and a workflow definition. The definition must be built against the current catalogue; every structural or semantic fault is returned as its own error pointing into `/data/attributes/definition`. Needs the Automations entitlement and a portal admin; answers 404 for a portal without the automations rollout.","tags":["Automation"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"Automation","enum":["Automation"]},"attributes":{"type":"object","required":["name","definition"],"properties":{"name":{"type":"string","minLength":1,"readOnly":false,"nullable":false},"description":{"type":"string","maxLength":500,"readOnly":false,"nullable":true},"definition":{"type":"object","description":"The workflow definition: `WorkflowDefinitionSchema` from `@synap-ac/automations-contracts`. Validated structurally and against the current catalogue; every fault is reported as its own error with a `source.pointer` into the definition and the issue `code` in `meta`. Saving a new definition bumps `version` and re-derives `triggerEvent`.","additionalProperties":true,"readOnly":false,"nullable":false},"state":{"type":"string","enum":["draft","enabled","disabled","paused"],"description":"Writable to move the automation: `enabled`, `paused` (from enabled, with `waitingRuns`) or `disabled`. Created as `disabled`.","readOnly":false,"nullable":false},"waitingRuns":{"type":"string","enum":["pause","continue"],"description":"Required when pausing: whether runs waiting on a checkpoint pause with the automation or continue. Never returned.","writeOnly":true,"nullable":false},"pausedRuns":{"type":"string","enum":["resume","discard"],"description":"Required when enabling a paused automation: whether paused runs resume (on the current version) or are discarded. Never returned.","writeOnly":true,"nullable":false},"enabled":{"type":"boolean","readOnly":true,"nullable":false},"pausedReason":{"type":"string","enum":["health","blockRetired","entitlementRemoved",null],"readOnly":true,"nullable":true},"version":{"type":"integer","minimum":1,"readOnly":true,"nullable":false},"triggerEvent":{"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},"catalogueVersion":{"type":"string","readOnly":true,"nullable":false},"health":{"type":"object","required":["consecutiveFailures"],"properties":{"consecutiveFailures":{"type":"integer","minimum":0},"lastRunAt":{"type":"string","format":"date-time","readOnly":true},"lastRunStatus":{"type":"string","enum":["pending","running","waiting","paused","completed","skipped","failed","exhausted","cancelled"],"readOnly":true}},"readOnly":true,"nullable":false},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","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/Automation"}}}}}},"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"}}}}}}}},"operationId":"automation.createAutomation"},"get":{"summary":"List Automations","description":"The automations of the portal, newest change first unless sorted otherwise.","tags":["Automation"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["draft","enabled","disabled","paused"]},{"type":"array","items":{"type":"string","enum":["draft","enabled","disabled","paused"]}}]},"triggerEvent":{"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"]}}]}}}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["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}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Automation"}},"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"}}}}}}}},"operationId":"automation.findAutomations"}},"/automations/{object_id}":{"get":{"summary":"Get Automation","tags":["Automation"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Automation"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Automation"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"automation.getAutomation"},"patch":{"summary":"Update Automation","description":"Renames the automation, replaces its definition (re-validated; bumps `version`) or changes its `state`. Pausing needs `waitingRuns` (`pause` moves waiting runs to `paused`, `continue` leaves them). Enabling a paused automation needs `pausedRuns` (`resume` puts paused runs back to waiting on the current version, recording `upgradedFromVersion` when the version moved; `discard` cancels them with `cancelledReason: discarded`). Disabling cancels pending, waiting and paused runs with `cancelledReason: disabled`.","tags":["Automation"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Automation"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Automation"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Automation"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"automation.updateAutomation"},"delete":{"summary":"Delete Automation","description":"Deletes the automation and cancels its in-flight runs with `cancelledReason: disabled`. Finished runs and recorded events are kept until their retention expires.","tags":["Automation"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Automation"]}],"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"}}}}}}}},"operationId":"automation.deleteAutomation"}},"/automations/{object_id}/runs":{"get":{"summary":"List Automation Runs","description":"The runs of the automation, newest first, without their step log or definition snapshot: read a single run for those.","tags":["Automation"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Automation"]},{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"status":{"oneOf":[{"type":"string","enum":["pending","running","waiting","paused","completed","skipped","failed","exhausted","cancelled"]},{"type":"array","items":{"type":"string","enum":["pending","running","waiting","paused","completed","skipped","failed","exhausted","cancelled"]}}]}}}},{"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/AutomationRun"}},"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"}}}}}}}},"operationId":"automation.findAutomationRuns"}},"/automations/{object_id}/recent-events":{"get":{"summary":"List recent events for an Automation","description":"The events recorded for the portal over the last seven days that match the automation trigger, newest first. Pick one to start a test run.","tags":["Automation"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Automation"]},{"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/AutomationEvent"}},"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"}}}}}}}},"operationId":"automation.findAutomationRecentEvents"}},"/automations/{object_id}/operations/test-run":{"post":{"summary":"Start a test run of an Automation","description":"Creates a `dryRun` run of the automation from one of its recent events (`relationships.triggerEvent`). The event must match the automation trigger. The run snapshots the current definition and is picked up by the engine like a live run, but with side effects suppressed.","tags":["Automation"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Automation"]}],"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":"AutomationRun","enum":["AutomationRun"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["triggerEvent"],"properties":{"triggerEvent":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is 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":"AutomationEvent","enum":["AutomationEvent"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AutomationRun"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"automation.createAutomationTestRun"}},"/available-access-policies":{"get":{"summary":"List AvailableAccessPolicies","tags":["Access Policies"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"availableAccessPolicies.findAvailableAccessPolicies"}},"/background-jobs/{object_id}":{"get":{"summary":"Get BackgroundJob","tags":["Notifications"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["BackgroundJob"]},{"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"}}}}}}}},"operationId":"backgroundJob.getBackgroundJob"}},"/billing-infos/current":{"get":{"summary":"Get Billing Info","tags":["Billing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"billingInfo.getBillingInfo"}},"/billing-usage-reports/current":{"get":{"summary":"Get Billing Usage Report","description":"The requesting admin's portal: plan, credit or MAU usage and plan options over the requested range. Portals without a metered subscription have no report.","tags":["Billing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"range","in":"query","required":true,"schema":{"type":"string","enum":["this-month","3-months","6-months","9-months","12-months","all-time","contract-year"]}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/BillingUsageReport"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"billingUsageReport.getCurrentBillingUsageReport"}},"/billing-usage-reports/current/mau-subportal-usage.csv":{"get":{"summary":"Export MAU Usage by Subportal","description":"Exports active users and activity counts per usage period and current subportal, without credits or currency. Subportal fields are blank for unassigned users.","tags":["Billing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"range","in":"query","required":true,"schema":{"type":"string","enum":["this-month","3-months","6-months","9-months","12-months","all-time","contract-year"]}}],"responses":{"200":{"description":"CSV export","content":{"text/csv":{"schema":{"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"}}}}}}}},"operationId":"billingUsageReport.exportMauSubportalUsage"}},"/billing-usage-reports/current/payg-usage.csv":{"get":{"summary":"Export PAYG Credit Usage","description":"Exports activity counts and credits per usage period and current subportal, including total credits used. Subportal fields are blank for unassigned users; no currency is calculated.","tags":["Billing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"range","in":"query","required":true,"schema":{"type":"string","enum":["this-month","3-months","6-months","9-months","12-months","all-time","contract-year"]}}],"responses":{"200":{"description":"CSV export","content":{"text/csv":{"schema":{"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"}}}}}}}},"operationId":"billingUsageReport.exportPaygUsage"}},"/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"}}}}}}}},"operationId":"botSessions.create"}},"/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"}}}}}}}},"operationId":"botUsers.createBotUser"},"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"}}}}}}}},"operationId":"botUsers.findBotUsers"}},"/certificates/{object_id}":{"get":{"summary":"Get Certificate","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Certificate"]}],"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"}}}}}}}},"operationId":"certificates.getCertificate"}},"/certificates":{"get":{"summary":"List Certificates","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"certificates.findCertificates"},"post":{"summary":"Create Certificate","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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},"revokedAt":{"type":"string","format":"date-time","readOnly":true,"description":"When the certificate was withdrawn in favour of `supersededBy`. Absent while it is live."}}},"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"]}}}}},"supersededBy":{"type":"object","description":"The certificate that replaced this one. It may itself have been withdrawn since, so follow the chain to the live certificate. Absent while this one is live.","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"]}}}}}}}}}}}}}},"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"}}}}}}}},"operationId":"certificates.createCertificate"}},"/chart-js":{"get":{"summary":"Get Chart","tags":["Insights"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"chartJSs.findChart"}},"/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 that is not embedded."},"paymentGatewayClientSecret":{"type":"string","readOnly":true,"nullable":true,"description":"The client secret that renders an embedded Checkout, only returned when creating a paid Checkout Session that is embedded."},"paymentGatewayAccountId":{"type":"string","readOnly":true,"nullable":true,"description":"The connected payment account an embedded Checkout is created in, only returned when creating an embedded 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"}}}}}}}},"operationId":"checkoutSessions.createCheckoutSession"}},"/checkout-sessions/{object_id}":{"get":{"summary":"Get CheckoutSession","tags":["Shop"],"security":[],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CheckoutSession"]},{"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"}}}}}}}},"operationId":"checkoutSessions.getCheckoutSession"},"patch":{"summary":"Update CheckoutSession","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CheckoutSession"]}],"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"}}}}}}}},"operationId":"checkoutSessions.updateCheckoutSession"}},"/clone-jobs":{"post":{"summary":"Create CloneJob","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"cloneJob.createCloneJob"}},"/clone-jobs/{object_id}":{"get":{"summary":"Get CloneJob","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CloneJob"]}],"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"}}}}}}}},"operationId":"cloneJob.getCloneJob"}},"/collection-accesses":{"post":{"summary":"Create CollectionAccess","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionAccess.createCollectionAccess"}},"/collection-accesses/{object_id}":{"delete":{"summary":"Delete CollectionAccess","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionAccess"]}],"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"}}}}}}}},"operationId":"collectionAccess.deleteCollectionAccess"}},"/collection-folders":{"post":{"summary":"Create CollectionFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionFolders.createCollectionFolder"},"get":{"summary":"List CollectionFolders","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionFolders.findCollectionFolders"}},"/collection-folders/{object_id}":{"get":{"summary":"Get CollectionFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionFolder"]},{"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"}}}}}}}},"operationId":"collectionFolders.getCollectionFolder"},"patch":{"summary":"Update CollectionFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionFolder"]}],"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"}}}}}}}},"operationId":"collectionFolders.updateCollectionFolder"},"delete":{"summary":"Delete CollectionFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionFolder"]}],"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"}}}}}}}},"operationId":"collectionFolders.deleteCollectionFolder"}},"/collection-folders/{object_id}/relationships/items":{"patch":{"summary":"Reorder CollectionFolder Items","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionFolder"]}],"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"}}}}}}}},"operationId":"collectionFolders.reorderCollectionFolderItems"},"post":{"summary":"Create CollectionSubFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionFolders.createCollectionSubFolder"}},"/collection-folders/{object_id}/relationships/items/{item_id}":{"get":{"summary":"Get CollectionSubFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionFolder"]},{"name":"item_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionSubFolder"]},{"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"}}}}}}}},"operationId":"collectionFolders.getCollectionSubFolder"},"patch":{"summary":"Update CollectionSubFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionFolder"]},{"name":"item_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionSubFolder"]}],"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"}}}}}}}},"operationId":"collectionFolders.updateCollectionSubFolder"},"delete":{"summary":"Delete CollectionSubFolder","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionFolder"]},{"name":"item_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionSubFolder"]}],"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"}}}}}}}},"operationId":"collectionFolders.deleteCollectionSubFolder"}},"/collection-folders/{object_id}/relationships/items/{item_id}/relationships/items":{"patch":{"summary":"Reorder CollectionSubFolder Items","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionFolder"]},{"name":"item_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionSubFolder"]}],"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"}}}}}}}},"operationId":"collectionFolders.reorderCollectionSubFolderItems"}},"/collection-item-audio":{"post":{"summary":"Create CollectionItemAudio","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionItemAudio.createCollectionItem"},"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"}}}}}}}},"operationId":"collectionItemAudio.findCollectionItems"}},"/collection-item-audio/{object_id}":{"get":{"summary":"Get CollectionItemAudio","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemAudio"]},{"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"}}}}}}}},"operationId":"collectionItemAudio.getCollectionItem"},"patch":{"summary":"Update CollectionItemAudio","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemAudio"]}],"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"}}}}}}}},"operationId":"collectionItemAudio.updateCollectionItem"},"delete":{"summary":"Delete CollectionItemAudio","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemAudio"]}],"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"}}}}}}}},"operationId":"collectionItemAudio.deleteCollectionItem"}},"/collection-item-document/{object_id}":{"get":{"summary":"Get CollectionItemDocument","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemDocument"]},{"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"}}}}}}}},"operationId":"collectionItemDocument.getCollectionItem"},"patch":{"summary":"Update CollectionItemDocument","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemDocument"]}],"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"}}}}}}}},"operationId":"collectionItemDocument.updateCollectionItem"},"delete":{"summary":"Delete CollectionItemDocument","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemDocument"]}],"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"}}}}}}}},"operationId":"collectionItemDocument.deleteCollectionItem"}},"/collection-item-document":{"post":{"summary":"Create CollectionItemDocument","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionItemDocument.createCollectionItem"}},"/collection-item-embed":{"post":{"summary":"Create CollectionItemEmbed","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionItemEmbed.createCollectionItem"},"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"}}}}}}}},"operationId":"collectionItemEmbed.findCollectionItems"}},"/collection-item-embed/{object_id}":{"get":{"summary":"Get CollectionItemEmbed","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemEmbed"]},{"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"}}}}}}}},"operationId":"collectionItemEmbed.getCollectionItem"},"patch":{"summary":"Update CollectionItemEmbed","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemEmbed"]}],"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"}}}}}}}},"operationId":"collectionItemEmbed.updateCollectionItem"},"delete":{"summary":"Delete CollectionItemEmbed","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemEmbed"]}],"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"}}}}}}}},"operationId":"collectionItemEmbed.deleteCollectionItem"}},"/collection-item-note":{"post":{"summary":"Create CollectionItemNote","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionItemNote.createCollectionItem"},"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"}}}}}}}},"operationId":"collectionItemNote.findCollectionItems"}},"/collection-item-note/{object_id}":{"get":{"summary":"Get CollectionItemNote","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemNote"]},{"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"}}}}}}}},"operationId":"collectionItemNote.getCollectionItem"},"patch":{"summary":"Update CollectionItemNote","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemNote"]}],"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"}}}}}}}},"operationId":"collectionItemNote.updateCollectionItem"},"delete":{"summary":"Delete CollectionItemNote","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemNote"]}],"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"}}}}}}}},"operationId":"collectionItemNote.deleteCollectionItem"}},"/collection-item-pdf-exports":{"post":{"summary":"Create CollectionItemPdfExport","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionItemPdfExports.createCollectionItemPdfExport"}},"/collection-item-quiz":{"post":{"summary":"Create CollectionItemQuiz","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionItemQuiz.createCollectionItem"},"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"}}}}}}}},"operationId":"collectionItemQuiz.findCollectionItems"}},"/collection-item-quiz/{object_id}":{"get":{"summary":"Get CollectionItemQuiz","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemQuiz"]},{"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"}}}}}}}},"operationId":"collectionItemQuiz.getCollectionItem"},"patch":{"summary":"Update CollectionItemQuiz","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemQuiz"]}],"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"}}}}}}}},"operationId":"collectionItemQuiz.updateCollectionItem"},"delete":{"summary":"Delete CollectionItemQuiz","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemQuiz"]}],"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"}}}}}}}},"operationId":"collectionItemQuiz.deleteCollectionItem"}},"/collection-item-video":{"post":{"summary":"Create CollectionItemVideo","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionItemVideo.createCollectionItem"},"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"}}}}}}}},"operationId":"collectionItemVideo.findCollectionItems"}},"/collection-item-video/{object_id}":{"get":{"summary":"Get CollectionItemVideo","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemVideo"]},{"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"}}}}}}}},"operationId":"collectionItemVideo.getCollectionItem"},"patch":{"summary":"Update CollectionItemVideo","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemVideo"]}],"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"}}}}}}}},"operationId":"collectionItemVideo.updateCollectionItem"},"delete":{"summary":"Delete CollectionItemVideo","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemVideo"]}],"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"}}}}}}}},"operationId":"collectionItemVideo.deleteCollectionItem"}},"/collection-item-zip":{"post":{"summary":"Create CollectionItemZip","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionItemZip.createCollectionItem"},"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"}}}}}}}},"operationId":"collectionItemZip.findCollectionItems"}},"/collection-item-zip/{object_id}":{"get":{"summary":"Get CollectionItemZip","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemZip"]},{"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"}}}}}}}},"operationId":"collectionItemZip.getCollectionItem"},"patch":{"summary":"Update CollectionItemZip","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemZip"]}],"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"}}}}}}}},"operationId":"collectionItemZip.updateCollectionItem"},"delete":{"summary":"Delete CollectionItemZip","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionItemZip"]}],"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"}}}}}}}},"operationId":"collectionItemZip.deleteCollectionItem"}},"/collection-items":{"get":{"summary":"List CollectionItems","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionItems.findCollectionItems"}},"/collection-items/operations":{"post":{"summary":"BETA: Atomically add many items to a collection","description":"BETA: JSON:API Atomic Operations extension. Send `atomic:operations` with `op: \"add\"` and a typed collection item resource per operation, shaped as the matching `POST /v3/collection-item-*` body. Every operation must add to the same collection. A request may carry up to 50 operations. 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}`. Results are returned in request order. Use the media type `application/vnd.api+json; ext=\"https://jsonapi.org/ext/atomic\"`.","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":50,"items":{"type":"object","required":["op","data"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["add"]},"data":{"oneOf":[{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}}]}}}}}}},"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":50,"items":{"type":"object","required":["op","data"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["add"]},"data":{"oneOf":[{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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":{"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/CollectionItem"}}}}}}},"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/CollectionItem"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"collectionItemOperations.applyCollectionItemOperations"}},"/collection-mocks":{"get":{"summary":"List CollectionMocks","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionMocks.findCollectionMocks"}},"/collection-pdf-exports":{"post":{"summary":"Create CollectionPdfExport","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionPdfExports.createCollectionPdfExport"}},"/collection-progresses":{"post":{"summary":"Create CollectionProgress","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionProgresses.createCollectionProgress"},"get":{"summary":"List CollectionProgresses","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionProgresses.findCollectionProgresses"}},"/collection-progresses/{object_id}":{"patch":{"summary":"Update CollectionProgress","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionProgress"]}],"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"}}}}}}}},"operationId":"collectionProgresses.updateCollectionProgress"},"get":{"summary":"Get CollectionProgress","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionProgress"]}],"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"}}}}}}}},"operationId":"collectionProgresses.getCollection"}},"/collection-sub-folders":{"get":{"summary":"List CollectionSubFolders","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collectionSubFolders.findCollectionFolders"}},"/collection-tag-breakdowns/{object_id}":{"get":{"summary":"Get CollectionTagBreakdown","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CollectionTagBreakdown"]}],"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"}}}}}}}},"operationId":"collectionTagBreakdowns.getCollectionTagBreakdown"}},"/collections":{"get":{"summary":"List Collections","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"collections.findCollections"},"post":{"summary":"Create Collection","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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},"ignoreSkippedResponses":{"type":"boolean","readOnly":false},"reviewAndSubmitEnabled":{"type":"boolean","readOnly":false},"saveAndResumeEnabled":{"type":"boolean","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"}}}}}}}},"operationId":"collections.createCollection"}},"/collections/{object_id}":{"get":{"summary":"Get Collection","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Collection"]},{"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"}}}}}}}},"operationId":"collections.getCollection"},"patch":{"summary":"Update Collection","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Collection"]}],"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"}}}}}}}},"operationId":"collections.updateCollection"},"delete":{"summary":"Delete Collection","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Collection"]}],"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"}}}}}}}},"operationId":"collections.deleteCollection"}},"/collections/{object_id}/relationships/folders":{"patch":{"summary":"Reorder Collection Folders","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Collection"]}],"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"}}}}}}}},"operationId":"collections.updateCollectionFolders"}},"/collections/{object_id}/relationships/items":{"patch":{"summary":"Reorder Collection Items","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Collection"]}],"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"}}}}}}}},"operationId":"collections.updateCollectionItems"}},"/content-embed-data":{"post":{"summary":"Create ContentEmbedDatum","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"contentEmbedDatas.createContentEmbedDatum"}},"/contents":{"post":{"summary":"Create Content","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"contents.createContent"}},"/contents/{object_id}":{"get":{"summary":"Get Content","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Content"]},{"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"}}}}}}}},"operationId":"contents.getContent"},"patch":{"summary":"Update Content","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Content"]}],"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"}}}}}}}},"operationId":"contents.updateContent"},"delete":{"summary":"Delete Content","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Content"]}],"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"}}}}}}}},"operationId":"contents.deleteContent"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Content"]}],"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"}}}}}}}},"operationId":"contents.addContentCollaboratingUsers"},"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Content"]}],"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"}}}}}}}},"operationId":"contents.removeContentCollaboratingUsers"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Content"]}],"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"}}}}}}}},"operationId":"contents.addContentCollaboratingUserGroups"},"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Content"]}],"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"}}}}}}}},"operationId":"contents.removeContentCollaboratingUserGroups"}},"/course-folders":{"post":{"summary":"Create CourseFolder","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courseFolders.createCourseFolder"},"get":{"summary":"List CourseFolders","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courseFolders.findCourseFolders"}},"/course-folders/{object_id}":{"get":{"summary":"Get CourseFolder","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseFolder"]},{"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"}}}}}}}},"operationId":"courseFolders.getCourseFolder"},"patch":{"summary":"Update CourseFolder","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseFolder"]}],"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"}}}}}}}},"operationId":"courseFolders.updateCourseFolder"},"delete":{"summary":"Delete CourseFolder","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseFolder"]}],"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"}}}}}}}},"operationId":"courseFolders.deleteCourseFolder"}},"/course-folders/{object_id}/relationships/items":{"patch":{"summary":"Update CourseFolder Items","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseFolder"]}],"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"}}}}}}}},"operationId":"courseFolders.updateCourseFolderItems"}},"/course-item-audio":{"post":{"summary":"Create CourseItemAudio","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courseItemAudio.createCourseItem"},"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"}}}}}}}},"operationId":"courseItemAudio.findCourseItems"}},"/course-item-audio/{object_id}":{"get":{"summary":"Get CourseItemAudio","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemAudio"]},{"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"}}}}}}}},"operationId":"courseItemAudio.getCourseItem"},"patch":{"summary":"Update CourseItemAudio","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemAudio"]}],"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"}}}}}}}},"operationId":"courseItemAudio.updateCourseItem"},"delete":{"summary":"Delete CourseItemAudio","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemAudio"]}],"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"}}}}}}}},"operationId":"courseItemAudio.deleteCourseItem"}},"/course-item-document":{"post":{"summary":"Create CourseItemDocument","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courseItemDocument.createCourseItem"},"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"}}}}}}}},"operationId":"courseItemDocument.findCourseItems"}},"/course-item-document/{object_id}":{"get":{"summary":"Get CourseItemDocument","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemDocument"]},{"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"}}}}}}}},"operationId":"courseItemDocument.getCourseItem"},"patch":{"summary":"Update CourseItemDocument","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemDocument"]}],"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"}}}}}}}},"operationId":"courseItemDocument.updateCourseItem"},"delete":{"summary":"Delete CourseItemDocument","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemDocument"]}],"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"}}}}}}}},"operationId":"courseItemDocument.deleteCourseItem"}},"/course-item-embed":{"post":{"summary":"Create CourseItemEmbed","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courseItemEmbed.createCourseItem"},"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"}}}}}}}},"operationId":"courseItemEmbed.findCourseItems"}},"/course-item-embed/{object_id}":{"get":{"summary":"Get CourseItemEmbed","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemEmbed"]},{"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"}}}}}}}},"operationId":"courseItemEmbed.getCourseItem"},"patch":{"summary":"Update CourseItemEmbed","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemEmbed"]}],"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"}}}}}}}},"operationId":"courseItemEmbed.updateCourseItem"},"delete":{"summary":"Delete CourseItemEmbed","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemEmbed"]}],"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"}}}}}}}},"operationId":"courseItemEmbed.deleteCourseItem"}},"/course-item-note":{"post":{"summary":"Create CourseItemNote","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courseItemNote.createCourseItem"},"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"}}}}}}}},"operationId":"courseItemNote.findCourseItems"}},"/course-item-note/{object_id}":{"get":{"summary":"Get CourseItemNote","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemNote"]},{"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"}}}}}}}},"operationId":"courseItemNote.getCourseItem"},"patch":{"summary":"Update CourseItemNote","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemNote"]}],"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"}}}}}}}},"operationId":"courseItemNote.updateCourseItem"},"delete":{"summary":"Delete CourseItemNote","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemNote"]}],"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"}}}}}}}},"operationId":"courseItemNote.deleteCourseItem"}},"/course-item-quiz":{"post":{"summary":"Create CourseItemQuiz","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courseItemQuiz.createCourseItem"},"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"}}}}}}}},"operationId":"courseItemQuiz.findCourseItems"}},"/course-item-quiz/{object_id}":{"get":{"summary":"Get CourseItemQuiz","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemQuiz"]},{"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"}}}}}}}},"operationId":"courseItemQuiz.getCourseItem"},"patch":{"summary":"Update CourseItemQuiz","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemQuiz"]}],"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"}}}}}}}},"operationId":"courseItemQuiz.updateCourseItem"},"delete":{"summary":"Delete CourseItemQuiz","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemQuiz"]}],"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"}}}}}}}},"operationId":"courseItemQuiz.deleteCourseItem"}},"/course-item-scorm":{"post":{"summary":"Create CourseItemScorm","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courseItemScorm.createCourseItem"},"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"}}}}}}}},"operationId":"courseItemScorm.findCourseItems"}},"/course-item-scorm/{object_id}":{"get":{"summary":"Get CourseItemScorm","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemScorm"]},{"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"}}}}}}}},"operationId":"courseItemScorm.getCourseItem"},"patch":{"summary":"Update CourseItemScorm","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemScorm"]}],"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"}}}}}}}},"operationId":"courseItemScorm.updateCourseItem"},"delete":{"summary":"Delete CourseItemScorm","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemScorm"]}],"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"}}}}}}}},"operationId":"courseItemScorm.deleteCourseItem"}},"/course-item-survey":{"post":{"summary":"Create CourseItemSurvey","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courseItemSurvey.createCourseItem"},"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"}}}}}}}},"operationId":"courseItemSurvey.findCourseItems"}},"/course-item-survey/{object_id}":{"get":{"summary":"Get CourseItemSurvey","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemSurvey"]},{"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"}}}}}}}},"operationId":"courseItemSurvey.getCourseItem"},"patch":{"summary":"Update CourseItemSurvey","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemSurvey"]}],"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"}}}}}}}},"operationId":"courseItemSurvey.updateCourseItem"},"delete":{"summary":"Delete CourseItemSurvey","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemSurvey"]}],"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"}}}}}}}},"operationId":"courseItemSurvey.deleteCourseItem"}},"/course-item-text-entry":{"post":{"summary":"Create CourseItemTextEntry","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courseItemTextEntry.createCourseItem"},"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"}}}}}}}},"operationId":"courseItemTextEntry.findCourseItems"}},"/course-item-text-entry/{object_id}":{"get":{"summary":"Get CourseItemTextEntry","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemTextEntry"]},{"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"}}}}}}}},"operationId":"courseItemTextEntry.getCourseItem"},"patch":{"summary":"Update CourseItemTextEntry","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemTextEntry"]}],"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"}}}}}}}},"operationId":"courseItemTextEntry.updateCourseItem"},"delete":{"summary":"Delete CourseItemTextEntry","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemTextEntry"]}],"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"}}}}}}}},"operationId":"courseItemTextEntry.deleteCourseItem"}},"/course-item-upload":{"post":{"summary":"Create CourseItemUpload","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courseItemUpload.createCourseItem"},"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"}}}}}}}},"operationId":"courseItemUpload.findCourseItems"}},"/course-item-upload/{object_id}":{"get":{"summary":"Get CourseItemUpload","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemUpload"]},{"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"}}}}}}}},"operationId":"courseItemUpload.getCourseItem"},"patch":{"summary":"Update CourseItemUpload","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemUpload"]}],"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"}}}}}}}},"operationId":"courseItemUpload.updateCourseItem"},"delete":{"summary":"Delete CourseItemUpload","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemUpload"]}],"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"}}}}}}}},"operationId":"courseItemUpload.deleteCourseItem"}},"/course-item-video":{"post":{"summary":"Create CourseItemVideo","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courseItemVideo.createCourseItem"},"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"}}}}}}}},"operationId":"courseItemVideo.findCourseItems"}},"/course-item-video/{object_id}":{"get":{"summary":"Get CourseItemVideo","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemVideo"]},{"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"}}}}}}}},"operationId":"courseItemVideo.getCourseItem"},"patch":{"summary":"Update CourseItemVideo","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemVideo"]}],"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"}}}}}}}},"operationId":"courseItemVideo.updateCourseItem"},"delete":{"summary":"Delete CourseItemVideo","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemVideo"]}],"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"}}}}}}}},"operationId":"courseItemVideo.deleteCourseItem"}},"/course-item-zip":{"post":{"summary":"Create CourseItemZip","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courseItemZip.createCourseItem"},"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"}}}}}}}},"operationId":"courseItemZip.findCourseItems"}},"/course-item-zip/{object_id}":{"get":{"summary":"Get CourseItemZip","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemZip"]},{"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"}}}}}}}},"operationId":"courseItemZip.getCourseItem"},"patch":{"summary":"Update CourseItemZip","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemZip"]}],"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"}}}}}}}},"operationId":"courseItemZip.updateCourseItem"},"delete":{"summary":"Delete CourseItemZip","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["CourseItemZip"]}],"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"}}}}}}}},"operationId":"courseItemZip.deleteCourseItem"}},"/course-items":{"get":{"summary":"List CourseItems","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courseItems.findCourseItems"}},"/course-items/operations":{"post":{"summary":"BETA: Atomically add many library items to a course","description":"BETA: JSON:API Atomic Operations extension. Send `atomic:operations` with `op: \"add\"` and a typed course item resource per operation, shaped as the matching `POST /v3/course-item-*` body. Text entry and upload items are not supported. Every operation must add to the same course. A request may carry up to 50 operations. 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}`. Results are returned in request order. Use the media type `application/vnd.api+json; ext=\"https://jsonapi.org/ext/atomic\"`.","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":50,"items":{"type":"object","required":["op","data"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["add"]},"data":{"oneOf":[{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}}]}}}}}}},"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":50,"items":{"type":"object","required":["op","data"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["add"]},"data":{"oneOf":[{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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"]}}}}}}}}},{"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":{"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/CourseItem"}}}}}}},"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/CourseItem"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"courseItemOperations.applyCourseItemOperations"}},"/courses":{"post":{"summary":"Create Course","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"courses.createCourse"}},"/courses/{object_id}":{"get":{"summary":"Get Course","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Course"]},{"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"}}}}}}}},"operationId":"courses.getCourse"},"patch":{"summary":"Update Course","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Course"]}],"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"}}}}}}}},"operationId":"courses.updateCourse"},"delete":{"summary":"Delete Course","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Course"]}],"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"}}}}}}}},"operationId":"courses.deleteCourse"}},"/courses/{object_id}/relationships/folders":{"patch":{"summary":"Reorder Course Folders","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Course"]}],"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"}}}}}}}},"operationId":"courses.updateCourseFolders"}},"/courses/{object_id}/relationships/items":{"patch":{"summary":"Reorder Course Items","tags":["Courses"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Course"]}],"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"}}}}}}}},"operationId":"courses.updateCourseItems"}},"/custom-insights":{"get":{"summary":"List CustomInsights","tags":["Insights"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"customInsights.findCustomInsights"}},"/documents":{"get":{"summary":"List Documents","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"document.findDocuments"}},"/email-verifications":{"post":{"summary":"Create EmailVerification","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"emailVerifications.createEmailVerification"}},"/email-verifications/{object_id}":{"patch":{"summary":"Update EmailVerification","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["EmailVerification"]}],"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"}}}}}}}},"operationId":"emailVerifications.acceptEmailVerification"}},"/emq-group-exports":{"post":{"summary":"Create EmqGroupExport","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"emqGroupExports.createEmqExport"}},"/emq-group-import-validations":{"post":{"summary":"Create EmqGroupImportValidation","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"emqGroupImportValidations.createEmqGroupImportValidation"}},"/emq-group-imports":{"post":{"summary":"Create EmqGroupImport","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"emqGroupImports.createEmqGroupImport"}},"/enriched-attempt-options":{"get":{"summary":"List EnrichedAttemptOptions","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"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"}}}}}}}},"operationId":"enrichedAttemptOptions.findEnrichedAttemptOptions"}},"/enriched-attempts":{"get":{"summary":"List EnrichedAttempts","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"portalId":{"type":"string"},"isArchived":{"type":"string","enum":["true","false","any"],"description":"Omit or any for archived and live attempts together, false for live attempts only, true for archived attempts only."},"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","subPortal","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"}}}}}}}},"operationId":"enrichedAttempts.findEnrichedAttempts"}},"/exam-attempt-headline-insights/{object_id}":{"get":{"summary":"Get ExamAttemptHeadlineInsight","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamAttemptHeadlineInsight"]},{"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"}}}}}}}},"operationId":"examAttemptHeadlineInsights.getExamAttemptHeadlineInsight"}},"/exam-candidate-exports":{"post":{"summary":"Create ExamCandidateExport","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":{"attemptIds":{"type":"array","items":{"type":"string"}},"filter":{"type":"object","properties":{"propertyFilters":{"type":"array","description":"Candidate attribute filters. Each attribute may appear only once.","items":{"type":"object","required":["attribute","value"],"properties":{"attribute":{"type":"string","pattern":"^filter\\.attr\\.[a-z0-9_-]+$"},"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"]}}}},"examStatus":{"type":"array","items":{"type":"string","enum":["enrolled","notified","preflight","started","submitted","revoked","expired","cancelled"]}},"markingStatus":{"type":"array","items":{"type":"string","enum":["notStarted","inProgress","readyToFinalise","finalised","completed"]}},"gradeStatus":{"type":"array","items":{"type":"string","enum":["passed","failed"]}},"proctorStatus":{"type":"array","items":{"type":"string","enum":["disabled","enabled","readyForReview","reviewNotRequired","autoApproved","inReview","passed","failed","error"]}},"resultStatus":{"type":"array","items":{"type":"string","enum":["pending","finalised","released"]}},"lockStatus":{"type":"array","items":{"type":"string","enum":["locked","unlocked","none"]}},"systemsCheckStatus":{"type":"array","items":{"type":"string","enum":["notRun","inProgress","passed","attention"]}},"subPortals":{"type":"array","items":{"type":"string"}},"testVersions":{"type":"array","items":{"type":"string"}},"isArchived":{"type":"boolean"},"isCompleted":{"type":"boolean"}}},"search":{"type":"string"}}},"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"}}}}}}}},"operationId":"examCandidateExport.createExamCandidateExport"}},"/exam-enrolments":{"post":{"summary":"Enrol candidates in an ExamWindow, or register them directly on an Exam","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"ExamEnrolment","enum":["ExamEnrolment"]},"attributes":{"type":"object","properties":{"issued":{"type":"integer","readOnly":true,"description":"Candidates issued a new attempt."},"alreadyIssued":{"type":"integer","readOnly":true,"description":"Candidates who already held an attempt in the window, or on the exam when registering directly."},"failedUserIds":{"type":"array","readOnly":true,"items":{"type":"string"},"description":"Candidates who could not be issued."}}},"relationships":{"type":"object","required":["examV2"],"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":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"examWindow":{"type":"object","description":"Omit to register candidates directly on an exam that allows it.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamWindow","enum":["ExamWindow"]}}}}},"users":{"type":"object","description":"Fewer than five are issued in the request; more are queued. Provide this or `userGroup`.","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"}]}}}}}},"userGroup":{"type":"object","description":"Every current member is queued for issue. Provide this or `users`.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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":{"200":{"description":"Issued","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamEnrolment"}}}}}},"202":{"description":"Queued; the BackgroundJob result has the same fields","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"]}]}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"examEnrolments.createExamEnrolment"}},"/exam-halls/{object_id}":{"get":{"summary":"Get ExamHall","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamHall"]},{"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"}}}}}}}},"operationId":"examHalls.getExamHall"}},"/exam-moderation-readiness-reports/{object_id}":{"get":{"summary":"Get ExamModerationReadinessReport","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamModerationReadinessReport"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamModerationReadinessReport"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"examModerationReadinessReports.getExamModerationReadinessReport"}},"/exam-previews":{"post":{"summary":"Create ExamPreview","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examPreviews.createExamPreview"}},"/exam-question-remarks":{"post":{"summary":"Create ExamQuestionRemark","description":"Re-marks every attempt on an exam version for one question, after that question was edited in place on the version (its credits, per-option credits or answer key). A question belongs to exactly one version, and a version's dynamic variants share its questions, so the call covers that version and its variants and no other. Completed attempts are re-marked from the question as it stands now, re-totalled, and their score and grade recomputed whatever their results state; a certificate is reissued only where the outcome moved and the marks are final, and a short results-updated notice only on request (`notifyCandidates`) for a released candidate whose marks or outcome moved. Attempts not yet started have their responses refreshed so submission marks against the edited question; attempts being sat are left alone and reported. An administrator's per-attempt override keeps its credit and only its maximum moves; a max-points override is never cleared. Attempt and results webhooks, LTI outcomes and insights are not re-fired; a reissued certificate raises the certificate-generated webhook as any issue does. With `dryRun` the call reports what it would touch (`meta.preview`) and writes nothing; otherwise it queues a background job without walking the version first, returned as `relationships.backgroundJob`, whose `result` lists what happened per attempt bucket, which attempts failed and which certificates could not be reissued. Re-running is safe: a second run over the same definition changes nothing. Requires the override-marking grant on the exam; the attempts it touches are further limited to those the caller may override. Not available (501) unless post-submission attempt management is enabled for the portal. `POST /v3/attempt-markings` remains for the internal lambda.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"ExamQuestionRemark","enum":["ExamQuestionRemark"]},"attributes":{"type":"object","properties":{"dryRun":{"type":"boolean","default":false,"description":"Report what the run would touch (see `meta.preview`) and write nothing; answered with 200 and no background job."},"notifyCandidates":{"type":"boolean","default":false,"description":"Email each released candidate whose marks or outcome moved a short notice that their results were updated, with a link and no marks; the exam’s results-email setting and hidden-results page still apply."}}},"relationships":{"type":"object","required":["exam","question"],"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"]}}}}},"question":{"type":"object","description":"The question as edited on the version; it names the version, so one call covers that version and its variants and no other.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Question","enum":["Question"]}}}}}}}}}}}}}},"responses":{"200":{"description":"OK: a dry run, nothing written and no job queued","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamQuestionRemark"},"meta":{"type":"object","properties":{"sideEffects":{"type":"object","description":"What the run does beyond the marks.","properties":{"certificates":{"type":"string"},"notifications":{"type":"string"},"notReFired":{"type":"array","items":{"type":"string"}}}},"preview":{"type":"object","description":"What the run finds on the version, before anything is written. Present on a dry run only; a queued run reports in its job result.","required":["attempts","responses"],"properties":{"attempts":{"type":"object","properties":{"notStarted":{"type":"integer","description":"Pre-generated attempts the candidate has not started; their responses and denominators are refreshed so submission marks against the edited question."},"inProgress":{"type":"integer","description":"Attempts being sat; left alone and reported. Run again once the exam has closed."},"pending":{"type":"integer","description":"Completed attempts whose result is still pending."},"finalised":{"type":"integer","description":"Completed attempts with a finalised result."},"released":{"type":"integer","description":"Completed attempts whose result has been released."},"noAccess":{"type":"integer","description":"Attempts on the version the caller may not override; left alone."},"total":{"type":"integer","description":"Every attempt on the version and its variants, previews and invalidated attempts excluded."}}},"responses":{"type":"object","description":"Among the completed attempts, the responses to the question.","properties":{"total":{"type":"integer","description":"Responses to the question."},"completed":{"type":"integer","description":"Of which answered."},"overridden":{"type":"integer","description":"Carrying an administrator’s per-attempt override; the override’s credit is kept and only the maximum moves."},"maxPointsOverridden":{"type":"integer","description":"Carrying a max-points override, which outranks the re-derived maximum and is never cleared."},"customMarking":{"type":"integer","description":"Under custom marking; left with their marker."},"pendingManual":{"type":"integer","description":"Answered but awaiting a manual mark; only their maximum moves."}}}}}}}}}}}},"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamQuestionRemark"},"meta":{"type":"object","properties":{"sideEffects":{"type":"object","description":"What the run does beyond the marks.","properties":{"certificates":{"type":"string"},"notifications":{"type":"string"},"notReFired":{"type":"array","items":{"type":"string"}}}},"preview":{"type":"object","description":"What the run finds on the version, before anything is written. Present on a dry run only; a queued run reports in its job result.","required":["attempts","responses"],"properties":{"attempts":{"type":"object","properties":{"notStarted":{"type":"integer","description":"Pre-generated attempts the candidate has not started; their responses and denominators are refreshed so submission marks against the edited question."},"inProgress":{"type":"integer","description":"Attempts being sat; left alone and reported. Run again once the exam has closed."},"pending":{"type":"integer","description":"Completed attempts whose result is still pending."},"finalised":{"type":"integer","description":"Completed attempts with a finalised result."},"released":{"type":"integer","description":"Completed attempts whose result has been released."},"noAccess":{"type":"integer","description":"Attempts on the version the caller may not override; left alone."},"total":{"type":"integer","description":"Every attempt on the version and its variants, previews and invalidated attempts excluded."}}},"responses":{"type":"object","description":"Among the completed attempts, the responses to the question.","properties":{"total":{"type":"integer","description":"Responses to the question."},"completed":{"type":"integer","description":"Of which answered."},"overridden":{"type":"integer","description":"Carrying an administrator’s per-attempt override; the override’s credit is kept and only the maximum moves."},"maxPointsOverridden":{"type":"integer","description":"Carrying a max-points override, which outranks the re-derived maximum and is never cleared."},"customMarking":{"type":"integer","description":"Under custom marking; left with their marker."},"pendingManual":{"type":"integer","description":"Answered but awaiting a manual mark; only their maximum moves."}}}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}},"501":{"description":"Not enabled for this portal","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"operationId":"examQuestionRemarks.createExamQuestionRemark"}},"/exam-question-stats":{"get":{"summary":"List ExamQuestionStats","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","maxItems":50,"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"}}}}}}}},"operationId":"examQuestionStats.findExamQuestionStats"}},"/exam-question-stats-exports":{"post":{"summary":"Create ExamQuestionStatsExport","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","maxItems":50,"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"}}}}}}}},"operationId":"examQuestionStatsExport.createExamQuestionStatsExport"}},"/exam-stats":{"get":{"summary":"Get ExamStats","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","maxItems":50,"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"}}}}}}}},"operationId":"examStats.findExamStats"}},"/exam-tag-stats-exports":{"post":{"summary":"Create ExamTagStatsExport","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"ExamTagStatsExport","enum":["ExamTagStatsExport"]},"attributes":{"type":"object","properties":{"examId":{"type":"string"},"version":{"type":"string","pattern":"^[0-9]+$"},"versions":{"type":"array","maxItems":50,"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/ExamTagStatsExport"}}}}}},"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"}}}}}}}},"operationId":"examTagStatsExport.createExamTagStatsExport"}},"/exam-template-sections":{"post":{"summary":"Create ExamTemplateSection","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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},"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},"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"}}}}}}}},"operationId":"examTemplateSections.createExamTemplateSection"},"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"}}}}}}}},"operationId":"examTemplateSections.findExamTemplateSections"}},"/exam-template-sections/{object_id}":{"get":{"summary":"Get ExamTemplateSection","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplateSection"]}],"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"}}}}}}}},"operationId":"examTemplateSections.getExamTemplateSection"},"patch":{"summary":"Update ExamTemplateSection","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplateSection"]}],"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"}}}}}}}},"operationId":"examTemplateSections.updateExamTemplateSection"},"delete":{"summary":"Delete ExamTemplateSection","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplateSection"]}],"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"}}}}}}}},"operationId":"examTemplateSections.deleteExamTemplateSection"}},"/exam-templates":{"post":{"summary":"Create ExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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},"isArchived":{"type":"boolean","readOnly":true},"dynamicIsSectioned":{"type":"boolean","nullable":true},"dynamicFiltersWeightingType":{"type":"string","enum":["absolute","percentage",null],"nullable":true},"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}}}}]}]}}}}},"lockedByDefault":{"type":"boolean","nullable":true},"lockedByDefaultScope":{"type":"string","enum":["allAttempts","excludeResits"],"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},"markingShowAllMarkerFeedback":{"type":"boolean","nullable":true},"markingProvisionalMarkerAllocation":{"type":"string","nullable":true},"markingModeratingMarkerAllocation":{"type":"string","nullable":true},"markingEscalationMarkerAllocation":{"type":"string","nullable":true},"markingProvisionalMarkerGranularity":{"type":"string","nullable":true},"markingModeratingMarkerGranularity":{"type":"string","nullable":true},"markingEscalationMarkerGranularity":{"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},"resitCloseMode":{"type":"string","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},"proctorRequireSecondCamera":{"type":"boolean","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},"proctorLiveAiDetection":{"type":"boolean","nullable":true},"proctorAiPrompts":{"type":"array","nullable":true,"maxItems":12,"items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true},"enabled":{"type":"boolean","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},"proctorRoomScanCoverage":{"type":"string","enum":["off","workspace","full",null],"nullable":true},"proctorRoomScanDevice":{"type":"string","enum":["phone","webcam","either",null],"nullable":true},"identityCheckRequired":{"type":"boolean","nullable":true},"identityCheckFailureAction":{"type":"string","enum":["flag","block",null],"nullable":true},"identityCheckVendor":{"type":"string","enum":["stripe","entrust","internal",null],"nullable":true},"identityCheckAutomaticFaceMatch":{"type":"boolean","nullable":true},"identityCheckNameComparison":{"type":"boolean","nullable":true},"identityCheckNameAction":{"type":"string","enum":["record","flag","block",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"}}}}}}}},"operationId":"examTemplates.createExamTemplate"},"get":{"summary":"List ExamTemplates","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"subPortal":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}],"description":"Sub-portal id, or several. An empty string matches root portal templates."},"owner":{"type":"string"},"isDynamic":{"type":"string","enum":["true","false"]},"isArchived":{"type":"string","enum":["true","false","any"],"description":"Omit or false for live templates only, true for archived templates only, any for both."}}}},{"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"}}}}}}}},"operationId":"examTemplates.findExamTemplates"}},"/exam-templates/{object_id}":{"get":{"summary":"Get ExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplate"]},{"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"}}}}}}}},"operationId":"examTemplates.getExamTemplate"},"patch":{"summary":"Update ExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplate"]}],"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"}}}}}}}},"operationId":"examTemplates.updateExamTemplate"},"delete":{"summary":"Delete ExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplate"]}],"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"}}}}}}}},"operationId":"examTemplates.deleteExamTemplate"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplate"]}],"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"}}}}}}}},"operationId":"examTemplates.addCollaboratingUsers"},"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplate"]}],"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"}}}}}}}},"operationId":"examTemplates.removeCollaboratingUsers"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplate"]}],"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"}}}}}}}},"operationId":"examTemplates.addCollaboratingUserGroups"},"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplate"]}],"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"}}}}}}}},"operationId":"examTemplates.removeCollaboratingUserGroups"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplate"]}],"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"}}}}}}}},"operationId":"examTemplates.updateExamTemplateSections"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplate"]}],"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"}}}}}}}},"operationId":"examTemplates.setMarkers"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplate"]}],"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"}}}}}}}},"operationId":"examTemplates.setModeratingMarkers"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplate"]}],"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"}}}}}}}},"operationId":"examTemplates.setEscalatingMarkers"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplate"]}],"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"}}}}}}}},"operationId":"examTemplates.setBackReadingMarkers"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamTemplate"]}],"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"}}}}}}}},"operationId":"examTemplates.setAuditingMarkers"}},"/exam-v-2s":{"post":{"summary":"Create ExamV2","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"},"markingShowAllMarkerFeedback":{"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},"markingModeratingMarkerGranularity":{"type":"string","enum":["attempt","question"],"nullable":true},"markingProvisionalMarkerGranularity":{"type":"string","enum":["attempt","question"],"nullable":true},"markingEscalationMarkerGranularity":{"type":"string","enum":["attempt","question"],"nullable":true},"ipAllowList":{"type":"array","readOnly":false,"nullable":true,"minItems":1,"items":{"type":"string"}},"lockedByDefault":{"type":"boolean","readOnly":false,"nullable":true},"lockedByDefaultScope":{"type":"string","enum":["allAttempts","excludeResits"],"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":"array","readOnly":false,"nullable":true,"description":"Corroborating details a per-attempt login code asks for. Empty means none. Ignored when codeLoginSharedCode is on.","items":{"type":"string","enum":["surname","externalId"]}},"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."},"candidateSource":{"type":"string","readOnly":false,"nullable":false,"enum":["defaultGroup","examWindows"],"description":"Where candidates come from. defaultGroup (the default when unset) issues an attempt to every member of the user group on publish; examWindows issues nothing on publish and leaves enrolment to Exam Windows. Can only be changed while the exam has no attempts."},"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"}}}}}}}},"operationId":"examV2s.createExamV2"},"get":{"summary":"Find ExamV2s","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examV2s.findExamV2s"}},"/exam-v-2s/{object_id}":{"get":{"summary":"Get ExamV2","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]},{"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"}},"meta":{"type":"object","properties":{"isSummary":{"type":"boolean","description":"Set when the caller can read the exam’s summary but not its content, so it comes without its content or version relationships."}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"examV2s.getExamV2"},"patch":{"summary":"Update ExamV2","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"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"},"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"}}}}}}}},"operationId":"examV2s.updateExamV2"},"delete":{"summary":"Delete ExamV2","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"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"}}}}}}}},"operationId":"examV2s.deleteExamV2"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"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"}}}}}}}},"operationId":"examV2s.addExamV2CollaboratingUsers"},"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"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"}}}}}}}},"operationId":"examV2s.removeExamV2CollaboratingUsers"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"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"}}}}}}}},"operationId":"examV2s.addExamV2CollaboratingUserGroups"},"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"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"}}}}}}}},"operationId":"examV2s.removeExamV2CollaboratingUserGroups"}},"/exam-v-2s/{object_id}/markers":{"post":{"summary":"Create Internal Markers Group","tags":["Exams"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examV2s.createMarkers"}},"/exam-v-2s/{object_id}/relationships/markers":{"patch":{"summary":"Set Shared Markers Group","tags":["Exams"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examV2s.setMarkers"}},"/exam-v-2s/{object_id}/moderating-markers":{"post":{"summary":"Create Internal Moderating Markers Group","tags":["Exams"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examV2s.createModeratingMarkers"}},"/exam-v-2s/{object_id}/relationships/moderating-markers":{"patch":{"summary":"Set Shared Moderating Markers Group","tags":["Exams"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examV2s.setModeratingMarkers"}},"/exam-v-2s/{object_id}/relationships/escalating-markers":{"patch":{"summary":"Set Shared Escalating Markers Group","tags":["Exams"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examV2s.setEscalatingMarkers"}},"/exam-v-2s/{object_id}/relationships/auditing-markers":{"patch":{"summary":"Set Shared Auditing Markers Group","tags":["Exams"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examV2s.setAuditingMarkers"}},"/exam-v-2s/{object_id}/escalating-markers":{"post":{"summary":"Create Internal Escalating Markers Group","tags":["Exams"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examV2s.createEscalatingMarkers"}},"/exam-v-2s/{object_id}/auditing-markers":{"post":{"summary":"Create Internal Auditing Markers Group","tags":["Exams"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examV2s.createAuditingMarkers"}},"/exam-v-2s/{object_id}/back-reading-markers":{"post":{"summary":"Create Internal BackReading Markers Group","tags":["Exams"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examV2s.createBackReadingMarkers"}},"/exam-v-2s/{object_id}/relationships/back-reading-markers":{"patch":{"summary":"Set Shared BackReading Markers Group","tags":["Exams"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examV2s.setBackreadingMarkers"}},"/exam-v-2s/{object_id}/relationships/sections":{"patch":{"summary":"Update Exam Section","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"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"}}}}}}}},"operationId":"examV2s.updateExamSections"}},"/exam-v-2s/{object_id}/current-version":{"post":{"summary":"Creates a new draft version of the underlying quiz","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"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},"ignoreSkippedResponses":{"type":"boolean","readOnly":false},"reviewAndSubmitEnabled":{"type":"boolean","readOnly":false},"saveAndResumeEnabled":{"type":"boolean","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","failedSectionsOnly",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},"resitCloseMode":{"type":"string","enum":["sameAsExam","sameAsPreviousAttempt","delay"],"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":["rosalyn","synopticV2",null],"nullable":true},"proctorRequireSecondCamera":{"type":"boolean","readOnly":false,"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},"proctorLiveAiDetection":{"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,"maxItems":12,"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},"enabled":{"type":"boolean","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]},"proctorRoomScanCoverage":{"type":"string","enum":["off","workspace","full",null],"nullable":true},"proctorRoomScanDevice":{"type":"string","enum":["phone","webcam","either",null],"nullable":true},"identityCheckRequired":{"type":"boolean","readOnly":false,"nullable":false},"identityCheckFailureAction":{"type":"string","enum":["flag","block",null],"readOnly":false,"nullable":true},"identityCheckVendor":{"type":"string","enum":["stripe","entrust","internal",null],"readOnly":false,"nullable":true},"identityCheckAutomaticFaceMatch":{"type":"boolean","readOnly":false,"nullable":true,"description":"Internal identity checks only: compare the face on the ID with the candidate's photo automatically, instead of leaving every check for review."},"identityCheckNameComparison":{"type":"boolean","readOnly":false,"nullable":true,"description":"Internal identity checks only: compare the candidate's account name with the name on their ID automatically. Off unless set."},"identityCheckNameAction":{"type":"string","enum":["record","flag","block",null],"readOnly":false,"nullable":true,"description":"Internal identity checks only: what happens when the candidate's account name is not found on their ID. Defaults to flag."},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"examV2s.createNewVersion"}},"/exam-v-2s/{object_id}/relationships/current-version":{"patch":{"summary":"Discards the current draft quiz and replaces it with the latest published version.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"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"}}}}}}}},"operationId":"examV2s.discardDraftVersion"}},"/exam-v-2s/{object_id}/relationships/published-version":{"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"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"}}}}}}}},"operationId":"examV2s.publishVersion"}},"/exam-v-2s/{object_id}/currentVersion":{"post":{"summary":"Creates a new draft version of the underlying quiz","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"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},"ignoreSkippedResponses":{"type":"boolean","readOnly":false},"reviewAndSubmitEnabled":{"type":"boolean","readOnly":false},"saveAndResumeEnabled":{"type":"boolean","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","failedSectionsOnly",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},"resitCloseMode":{"type":"string","enum":["sameAsExam","sameAsPreviousAttempt","delay"],"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":["rosalyn","synopticV2",null],"nullable":true},"proctorRequireSecondCamera":{"type":"boolean","readOnly":false,"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},"proctorLiveAiDetection":{"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,"maxItems":12,"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},"enabled":{"type":"boolean","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]},"proctorRoomScanCoverage":{"type":"string","enum":["off","workspace","full",null],"nullable":true},"proctorRoomScanDevice":{"type":"string","enum":["phone","webcam","either",null],"nullable":true},"identityCheckRequired":{"type":"boolean","readOnly":false,"nullable":false},"identityCheckFailureAction":{"type":"string","enum":["flag","block",null],"readOnly":false,"nullable":true},"identityCheckVendor":{"type":"string","enum":["stripe","entrust","internal",null],"readOnly":false,"nullable":true},"identityCheckAutomaticFaceMatch":{"type":"boolean","readOnly":false,"nullable":true,"description":"Internal identity checks only: compare the face on the ID with the candidate's photo automatically, instead of leaving every check for review."},"identityCheckNameComparison":{"type":"boolean","readOnly":false,"nullable":true,"description":"Internal identity checks only: compare the candidate's account name with the name on their ID automatically. Off unless set."},"identityCheckNameAction":{"type":"string","enum":["record","flag","block",null],"readOnly":false,"nullable":true,"description":"Internal identity checks only: what happens when the candidate's account name is not found on their ID. Defaults to flag."},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"deprecated":true,"operationId":"examV2s.createNewVersionDeprecated"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"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"}}}}}}}},"deprecated":true,"operationId":"examV2s.discardDraftVersionDeprecated"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Exam-V-2"]}],"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"}}}}}}}},"deprecated":true,"operationId":"examV2s.publishVersionDeprecated"}},"/exam-voucher-batch-jobs":{"post":{"summary":"Create ExamVoucherBatchJob","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examVoucherBatchJobs.createExamVoucherBatchJob"}},"/exam-voucher-exports":{"post":{"summary":"Create ExamVoucherExport","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examVoucherExports.createExamVoucherExport"}},"/exam-vouchers":{"post":{"summary":"Create ExamVoucher","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examVouchers.createExamVoucher"},"get":{"summary":"List ExamVouchers","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examVouchers.findExamVouchers"}},"/exam-vouchers/{object_id}":{"get":{"summary":"Get ExamVoucher","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamVoucher"]},{"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"}}}}}}}},"operationId":"examVouchers.getExamVoucher"},"patch":{"summary":"Update ExamVoucher","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamVoucher"]}],"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"}}}}}}}},"operationId":"examVouchers.updateExamVoucher"},"delete":{"summary":"Delete ExamVoucher","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamVoucher"]}],"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"}}}}}}}},"operationId":"examVouchers.deleteExamVoucher"}},"/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"}}}}}}}},"operationId":"examVouchers.verifyCode"}},"/exam-window-publications":{"post":{"summary":"Publish an ExamWindow","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"ExamWindowPublication","enum":["ExamWindowPublication"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["examWindow"],"properties":{"examWindow":{"type":"object","description":"The draft window to publish.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamWindow","enum":["ExamWindow"]}}}}}}}}}}}}}},"responses":{"202":{"description":"Queued; the BackgroundJob result has the fields of an ExamEnrolment","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"]}]}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"description":"Takes the window out of draft and issues attempts to its selection, as an enrolment does. Cannot be undone.","operationId":"examWindowPublications.createExamWindowPublication"}},"/exam-windows":{"post":{"summary":"Create ExamWindow","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"ExamWindow","enum":["ExamWindow"]},"attributes":{"type":"object","required":["name","activateAt"],"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","minLength":1,"maxLength":255},"activateAt":{"type":"string","format":"date-time","description":"When candidates enrolled through this window may start. Independent of the selected test’s own dates."},"deactivateAt":{"type":"string","format":"date-time","nullable":true,"description":"Last start time for this window. Omit for no close."},"relativeCloseTimeInMs":{"type":"integer","minimum":1,"nullable":true,"description":"How long each candidate has once their attempt opens, in milliseconds. An attempt opens with the window, or on enrolment if that is later, and never closes after the window does. Omit for attempts that take the window’s dates."},"isArchived":{"type":"boolean","readOnly":true,"description":"An archived window accepts no new candidates. Existing attempts are unaffected."},"isCancelled":{"type":"boolean","readOnly":true,"description":"A cancelled window accepts no new candidates, and its attempts that have not started are cancelled. Attempts in progress can finish. Cancelling cannot be undone."},"isDraft":{"type":"boolean","readOnly":false,"description":"A draft issues no attempts until it is published through exam-window-publications. Defaults to true; false creates the window published."},"attemptCount":{"type":"integer","readOnly":true,"nullable":true,"description":"How many attempts the window has issued. Null when the caller can't read the exam's attempts."},"candidateCount":{"type":"integer","readOnly":true,"nullable":true,"description":"How many people the window has issued attempts to. Null when the caller can't read the exam's attempts."},"attemptCountsByStatus":{"type":"object","readOnly":true,"nullable":true,"description":"The window's attempts by exam status. Statuses with no attempts are left out. Null when the caller can't read the exam's attempts.","properties":{"enrolled":{"type":"integer"},"notified":{"type":"integer"},"preflight":{"type":"integer"},"started":{"type":"integer"},"submitted":{"type":"integer"},"revoked":{"type":"integer"},"expired":{"type":"integer"},"cancelled":{"type":"integer"}},"additionalProperties":false}}},"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"]}}}}},"test":{"type":"object","description":"The released exam version candidates will sit. Optional for a draft; publication uses the exam’s published version. Changing it after publication affects future enrolments only.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}},"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":"Sub-portal staff can only create windows in their own sub-portal. Root staff can choose any sub-portal, or omit it for a root window. It cannot change later.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}},"selectedUsers":{"type":"object","description":"Candidates picked for the draft, replaced whole on each save. Cleared when the window is published.","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"}]}}}}}},"selectedUserGroups":{"type":"object","description":"Groups picked for the draft, replaced whole on each save. Their members at publication are issued attempts, and the list is cleared.","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/ExamWindow"}}}}}},"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"}}}}}}}},"operationId":"examWindows.createExamWindow"},"get":{"summary":"List ExamWindows","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","required":["exam"],"properties":{"exam":{"type":"string"},"isArchived":{"type":"string","enum":["true","false","any"],"description":"Omit or false for live windows only, true for archived windows only, any for both."},"isDraft":{"type":"string","enum":["true","false"],"description":"true for draft windows only, false for published windows only. Omit for both."},"subPortals":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}],"description":"Windows in these sub-portals. An empty value matches windows on the root portal."},"search":{"type":"string","description":"Windows whose name contains this text, in any case, or whose ID is exactly this value."}}}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["createdAt","-createdAt","activateAt","-activateAt","deactivateAt","-deactivateAt"]}},{"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/ExamWindow"}},"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"}}}}}}}},"operationId":"examWindows.findExamWindows"}},"/exam-windows/{object_id}":{"get":{"summary":"Get ExamWindow","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamWindow"]},{"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/ExamWindow"},"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"}}}}}}}},"operationId":"examWindows.getExamWindow"},"patch":{"summary":"Update ExamWindow","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamWindow"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ExamWindow"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExamWindow"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"examWindows.updateExamWindow"},"delete":{"summary":"Delete ExamWindow","description":"Cancels the window and queues the deletion of its attempts and the window. Refused once any of the window's attempts has started.","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExamWindow"]}],"responses":{"202":{"description":"Queued; the BackgroundJob result says how many attempts were deleted","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"]}]}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"examWindows.deleteExamWindow"}},"/examinee-notifications":{"post":{"summary":"Create ExamineeNotification","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"examineeNotifications.createExamineeNotification"}},"/export-enriched-attempts":{"post":{"summary":"Create ExportEnrichedAttempt","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"},"attemptIds":{"type":"array","items":{"type":"string"}},"isArchived":{"type":"string","enum":["true","false","any"],"description":"Omit or any for archived and live attempts together, false for live attempts only, true for archived attempts only."},"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","subPortal","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","tagPerformance"]}},"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"}}}}}}}},"operationId":"exportEnrichedAttempts.createExportEnrichedAttempt"}},"/external-exam-sittings":{"post":{"summary":"Create ExternalExamSitting","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"externalExamSittings.createExternalExamSitting"},"get":{"summary":"List ExternalExamSittings","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"externalExamSittings.findExternalExamSittings"}},"/external-exam-sittings/{object_id}":{"patch":{"summary":"Update ExternalExamSitting","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExternalExamSitting"]}],"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"}}}}}}}},"operationId":"externalExamSittings.updateExternalExamSitting"}},"/external-proctor-session-results/{object_id}":{"get":{"summary":"Get ExternalProctorSessionResult","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ExternalProctorSessionResults"]}],"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"}}}}}}}},"operationId":"externalProctorSessionResults.getExternalProctorSessionResults"}},"/external-proctor-sessions":{"post":{"summary":"Create ExternalProctorSession","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"externalProctorSessions.createExternalProctorSession"}},"/facet-configs":{"post":{"summary":"Create FacetConfig","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"FacetConfig","enum":["FacetConfig"]},"attributes":{"type":"object","properties":{"label":{"type":"string","readOnly":true},"customLabel":{"type":"string","nullable":true,"maxLength":100,"description":"Custom display term for this facet. An empty value restores the default label."},"facet":{"type":"string","enum":["exam","module","subject","topic","subtopic","difficulty","skill","context"],"readOnly":false},"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"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FacetConfig"}}}}}},"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"}}}}}}}},"operationId":"facetConfigs.createFacetConfig"},"get":{"summary":"List FacetConfigs","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"facetConfigs.findFacetConfigs"}},"/facet-configs/{object_id}":{"patch":{"summary":"Update FacetConfig","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["FacetConfig"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FacetConfig"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FacetConfig"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"facetConfigs.updateFacetConfig"}},"/files":{"post":{"summary":"Create File","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"files.createFile"}},"/files/{object_id}":{"get":{"summary":"Get File","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["File"]}],"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"}}}}}}}},"operationId":"files.getFile"}},"/flag-exports":{"post":{"summary":"Create FlagExport","tags":["User Feedback"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"flagExports.createFlagExport"}},"/flags":{"post":{"summary":"Create Flag","tags":["User Feedback"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"flags.createFlag"},"get":{"summary":"List Flags","tags":["User Feedback"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"flags.findFlags"}},"/flags/{object_id}":{"get":{"summary":"Get Flag","tags":["User Feedback"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Flag"]},{"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"}}}}}}}},"operationId":"flags.getFlag"},"patch":{"summary":"Update Flag","tags":["User Feedback"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Flag"]}],"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"}}}}}}}},"operationId":"flags.updateFlag"}},"/generate-test-jobs":{"post":{"summary":"Create GenerateTestJob","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"generateTestJobs.createJob"}},"/generate-test-jobs/{object_id}":{"get":{"summary":"Get GenerateTestJob","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["GenerateTestJob"]}],"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"}}}}}}}},"operationId":"generateTestJobs.getJob"}},"/generated-accounts":{"post":{"summary":"Create GeneratedAccount","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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,"operationId":"generatedAccount.createGenerateUser"}},"/generated-tests":{"post":{"summary":"Create GeneratedTest","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"generatedTest.createQuiz"}},"/generic-notifications":{"post":{"summary":"Create GenericNotification","tags":["Notifications"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"genericNotifications.createGenericNotification"}},"/global-exam-templates":{"post":{"summary":"Create GlobalExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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},"lockedByDefaultScope":{"type":"string","enum":["allAttempts","excludeResits"],"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},"markingShowAllMarkerFeedback":{"type":"boolean","nullable":true},"markingProvisionalMarkerAllocation":{"type":"string","nullable":true},"markingModeratingMarkerAllocation":{"type":"string","nullable":true},"markingEscalationMarkerAllocation":{"type":"string","nullable":true},"markingProvisionalMarkerGranularity":{"type":"string","nullable":true},"markingModeratingMarkerGranularity":{"type":"string","nullable":true},"markingEscalationMarkerGranularity":{"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},"resitCloseMode":{"type":"string","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},"proctorRequireSecondCamera":{"type":"boolean","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},"proctorLiveAiDetection":{"type":"boolean","nullable":true},"proctorAiPrompts":{"type":"array","nullable":true,"maxItems":12,"items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true},"enabled":{"type":"boolean","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},"proctorRoomScanCoverage":{"type":"string","enum":["off","workspace","full",null],"nullable":true},"proctorRoomScanDevice":{"type":"string","enum":["phone","webcam","either",null],"nullable":true},"identityCheckRequired":{"type":"boolean","nullable":true},"identityCheckFailureAction":{"type":"string","enum":["flag","block",null],"nullable":true},"identityCheckVendor":{"type":"string","enum":["stripe","entrust","internal",null],"nullable":true},"identityCheckAutomaticFaceMatch":{"type":"boolean","nullable":true},"identityCheckNameComparison":{"type":"boolean","nullable":true},"identityCheckNameAction":{"type":"string","enum":["record","flag","block",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"}}}}}}}},"operationId":"globalExamTemplates.createGlobalExamTemplate"},"get":{"summary":"Get GlobalExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"globalExamTemplates.getGlobalExamTemplate"}},"/global-exam-templates/{object_id}":{"patch":{"summary":"Update GlobalExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["GlobalExamTemplate"]}],"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"}}}}}}}},"operationId":"globalExamTemplates.updateGlobalExamTemplate"},"delete":{"summary":"Delete GlobalExamTemplate","tags":["Exams"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["GlobalExamTemplate"]}],"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"}}}}}}}},"operationId":"globalExamTemplates.deleteGlobalExamTemplate"}},"/highlights":{"post":{"summary":"Create Highlight","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"highlights.createAnnotation"},"get":{"summary":"List Highlights","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"highlights.findAnnotations"}},"/highlights/{object_id}":{"get":{"summary":"Get Highlight","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Highlight"]}],"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"}}}}}}}},"operationId":"highlights.getAnnotation"},"patch":{"summary":"Update Highlight","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Highlight"]}],"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"}}}}}}}},"operationId":"highlights.updateAnnotation"},"delete":{"summary":"Delete Highlight","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Highlight"]}],"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"}}}}}}}},"operationId":"highlights.deleteAnnotation"}},"/ice-candidates/{object_id}":{"get":{"summary":"Get IceCandidate","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["IceCandidate"]}],"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"}}}}}}}},"operationId":"iceCandidates.getIceCandidate"}},"/identity-checks":{"post":{"summary":"Create IdentityCheck","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"IdentityCheck","enum":["IdentityCheck"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["created","processing","verified","failed","cancelled","awaiting_review"],"readOnly":true},"vendor":{"type":"string","enum":["stripe","entrust","internal"],"readOnly":true},"vendorSessionRef":{"type":"string","readOnly":true,"nullable":true,"description":"The vendor's reference for this check's session, which some vendors' capture flows need alongside the client secret."},"failureCode":{"type":"string","readOnly":true,"nullable":true},"attemptNumber":{"type":"integer","minimum":1,"readOnly":true},"attemptsUsed":{"type":"integer","minimum":0,"readOnly":true},"consentAt":{"type":"string","readOnly":true,"nullable":true},"submittedAt":{"type":"string","readOnly":true,"nullable":true},"checkedAt":{"type":"string","readOnly":true,"nullable":true},"redactAfter":{"type":"string","readOnly":true,"nullable":true},"redactedAt":{"type":"string","readOnly":true,"nullable":true},"consent":{"type":"boolean","writeOnly":true,"description":"Must be true on create: the candidate has explicitly agreed to their ID and selfie being processed."},"submitted":{"type":"boolean","writeOnly":true,"description":"Set true on update to reconcile the outcome with the vendor after the capture flow closes. Idempotent."},"clientSecret":{"type":"string","readOnly":true,"nullable":true,"description":"Vendor client secret for the capture flow. Only present on the create response; never stored or served again."},"documentImage":{"type":"string","writeOnly":true,"description":"Internal checks only: a JPEG or PNG photo of the candidate's ID, base64 encoded. Sent with faceImage on update, or on its own to the photo-checks route to screen just this photo."},"faceImage":{"type":"string","writeOnly":true,"description":"Internal checks only: a JPEG or PNG photo of the candidate's face, base64 encoded. Sent with documentImage on update, or on its own to the photo-checks route to screen just this photo."},"reviewOutcome":{"type":"string","enum":["verified","failed"],"writeOnly":true,"description":"Internal checks only: a reviewer's decision on the candidate's identity, which replaces the automatic outcome."},"captureIssues":{"type":"array","readOnly":true,"nullable":true,"items":{"type":"string","enum":["document_not_found","document_too_small","document_cut_off","document_face_not_found","document_text_not_readable","face_not_found","multiple_faces","face_obscured","too_far_from_camera","face_angle"]},"description":"Why the submitted photos could not be used. Only present on the update response that submitted them, and on a photo-checks response, where it lists the problems with that one photo."},"capturesRemaining":{"type":"integer","minimum":0,"readOnly":true,"nullable":true,"description":"Photo submissions left before an internal check fails. Null once the check has an outcome, and for vendor checks."},"faceMatchSimilarity":{"type":"number","minimum":0,"maximum":100,"readOnly":true,"nullable":true,"description":"How closely the face on the ID matched the candidate's photo, when the check compared them automatically."},"captureReport":{"type":"object","readOnly":true,"nullable":true,"description":"What the automatic checks found in the photos of an internal check, so a reviewer can sense-check them. Only served to reviewers.","properties":{"selfie":{"type":"object","required":["faceDetected","faceCount"],"properties":{"faceDetected":{"type":"boolean"},"faceCount":{"type":"integer","minimum":0},"faceHeight":{"type":"number","nullable":true,"description":"How tall the face is, as a fraction of the photo."},"covered":{"type":"boolean","nullable":true,"description":"Whether a mask, hand or dark sunglasses cover the face. Absent when the check was unsure."},"eyesOpen":{"type":"boolean","nullable":true,"description":"Whether the eyes are open. Absent when the check was unsure."},"yaw":{"type":"number","nullable":true,"description":"Degrees the head is turned to one side."},"pitch":{"type":"number","nullable":true,"description":"Degrees the head is tilted up or down."},"brightness":{"type":"number","nullable":true,"description":"How well lit the face is, from 0 to 100."},"sharpness":{"type":"number","nullable":true,"description":"How sharp the face is, from 0 to 100."}}},"document":{"type":"object","required":["detected","isIdentityDocument","portraitFound"],"properties":{"detected":{"type":"boolean"},"type":{"type":"string","nullable":true,"description":"What the document was recognised as, such as Driving License."},"typeConfidence":{"type":"number","nullable":true,"description":"How sure the check was of the type, from 0 to 100."},"isIdentityDocument":{"type":"boolean"},"wholeInFrame":{"type":"boolean","nullable":true,"description":"Whether the whole document is in the photo. Absent when it could not be placed."},"portraitFound":{"type":"boolean"},"portraitBrightness":{"type":"number","nullable":true,"description":"How well lit the photo on the document is, from 0 to 100."},"portraitSharpness":{"type":"number","nullable":true,"description":"How sharp the photo on the document is, from 0 to 100."},"wordCount":{"type":"integer","minimum":0,"nullable":true,"description":"How many words the check could read on the document. The text itself is never kept."},"nameOnDocument":{"type":"string","enum":["found","not_found","not_checked",null],"nullable":true,"description":"Whether the candidate's name appears in the text read from the document, or not_checked when the account holds no usable name or the text could not be read."}}}}},"history":{"type":"array","readOnly":true,"description":"Every settled outcome of an internal check, oldest first: the automatic result and each reviewer decision. Only served to reviewers.","items":{"type":"object","required":["source","status","at"],"properties":{"source":{"type":"string","enum":["automatic","reviewer"]},"status":{"type":"string","enum":["created","processing","verified","failed","cancelled","awaiting_review"]},"failureCode":{"type":"string","nullable":true},"faceMatchSimilarity":{"type":"number","minimum":0,"maximum":100,"nullable":true},"at":{"type":"string","format":"date-time"},"byUserId":{"type":"string","nullable":true}}}},"documentImageUrl":{"type":"string","readOnly":true,"nullable":true,"description":"A short-lived link to the ID photo of an internal check. Only served to reviewers, and never after redaction."},"faceImageUrl":{"type":"string","readOnly":true,"nullable":true,"description":"A short-lived link to the face photo of an internal check. Only served to reviewers, and never after redaction."},"reviewedAt":{"type":"string","readOnly":true,"nullable":true}},"required":["consent"]},"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"]}}}}},"reviewedBy":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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/IdentityCheck"}}}}}},"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"}}}}}}}},"operationId":"identityChecks.createIdentityCheck"},"get":{"summary":"Find IdentityCheck","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"attempt":{"type":"string"}},"required":["attempt"]}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdentityCheck"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}},"operationId":"identityChecks.findIdentityChecks"}},"/identity-checks/{object_id}":{"patch":{"summary":"Update IdentityCheck","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["IdentityCheck"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IdentityCheck"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdentityCheck"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"identityChecks.updateIdentityCheck"},"get":{"summary":"Get IdentityCheck","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["IdentityCheck"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdentityCheck"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"identityChecks.getIdentityCheck"}},"/identity-checks/{object_id}/photo-checks":{"post":{"summary":"Check an IdentityCheck photo","description":"Internal checks only: screens one photo, sent as either documentImage or faceImage, and returns captureIssues for it. The photo is not stored. Each call uses one of a limited number of photo checks per IdentityCheck, separate from the capture allowance.","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["IdentityCheck"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IdentityCheck"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdentityCheck"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"identityChecks.checkIdentityCheckPhoto"}},"/insights-tag-breakdowns":{"get":{"summary":"List InsightsTagBreakdowns","tags":["Insights"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"integer","minimum":1,"maximum":366,"description":"Ceiling shown is for daily units; the per-unit maxima (days 366, weeks 104, months 36, years 10) live in TimeFrame.MAX_AMOUNT."},"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","maxItems":50,"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"}}}}}}}},"operationId":"insightsTagBreakdown.findInsightsTagBreakdown"}},"/insights-tag-distributions":{"get":{"summary":"List InsightsTagDistributions","tags":["Insights"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","description":"One score distribution per value of the requested facet, across the cohort and time frame.","required":["cohort","targetId","timeFrameUnit","timeFrameAmount","facet"],"properties":{"cohort":{"type":"string","enum":["userGroup"],"description":"Only userGroup is supported: the portal view carries no userId and a single user has no distribution."},"targetId":{"type":"string"},"timeFrameUnit":{"type":"string","enum":["days","weeks","months","years"]},"timeFrameAmount":{"type":"integer","minimum":1,"maximum":366,"description":"Ceiling shown is for daily units; the per-unit maxima (days 366, weeks 104, months 36, years 10) live in TimeFrame.MAX_AMOUNT."},"facet":{"type":"string","enum":["subject","topic","subtopic","skill","difficulty"],"description":"The facet whose values the distributions are for."},"tagSetId":{"type":"string","nullable":true},"tagBreakdowns":{"type":"array","items":{"type":"string","enum":["subject","topic","subtopic","skill","difficulty"]},"description":"Extra facets to split each score by before the distribution is taken. Without them a student contributes one score per time period per facet value; pass the facets the equivalent insights-tag-breakdowns request used to reproduce its numbers exactly."}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InsightsTagDistribution"}},"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"}}}}}}}},"operationId":"insightsTagDistribution.findInsightsTagDistributions"}},"/integrations":{"post":{"summary":"Create Integration","tags":["Integrations"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"integrations.createIntegration"}},"/integrations/{object_id}":{"get":{"summary":"Get Integration","tags":["Integrations"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Integration"]}],"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"}}}}}}}},"operationId":"integrations.getIntegration"},"patch":{"summary":"Update Integration","tags":["Integrations"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Integration"]}],"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"}}}}}}}},"operationId":"integrations.updateIntegration"},"delete":{"summary":"Delete Integration","tags":["Integrations"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Integration"]}],"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"}}}}}}}},"operationId":"integrations.deleteIntegration"}},"/invite-exports":{"post":{"summary":"Create InviteExport","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"inviteExports.createInviteExport"}},"/invites":{"get":{"summary":"List Invites","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"invites.findInvites"}},"/invites/{object_id}":{"get":{"summary":"Get Invite","tags":["Users"],"security":[],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Invite"]}],"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"}}}}}}}},"operationId":"invites.getInvite"},"patch":{"summary":"Update Invite","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Invite"]}],"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"}}}}}}}},"operationId":"invites.updateInvite"}},"/learning-record-exports":{"post":{"summary":"Create LearningRecordExport","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"learningRecordExport.createLearningRecordExport"}},"/learning-records":{"post":{"summary":"Create LearningRecord","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"learningRecords.createLearningRecord"},"get":{"summary":"List LearningRecords","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"learningRecords.findLearningRecords"}},"/learning-records/{object_id}":{"get":{"summary":"Get LearningRecord","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["LearningRecord"]}],"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"}}}}}}}},"operationId":"learningRecords.getLearningRecord"},"patch":{"summary":"Update LearningRecord","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["LearningRecord"]}],"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"}}}}}}}},"operationId":"learningRecords.updateLearningRecord"},"delete":{"summary":"Delete LearningRecord","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["LearningRecord"]}],"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"}}}}}}}},"operationId":"learningRecords.deleteLearningRecord"}},"/legacy-access-upgrade-options":{"get":{"summary":"List LegacyAccessUpgradeOptions","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"legacyAccessUpgradeOption.findLegacyAccessUpgradeOptions"}},"/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"}}}}}}}},"operationId":"loginQrCodes.getAppLoginQrCode"}},"/manage-billing-sessions":{"post":{"summary":"Create ManageBillingSession","tags":["Billing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"manageBillingSessions.createManageBillingSession"}},"/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"}}}}}}}},"operationId":"marketingConsents.createMarketingConsent"}},"/marketing-consents/{object_id}":{"delete":{"summary":"Delete MarketingConsent","tags":["Users"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MarketingConsent"]}],"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"}}}}}}}},"operationId":"marketingConsents.deleteMarketingConsent"}},"/marking-entries":{"post":{"summary":"Create MarkingEntry","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","properties":{"slug":{"type":"string","nullable":false},"label":{"type":"string"},"maxCredits":{"type":"number","minimum":0},"description":{"type":"string","nullable":true}}},"minItems":1,"maxItems":25,"readOnly":false},"rubricMarks":{"type":"object","readOnly":false,"nullable":true},"maxPoints":{"type":"number","description":"Writable only with `relationships.supersedes`, where it changes what the response is worth as well as what this entry was marked against; `null` clears that change. A rubric override takes its total from `rubricAreas`, so it may only repeat it here. Zero is refused here — use `response-max-points-overrides` to take a response out of scoring.","minimum":0,"nullable":true,"readOnly":false},"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","adminMarked","superseded"],"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},"collision":{"type":"object","description":"Present when entries of the same role tied on this response, listing the colliding entries the reader can see. The entry with `final: true` sourced the mark.","properties":{"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"markingEntryIds":{"type":"array","items":{"type":"string"}}},"required":["role","markingEntryIds"],"readOnly":true},"timeMarked":{"type":"string","readOnly":true},"final":{"type":"boolean","readOnly":true},"selectedAsFinal":{"type":"boolean","description":"True when an administrator chose this entry as the source of the response final mark. Writable on its own: sending it with any other attribute is rejected.","readOnly":false},"selectedAt":{"type":"string","description":"When this entry was chosen as the source mark.","readOnly":true},"candidateFeedback":{"type":"string","readOnly":false,"nullable":true},"notifyCandidate":{"type":"boolean","writeOnly":true,"description":"Override only (with `relationships.supersedes`). Off unless `true`. Email the candidate a short notice that their results were updated, with a link and no marks. Sent only for a released result once marking is final; the exam’s results-email setting and hidden-results page still apply. See `meta.notification`."},"notes":{"type":"string","readOnly":false,"nullable":true},"marksWithheld":{"type":"boolean","description":"True when this entry's marks belong to another marker and are not yet submitted.","readOnly":true}}},"relationships":{"type":"object","properties":{"supersedes":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingEntry","enum":["MarkingEntry"]}}}}},"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"]}}}}},"selectedBy":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"},"meta":{"type":"object","properties":{"certificate":{"type":"object","required":["action"],"properties":{"action":{"type":"string","enum":["unchanged","reissued","notIssued","deferred","failed"]},"certificateId":{"type":"string"},"reason":{"type":"string"}}},"notification":{"type":"object","required":["action"],"description":"The candidate email this write asked for. `requested` means it was handed to the notification queue after the exam’s own rules passed; it confirms neither that an email was queued nor that one was sent.","properties":{"action":{"type":"string","enum":["requested","skipped","failed"]},"reason":{"type":"string","description":"Why it was skipped (notRequested, outcomeUnchanged, notReleased, marksNotFinal, notExam, resultsEmailDisabled, resultsHidden) or failed."}}},"maxPoints":{"type":"object","description":"What the response is now worth, which is not always what was asked for. Present whenever the override named a ceiling or moved one, so a request that asked is answered even when the answer is that nothing changed. Absent, rather than a guess at what was asked for, on the rare occasion the resulting value cannot be read back.","required":["responseId","previousMaxPoints","maxPoints"],"properties":{"responseId":{"type":"string"},"previousMaxPoints":{"type":"number","nullable":true},"maxPoints":{"type":"number","nullable":true}}}}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"meta":{"type":"object","properties":{"certificate":{"type":"object","required":["action"],"properties":{"action":{"type":"string","enum":["unchanged","reissued","notIssued","deferred","failed"]},"certificateId":{"type":"string"},"reason":{"type":"string"}}},"notification":{"type":"object","required":["action"],"description":"The candidate email this write asked for. `requested` means it was handed to the notification queue after the exam’s own rules passed; it confirms neither that an email was queued nor that one was sent.","properties":{"action":{"type":"string","enum":["requested","skipped","failed"]},"reason":{"type":"string","description":"Why it was skipped (notRequested, outcomeUnchanged, notReleased, marksNotFinal, notExam, resultsEmailDisabled, resultsHidden) or failed."}}},"maxPoints":{"type":"object","description":"What the response is now worth, which is not always what was asked for. Present whenever the override named a ceiling or moved one, so a request that asked is answered even when the answer is that nothing changed. Absent, rather than a guess at what was asked for, on the rare occasion the resulting value cannot be read back.","required":["responseId","previousMaxPoints","maxPoints"],"properties":{"responseId":{"type":"string"},"previousMaxPoints":{"type":"number","nullable":true},"maxPoints":{"type":"number","nullable":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"}}}}}}},"409":{"description":"Conflict","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"operationId":"markingEntries.createMarkingEntry"},"get":{"summary":"List MarkingEntries","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"markingEntries.findMarkingEntries"}},"/marking-entries/{object_id}":{"patch":{"summary":"Update MarkingEntry","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MarkingEntry"]}],"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"}}}}}}}},"operationId":"markingEntries.updateMarkingEntry"}},"/marking-inheritances":{"post":{"summary":"Create MarkingInheritance","description":"Copies an earlier marking session's marks, rubric marks and candidate feedback into the session that replaced it, so a marker taking an attempt over resumes from what the previous marker wrote. The entries become the requester's own submitted marks, which they may still change, and the session is theirs to complete as usual: nothing is published here. Send `responses` to copy part of the session. The requester must own the session being written into, which must still be open for marking, and the two sessions must be marking the same attempt. The session inherited from must be completed, finalised or voided — an in-flight pass is another marker's unsubmitted work — and its role must be one the requester's own role may read. A response the earlier session had not marked is reported back rather than refused; a response the two sessions marked out of different totals, or against a different rubric, refuses the whole request so that nothing lands half-copied. Not available (501) unless post-submission attempt management is enabled for the portal.","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"MarkingInheritance","enum":["MarkingInheritance"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["markingSession","sourceSession"],"properties":{"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"]}}}}},"sourceSession":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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":{"type":"object","description":"This is a resource linkage 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":500,"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/MarkingInheritance"}}}}}},"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"}}}}}}}},"operationId":"markingInheritances.createMarkingInheritance"}},"/marking-resets":{"post":{"summary":"Create MarkingReset","description":"Puts one marker role's marking of an attempt back to a fresh start without deleting anything. Every live session of the role is voided, so its marking entries are retired (`disabled`) but kept; the marks those entries sourced are withdrawn from the responses, which read as pending again, and the attempt's marking status drops back to in progress so the result can no longer be finalised or released on the retired marks. Unstarted sessions of the roles that build on this one are voided with it, while one that has started work refuses the reset until it is reset first. No session is created: re-assign a marker to start them a fresh session. Requires the assign-markers grant on the attempt; refused once marking is finalised and on a released or finalised attempt. Not available (501) unless post-submission attempt management is enabled for the portal.","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"MarkingReset","enum":["MarkingReset"]},"attributes":{"type":"object","required":["role","reason"],"properties":{"role":{"type":"string","enum":["moderating","escalation","backReading"],"description":"The marker role whose marking of the attempt is reset. Provisional marking cannot be reset, and auditing sessions only exist once marking is finalised."},"reason":{"type":"string","maxLength":1000,"description":"Recorded on the audit log and on every session the reset voids."}}},"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/MarkingReset"}}}}}},"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"}}}}}}}},"operationId":"markingResets.createMarkingReset"}},"/marking-session-exports":{"post":{"summary":"Create MarkingSessionExport","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"MarkingSessionExport","enum":["MarkingSessionExport"]},"attributes":{"type":"object","properties":{"attemptIds":{"type":"array","items":{"type":"string"}},"filter":{"type":"object","properties":{"propertyFilters":{"type":"array","description":"Candidate attribute filters. Each attribute may appear only once.","items":{"type":"object","required":["attribute","value"],"properties":{"attribute":{"type":"string","pattern":"^filter\\.attr\\.[a-z0-9_-]+$"},"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"]}}}},"examStatus":{"type":"array","items":{"type":"string","enum":["enrolled","notified","preflight","started","submitted","revoked","expired","cancelled"]}},"markingStatus":{"type":"array","items":{"type":"string","enum":["notStarted","inProgress","readyToFinalise","finalised","completed"]}},"gradeStatus":{"type":"array","items":{"type":"string","enum":["passed","failed"]}},"proctorStatus":{"type":"array","items":{"type":"string","enum":["disabled","enabled","readyForReview","reviewNotRequired","autoApproved","inReview","passed","failed","error"]}},"resultStatus":{"type":"array","items":{"type":"string","enum":["pending","finalised","released"]}},"lockStatus":{"type":"array","items":{"type":"string","enum":["locked","unlocked","none"]}},"systemsCheckStatus":{"type":"array","items":{"type":"string","enum":["notRun","inProgress","passed","attention"]}},"subPortals":{"type":"array","items":{"type":"string"}},"testVersions":{"type":"array","items":{"type":"string"}},"isArchived":{"type":"boolean"},"isCompleted":{"type":"boolean"}}},"search":{"type":"string"}}},"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/MarkingSessionExport"}}}}}},"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"}}}}}}}},"operationId":"markingSessionExport.createMarkingSessionExport"}},"/marking-sessions/{object_id}":{"get":{"summary":"Get MarkingSession","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MarkingSession"]},{"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"}}}}}}}},"operationId":"markingSessions.getMarkingSession"},"patch":{"summary":"Update MarkingSession","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MarkingSession"]}],"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"}}}}}}}},"operationId":"markingSessions.updateMarkingSession"}},"/marking-sessions":{"get":{"summary":"List MarkingSessions","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","schema":{"type":"object","properties":{"role":{"description":"One or more marker roles. Narrows within the roles the caller may already read, so on `filter[markingSession]` a role that session may not read returns nothing. Not available in question mode.","anyOf":[{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},{"type":"array","items":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]}}]},"status":{"description":"One or more session statuses, voided and suspended included. Replaces the status set `filter[marked]` picks, so the two can not be combined. Naming voided or suspended through `filter[markingSession]` requires permission to view marks on the attempt. Not available in question mode.","anyOf":[{"type":"string","enum":["pending","locked","inProgress","inConflict","escalated","completed","rejected","finalised","voided","suspended"]},{"type":"array","items":{"type":"string","enum":["pending","locked","inProgress","inConflict","escalated","completed","rejected","finalised","voided","suspended"]}}]},"attemptResultStatus":{"description":"One or more results statuses of the session's attempt. Requires `filter[exam]` or `filter[attempt]`. Not available in question mode.","anyOf":[{"type":"string","enum":["pending","finalised","released"]},{"type":"array","items":{"type":"string","enum":["pending","finalised","released"]}}]},"attemptMarkingStatus":{"description":"One or more marking statuses of the session's attempt. Requires `filter[exam]` or `filter[attempt]`. Not available in question mode.","anyOf":[{"type":"string","enum":["notStarted","inProgress","readyToFinalise","finalised","completed"]},{"type":"array","items":{"type":"string","enum":["notStarted","inProgress","readyToFinalise","finalised","completed"]}}]},"attempt":{"type":"string"},"markingSession":{"type":"string"},"owner":{"type":"string","description":"Defaults to the requesting user, or to every marker when the caller may view marks on the attempt or exam. Naming another user requires permission to view marks — on the attempt when `filter[attempt]` is given, otherwise on the exam named by `filter[exam]`, which is then required. Not available in question mode, where a caller may only list their own sessions."},"exam":{"type":"string","description":"Narrows an attempt-mode listing to one exam. Where post-submission attempt management is on, a caller with permission to view marks on the exam gets every marker's sessions on it, limited to candidates in their sub-portal, in every status unless `filter[status]` or `filter[marked]` names some; anyone else gets only their own. Also carries the permission an owner filter naming another user is authorised against. Not applied in question mode."},"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","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"]}}}}},{"name":"search","in":"query","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Completion-time sorting is not supported in question mode.","schema":{"type":"string","enum":["createdAt","-createdAt","timeCompleted","-timeCompleted"]}},{"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":{"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":{"statusCounts":{"type":"object","description":"Sessions per status under every filter but `filter[status]` and `filter[marked]`. Only on the listing of every marker's sessions on an exam.","properties":{"pending":{"type":"integer"},"locked":{"type":"integer"},"inProgress":{"type":"integer"},"inConflict":{"type":"integer"},"escalated":{"type":"integer"},"completed":{"type":"integer"},"rejected":{"type":"integer"},"finalised":{"type":"integer"},"voided":{"type":"integer"},"suspended":{"type":"integer"}},"required":["pending","locked","inProgress","inConflict","escalated","completed","rejected","finalised","voided","suspended"],"additionalProperties":false}}}]}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}},"operationId":"markingSessions.findMarkingSessions"},"post":{"summary":"Create MarkingSession","description":"A new session continues an existing one, told apart by its relationships. `predecessor` alone starts an additional pass by that completed session's marker, and takes no attributes. `replaces` with `owner` reassigns the replaced session: it is voided under `attributes.reason`, or \"reassigned to another marker\", and the `owner` gets a fresh session on the same attempt and role. To reassign several at once, use `POST /v3/marking-sessions/operations`. Responds `501` for a portal without the post-submission attempt management rollout.","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"MarkingSession","enum":["MarkingSession"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"reason":{"type":"string","maxLength":1000,"description":"Recorded on the replaced session's void. Defaults to \"reassigned to another marker\"."}}},"relationships":{"type":"object","description":"Either `predecessor` alone, for an additional pass by that completed session's marker, or `replaces` with `owner`, to hand the replaced session's remaining work to that marker.","properties":{"predecessor":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}},"replaces":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}},"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/MarkingSession"}}}}}},"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"}}}}}}}},"operationId":"markingSessions.createMarkingSession"}},"/marking-sessions/operations":{"post":{"summary":"BETA: Atomically reassign many MarkingSessions to other markers","description":"BETA: JSON:API Atomic Operations extension. Send `atomic:operations` with `op: \"add\"` and a MarkingSession whose `relationships.replaces` names the session to reassign and `relationships.owner` the marker it goes to, as for `POST /v3/marking-sessions`. Each replaced session is voided under `attributes.reason`, or \"reassigned to another marker\", and the `owner` gets a fresh session on the same attempt and role. Every operation must reassign sessions of the same role, and a request may carry up to 50 operations. 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` at or under `/atomic:operations/{index}`; an error about the batch as a whole points at `/atomic:operations`. A void cannot be undone, so after any `500` part of the batch may stand: send the same request again, which finishes it without creating any session twice. Results are the new sessions, in request order. 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":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":50,"items":{"type":"object","required":["op","data"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["add"]},"data":{"type":"object","required":["type","relationships"],"additionalProperties":false,"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingSession","enum":["MarkingSession"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"reason":{"type":"string","maxLength":1000,"description":"Recorded on the replaced session's void. Defaults to \"reassigned to another marker\"."}}},"relationships":{"type":"object","required":["replaces","owner"],"additionalProperties":false,"properties":{"replaces":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}},"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"]}}}}}}}}}}}}}}},"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":50,"items":{"type":"object","required":["op","data"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["add"]},"data":{"type":"object","required":["type","relationships"],"additionalProperties":false,"properties":{"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingSession","enum":["MarkingSession"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"reason":{"type":"string","maxLength":1000,"description":"Recorded on the replaced session's void. Defaults to \"reassigned to another marker\"."}}},"relationships":{"type":"object","required":["replaces","owner"],"additionalProperties":false,"properties":{"replaces":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}},"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":{"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/MarkingSession"}}}}}}},"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/MarkingSession"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"markingSessionOperations.applyMarkingSessionOperations"}},"/marking-states":{"post":{"summary":"Create MarkingState","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"},"finalisation":{"type":"object"}}},"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"}}}}}}}},"operationId":"markingStates.createMarkingState"},"get":{"summary":"List MarkingStates","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"markingStates.findMarkingStates"}},"/marking-states/{object_id}":{"get":{"summary":"Get MarkingState","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MarkingState"]}],"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"}}}}}}}},"operationId":"markingStates.getMarkingState"},"patch":{"summary":"Update MarkingState","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MarkingState"]}],"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"}}}}}}}},"operationId":"markingStates.updateMarkingState"},"delete":{"summary":"Delete MarkingState","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MarkingState"]}],"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"}}}}}}}},"operationId":"markingStates.deleteMarkingState"}},"/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"}}}}}}}},"operationId":"mfaActivation.createMfaActivation"}},"/mfa-configs/{object_id}":{"get":{"summary":"Get MfaConfig","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MfaConfig"]}],"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"}}}}}}}},"operationId":"mfaConfigs.getMfaConfig"}},"/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"}}}}}}}},"operationId":"mfaConfigs.createMfaConfig"}},"/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"}}}}}}}},"operationId":"mfaDeactivation.createMfaDeactivation"}},"/mobile/attempts":{"post":{"summary":"Create MobileAttempt","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"mobileAttempts.createMobileAttempt"},"get":{"summary":"List MobileAttempts","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"mobileAttempts.findMobileAttempts"}},"/mobile/attempts/{object_id}":{"get":{"summary":"Get MobileAttempt","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MobileAttempt"]}],"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"}}}}}}}},"operationId":"mobileAttempts.getMobileAttempt"},"patch":{"summary":"Update MobileAttempt","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MobileAttempt"]}],"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"}}}}}}}},"operationId":"mobileAttempts.updateMobileAttempt"}},"/mobile/collection-items":{"post":{"summary":"Create MobileCollectionItem","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"mobileCollectionItems.createMobileCollectionItem"},"get":{"summary":"List MobileCollectionItems","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"mobileCollectionItems.findMobileCollectionItems"}},"/mobile/collection-items/{object_id}":{"get":{"summary":"Get MobileCollectionItem","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MobileCollectionItem"]}],"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"}}}}}}}},"operationId":"mobileCollectionItems.getMobileCollectionItem"},"patch":{"summary":"Update MobileCollectionItem","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MobileCollectionItem"]}],"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"}}}}}}}},"operationId":"mobileCollectionItems.updateMobileCollectionItem"},"delete":{"summary":"Delete MobileCollectionItem","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MobileCollectionItem"]}],"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"}}}}}}}},"operationId":"mobileCollectionItems.deleteMobileCollectionItem"}},"/mobile/collections":{"get":{"summary":"List Collections","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"mobileCollections.findMobileCollections"}},"/mobile/collections/{object_id}":{"get":{"summary":"Get Collection","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MobileCollection"]}],"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"}}}}}}}},"operationId":"mobileCollections.getMobileCollection"}},"/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"}}}}}}}},"operationId":"mobileConfig.getMobileConfig"}},"/mobile/responses":{"get":{"summary":"List MobileResponses","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"mobileResponses.findMobileResponses"}},"/mobile/responses/{object_id}":{"get":{"summary":"Get MobileResponse","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MobileResponse"]}],"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"}}}}}}}},"operationId":"mobileResponses.getMobileResponse"},"patch":{"summary":"Update MobileResponse","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MobileResponse"]}],"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"}}}}}}}},"operationId":"mobileResponses.updateMobileResponse"}},"/mobile/sessions/{object_id}":{"get":{"summary":"Get Session","tags":["Mobile"],"security":[],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MobileSession"]}],"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"}}}}}}}},"operationId":"mobileSession.getMobileUser"}},"/mobile/spaced-learnings/{object_id}":{"get":{"summary":"Get MobileSpacedLearning","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MobileSpacedLearning"]}],"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"}}}}}}}},"operationId":"mobileSpacedLearnings.getMobileSpacedLearning"},"patch":{"summary":"Update MobileSpacedLearning","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MobileSpacedLearning"]}],"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"}}}}}}}},"operationId":"mobileSpacedLearnings.updateMobileSpacedLearning"}},"/mobile/spaced-learnings/{object_id}/relationships/study-items":{"post":{"summary":"Add MobileStudyItems","tags":["Mobile"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MobileSpacedLearning"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"mobileSpacedLearnings.addStudyItems"},"delete":{"summary":"Remove MobileStudyItems","tags":["Mobile"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MobileSpacedLearning"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"mobileSpacedLearnings.removeStudyItems"}},"/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"}}}}}}}},"operationId":"mobileUsers.createMobileUser"}},"/mobile/users/{object_id}":{"get":{"summary":"Get MobileUser","tags":["Mobile"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["MobileUser"]}],"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"}}}}}}}},"operationId":"mobileUsers.getMobileUser"}},"/network-checks":{"post":{"summary":"Start a NetworkCheck","description":"Issues what one network check needs: the file to download and two places to upload to that only accept a fixed size. Only the candidate who owns the PreflightRun can start one, and each run allows ten starts per five-minute window.","tags":["Preflight"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"NetworkCheck","enum":["NetworkCheck"]},"attributes":{"type":"object","properties":{"key":{"type":"string","minLength":16,"maxLength":128,"writeOnly":true,"description":"The key held by the browser or desktop app reporting this run. Required for runs issued with a key."},"writerGeneration":{"type":"integer","minimum":1,"writeOnly":true,"description":"The reporting generation issued when the run was created or resumed. Send the same generation when starting and completing a check."},"downloadUrl":{"type":"string","readOnly":true,"description":"The file to download. Only on the response that starts a check; add a query string that changes each time so nothing is served from the browser’s cache."},"downloadBytes":{"type":"integer","minimum":1,"readOnly":true,"description":"How many bytes the download file holds."},"expiresAt":{"type":"string","format":"date-time","readOnly":true,"description":"When the upload addresses stop working. Only on the response that starts a check."},"uploads":{"type":"array","readOnly":true,"description":"Where to upload to, with a PUT of exactly sizeBytes of data and the stated content type. The same address may be used repeatedly until it expires. Only on the response that starts a check.","items":{"type":"object","required":["name","url","sizeBytes","contentType"],"properties":{"name":{"type":"string"},"url":{"type":"string"},"sizeBytes":{"type":"integer","minimum":1},"contentType":{"type":"string"}}}},"probes":{"type":"array","readOnly":true,"description":"Addresses of the exam’s own hosts. Request each with a plain no-cors GET: any answer at all, even an error page, means the host can be reached. Only on the response that starts a check.","items":{"type":"object","required":["name","url"],"properties":{"name":{"type":"string","enum":["files","storage"]},"url":{"type":"string"}}}},"services":{"type":"array","readOnly":true,"description":"The proctoring connections a proctored exam depends on, each to be tried the way the exam uses it: a WebSocket is opened and must answer, and the video relay must hand out a relay candidate to a peer connection that only accepts relayed ones. Left out for an exam that is not proctored. Only on the response that starts a check.","items":{"type":"object","required":["name","kind"],"properties":{"name":{"type":"string","enum":["synoptic","turn"]},"kind":{"type":"string","enum":["websocket","turn"]},"url":{"type":"string","description":"The WebSocket address, for a websocket service."},"urls":{"type":"array","items":{"type":"string"},"description":"The ICE server addresses, for a turn service."},"username":{"type":"string"},"credential":{"type":"string"}}}},"overall":{"type":"string","enum":["ok","warn","error"],"readOnly":true,"description":"How the candidate’s connection looks, from the results that clearly mean trouble. Only on the response that completes a check."}}},"relationships":{"type":"object","required":["preflightRun"],"properties":{"preflightRun":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PreflightRun","enum":["PreflightRun"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkCheck"}}}}}},"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"}}}}}}},"429":{"description":"The network-check allowance is exhausted temporarily. Retry-After and errors[].meta.retryAfterSeconds report the cooldown in seconds.","headers":{"Retry-After":{"schema":{"type":"integer","minimum":1}}},"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"operationId":"networkChecks.startNetworkCheck"}},"/network-checks/{object_id}":{"patch":{"summary":"Complete a NetworkCheck","description":"Reports what the browser measured. Responds with how the connection looks to the candidate. The detail, including results the candidate is not shown, is kept for reviewers. A check can be completed once.","tags":["Preflight"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["NetworkCheck"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/NetworkCheck"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkCheck"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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":"The reporting session has been replaced.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"operationId":"networkChecks.completeNetworkCheck"}},"/network-ping":{"get":{"summary":"Ping the API","description":"Answers as cheaply as an authenticated request can, so the preflight network check can time the real API path. Nothing is read or written.","tags":["Preflight"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"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"}}}}}}}},"operationId":"networkPing.pingNetwork"}},"/notes/{object_id}":{"get":{"summary":"Get Note","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Note"]},{"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"}}}}}}}},"operationId":"notes.getNote"},"delete":{"summary":"Delete Note","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Note"]}],"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"}}}}}}}},"operationId":"notes.deleteNote"},"patch":{"summary":"Update Note","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Note"]}],"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"}}}}}}}},"operationId":"notes.updateNote"}},"/notes":{"post":{"summary":"Create Note","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"notes.createNote"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Note"]}],"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"}}}}}}}},"operationId":"notes.addNoteCollaboratingUsers"},"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Note"]}],"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"}}}}}}}},"operationId":"notes.removeNoteCollaboratingUsers"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Note"]}],"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"}}}}}}}},"operationId":"notes.addNoteCollaboratingUserGroups"},"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Note"]}],"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"}}}}}}}},"operationId":"notes.removeNoteCollaboratingUserGroups"}},"/notification-groups":{"get":{"summary":"List NotificationGroups","tags":["Notifications"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"notificationGroups.findNotificationGroups"}},"/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"}}}}}}}},"operationId":"passkeyAuthenticationOptions.createPasskeyAuthenticationOptions"}},"/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"}}}}}}}},"operationId":"passkeyAuthentications.createPasskeyAuthentication"}},"/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"}}}}}}}},"operationId":"passkeyEnrolmentDeferrals.createPasskeyEnrolmentDeferral"}},"/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"}}}}}}}},"operationId":"passkeyRegistrationOptions.createPasskeyRegistrationOptions"}},"/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"}}}}}}}},"operationId":"passkeyRevocations.createPasskeyRevocation"}},"/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"}},"meta":{"type":"object","required":["credentialStore"],"properties":{"credentialStore":{"description":"The relying party the caller's page is on and the WebAuthn user handle their passkeys carry there, for `PublicKeyCredential.signalAllAcceptedCredentials`. Null when the request origin is not a passkey hostname of the portal.","type":"object","nullable":true,"required":["rpId","userHandle"],"properties":{"rpId":{"type":"string"},"userHandle":{"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"}}}}}}}},"operationId":"passkeys.listPasskeys"},"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"}}}}}}}},"operationId":"passkeys.createPasskey"}},"/passkeys/{object_id}":{"patch":{"summary":"Update Passkey (rename)","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Passkey"]}],"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"}}}}}}}},"operationId":"passkeys.updatePasskey"}},"/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"}}}}}}}},"operationId":"passwordResetRequests.createPasswordResetRequest"}},"/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},"passwordStyle":{"type":"string","enum":["strong","simple"],"description":"Which kind of password to generate for an instant reset. `simple` returns a short, readable password that is easy to pass on verbally. Defaults to `strong`.","readOnly":false},"newPassword":{"type":"string","description":"The users new password. On create it can only be supplied alongside `instant`, and not alongside `passwordStyle`.","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"]}}}}}}}}}}}}}},"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"}}}}}}}},"operationId":"passwordResets.createPasswordReset"}},"/password-resets/{object_id}":{"get":{"summary":"Get PasswordReset","tags":["Users"],"security":[],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PasswordReset"]}],"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"}}}}}}}},"operationId":"passwordResets.getPasswordReset"},"patch":{"summary":"Update PasswordReset","tags":["Users"],"security":[],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PasswordReset"]}],"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"}}}}}}}},"operationId":"passwordResets.updatePasswordReset"}},"/pdf-annotations":{"post":{"summary":"Create or Update PDF Annotation","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"pdfAnnotations.createPdfAnnotation"},"get":{"summary":"List PDF Annotations","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"pdfAnnotations.findPdfAnnotations"}},"/pdf-annotations/{object_id}":{"get":{"summary":"Get PDF Annotation","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PdfAnnotation"]}],"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"}}}}}}}},"operationId":"pdfAnnotations.getPdfAnnotation"},"delete":{"summary":"Delete PDF Annotation","tags":["Collections"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PdfAnnotation"]}],"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"}}}}}}}},"operationId":"pdfAnnotations.deletePdfAnnotation"}},"/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"}}}}}}}},"operationId":"personalAccessTokens.createPersonalAccessToken"},"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"}}}}}}}},"operationId":"personalAccessTokens.findPersonalAccessTokens"}},"/personal-access-tokens/{object_id}":{"patch":{"summary":"Update PersonalAccessToken","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PersonalAccessToken"]}],"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"}}}}}}}},"operationId":"personalAccessTokens.updatePersonalAccessToken"},"delete":{"summary":"Delete PersonalAccessToken","tags":["Authentication"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PersonalAccessToken"]}],"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"}}}}}}}},"operationId":"personalAccessTokens.deletePersonalAccessToken"}},"/phone-capture-capabilities":{"post":{"summary":"Create PhoneCaptureCapability","tags":["Preflight"],"security":[],"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":"PhoneCaptureCapability","enum":["PhoneCaptureCapability"]},"attributes":{"type":"object","properties":{"pairToken":{"type":"string","minLength":16,"maxLength":128,"writeOnly":true}},"required":["pairToken"],"additionalProperties":false},"relationships":{"type":"object","properties":{"phoneCapture":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PhoneCapture","enum":["PhoneCapture"]}}}}}},"required":["phoneCapture"]}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PhoneCaptureCapability"}}}}}},"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"}}}}}}}},"operationId":"phoneCaptureCapabilities.create"}},"/phone-capture-capabilities/{object_id}":{"patch":{"summary":"Update PhoneCaptureCapability","tags":["Preflight"],"security":[],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PhoneCaptureCapability"]}],"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":["PhoneCaptureCapability"]},"attributes":{"type":"object","properties":{"capability":{"type":"string","minLength":16,"maxLength":128,"writeOnly":true}},"required":["capability"],"additionalProperties":false}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PhoneCaptureCapability"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"phoneCaptureCapabilities.update"}},"/phone-capture-room-scans":{"post":{"summary":"Authorise access to PhoneCaptureRoomScan","tags":["Preflight"],"security":[],"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":"PhoneCaptureRoomScan","enum":["PhoneCaptureRoomScan"]},"attributes":{"type":"object","properties":{"capability":{"type":"string","minLength":16,"maxLength":128,"writeOnly":true},"roomScanId":{"type":"string"}},"required":["capability","roomScanId"],"additionalProperties":false},"relationships":{"type":"object","properties":{"phoneCapture":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PhoneCapture","enum":["PhoneCapture"]}}}}}},"required":["phoneCapture"]}}}}}}}},"responses":{"200":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PhoneCaptureRoomScan"}}}}}},"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"}}}}}}}},"operationId":"phoneCaptureRoomScans.create"}},"/phone-capture-room-scans/{object_id}":{"patch":{"summary":"Update PhoneCaptureRoomScan","tags":["Preflight"],"security":[],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PhoneCaptureRoomScan"]}],"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":["PhoneCaptureRoomScan"]},"attributes":{"type":"object","properties":{"capability":{"type":"string","minLength":16,"maxLength":128,"writeOnly":true},"uploadId":{"type":"string","format":"uuid"},"reportedRecordedAt":{"type":"string","format":"date-time"},"browser":{"type":"string","maxLength":120},"os":{"type":"string","maxLength":120}},"required":["capability","uploadId"],"additionalProperties":false}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PhoneCaptureRoomScan"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"phoneCaptureRoomScans.update"}},"/phone-captures":{"post":{"summary":"Create PhoneCapture pairing","tags":["Preflight"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"PhoneCapture","enum":["PhoneCapture"]},"attributes":{"type":"object","properties":{"key":{"type":"string","minLength":16,"maxLength":128,"writeOnly":true},"writerGeneration":{"type":"integer","minimum":1},"roomScanId":{"type":"string"}},"required":["key","writerGeneration"]},"relationships":{"type":"object","properties":{"preflightRun":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PreflightRun","enum":["PreflightRun"]}}}}}},"required":["preflightRun"]}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PhoneCapture"}}}}}},"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"}}}}}}}},"operationId":"phoneCaptures.create"}},"/phone-captures/{object_id}":{"get":{"summary":"Get PhoneCapture","tags":["Preflight"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PhoneCapture"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PhoneCapture"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"phoneCaptures.get"},"patch":{"summary":"Enable PhoneCapture publisher","tags":["Preflight"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PhoneCapture"]}],"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":["PhoneCapture"]},"attributes":{"type":"object","properties":{"key":{"type":"string","minLength":16,"maxLength":128},"writerGeneration":{"type":"integer","minimum":1},"publisherEnabled":{"type":"boolean","enum":[true]}},"required":["key","writerGeneration","publisherEnabled"],"additionalProperties":false}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PhoneCapture"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"phoneCaptures.update"}},"/player-attempts/{object_id}":{"get":{"summary":"Get PlayerAttempt","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerAttempt"]},{"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"}}}}}}}},"operationId":"playerAttempts.getPlayerAttempt"},"patch":{"summary":"Update PlayerAttempt","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerAttempt"]}],"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"}}}}}}}},"operationId":"playerAttempts.updatePlayerAttempt"},"delete":{"summary":"Delete PlayerAttempt","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerAttempt"]}],"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"}}}}}}}},"operationId":"playerAttempts.deletePlayerAttempt"}},"/player-audio-responses/{object_id}":{"get":{"summary":"Get PlayerAudioResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerAudioResponse"]},{"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"}}}}}}}},"operationId":"playerAudioResponse.getPlayerAudioResponse"},"patch":{"summary":"Update PlayerAudioResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerAudioResponse"]}],"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"}}}}}}}},"operationId":"playerAudioResponse.updatePlayerAudioResponse"}},"/player-bow-tie-responses/{object_id}":{"get":{"summary":"Get PlayerBowTieResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerBowTieResponse"]},{"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/PlayerBowTieResponse"},"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"}}}}}}}},"operationId":"playerBowTieResponse.getPlayerBowTieResponse"},"patch":{"summary":"Update PlayerBowTieResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerBowTieResponse"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerBowTieResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerBowTieResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"playerBowTieResponse.updatePlayerBowTieResponse"}},"/player-choice-matrix-responses/{object_id}":{"get":{"summary":"Get PlayerChoiceMatrixResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerChoiceMatrixResponse"]},{"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/PlayerChoiceMatrixResponse"},"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"}}}}}}}},"operationId":"playerChoiceMatrixResponse.getPlayerChoiceMatrixResponse"},"patch":{"summary":"Update PlayerChoiceMatrixResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerChoiceMatrixResponse"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerChoiceMatrixResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerChoiceMatrixResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"playerChoiceMatrixResponse.updatePlayerChoiceMatrixResponse"}},"/player-classification-responses/{object_id}":{"get":{"summary":"Get PlayerClassificationResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerClassificationResponse"]},{"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/PlayerClassificationResponse"},"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"}}}}}}}},"operationId":"playerClassificationResponse.getPlayerClassificationResponse"},"patch":{"summary":"Update PlayerClassificationResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerClassificationResponse"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerClassificationResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerClassificationResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"playerClassificationResponse.updatePlayerClassificationResponse"}},"/player-cloze-drag-and-drop-responses/{object_id}":{"get":{"summary":"Get PlayerClozeDragAndDropResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerClozeDragAndDropResponse"]},{"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"}}}}}}}},"operationId":"playerClozeDragAndDropResponse.getPlayerClozeDragAndDropResponse"},"patch":{"summary":"Update PlayerClozeDragAndDropResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerClozeDragAndDropResponse"]}],"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"}}}}}}}},"operationId":"playerClozeDragAndDropResponse.updatePlayerClozeDragAndDropResponse"}},"/player-cloze-drop-down-responses/{object_id}":{"get":{"summary":"Get PlayerClozeDropDownResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerClozeDropDownResponse"]},{"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"}}}}}}}},"operationId":"playerClozeDropDownResponse.getPlayerClozeDropDownResponse"},"patch":{"summary":"Update PlayerClozeDropDownResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerClozeDropDownResponse"]}],"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"}}}}}}}},"operationId":"playerClozeDropDownResponse.updatePlayerClozeDropDownResponse"}},"/player-cloze-text-responses/{object_id}":{"get":{"summary":"Get PlayerClozeTextResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerClozeTextResponse"]},{"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"}}}}}}}},"operationId":"playerClozeTextResponse.getPlayerClozeTextResponse"},"patch":{"summary":"Update PlayerClozeTextResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerClozeTextResponse"]}],"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"}}}}}}}},"operationId":"playerClozeTextResponse.updatePlayerClozeTextResponse"}},"/player-coding-responses/{object_id}":{"get":{"summary":"Get PlayerCodingResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerCodingResponse"]},{"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/PlayerCodingResponse"},"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"}}}}}}}},"operationId":"playerCodingResponse.getPlayerCodingResponse"},"patch":{"summary":"Update PlayerCodingResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerCodingResponse"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerCodingResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerCodingResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"playerCodingResponse.updatePlayerCodingResponse"}},"/player-drawing-responses/{object_id}":{"get":{"summary":"Get PlayerDrawingResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerDrawingResponse"]},{"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"}}}}}}}},"operationId":"playerDrawingResponse.getPlayerDrawingResponse"},"patch":{"summary":"Update PlayerDrawingResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerDrawingResponse"]}],"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"}}}}}}}},"operationId":"playerDrawingResponse.updatePlayerDrawingResponse"}},"/player-emq-groups/{object_id}":{"get":{"summary":"Get PlayerEmqGroup","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerEmqGroup"]},{"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"}}}}}}}},"operationId":"playerEmqGroups.getPlayerEmqGroup"},"patch":{"summary":"Update PlayerEmqGroup","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerEmqGroup"]}],"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"}}}}}}}},"operationId":"playerEmqGroups.updatePlayerAttempt"}},"/player-file-upload-responses/{object_id}":{"get":{"summary":"Get PlayerFileUploadResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerFileUploadResponse"]},{"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"}}}}}}}},"operationId":"playerFileUploadResponse.getPlayerFileUploadResponse"},"patch":{"summary":"Update PlayerFileUploadResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerFileUploadResponse"]}],"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"}}}}}}}},"operationId":"playerFileUploadResponse.updatePlayerFileUploadResponse"}},"/player-flashcard-responses/{object_id}":{"get":{"summary":"Get PlayerFlashcardResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerFlashcardResponse"]},{"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"}}}}}}}},"operationId":"playerFlashcardResponse.getPlayerFlashcardResponse"},"patch":{"summary":"Update PlayerFlashcardResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerFlashcardResponse"]}],"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"}}}}}}}},"operationId":"playerFlashcardResponse.updatePlayerFlashcardResponse"}},"/player-free-text-responses/{object_id}":{"get":{"summary":"Get PlayerFreeTextResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerFreeTextResponse"]},{"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"}}}}}}}},"operationId":"playerFreeTextResponse.getPlayerFreeTextResponse"},"patch":{"summary":"Update PlayerFreeTextResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerFreeTextResponse"]}],"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"}}}}}}}},"operationId":"playerFreeTextResponse.updatePlayerFreeTextResponse"}},"/player-image-hotspot-responses/{object_id}":{"get":{"summary":"Get PlayerImageHotspotResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerImageHotspotResponse"]},{"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"}}}}}}}},"operationId":"playerImageHotspotResponse.getPlayerImageHotspotResponse"},"patch":{"summary":"Update PlayerImageHotspotResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerImageHotspotResponse"]}],"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"}}}}}}}},"operationId":"playerImageHotspotResponse.updatePlayerImageHotspotResponse"}},"/player-image-labelling-drag-and-drop-responses/{object_id}":{"get":{"summary":"Get PlayerImageLabellingDragAndDropResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerImageLabellingDragAndDropResponse"]},{"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/PlayerImageLabellingDragAndDropResponse"},"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"}}}}}}}},"operationId":"playerImageLabellingDragAndDropResponse.getPlayerImageLabellingDragAndDropResponse"},"patch":{"summary":"Update PlayerImageLabellingDragAndDropResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerImageLabellingDragAndDropResponse"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerImageLabellingDragAndDropResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerImageLabellingDragAndDropResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"playerImageLabellingDragAndDropResponse.updatePlayerImageLabellingDragAndDropResponse"}},"/player-image-labelling-drop-down-responses/{object_id}":{"get":{"summary":"Get PlayerImageLabellingDropDownResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerImageLabellingDropDownResponse"]},{"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/PlayerImageLabellingDropDownResponse"},"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"}}}}}}}},"operationId":"playerImageLabellingDropDownResponse.getPlayerImageLabellingDropDownResponse"},"patch":{"summary":"Update PlayerImageLabellingDropDownResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerImageLabellingDropDownResponse"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerImageLabellingDropDownResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerImageLabellingDropDownResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"playerImageLabellingDropDownResponse.updatePlayerImageLabellingDropDownResponse"}},"/player-image-labelling-text-responses/{object_id}":{"get":{"summary":"Get PlayerImageLabellingTextResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerImageLabellingTextResponse"]},{"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/PlayerImageLabellingTextResponse"},"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"}}}}}}}},"operationId":"playerImageLabellingTextResponse.getPlayerImageLabellingTextResponse"},"patch":{"summary":"Update PlayerImageLabellingTextResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerImageLabellingTextResponse"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerImageLabellingTextResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerImageLabellingTextResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"playerImageLabellingTextResponse.updatePlayerImageLabellingTextResponse"}},"/player-informational-responses/{object_id}":{"get":{"summary":"Get PlayerInformationalResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerInformationalResponse"]},{"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"}}}}}}}},"operationId":"playerInformationalResponse.getPlayerInformationalResponse"},"patch":{"summary":"Update PlayerInformationalResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerInformationalResponse"]}],"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"}}}}}}}},"operationId":"playerInformationalResponse.updatePlayerInformationalResponse"}},"/player-likert-responses/{object_id}":{"get":{"summary":"Get PlayerLikertResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerLikertResponse"]},{"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/PlayerLikertResponse"},"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"}}}}}}}},"operationId":"playerLikertResponse.getPlayerLikertResponse"},"patch":{"summary":"Update PlayerLikertResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerLikertResponse"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerLikertResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerLikertResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"playerLikertResponse.updatePlayerLikertResponse"}},"/player-matching-responses/{object_id}":{"get":{"summary":"Get PlayerMatchingResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerMatchingResponse"]},{"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/PlayerMatchingResponse"},"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"}}}}}}}},"operationId":"playerMatchingResponse.getPlayerMatchingResponse"},"patch":{"summary":"Update PlayerMatchingResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerMatchingResponse"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerMatchingResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerMatchingResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"playerMatchingResponse.updatePlayerMatchingResponse"}},"/player-multiple-choice-responses/{object_id}":{"get":{"summary":"Get PlayerMultipleChoiceResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerMultipleChoiceResponse"]},{"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"}}}}}}}},"operationId":"playerMultipleChoiceResponse.getPlayerMultipleChoiceResponse"},"patch":{"summary":"Update PlayerMultipleChoiceResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerMultipleChoiceResponse"]}],"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"}}}}}}}},"operationId":"playerMultipleChoiceResponse.updatePlayerMultipleChoiceResponse"}},"/player-numeric-answer-responses/{object_id}":{"get":{"summary":"Get PlayerNumericAnswerResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerNumericAnswerResponse"]},{"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/PlayerNumericAnswerResponse"},"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"}}}}}}}},"operationId":"playerNumericAnswerResponse.getPlayerNumericAnswerResponse"},"patch":{"summary":"Update PlayerNumericAnswerResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerNumericAnswerResponse"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerNumericAnswerResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerNumericAnswerResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"playerNumericAnswerResponse.updatePlayerNumericAnswerResponse"}},"/player-off-platform-responses/{object_id}":{"get":{"summary":"Get PlayerOffPlatformResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerOffPlatformResponse"]},{"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"}}}}}}}},"operationId":"playerOffPlatformResponse.getPlayerOffPlatformResponse"},"patch":{"summary":"Update PlayerOffPlatformResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerOffPlatformResponse"]}],"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"}}}}}}}},"operationId":"playerOffPlatformResponse.updatePlayerOffPlatformResponse"}},"/player-ranked-responses/{object_id}":{"get":{"summary":"Get PlayerRankedResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerRankedResponse"]},{"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"}}}}}}}},"operationId":"playerRankedResponse.getPlayerRankedResponse"},"patch":{"summary":"Update PlayerRankedResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerRankedResponse"]}],"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"}}}}}}}},"operationId":"playerRankedResponse.updatePlayerRankedResponse"}},"/player-sections/{object_id}":{"get":{"summary":"Get PlayerSection","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerSection"]},{"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"}}}}}}}},"operationId":"playerSections.getPlayerSection"},"patch":{"summary":"Update PlayerSection","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerSection"]}],"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"}}}}}}}},"operationId":"playerSections.updatePlayerSection"}},"/player-short-answer-responses/{object_id}":{"get":{"summary":"Get PlayerShortAnswerResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerShortAnswerResponse"]},{"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"}}}}}}}},"operationId":"playerShortAnswerResponse.getPlayerShortAnswerResponse"},"patch":{"summary":"Update PlayerShortAnswerResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerShortAnswerResponse"]}],"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"}}}}}}}},"operationId":"playerShortAnswerResponse.updatePlayerShortAnswerResponse"}},"/player-single-choice-responses/{object_id}":{"get":{"summary":"Get PlayerSingleChoiceResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerSingleChoiceResponse"]},{"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"}}}}}}}},"operationId":"playerSingleChoiceResponse.getPlayerSingleChoiceResponse"},"patch":{"summary":"Update PlayerSingleChoiceResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerSingleChoiceResponse"]}],"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"}}}}}}}},"operationId":"playerSingleChoiceResponse.updatePlayerSingleChoiceResponse"}},"/player-spreadsheet-responses/{object_id}":{"get":{"summary":"Get PlayerSpreadsheetResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerSpreadsheetResponse"]},{"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"}}}}}}}},"operationId":"playerSpreadsheetResponse.getPlayerSpreadsheetResponse"},"patch":{"summary":"Update PlayerSpreadsheetResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerSpreadsheetResponse"]}],"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"}}}}}}}},"operationId":"playerSpreadsheetResponse.updatePlayerSpreadsheetResponse"}},"/player-text-selection-responses/{object_id}":{"get":{"summary":"Get PlayerTextSelectionResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerTextSelectionResponse"]},{"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/PlayerTextSelectionResponse"},"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"}}}}}}}},"operationId":"playerTextSelectionResponse.getPlayerTextSelectionResponse"},"patch":{"summary":"Update PlayerTextSelectionResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerTextSelectionResponse"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlayerTextSelectionResponse"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlayerTextSelectionResponse"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"playerTextSelectionResponse.updatePlayerTextSelectionResponse"}},"/player-true-or-false-responses/{object_id}":{"get":{"summary":"Get PlayerTrueOrFalseResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerTrueOrFalseResponse"]},{"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"}}}}}}}},"operationId":"playerTrueOrFalseResponse.getPlayerTrueOrFalseResponse"},"patch":{"summary":"Update PlayerTrueOrFalseResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerTrueOrFalseResponse"]}],"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"}}}}}}}},"operationId":"playerTrueOrFalseResponse.updatePlayerTrueOrFalseResponse"}},"/player-video-responses/{object_id}":{"get":{"summary":"Get PlayerVideoResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerVideoResponse"]},{"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"}}}}}}}},"operationId":"playerVideoResponse.getPlayerAudioResponse"},"patch":{"summary":"Update PlayerAudioResponse","tags":["Attempts"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PlayerVideoResponse"]}],"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"}}}}}}}},"operationId":"playerVideoResponse.updatePlayerAudioResponse"}},"/portal-stores":{"post":{"summary":"Create PortalStore","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":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/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"}}}}}}}},"operationId":"portalStores.createPortalStore"},"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, falling back to the root store when the sub-portal has none.","type":"string"},"allScopes":{"description":"Admins only. Return every store in the portal — the root store and all sub-portal stores. Cannot be combined with filter[subPortal].","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/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"}}}}}}}},"operationId":"portalStores.findPortalStores"}},"/portal-stores/{object_id}":{"get":{"summary":"Get PortalStore","tags":["Shop"],"security":[],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PortalStore"]}],"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"}}}}}}}},"operationId":"portalStores.getPortalStore"},"patch":{"summary":"Update PortalStore","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PortalStore"]}],"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"}}}}}}}},"operationId":"portalStores.updatePortalStore"},"delete":{"summary":"Delete PortalStore","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PortalStore"]}],"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"}}}}}}}},"operationId":"portalStores.deletePortalStore"}},"/portal-usage/{object_id}":{"get":{"summary":"Get PortalUsage","tags":["Billing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PortalUsage"]},{"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"}}}}}}}},"operationId":"portalUsage.getPortalUsage"}},"/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"}}}}}}}},"operationId":"portal.createPortal"}},"/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"}}}}}}}},"operationId":"portal.getCurrentPortal"},"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"}}}}}}}},"operationId":"portal.updatePortal"}},"/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":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Portal"]}],"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"}}}}}}}},"operationId":"portal.transferPortalOwner"}},"/preflight-runs":{"post":{"summary":"Create PreflightRun","description":"Starts the preflight journey for the candidate's attempt, if they may start the exam now, and makes it the newest preflight of that attempt. For a proctored exam the candidate has not started yet, the attempt moves to the preflight status. The key in the response is returned once and must be sent with every progress update. Send resumeRunId and resumeKey to continue the run this browser already holds, which restarts it, or takeover to end a preflight that is in progress on another device. Answers 409 with code preflight-run-active-elsewhere when one is in progress on another device and takeover was not sent.","tags":["Preflight"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"PreflightRun","enum":["PreflightRun"]},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["exam_preflight","exam_systems_check"],"description":"What the run is for. exam_preflight leads into the exam and is refused before the entry window opens. exam_systems_check is a practice check a candidate can run at any time before submitting: it never starts the exam and never counts towards admission."},"createdAt":{"type":"string","format":"date-time","readOnly":true},"client":{"type":"object","readOnly":true,"nullable":true,"description":"What the candidate was using when the run began. Only served to reviewers.","properties":{"ipAddress":{"type":"string"},"userAgent":{"type":"string"},"region":{"type":"string"},"webVersion":{"type":"string"},"desktopVersion":{"type":"string"},"extensionVersion":{"type":"string"},"os":{"type":"string"},"browser":{"type":"string"},"timezone":{"type":"string"},"locale":{"type":"string"},"synopticLevel":{"type":"string"},"systemsCheckRunId":{"type":"string"}}},"payloadRedactedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"When the personal details of client (IP address, user agent, time zone and locale) were removed. Only served to reviewers."},"authoritative":{"type":"boolean","readOnly":true,"description":"Whether this is the newest preflight of its attempt. Progress updates also return false when another browser or desktop session has resumed the run and replaced the writer."},"writerGeneration":{"type":"integer","minimum":1,"description":"Issued on creation and resume. Progress updates must send the generation issued to that reporter; resuming invalidates earlier generations."},"requestSequence":{"type":"integer","minimum":1,"maximum":9007199254740991,"writeOnly":true,"description":"Increasing request number within the issued writer generation. Older or repeated updates are ignored."},"source":{"type":"string","enum":["browser","desktop"],"writeOnly":true,"description":"Create or resume: whether this reporter is the browser or desktop app."},"progress":{"type":"object","readOnly":true,"nullable":true,"description":"Where the candidate is up to in the preflight journey. Only served to reviewers.","required":["lastSeenAt"],"properties":{"lastSeenAt":{"type":"string","format":"date-time"},"writer":{"type":"object","required":["generation","source","startedAt"],"properties":{"generation":{"type":"integer","minimum":1},"source":{"type":"string","enum":["browser","desktop"]},"startedAt":{"type":"string","format":"date-time"},"environment":{"type":"object","properties":{"webVersion":{"type":"string"},"desktopVersion":{"type":"string"},"extensionVersion":{"type":"string"},"os":{"type":"string"},"browser":{"type":"string"}}}}},"requestSequence":{"type":"integer","minimum":1,"maximum":9007199254740991},"currentStep":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$","description":"The key of a preflight journey step."},"visible":{"type":"boolean","description":"Whether the preflight page was visible when last seen."},"route":{"type":"string","maxLength":128},"completedAt":{"type":"string","format":"date-time"},"plannedSteps":{"type":"array","maxItems":30,"description":"The steps the journey will take the candidate through, in order.","items":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$","description":"The key of a preflight journey step."}},"device":{"type":"object","required":["clientTime","screenWidth","screenHeight","windowWidth","windowHeight","isFullscreen"],"description":"What the candidate's device reported when it last checked in: its clock, screen and window size, whether the page is full screen, and its connection.","properties":{"clientTime":{"type":"string","format":"date-time","description":"The time on the device's own clock."},"pageUrl":{"type":"string","maxLength":300,"description":"The address the candidate is using, without any query string or fragment."},"screenWidth":{"type":"integer","minimum":0,"maximum":32768},"screenHeight":{"type":"integer","minimum":0,"maximum":32768},"windowWidth":{"type":"integer","minimum":0,"maximum":32768},"windowHeight":{"type":"integer","minimum":0,"maximum":32768},"windowX":{"type":"integer","description":"Distance from the left of the screen to the browser window.","minimum":-32768,"maximum":32768},"windowY":{"type":"integer","description":"Distance from the top of the screen to the browser window.","minimum":-32768,"maximum":32768},"isExtendedDisplay":{"type":"boolean","description":"Whether the device has more than one screen, when the browser says."},"mediaDevices":{"type":"array","description":"The cameras and microphones the browser can see.","maxItems":20,"items":{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["audioinput","videoinput"]},"label":{"type":"string","maxLength":120},"selectable":{"type":"boolean","description":"Whether this device appears in the candidate picker after filtering and deduplication."}}}},"screenShare":{"type":"object","description":"The active screen capture track, when available. This does not identify a primary or external display.","required":["active"],"properties":{"active":{"type":"boolean"},"label":{"type":"string","maxLength":120},"surface":{"type":"string","enum":["monitor","window","browser"]},"width":{"type":"integer","minimum":0,"maximum":32768},"height":{"type":"integer","minimum":0,"maximum":32768}}},"pixelRatio":{"type":"number","minimum":0,"maximum":16},"isFullscreen":{"type":"boolean"},"memoryGb":{"type":"number","minimum":0},"cpuCores":{"type":"integer","minimum":0},"architecture":{"type":"string","maxLength":16},"bitness":{"type":"string","maxLength":8},"connection":{"type":"object","description":"What the browser reports about the connection. Not every browser reports it.","properties":{"effectiveType":{"type":"string","enum":["slow-2g","2g","3g","4g"]},"type":{"type":"string","maxLength":16},"downlinkMbps":{"type":"number","minimum":0},"rttMs":{"type":"integer","minimum":0},"saveData":{"type":"boolean"}}}}},"status":{"type":"object","description":"A snapshot of what the candidate page can see right now. It replaces the previous snapshot.","properties":{"stage":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$","description":"Where the candidate is within the current step."},"blockedApps":{"type":"array","maxItems":20,"description":"Names of prohibited apps found running. Only a systems check reports these, and only reviewers see them.","items":{"type":"string","maxLength":60}},"facts":{"type":"object","description":"Things that are true or false right now, such as whether the camera is live.","additionalProperties":{"type":"boolean"}},"checks":{"type":"object","description":"The live readiness of each requirement the journey checks before the exam can start.","additionalProperties":{"type":"string","enum":["ok","attention","blocked"]}}}},"steps":{"type":"object","additionalProperties":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["started","completed","failed","skipped"]},"startedAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","format":"date-time"},"errorCode":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,63}$","description":"The key of the error the candidate was shown."}}}},"events":{"type":"array","description":"The most recent milestones, oldest first.","items":{"type":"object","required":["at","type"],"properties":{"at":{"type":"string","format":"date-time"},"writerGeneration":{"type":"integer","minimum":1},"source":{"type":"string","enum":["browser","desktop"]},"type":{"type":"string","enum":["step_started","step_completed","step_failed","step_skipped","journey_completed","restarted","handed_off"]},"step":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$","description":"The key of a preflight journey step."},"errorCode":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,63}$","description":"The key of the error the candidate was shown."}}}}}},"network":{"type":"object","readOnly":true,"nullable":true,"description":"How the network checks of this run went, including the results the candidate is not shown. Only served to reviewers.","properties":{"checksStarted":{"type":"integer","minimum":0},"checks":{"type":"array","description":"The most recent checks, oldest first.","items":{"type":"object","required":["id","tier","startedAt"],"properties":{"id":{"type":"string"},"tier":{"type":"string","enum":["basic","audio","video"],"description":"What the exam asks of the candidate’s connection: nothing recorded, audio, or video."},"startedAt":{"type":"string","format":"date-time"},"writerGeneration":{"type":"integer","minimum":1},"completedAt":{"type":"string","format":"date-time"},"metrics":{"type":"object","additionalProperties":false,"required":["durationMs"],"description":"What the candidate’s browser measured. Every part is optional except how long the check took, and a part the browser could not measure is left out.","properties":{"durationMs":{"type":"number","minimum":0,"maximum":600000},"reachability":{"type":"object","additionalProperties":false,"description":"Whether the browser got any answer at all from the exam’s own hosts, which the probes it was handed point at. A part the browser could not test is left out.","properties":{"files":{"type":"boolean","description":"The host exam media is served from."},"storage":{"type":"boolean","description":"The accelerated storage endpoint answers are uploaded to."},"synoptic":{"type":"boolean","description":"The proctoring server answered over a WebSocket. Only for a proctored attempt."},"turn":{"type":"boolean","description":"The video relay handed out a relay candidate. Only for a proctored attempt."}}},"synopticSocket":{"type":"object","additionalProperties":false,"required":["heldMs","closedEarly"],"description":"How the proctoring socket fared once it had answered: the browser holds it open for the rest of the check, so a network that lets a WebSocket open and then cuts it off shows up here. Left out when the socket never answered.","properties":{"heldMs":{"type":"number","minimum":0,"maximum":600000,"description":"How long the socket stayed open before the browser let it go, or before the network closed it."},"closedEarly":{"type":"boolean","description":"The network closed the socket before the browser let it go."},"closeCode":{"type":"integer","minimum":0,"maximum":65535,"description":"The WebSocket close code, when the network closed it."}}},"probes":{"type":"object","additionalProperties":false,"required":["attempts","failures"],"description":"Every small request made during the check: reachability probes, API pings and the latency requests.","properties":{"attempts":{"type":"integer","minimum":0,"maximum":10000},"failures":{"type":"integer","minimum":0,"maximum":10000}}},"api":{"type":"object","additionalProperties":false,"required":["count","failures"],"properties":{"count":{"type":"integer","minimum":0,"maximum":10000},"failures":{"type":"integer","minimum":0,"maximum":10000},"medianMs":{"type":"number","minimum":0,"maximum":600000},"p95Ms":{"type":"number","minimum":0,"maximum":600000}},"description":"Authenticated pings of the API."},"latency":{"type":"object","additionalProperties":false,"description":"Small requests to the download host, while nothing else was moving and while a transfer was.","properties":{"idle":{"type":"object","additionalProperties":false,"required":["count","failures"],"properties":{"count":{"type":"integer","minimum":0,"maximum":10000},"failures":{"type":"integer","minimum":0,"maximum":10000},"medianMs":{"type":"number","minimum":0,"maximum":600000},"p95Ms":{"type":"number","minimum":0,"maximum":600000}}},"loaded":{"type":"object","additionalProperties":false,"required":["count","failures"],"properties":{"count":{"type":"integer","minimum":0,"maximum":10000},"failures":{"type":"integer","minimum":0,"maximum":10000},"medianMs":{"type":"number","minimum":0,"maximum":600000},"p95Ms":{"type":"number","minimum":0,"maximum":600000}}}}},"download":{"type":"object","additionalProperties":false,"required":["bytes","durationMs","failed","aborted"],"properties":{"bytes":{"type":"number","minimum":0,"maximum":1000000000},"durationMs":{"type":"number","minimum":0,"maximum":600000},"throughputMbps":{"type":"number","minimum":0,"maximum":100000},"longestStallMs":{"type":"number","minimum":0,"maximum":600000,"description":"The longest stretch in which no data moved while the transfer was under way."},"failed":{"type":"boolean","description":"The request errored."},"aborted":{"type":"boolean","description":"The client gave up because no data moved for several seconds. A transfer that was only cut off by the time allowed, while still moving, is neither failed nor aborted."}}},"upload":{"type":"object","additionalProperties":false,"required":["bytes","durationMs","failed","aborted"],"properties":{"bytes":{"type":"number","minimum":0,"maximum":1000000000},"durationMs":{"type":"number","minimum":0,"maximum":600000},"throughputMbps":{"type":"number","minimum":0,"maximum":100000},"longestStallMs":{"type":"number","minimum":0,"maximum":600000,"description":"The longest stretch in which no data moved while the transfer was under way."},"failed":{"type":"boolean","description":"The request errored."},"aborted":{"type":"boolean","description":"The client gave up because no data moved for several seconds. A transfer that was only cut off by the time allowed, while still moving, is neither failed nor aborted."}}},"connection":{"type":"object","additionalProperties":false,"description":"What the browser says about the connection, kept as context only.","properties":{"effectiveType":{"type":"string","maxLength":16},"downlinkMbps":{"type":"number","minimum":0,"maximum":100000},"rttMs":{"type":"number","minimum":0,"maximum":600000},"saveData":{"type":"boolean"}}}}},"verdict":{"type":"object","required":["thresholdsVersion","overall","candidateOverall","findings"],"properties":{"thresholdsVersion":{"type":"integer","minimum":1},"overall":{"type":"string","enum":["ok","warn","error"]},"candidateOverall":{"type":"string","enum":["ok","warn","error"],"description":"What the candidate was shown, which only counts the results that clearly mean trouble."},"findings":{"type":"array","items":{"type":"object","required":["id","status","candidateVisible"],"properties":{"id":{"type":"string"},"status":{"type":"string","enum":["ok","warn","error"]},"reason":{"type":"string"},"candidateVisible":{"type":"boolean"}}}}}}}}}}},"systemsCheckRunId":{"type":"string","maxLength":64,"writeOnly":true,"description":"Preflight create only: the id of the systems check the candidate completed in this browser. Kept on the run when it is a completed systems check of the same attempt, and ignored otherwise."},"webVersion":{"type":"string","writeOnly":true,"description":"The version of the web app in use. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"desktopVersion":{"type":"string","writeOnly":true,"description":"The version of the desktop proctoring application, when one is in use. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"extensionVersion":{"type":"string","writeOnly":true,"description":"The version of the browser extension, when one is in use. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"os":{"type":"string","writeOnly":true,"description":"The operating system, as the browser reports it. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"browser":{"type":"string","writeOnly":true,"description":"The browser, as it reports itself. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"timezone":{"type":"string","writeOnly":true,"description":"The time zone of the device. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"locale":{"type":"string","writeOnly":true,"description":"The language the device is set to. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"synopticLevel":{"type":"string","writeOnly":true,"description":"The level of proctoring software the journey is running in. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"resumeRunId":{"type":"string","maxLength":64,"writeOnly":true,"description":"Create: the run this browser holds the key for, to resume it instead of starting another."},"resumeKey":{"type":"string","minLength":16,"maxLength":128,"writeOnly":true,"description":"Create: the key issued when that run was created."},"takeover":{"type":"boolean","writeOnly":true,"description":"Create: end a preflight that is in progress on another device and start one here."},"key":{"type":"string","minLength":16,"maxLength":128,"description":"Returned once, when a run is created, and never again. The browser keeps it and sends it with every progress update, so only that browser can write to the run."},"resumed":{"type":"boolean","readOnly":true,"description":"True when creating returned a run that was already in progress on this browser, restarted, rather than a new one."},"completedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"When the journey was completed, if it has been."},"currentStep":{"type":"string","enum":["welcome","connect","confirm","system","network","displays","apps","tabs","media","speakers","room-scan","second-camera","identity","screen","full-screen","ready","results"],"description":"Progress update: the step the candidate is on. Sent with every heartbeat.","writeOnly":true},"visible":{"type":"boolean","writeOnly":true,"description":"Progress update: whether the preflight page is visible to the candidate."},"route":{"type":"string","maxLength":128,"writeOnly":true,"description":"Progress update: the name of the route the candidate is on, never a URL."},"plannedSteps":{"type":"array","writeOnly":true,"maxItems":30,"description":"Progress update: the steps the journey will take the candidate through, in order. Sent when it starts and whenever it changes.","items":{"type":"string","enum":["welcome","connect","confirm","system","network","displays","apps","tabs","media","speakers","room-scan","second-camera","identity","screen","full-screen","ready","results"],"description":"The key of a preflight journey step."}},"device":{"type":"object","required":["clientTime","screenWidth","screenHeight","windowWidth","windowHeight","isFullscreen"],"description":"What the candidate's device reported when it last checked in: its clock, screen and window size, whether the page is full screen, and its connection.","properties":{"clientTime":{"type":"string","format":"date-time","description":"The time on the device's own clock."},"pageUrl":{"type":"string","maxLength":300,"description":"The address the candidate is using, without any query string or fragment."},"screenWidth":{"type":"integer","minimum":0,"maximum":32768},"screenHeight":{"type":"integer","minimum":0,"maximum":32768},"windowWidth":{"type":"integer","minimum":0,"maximum":32768},"windowHeight":{"type":"integer","minimum":0,"maximum":32768},"windowX":{"type":"integer","description":"Distance from the left of the screen to the browser window.","minimum":-32768,"maximum":32768},"windowY":{"type":"integer","description":"Distance from the top of the screen to the browser window.","minimum":-32768,"maximum":32768},"isExtendedDisplay":{"type":"boolean","description":"Whether the device has more than one screen, when the browser says."},"mediaDevices":{"type":"array","description":"The cameras and microphones the browser can see.","maxItems":20,"items":{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["audioinput","videoinput"]},"label":{"type":"string","maxLength":120},"selectable":{"type":"boolean","description":"Whether this device appears in the candidate picker after filtering and deduplication."}}}},"screenShare":{"type":"object","description":"The active screen capture track, when available. This does not identify a primary or external display.","required":["active"],"properties":{"active":{"type":"boolean"},"label":{"type":"string","maxLength":120},"surface":{"type":"string","enum":["monitor","window","browser"]},"width":{"type":"integer","minimum":0,"maximum":32768},"height":{"type":"integer","minimum":0,"maximum":32768}}},"pixelRatio":{"type":"number","minimum":0,"maximum":16},"isFullscreen":{"type":"boolean"},"memoryGb":{"type":"number","minimum":0},"cpuCores":{"type":"integer","minimum":0},"architecture":{"type":"string","maxLength":16},"bitness":{"type":"string","maxLength":8},"connection":{"type":"object","description":"What the browser reports about the connection. Not every browser reports it.","properties":{"effectiveType":{"type":"string","enum":["slow-2g","2g","3g","4g"]},"type":{"type":"string","maxLength":16},"downlinkMbps":{"type":"number","minimum":0},"rttMs":{"type":"integer","minimum":0},"saveData":{"type":"boolean"}}}},"writeOnly":true},"status":{"type":"object","description":"A snapshot of what the candidate page can see right now. It replaces the previous snapshot.","properties":{"stage":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$","description":"Where the candidate is within the current step."},"blockedApps":{"type":"array","maxItems":20,"description":"Names of prohibited apps found running. Only a systems check reports these, and only reviewers see them.","items":{"type":"string","maxLength":60}},"facts":{"type":"object","description":"Things that are true or false right now, such as whether the camera is live.","additionalProperties":{"type":"boolean"}},"checks":{"type":"object","description":"The live readiness of each requirement the journey checks before the exam can start.","additionalProperties":{"type":"string","enum":["ok","attention","blocked"]}}},"writeOnly":true},"events":{"type":"array","writeOnly":true,"maxItems":20,"description":"Progress update: milestones since the last update. step is required for every type except journey_completed.","items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["step_started","step_completed","step_failed","step_skipped","journey_completed","restarted","handed_off"]},"step":{"type":"string","enum":["welcome","connect","confirm","system","network","displays","apps","tabs","media","speakers","room-scan","second-camera","identity","screen","full-screen","ready","results"],"description":"The key of a preflight journey step."},"errorCode":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,63}$","description":"The key of the error the candidate was shown."}}}}},"required":["type"]},"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"]}}}}},"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/PreflightRun"}}}}}},"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"}}}}}}}},"operationId":"preflightRuns.createPreflightRun"},"get":{"summary":"Find PreflightRun","description":"Newest first. Returns the 10 newest runs of the attempt unless a page is asked for; the total number of runs is in the pagination metadata.","tags":["Preflight"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"attempt":{"type":"string"}},"required":["attempt"]}},{"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/PreflightRun"}},"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"}}}}}}}},"operationId":"preflightRuns.findPreflightRuns"}},"/preflight-runs/{object_id}":{"patch":{"summary":"Record PreflightRun progress","description":"Sent by the candidate while the preflight journey is open, as a heartbeat and whenever a step starts, finishes or fails. Returns the run with authoritative, which is false once a newer preflight of the same attempt has been started.","tags":["Preflight"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PreflightRun"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PreflightRun"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PreflightRun"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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":"Required room-scan evidence is missing or no longer matches this preflight journey.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"operationId":"preflightRuns.recordPreflightProgress"},"get":{"summary":"Get PreflightRun","tags":["Preflight"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["PreflightRun"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PreflightRun"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"preflightRuns.getPreflightRun"}},"/proctor-reviews":{"get":{"summary":"List ProctorReviews","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"proctorReview.findProctorReviews"},"post":{"summary":"Create ProctorReview","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"proctorReview.createProctorReview"}},"/proctor-reviews/{object_id}":{"patch":{"summary":"Update ProctorReview","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ProctorReview"]}],"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"}}}}}}}},"operationId":"proctorReview.updateProctorReview"},"delete":{"summary":"Delete ProctorReview","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ProctorReview"]}],"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"}}}}}}}},"operationId":"proctorReview.deleteProctorReview"}},"/product-lists":{"post":{"summary":"Create ProductList","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"productLists.createProductList"},"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"}}}}}}}},"operationId":"productLists.findProductLists"}},"/product-lists/{object_id}":{"get":{"summary":"Get ProductList","tags":["Shop"],"security":[],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ProductList"]},{"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"}}}}}}}},"operationId":"productLists.getProductList"},"patch":{"summary":"Update ProductList","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ProductList"]}],"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"}}}}}}}},"operationId":"productLists.updateProductList"},"delete":{"summary":"Delete ProductList","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ProductList"]}],"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"}}}}}}}},"operationId":"productLists.deleteProductList"}},"/product-lists/{object_id}/relationships/products":{"post":{"summary":"Add Products","tags":["Shop"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ProductList"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"productLists.addProducts"},"patch":{"summary":"Set Products","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ProductList"]}],"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"}}}}}}}},"operationId":"productLists.setProducts"},"delete":{"summary":"Remove Products","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ProductList"]}],"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"}}}}}}}},"operationId":"productLists.removeProducts"}},"/products":{"post":{"summary":"Create Product","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"products.createProduct"},"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"}}}}}}}},"operationId":"products.findProducts"}},"/products/{object_id}":{"get":{"summary":"Get Product","tags":["Shop"],"security":[],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Product"]},{"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"}}}}}}}},"operationId":"products.getProduct"},"patch":{"summary":"Update Product","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Product"]}],"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"}}}}}}}},"operationId":"products.updateProduct"},"delete":{"summary":"Delete Product","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Product"]}],"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"}}}}}}}},"operationId":"products.deleteProduct"}},"/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"}}}}}}}},"operationId":"publicAttributeConfig.findPublicAttributeConfigs"}},"/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"}}}}}}}},"operationId":"publicAuthenticationOptions.findPublicAuthenticationOptions"}},"/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"}}}}}}}},"operationId":"publicCertificates.findPublicCertificates"}},"/question-exports":{"post":{"summary":"Create QuestionExport","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"questionExports.createQuestionExport"}},"/question-import-validations":{"post":{"summary":"Create QuestionImportValidation","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"questionImportValidations.createQuestionImportValidation"}},"/question-imports":{"post":{"summary":"Create QuestionImport","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"questionImports.createQuestionImport"}},"/question-summaries":{"get":{"summary":"List QuestionSummaries","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"questionSummary.findQuestionSummaries"}},"/quiz-attempt-setup-configs":{"get":{"summary":"List QuizAttemptSetupConfigs","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"quizAttemptSetupConfigs.findQuizAttemptSetupConfigs"}},"/quiz-attempt-setup-configs/{object_id}":{"get":{"summary":"Get QuizAttemptSetupConfig","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizAttemptSetupConfig"]}],"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"}}}}}}}},"operationId":"quizAttemptSetupConfigs.getQuizAttemptSetupConfig"}},"/quiz-emq-groups":{"post":{"summary":"Create QuizEmqGroup","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"quizEmqGroups.createQuizEmqGroup"}},"/quiz-emq-groups/{object_id}":{"get":{"summary":"Get QuizEmqGroup","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizEmqGroup"]},{"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"}}}}}}}},"operationId":"quizEmqGroups.getQuizEmqGroup"},"patch":{"summary":"Update QuizEmqGroup","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizEmqGroup"]}],"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"}}}}}}}},"operationId":"quizEmqGroups.updateQuizEmqGroup"},"delete":{"summary":"Delete QuizEmqGroup","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizEmqGroup"]}],"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"}}}}}}}},"operationId":"quizEmqGroups.deleteQuizEmqGroup"}},"/quiz-emq-groups/{object_id}/relationships/questions":{"patch":{"summary":"Update quiz section questions.","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizEmqGroup"]}],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer","QuizQuestionCoding"],"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"}}}}}}}},"operationId":"quizEmqGroups.updateQuizEmqGroupQuestions"}},"/quiz-pdf-attempt-exports":{"post":{"summary":"Create QuizPdfAttemptExport","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"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. Marks on an attempt that is not finalised are labelled provisional."},"withCorrectOptions":{"type":"boolean","nullable":true,"description":"transcript only. Includes correct answers. Output is watermarked as not for candidate release."},"withFeedback":{"type":"boolean","nullable":true,"description":"transcript only. Prints the author's feedback beneath each question."},"withMarkScheme":{"type":"boolean","nullable":true,"description":"transcript only. Prints each question’s marking criteria and maximum marks beneath it, with a box per criterion for the marks awarded. Restricted to the roles that may request answers."},"fontSizePt":{"type":"number","enum":[11,15,18]},"fontFamily":{"type":"string","enum":["sans-serif","serif"]}}},"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"]}}}}},"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,"maxItems":500,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Attempt"],"example":"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"}}}}}}}},"operationId":"quizPdfAttemptExports.createQuizPdfAttemptExport"}},"/quiz-pdf-exports":{"post":{"summary":"Create QuizPdfExport","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"},"showFeedback":{"type":"boolean"},"showTags":{"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"}}}}}}}},"operationId":"quizPdfExports.createQuizPdfExport"}},"/quiz-question-audio-recording":{"post":{"summary":"Create QuizQuestionAudioRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionAudioRecording.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionAudioRecording.findQuizQuestion"}},"/quiz-question-audio-recording/{object_id}":{"get":{"summary":"Get QuizQuestionAudioRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionAudioRecording"]}],"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"}}}}}}}},"operationId":"quizQuestionAudioRecording.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionAudioRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionAudioRecording"]}],"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"}}}}}}}},"operationId":"quizQuestionAudioRecording.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionAudioRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["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"}}}}}}}},"operationId":"quizQuestionAudioRecording.deleteQuizQuestion"}},"/quiz-question-bow-tie":{"post":{"summary":"Create QuizQuestionBowTie","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"QuizQuestionBowTie","enum":["QuizQuestionBowTie"]},"attributes":{"type":"object","required":["groups"],"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},"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":["bowTie"]},"optionFormat":{"type":"string","readOnly":false,"enum":["plainText"],"description":"How option content is written. Bow tie options are plain text only: text that is stored and shown exactly as typed. Group labels are always plain text.","default":"plainText"},"groups":{"type":"array","readOnly":false,"minItems":3,"maxItems":3,"description":"Exactly three groups, one for each of left, centre, right, sent in any order and stored in that order. The candidate picks 2, 1 and 2 options from the left, centre and right pools. Sent in full on update: the list replaces the stored groups.","items":{"type":"object","additionalProperties":false,"required":["key","label","options","correctOptionKeys"],"properties":{"key":{"type":"string","readOnly":false,"enum":["left","centre","right"],"description":"The position of the group in the bow tie."},"label":{"type":"string","readOnly":false,"minLength":1,"maxLength":100,"description":"The heading candidates see above the group. Plain text, saved exactly as sent apart from trimming surrounding whitespace, up to 100 characters."},"options":{"type":"array","readOnly":false,"maxItems":30,"description":"The pool of options the candidate chooses from for this group: at least 3 for left, 2 for centre and 3 for right, and at most 30. Options that are not correct are the distractors. Options must be unique within a group: the comparison ignores case, markup, zero-width characters and extra whitespace.","items":{"type":"object","additionalProperties":false,"required":["key","content"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its group. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":10000,"description":"Plain text, saved exactly as sent apart from trimming surrounding whitespace, of up to 500 characters. It is never parsed as HTML, so characters such as < and & are kept as typed."}}}},"correctOptionKeys":{"type":"array","readOnly":false,"items":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its group. Letters, numbers, hyphens and underscores only."},"description":"The keys of the correct options of this group: exactly 2 for left, 1 for centre and 2 for right. They must be distinct options of the same group."}}}},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"],"description":"Whether each pool is shuffled for every candidate. The three pools shuffle independently; the groups themselves never move.","default":"disabled"},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate"],"description":"exactMatch awards the credits only when every group has exactly its correct options. proportionate awards a fifth of the credits for each correct option the candidate selected; the groups are scored independently and nothing is deducted.","default":"exactMatch"}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionBowTie"}}}}}},"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"}}}}}}}},"operationId":"quizQuestionBowTie.createQuizQuestion"},"get":{"summary":"List QuizQuestionBowTie","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"}}}}}}}},"operationId":"quizQuestionBowTie.findQuizQuestion"}},"/quiz-question-bow-tie/{object_id}":{"get":{"summary":"Get QuizQuestionBowTie","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionBowTie"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionBowTie"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"quizQuestionBowTie.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionBowTie","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionBowTie"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionBowTie"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionBowTie"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"quizQuestionBowTie.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionBowTie","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionBowTie"]}],"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"}}}}}}}},"operationId":"quizQuestionBowTie.deleteQuizQuestion"}},"/quiz-question-bulk-actions":{"post":{"summary":"Create QuizQuestionBulkAction","description":"Adds tags to, and removes tags from, many of a quiz’s questions in a background job, returned with status 202. The caller needs to be able to update the quiz, which must not be archived or locked. The quiz is locked against other changes while the job runs, and each question is changed only if the caller may update it. The BackgroundJob result is { affected, skipped, failed }: affected counts the questions changed, skipped those that already had every tag to add and lacked every tag to remove, and failed lists each question that could not be changed with its reason: notInQuiz, accessDenied or failed.","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"QuizQuestionBulkAction","enum":["QuizQuestionBulkAction"]},"attributes":{"type":"object","additionalProperties":false,"required":["scope","action"],"properties":{"scope":{"description":"Which of the quiz's questions to change: either an explicit list of at most 5000 question ids, or everything matching a filter and search, which are read as they are for the quiz's list of QuizQuestionSummaries. An empty filter and no search selects every question. A selection of more than 5000 questions is refused.","oneOf":[{"type":"object","additionalProperties":false,"required":["questionIds"],"properties":{"questionIds":{"type":"array","minItems":1,"maxItems":5000,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"filter":{"type":"object","additionalProperties":false,"properties":{"type":{"oneOf":[{"type":"array","items":{"type":"string","enum":["audioRecording","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"]}},{"type":"string","enum":["audioRecording","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"]}],"description":"Only questions of one of these types, including older questions that predate the stored type."},"tag":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}],"description":"Only questions carrying one of the tags listed for each facet. Tags of the same facet are alternatives, and tags without a facet count as one facet of their own, so the question must match every facet that is named."},"section":{"type":"string","description":"Only the questions of this static section, by QuizSection id. A dynamic section selects questions by rule, so it matches none."},"emqGroup":{"type":"string","description":"Only the questions of this EMQ group."}}},"search":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\x00-\\x08\\x0b\\x0c\\x0e-\\x1f]*$"}}}]},"action":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"type":"string","enum":["updateTags"],"description":"updateTags adds the tags in addTagIds that a question lacks and removes the tags in removeTagIds that it has. At least one tag is needed between the two lists, and no tag may be in both."},"addTagIds":{"type":"array","maxItems":50,"items":{"type":"string"},"description":"Tags to add. They are in the quiz’s portal and the caller can read them."},"removeTagIds":{"type":"array","maxItems":50,"items":{"type":"string"},"description":"Tags to remove. They are in the quiz’s portal and the caller can read them."}}}}},"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/QuizQuestionBulkAction"}}}}}},"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"}}}}}}}},"operationId":"quizQuestionBulkActions.createQuizQuestionBulkAction"}},"/quiz-question-choice-matrix":{"post":{"summary":"Create QuizQuestionChoiceMatrix","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"QuizQuestionChoiceMatrix","enum":["QuizQuestionChoiceMatrix"]},"attributes":{"type":"object","required":["rows","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},"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":["choiceMatrix"]},"selectionMode":{"type":"string","readOnly":false,"enum":["single","multiple"],"description":"single: the candidate selects exactly one option in each row and every row has exactly one correct option. multiple: the candidate selects one or more options in each row and every row has one or more correct options. The mode applies to every row. Changing it re-validates the stored rows.","default":"single"},"rowFormat":{"type":"string","readOnly":false,"enum":["plainText","richText"],"description":"How row content is written: plainText (the default) is text that is stored and shown exactly as typed, richText is HTML from the rich text editor, which is sanitised. Images are not allowed in either.","default":"plainText"},"optionFormat":{"type":"string","readOnly":false,"enum":["plainText","richText"],"description":"How option content is written, with the same rules as rowFormat.","default":"plainText"},"rows":{"type":"array","readOnly":false,"minItems":2,"maxItems":30,"description":"The statements the candidate answers, in the order they are shown. Rows must be unique: the comparison ignores case, markup, zero-width characters and extra whitespace. Sent in full on update: the list replaces the stored rows. Changing rowFormat requires sending the rows again.","items":{"type":"object","additionalProperties":false,"required":["key","content","correctOptionKeys"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":10000,"description":"Plain text when rowFormat is plainText: saved exactly as sent, apart from trimming surrounding whitespace. It is never parsed as HTML, so characters such as < and & are kept as typed, and it can have up to 500 characters. Otherwise rich text HTML of up to 10000 characters, without images or other embedded content."},"correctOptionKeys":{"type":"array","readOnly":false,"minItems":1,"maxItems":10,"description":"The keys of the options that are correct for this row, each one an existing option, without repeats. Exactly one when selectionMode is single, one or more when it is multiple. A row is only correct when the candidate selects exactly these options.","items":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."}}}}},"options":{"type":"array","readOnly":false,"minItems":2,"maxItems":10,"description":"The options the candidate chooses from, shared by every row, in the order they are shown. An option such as \"None apply\" is an ordinary option. Options must be unique: the comparison ignores case, markup, zero-width characters and extra whitespace. Sent in full on update: the list replaces the stored options. Changing optionFormat requires sending the options again.","items":{"type":"object","additionalProperties":false,"required":["key","content"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":10000,"description":"Plain text when optionFormat is plainText: saved exactly as sent, apart from trimming surrounding whitespace. It is never parsed as HTML, so characters such as < and & are kept as typed, and it can have up to 500 characters. Otherwise rich text HTML of up to 10000 characters, without images or other embedded content."}}}},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate"],"description":"exactMatch: full credit only when every row is correct. proportionate: credit for the share of rows that are correct. A row is correct only when the selected options equal its correct options.","default":"exactMatch"}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionChoiceMatrix"}}}}}},"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"}}}}}}}},"operationId":"quizQuestionChoiceMatrix.createQuizQuestion"},"get":{"summary":"List QuizQuestionChoiceMatrix","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"}}}}}}}},"operationId":"quizQuestionChoiceMatrix.findQuizQuestion"}},"/quiz-question-choice-matrix/{object_id}":{"get":{"summary":"Get QuizQuestionChoiceMatrix","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionChoiceMatrix"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionChoiceMatrix"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"quizQuestionChoiceMatrix.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionChoiceMatrix","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionChoiceMatrix"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionChoiceMatrix"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionChoiceMatrix"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"quizQuestionChoiceMatrix.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionChoiceMatrix","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionChoiceMatrix"]}],"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"}}}}}}}},"operationId":"quizQuestionChoiceMatrix.deleteQuizQuestion"}},"/quiz-question-classification":{"post":{"summary":"Create QuizQuestionClassification","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"QuizQuestionClassification","enum":["QuizQuestionClassification"]},"attributes":{"type":"object","required":["items","categories"],"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},"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":["classification"]},"itemFormat":{"type":"string","readOnly":false,"enum":["plainText","richText"],"description":"How item content is written: plainText (the default) is text that is stored and shown exactly as typed, richText is HTML from the rich text editor, which is sanitised. Images are not allowed in either. Category content is always plain text.","default":"plainText"},"items":{"type":"array","readOnly":false,"minItems":2,"maxItems":30,"description":"The items a candidate sorts into categories. Items must be unique: the comparison ignores case, markup, zero-width characters and extra whitespace. Sent in full on update: the list replaces the stored items.","items":{"type":"object","additionalProperties":false,"required":["key","content","correctCategoryKey"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":10000,"description":"Plain text when itemFormat is plainText: saved exactly as sent, apart from trimming surrounding whitespace. It is never parsed as HTML, so characters such as < and & are kept as typed, and it can have up to 500 characters. Otherwise rich text HTML of up to 10000 characters, without images or other embedded content."},"correctCategoryKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"The key of the category this item belongs to. Every item belongs to exactly one category."}}}},"categories":{"type":"array","readOnly":false,"minItems":2,"maxItems":30,"description":"The categories the items are sorted into. A category that no item belongs to is valid. Categories must be unique: the comparison ignores case, zero-width characters and extra whitespace. Sent in full on update: the list replaces the stored categories.","items":{"type":"object","additionalProperties":false,"required":["key","content"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":500,"description":"Plain text, saved exactly as sent apart from trimming surrounding whitespace. It is never parsed as HTML, and it can have up to 500 characters."}}}},"itemShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"],"default":"disabled"},"categoryShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"],"default":"disabled"},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate"],"default":"exactMatch"}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClassification"}}}}}},"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"}}}}}}}},"operationId":"quizQuestionClassification.createQuizQuestion"},"get":{"summary":"List QuizQuestionClassification","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"}}}}}}}},"operationId":"quizQuestionClassification.findQuizQuestion"}},"/quiz-question-classification/{object_id}":{"get":{"summary":"Get QuizQuestionClassification","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionClassification"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClassification"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"quizQuestionClassification.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionClassification","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionClassification"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClassification"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionClassification"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"quizQuestionClassification.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionClassification","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionClassification"]}],"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"}}}}}}}},"operationId":"quizQuestionClassification.deleteQuizQuestion"}},"/quiz-question-cloze-drag-and-drop":{"post":{"summary":"Create QuizQuestionClozeDragAndDrop","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionClozeDragAndDrop.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionClozeDragAndDrop.findQuizQuestion"}},"/quiz-question-cloze-drag-and-drop/{object_id}":{"get":{"summary":"Get QuizQuestionClozeDragAndDrop","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionClozeDragAndDrop"]}],"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"}}}}}}}},"operationId":"quizQuestionClozeDragAndDrop.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionClozeDragAndDrop","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionClozeDragAndDrop"]}],"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"}}}}}}}},"operationId":"quizQuestionClozeDragAndDrop.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionClozeDragAndDrop","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionClozeDragAndDrop"]}],"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"}}}}}}}},"operationId":"quizQuestionClozeDragAndDrop.deleteQuizQuestion"}},"/quiz-question-cloze-drop-down":{"post":{"summary":"Create QuizQuestionClozeDropDown","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionClozeDropDown.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionClozeDropDown.findQuizQuestion"}},"/quiz-question-cloze-drop-down/{object_id}":{"get":{"summary":"Get QuizQuestionClozeDropDown","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionClozeDropDown"]}],"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"}}}}}}}},"operationId":"quizQuestionClozeDropDown.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionClozeDropDown","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionClozeDropDown"]}],"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"}}}}}}}},"operationId":"quizQuestionClozeDropDown.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionClozeDropDown","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionClozeDropDown"]}],"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"}}}}}}}},"operationId":"quizQuestionClozeDropDown.deleteQuizQuestion"}},"/quiz-question-cloze-text":{"post":{"summary":"Create QuizQuestionClozeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionClozeText.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionClozeText.findQuizQuestion"}},"/quiz-question-cloze-text/{object_id}":{"get":{"summary":"Get QuizQuestionClozeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionClozeText"]}],"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"}}}}}}}},"operationId":"quizQuestionClozeText.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionClozeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionClozeText"]}],"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"}}}}}}}},"operationId":"quizQuestionClozeText.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionClozeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionClozeText"]}],"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"}}}}}}}},"operationId":"quizQuestionClozeText.deleteQuizQuestion"}},"/quiz-question-coding":{"post":{"summary":"Create QuizQuestionCoding","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"QuizQuestionCoding","enum":["QuizQuestionCoding"]},"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},"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":["coding"]},"language":{"type":"string","readOnly":false,"enum":["javascript","typescript","html","css","python"],"description":"The language the code editor highlights. It is the only editor setting an author controls.","default":"javascript"},"template":{"type":"string","readOnly":false,"nullable":true,"maxLength":100000,"description":"The starting code the editor opens with for a candidate who has not saved an answer. Plain text: it is stored exactly as sent and never run or rendered as HTML."}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionCoding"}}}}}},"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"}}}}}}}},"operationId":"quizQuestionCoding.createQuizQuestion"},"get":{"summary":"List QuizQuestionCoding","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"}}}}}}}},"operationId":"quizQuestionCoding.findQuizQuestion"}},"/quiz-question-coding/{object_id}":{"get":{"summary":"Get QuizQuestionCoding","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionCoding"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionCoding"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"quizQuestionCoding.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionCoding","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionCoding"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionCoding"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionCoding"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"quizQuestionCoding.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionCoding","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionCoding"]}],"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"}}}}}}}},"operationId":"quizQuestionCoding.deleteQuizQuestion"}},"/quiz-question-drawing":{"post":{"summary":"Create QuizQuestionDrawing","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"quizQuestionDrawing.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionDrawing.findQuizQuestion"}},"/quiz-question-drawing/{object_id}":{"get":{"summary":"Get QuizQuestionDrawing","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionDrawing"]}],"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"}}}}}}}},"operationId":"quizQuestionDrawing.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionDrawing","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionDrawing"]}],"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"}}}}}}}},"operationId":"quizQuestionDrawing.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionDrawing","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionDrawing"]}],"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"}}}}}}}},"operationId":"quizQuestionDrawing.deleteQuizQuestion"}},"/quiz-question-file-upload":{"post":{"summary":"Create QuizQuestionFileUpload","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionFileUpload.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionFileUpload.findQuizQuestion"}},"/quiz-question-file-upload/{object_id}":{"get":{"summary":"Get QuizQuestionFileUpload","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionFileUpload"]}],"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"}}}}}}}},"operationId":"quizQuestionFileUpload.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionFileUpload","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionFileUpload"]}],"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"}}}}}}}},"operationId":"quizQuestionFileUpload.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionFileUpload","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionFileUpload"]}],"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"}}}}}}}},"operationId":"quizQuestionFileUpload.deleteQuizQuestion"}},"/quiz-question-flashcard":{"post":{"summary":"Create QuizQuestionFlashcard","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionFlashcard.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionFlashcard.findQuizQuestion"}},"/quiz-question-flashcard/{object_id}":{"get":{"summary":"Get QuizQuestionFlashcard","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionFlashcard"]}],"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"}}}}}}}},"operationId":"quizQuestionFlashcard.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionFlashcard","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionFlashcard"]}],"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"}}}}}}}},"operationId":"quizQuestionFlashcard.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionFlashcard","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionFlashcard"]}],"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"}}}}}}}},"operationId":"quizQuestionFlashcard.deleteQuizQuestion"}},"/quiz-question-free-text":{"post":{"summary":"Create QuizQuestionFreeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionFreeText.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionFreeText.findQuizQuestion"}},"/quiz-question-free-text/{object_id}":{"get":{"summary":"Get QuizQuestionFreeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionFreeText"]}],"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"}}}}}}}},"operationId":"quizQuestionFreeText.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionFreeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionFreeText"]}],"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"}}}}}}}},"operationId":"quizQuestionFreeText.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionFreeText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionFreeText"]}],"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"}}}}}}}},"operationId":"quizQuestionFreeText.deleteQuizQuestion"}},"/quiz-question-image-hotspot":{"post":{"summary":"Create QuizQuestionImageHotspot","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"quizQuestionImageHotspot.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionImageHotspot.findQuizQuestion"}},"/quiz-question-image-hotspot/{object_id}":{"get":{"summary":"Get QuizQuestionImageHotspot","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionImageHotspot"]}],"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"}}}}}}}},"operationId":"quizQuestionImageHotspot.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionImageHotspot","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionImageHotspot"]}],"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"}}}}}}}},"operationId":"quizQuestionImageHotspot.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionImageHotspot","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionImageHotspot"]}],"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"}}}}}}}},"operationId":"quizQuestionImageHotspot.deleteQuizQuestion"}},"/quiz-question-image-labelling-drag-and-drop":{"post":{"summary":"Create QuizQuestionImageLabellingDragAndDrop","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"QuizQuestionImageLabellingDragAndDrop","enum":["QuizQuestionImageLabellingDragAndDrop"]},"attributes":{"type":"object","required":["slots","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},"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":["imageLabellingDragAndDrop"]},"optionFormat":{"type":"string","readOnly":false,"enum":["plainText","richText"],"description":"How answer content is written: plainText (the default) is text that is stored and shown exactly as typed, richText is HTML from the rich text editor, which is sanitised. Images are not allowed in either.","default":"plainText"},"slots":{"type":"array","readOnly":false,"minItems":1,"maxItems":30,"description":"The fixed slots a candidate places options into, positioned over the background image. Sent in full on update: the list replaces the stored slots.","items":{"type":"object","additionalProperties":false,"required":["key","centerX","centerY","acceptedOptionKeys"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"groupKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"The key of the option group this belongs to. Required when optionGroups is set and not allowed otherwise."},"centerX":{"type":"number","readOnly":false,"minimum":0,"maximum":100,"description":"The horizontal centre of the slot as a percentage of the image width."},"centerY":{"type":"number","readOnly":false,"minimum":0,"maximum":100,"description":"The vertical centre of the slot as a percentage of the image height."},"acceptedOptionKeys":{"type":"array","readOnly":false,"minItems":1,"description":"The keys of the options that are correct for this slot. At least one is needed. When option groups are used they must all belong to the slot's own group.","items":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."}}}}},"options":{"type":"array","readOnly":false,"minItems":2,"maxItems":30,"description":"The options a candidate chooses from. Options that no slot accepts act as distractors. Options must be unique: the comparison ignores case, markup, zero-width characters and extra whitespace. Sent in full on update: the list replaces the stored options.","items":{"type":"object","additionalProperties":false,"required":["key","content"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"groupKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"The key of the option group this belongs to. Required when optionGroups is set and not allowed otherwise."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":10000,"description":"Plain text when optionFormat is plainText: saved exactly as sent, apart from trimming surrounding whitespace. It is never parsed as HTML, so characters such as < and & are kept as typed, and it can have up to 500 characters. Otherwise rich text HTML of up to 10000 characters, without images or other embedded content."}}}},"optionGroups":{"type":"array","readOnly":false,"nullable":true,"description":"Optional named groups of options, 2 to 6 of them when used. Each slot belongs to one group and only accepts options from it, and the candidate sees one bank of options per group. When set, every option and slot needs a groupKey, and each group needs at least one slot and one option. Group labels must be unique, ignoring case and extra whitespace. Sent in full on update: the list replaces the stored groups, and null removes the groups.","items":{"type":"object","additionalProperties":false,"required":["key","label"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"label":{"type":"string","readOnly":false,"minLength":1,"maxLength":100,"description":"Plain text shown as the heading of the group."}}}},"allowOptionReuse":{"type":"boolean","readOnly":false,"description":"Whether the same answer can be placed in more than one slot. It applies to every option group.","default":false},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"],"default":"disabled"},"tileWidth":{"type":"number","readOnly":false,"exclusiveMinimum":true,"minimum":0,"maximum":100,"description":"The width of every slot and answer tile as a percentage of the image width.","default":14},"tileHeight":{"type":"number","readOnly":false,"exclusiveMinimum":true,"minimum":0,"maximum":100,"description":"The height of every slot and answer tile as a percentage of the image height.","default":8},"transparentSlots":{"type":"boolean","readOnly":false,"description":"Show slots without a border or background, for diagrams that already draw the empty boxes.","default":false},"backgroundAltText":{"type":"string","readOnly":false,"nullable":true,"maxLength":500,"description":"An optional description of the background image for screen readers. It must not give away the options."},"pointPerSlot":{"type":"number","readOnly":false,"nullable":true,"minimum":0,"description":"The points for each correctly filled slot. Required when scoring is matchPerBlank."},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate","matchPerBlank"],"description":"exactMatch needs every slot right, proportionate awards credit in proportion to the slots filled correctly, and matchPerBlank awards pointPerSlot for each slot filled correctly.","default":"exactMatch"}}},"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":"QuizQuestionImageLabellingDragAndDrop","enum":["QuizQuestionImageLabellingDragAndDrop"]}}}}},"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/QuizQuestionImageLabellingDragAndDrop"}}}}}},"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"}}}}}}}},"operationId":"quizQuestionImageLabellingDragAndDrop.createQuizQuestion"},"get":{"summary":"List QuizQuestionImageLabellingDragAndDrop","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"}}}}}}}},"operationId":"quizQuestionImageLabellingDragAndDrop.findQuizQuestion"}},"/quiz-question-image-labelling-drag-and-drop/{object_id}":{"get":{"summary":"Get QuizQuestionImageLabellingDragAndDrop","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionImageLabellingDragAndDrop"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionImageLabellingDragAndDrop"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"quizQuestionImageLabellingDragAndDrop.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionImageLabellingDragAndDrop","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionImageLabellingDragAndDrop"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionImageLabellingDragAndDrop"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionImageLabellingDragAndDrop"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"quizQuestionImageLabellingDragAndDrop.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionImageLabellingDragAndDrop","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionImageLabellingDragAndDrop"]}],"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"}}}}}}}},"operationId":"quizQuestionImageLabellingDragAndDrop.deleteQuizQuestion"}},"/quiz-question-image-labelling-drop-down":{"post":{"summary":"Create QuizQuestionImageLabellingDropDown","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"QuizQuestionImageLabellingDropDown","enum":["QuizQuestionImageLabellingDropDown"]},"attributes":{"type":"object","required":["slots"],"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},"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":["imageLabellingDropDown"]},"slots":{"type":"array","readOnly":false,"minItems":1,"maxItems":30,"description":"The slots a candidate answers, positioned over the background image. Each slot has its own dropdown. Sent in full on update: the list replaces the stored slots.","items":{"type":"object","additionalProperties":false,"required":["key","centerX","centerY","choices"],"properties":{"key":{"type":"string","readOnly":false,"minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"centerX":{"type":"number","readOnly":false,"minimum":0,"maximum":100,"description":"The horizontal centre of the slot as a percentage of the image width."},"centerY":{"type":"number","readOnly":false,"minimum":0,"maximum":100,"description":"The vertical centre of the slot as a percentage of the image height."},"choices":{"type":"array","readOnly":false,"minItems":2,"maxItems":10,"description":"The choices in the dropdown of this slot. Exactly one is correct. Choices must be unique within the slot: the comparison ignores case, zero-width characters and extra whitespace.","items":{"type":"object","additionalProperties":false,"required":["key","content","correct"],"properties":{"key":{"type":"string","readOnly":false,"minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":200,"description":"Plain text, saved exactly as sent apart from trimming surrounding whitespace. It is never parsed as HTML. Up to 200 characters."},"correct":{"type":"boolean","readOnly":false,"description":"Whether this is the correct choice for the slot."}}}}}}},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"],"description":"Whether the choices of each slot are shuffled for every candidate. Slots keep their order.","default":"disabled"},"fieldWidth":{"type":"number","readOnly":false,"nullable":true,"exclusiveMinimum":true,"minimum":0,"maximum":100,"description":"The width of every slot as a percentage of the image width. Null fits each slot to its longest choice."},"fieldHeight":{"type":"number","readOnly":false,"nullable":true,"exclusiveMinimum":true,"minimum":0,"maximum":100,"description":"The height of every slot as a percentage of the image height. Null fits each slot to its content."},"backgroundAltText":{"type":"string","readOnly":false,"nullable":true,"maxLength":500,"description":"An optional description of the background image for screen readers. It must not give away the answers."},"pointPerSlot":{"type":"number","readOnly":false,"nullable":true,"minimum":0,"description":"The points for each correctly answered slot. Required when scoring is matchPerBlank."},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate","matchPerBlank"],"description":"exactMatch needs every slot right, proportionate awards credit in proportion to the slots answered correctly, and matchPerBlank awards pointPerSlot for each slot answered correctly.","default":"exactMatch"}}},"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":"QuizQuestionImageLabellingDropDown","enum":["QuizQuestionImageLabellingDropDown"]}}}}},"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/QuizQuestionImageLabellingDropDown"}}}}}},"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"}}}}}}}},"operationId":"quizQuestionImageLabellingDropDown.createQuizQuestion"},"get":{"summary":"List QuizQuestionImageLabellingDropDown","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"}}}}}}}},"operationId":"quizQuestionImageLabellingDropDown.findQuizQuestion"}},"/quiz-question-image-labelling-drop-down/{object_id}":{"get":{"summary":"Get QuizQuestionImageLabellingDropDown","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionImageLabellingDropDown"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionImageLabellingDropDown"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"quizQuestionImageLabellingDropDown.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionImageLabellingDropDown","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionImageLabellingDropDown"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionImageLabellingDropDown"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionImageLabellingDropDown"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"quizQuestionImageLabellingDropDown.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionImageLabellingDropDown","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionImageLabellingDropDown"]}],"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"}}}}}}}},"operationId":"quizQuestionImageLabellingDropDown.deleteQuizQuestion"}},"/quiz-question-image-labelling-text":{"post":{"summary":"Create QuizQuestionImageLabellingText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"QuizQuestionImageLabellingText","enum":["QuizQuestionImageLabellingText"]},"attributes":{"type":"object","required":["slots"],"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},"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":["imageLabellingText"]},"slots":{"type":"array","readOnly":false,"minItems":1,"maxItems":30,"description":"The slots a candidate types an answer into, positioned over the background image. Sent in full on update: the list replaces the stored slots.","items":{"type":"object","additionalProperties":false,"required":["key","centerX","centerY","acceptedAnswers"],"properties":{"key":{"type":"string","readOnly":false,"minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"centerX":{"type":"number","readOnly":false,"minimum":0,"maximum":100,"description":"The horizontal centre of the slot as a percentage of the image width."},"centerY":{"type":"number","readOnly":false,"minimum":0,"maximum":100,"description":"The vertical centre of the slot as a percentage of the image height."},"acceptedAnswers":{"type":"array","readOnly":false,"minItems":1,"maxItems":10,"description":"The answers that are correct for this slot. They must be unique after trimming, collapsing whitespace and Unicode normalisation, ignoring case unless caseSensitive is set.","items":{"type":"string","readOnly":false,"minLength":1,"maxLength":200}}}}},"caseSensitive":{"type":"boolean","readOnly":false,"description":"Whether the capitalisation of a typed answer has to match.","default":false},"disableSpellcheck":{"type":"boolean","readOnly":false,"description":"Whether spellcheck and autocorrect are switched off in the answer slots.","default":false},"fieldWidth":{"type":"number","readOnly":false,"nullable":true,"exclusiveMinimum":true,"minimum":0,"maximum":100,"description":"The width of every slot as a percentage of the image width. Null fits each slot to its longest accepted answer."},"fieldHeight":{"type":"number","readOnly":false,"nullable":true,"exclusiveMinimum":true,"minimum":0,"maximum":100,"description":"The height of every slot as a percentage of the image height. Null fits each slot to its content."},"backgroundAltText":{"type":"string","readOnly":false,"nullable":true,"maxLength":500,"description":"An optional description of the background image for screen readers. It must not give away the answers."},"pointPerSlot":{"type":"number","readOnly":false,"nullable":true,"minimum":0,"description":"The points for each correctly answered slot. Required when scoring is matchPerBlank."},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate","matchPerBlank"],"description":"exactMatch needs every slot right, proportionate awards credit in proportion to the slots answered correctly, and matchPerBlank awards pointPerSlot for each slot answered correctly.","default":"exactMatch"}}},"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":"QuizQuestionImageLabellingText","enum":["QuizQuestionImageLabellingText"]}}}}},"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/QuizQuestionImageLabellingText"}}}}}},"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"}}}}}}}},"operationId":"quizQuestionImageLabellingText.createQuizQuestion"},"get":{"summary":"List QuizQuestionImageLabellingText","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"}}}}}}}},"operationId":"quizQuestionImageLabellingText.findQuizQuestion"}},"/quiz-question-image-labelling-text/{object_id}":{"get":{"summary":"Get QuizQuestionImageLabellingText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionImageLabellingText"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionImageLabellingText"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"quizQuestionImageLabellingText.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionImageLabellingText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionImageLabellingText"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionImageLabellingText"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionImageLabellingText"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"quizQuestionImageLabellingText.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionImageLabellingText","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionImageLabellingText"]}],"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"}}}}}}}},"operationId":"quizQuestionImageLabellingText.deleteQuizQuestion"}},"/quiz-question-informational":{"post":{"summary":"Create QuizQuestionInformational","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionInformational.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionInformational.findQuizQuestion"}},"/quiz-question-informational/{object_id}":{"get":{"summary":"Get QuizQuestionInformational","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionInformational"]}],"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"}}}}}}}},"operationId":"quizQuestionInformational.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionInformational","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionInformational"]}],"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"}}}}}}}},"operationId":"quizQuestionInformational.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionInformational","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionInformational"]}],"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"}}}}}}}},"operationId":"quizQuestionInformational.deleteQuizQuestion"}},"/quiz-question-likert":{"post":{"summary":"Create QuizQuestionLikert","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"QuizQuestionLikert","enum":["QuizQuestionLikert"]},"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]},"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},"questionType":{"type":"string","readOnly":true,"enum":["likert"]},"options":{"type":"array","readOnly":false,"minItems":2,"maxItems":10,"description":"The points of the scale in order, from first to last: 2 to 10 of them. The candidate chooses exactly one. A point's value is its position, starting at 1, so reordering the labels changes what existing responses mean. A Likert question is never marked: it has no correct answer, credits, penalties, scoring strategy or option shuffling, and every response is excluded from scoring. Sent in full on update: the list replaces the stored scale.","items":{"type":"object","additionalProperties":false,"required":["content"],"properties":{"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":100,"description":"The label of the point. Plain text, saved exactly as sent apart from trimming surrounding whitespace and shown as text, never as HTML, up to 100 characters. Labels must be unique: the comparison ignores case, zero-width characters and extra whitespace."}}}}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionLikert"}}}}}},"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"}}}}}}}},"operationId":"quizQuestionLikert.createQuizQuestion"},"get":{"summary":"List QuizQuestionLikert","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"}}}}}}}},"operationId":"quizQuestionLikert.findQuizQuestion"}},"/quiz-question-likert/{object_id}":{"get":{"summary":"Get QuizQuestionLikert","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionLikert"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionLikert"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"quizQuestionLikert.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionLikert","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionLikert"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionLikert"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionLikert"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"quizQuestionLikert.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionLikert","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionLikert"]}],"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"}}}}}}}},"operationId":"quizQuestionLikert.deleteQuizQuestion"}},"/quiz-question-matching":{"post":{"summary":"Create QuizQuestionMatching","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"QuizQuestionMatching","enum":["QuizQuestionMatching"]},"attributes":{"type":"object","required":["prompts","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},"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":["matching"]},"promptFormat":{"type":"string","readOnly":false,"enum":["plainText","richText"],"description":"How prompt content is written: plainText (the default) is text that is stored and shown exactly as typed, richText is HTML from the rich text editor, which is sanitised. Images are not allowed in either.","default":"plainText"},"optionFormat":{"type":"string","readOnly":false,"enum":["plainText","richText"],"description":"How option content is written: plainText (the default) is text that is stored and shown exactly as typed, richText is HTML from the rich text editor, which is sanitised. Images are not allowed in either.","default":"plainText"},"prompts":{"type":"array","readOnly":false,"minItems":2,"maxItems":30,"description":"The prompts a candidate matches to options. Sent in full on update: the list replaces the stored prompts.","items":{"type":"object","additionalProperties":false,"required":["key","content","correctOptionKey"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":10000,"description":"Plain text when promptFormat is plainText: saved exactly as sent, apart from trimming surrounding whitespace. It is never parsed as HTML, so characters such as < and & are kept as typed, and it can have up to 500 characters. Otherwise rich text HTML of up to 10000 characters, without images or other embedded content."},"correctOptionKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"The key of the option that is the correct match for this prompt."}}}},"options":{"type":"array","readOnly":false,"minItems":2,"maxItems":30,"description":"The options shared by all prompts. Options that no prompt matches act as distractors. Options must be unique: the comparison ignores case, markup, zero-width characters and extra whitespace. Sent in full on update: the list replaces the stored options.","items":{"type":"object","additionalProperties":false,"required":["key","content"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":10000,"description":"Plain text when optionFormat is plainText: saved exactly as sent, apart from trimming surrounding whitespace. It is never parsed as HTML, so characters such as < and & are kept as typed, and it can have up to 500 characters. Otherwise rich text HTML of up to 10000 characters, without images or other embedded content."}}}},"allowOptionReuse":{"type":"boolean","readOnly":false,"description":"Whether several prompts can have the same option as their correct match.","default":false},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"],"default":"disabled"},"promptShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"],"default":"disabled"},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate"],"default":"exactMatch"}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionMatching"}}}}}},"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"}}}}}}}},"operationId":"quizQuestionMatching.createQuizQuestion"},"get":{"summary":"List QuizQuestionMatching","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"}}}}}}}},"operationId":"quizQuestionMatching.findQuizQuestion"}},"/quiz-question-matching/{object_id}":{"get":{"summary":"Get QuizQuestionMatching","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionMatching"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionMatching"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"quizQuestionMatching.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionMatching","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionMatching"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionMatching"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionMatching"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"quizQuestionMatching.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionMatching","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionMatching"]}],"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"}}}}}}}},"operationId":"quizQuestionMatching.deleteQuizQuestion"}},"/quiz-question-multiple-correct":{"post":{"summary":"Create QuizQuestionMultipleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionMultipleCorrect.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionMultipleCorrect.findQuizQuestion"}},"/quiz-question-multiple-correct/{object_id}":{"get":{"summary":"Get QuizQuestionMultipleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionMultipleCorrect"]}],"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"}}}}}}}},"operationId":"quizQuestionMultipleCorrect.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionMultipleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionMultipleCorrect"]}],"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"}}}}}}}},"operationId":"quizQuestionMultipleCorrect.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionMultipleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionMultipleCorrect"]}],"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"}}}}}}}},"operationId":"quizQuestionMultipleCorrect.deleteQuizQuestion"}},"/quiz-question-numeric-answer":{"post":{"summary":"Create QuizQuestionNumericAnswer","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"QuizQuestionNumericAnswer","enum":["QuizQuestionNumericAnswer"]},"attributes":{"type":"object","required":["rules"],"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},"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},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false,"description":"When false (the default) any accepted answer earns the question credit. When true each rule may carry its own credit and the highest matching rule credit is awarded."},"questionType":{"type":"string","readOnly":true,"enum":["numericAnswer"]},"prefix":{"type":"string","readOnly":false,"nullable":true,"maxLength":20,"description":"Text shown before the answer box, such as a currency symbol. Plain text, display only: it is never part of the candidate's answer and never marked. Trimmed, up to 20 characters. Send null or an empty string to clear it."},"suffix":{"type":"string","readOnly":false,"nullable":true,"maxLength":20,"description":"Text shown after the answer box, such as a unit like kg. Plain text, display only: there is no unit conversion and it is never marked. Trimmed, up to 20 characters. Send null or an empty string to clear it."},"precisionMode":{"type":"string","readOnly":false,"enum":["none","exactDecimalPlaces","maxDecimalPlaces"],"description":"The format requirement for the candidate's entry. none (the default) has no requirement. exactDecimalPlaces requires exactly decimalPlaces digits after the decimal point, so 1.50 satisfies 2 and 1.5 does not. maxDecimalPlaces requires at most decimalPlaces digits. The entry is never rounded or changed. The value is marked against the rules first; a value that matches a rule but does not meet the format scores zero and is recorded as formatValid false.","default":"none"},"decimalPlaces":{"type":"integer","readOnly":false,"minimum":0,"maximum":10,"description":"The number of decimal places the format requires, 0 to 10 (0 means a whole number). Required when precisionMode is not none and rejected when it is none. Changing precisionMode to none clears it."},"rules":{"type":"array","readOnly":false,"minItems":1,"maxItems":20,"description":"The accepted answers: 1 to 20 rules. Rules may overlap. When several rules accept the entry the rule with the highest credit is awarded, once (credits only count with markingScoreByChoiceEnabled): credits are never added up and the order of the rules does not matter. When no rule accepts it the answer is incorrect, and a blank entry is skipped, never zero. Where rules with equal credit accept the same entry, the rule that accepts the narrower interval wins (a plain exact value is the narrowest), then an exact rule beats a range of the same width, then the key in ascending order. Sent in full on update: the list replaces the stored rules.","items":{"type":"object","additionalProperties":false,"required":["key","matchType"],"properties":{"key":{"type":"string","readOnly":false,"minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","description":"Identifier set by the client, unique within the question. Letters, numbers, hyphens and underscores only."},"matchType":{"type":"string","readOnly":false,"enum":["exact","range"],"description":"exact accepts one value, or a value within a tolerance of it, and needs exact. range accepts every value from minimum to maximum inclusive and needs minimum and maximum. The fields that belong to the other match type are rejected."},"exact":{"type":"string","readOnly":false,"description":"The accepted value of an exact rule. A plain decimal number written as a string with a decimal point, for example \"42\", \"-0.5\" or \"12.50\": no plus sign, grouping commas, exponent, spaces, or a decimal point without digits on either side. At most 30 characters, not counting a leading minus. Trailing zeros are kept as sent."},"minimum":{"type":"string","readOnly":false,"description":"The lowest accepted value of a range rule, inclusive. A plain decimal number written as a string with a decimal point, for example \"42\", \"-0.5\" or \"12.50\": no plus sign, grouping commas, exponent, spaces, or a decimal point without digits on either side. At most 30 characters, not counting a leading minus. Trailing zeros are kept as sent."},"maximum":{"type":"string","readOnly":false,"description":"The highest accepted value of a range rule, inclusive. It cannot be lower than minimum. A plain decimal number written as a string with a decimal point, for example \"42\", \"-0.5\" or \"12.50\": no plus sign, grouping commas, exponent, spaces, or a decimal point without digits on either side. At most 30 characters, not counting a leading minus. Trailing zeros are kept as sent."},"toleranceType":{"type":"string","readOnly":false,"enum":["absolute","percentage"],"description":"Only for an exact rule, and only together with tolerance. absolute accepts values within tolerance of exact, bounds included. percentage accepts values within tolerance percent of the size of exact, so an exact of 0 accepts only exactly 0."},"tolerance":{"type":"string","readOnly":false,"description":"Only for an exact rule, and only together with toleranceType. How far from exact the rule still accepts, bounds included. Greater than 0, and for a percentage at most 10000. A plain decimal number written as a string with a decimal point, for example \"42\", \"-0.5\" or \"12.50\": no plus sign, grouping commas, exponent, spaces, or a decimal point without digits on either side. At most 30 characters, not counting a leading minus. Trailing zeros are kept as sent."},"credit":{"type":"number","readOnly":false,"exclusiveMinimum":true,"minimum":0,"maximum":100000,"description":"Optional. Only used when markingScoreByChoiceEnabled is true, and ignored otherwise: the marks awarded when this rule is the one that accepts the entry, more than 0 and up to 100000. Left out it defaults to the credit of the question. The question is worth the highest of these."},"feedback":{"type":"string","readOnly":false,"nullable":true,"maxLength":10000,"description":"Optional rich text feedback, sanitised like option feedback. Shown to the candidate only with the rest of the answers, and only for the rule that was awarded."}}}}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionNumericAnswer"}}}}}},"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"}}}}}}}},"operationId":"quizQuestionNumericAnswer.createQuizQuestion"},"get":{"summary":"List QuizQuestionNumericAnswer","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"}}}}}}}},"operationId":"quizQuestionNumericAnswer.findQuizQuestion"}},"/quiz-question-numeric-answer/{object_id}":{"get":{"summary":"Get QuizQuestionNumericAnswer","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionNumericAnswer"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionNumericAnswer"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"quizQuestionNumericAnswer.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionNumericAnswer","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionNumericAnswer"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionNumericAnswer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionNumericAnswer"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"quizQuestionNumericAnswer.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionNumericAnswer","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionNumericAnswer"]}],"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"}}}}}}}},"operationId":"quizQuestionNumericAnswer.deleteQuizQuestion"}},"/quiz-question-off-platform":{"post":{"summary":"Create QuizQuestionOffPlatform","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionOffPlatform.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionOffPlatform.findQuizQuestion"}},"/quiz-question-off-platform/{object_id}":{"get":{"summary":"Get QuizQuestionOffPlatform","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionOffPlatform"]}],"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"}}}}}}}},"operationId":"quizQuestionOffPlatform.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionOffPlatform","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionOffPlatform"]}],"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"}}}}}}}},"operationId":"quizQuestionOffPlatform.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionOffPlatform","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionOffPlatform"]}],"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"}}}}}}}},"operationId":"quizQuestionOffPlatform.deleteQuizQuestion"}},"/quiz-question-ranked":{"post":{"summary":"Create QuizQuestionRanked","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionRanked.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionRanked.findQuizQuestion"}},"/quiz-question-ranked/{object_id}":{"get":{"summary":"Get QuizQuestionRanked","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionRanked"]}],"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"}}}}}}}},"operationId":"quizQuestionRanked.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionRanked","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionRanked"]}],"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"}}}}}}}},"operationId":"quizQuestionRanked.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionRanked","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionRanked"]}],"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"}}}}}}}},"operationId":"quizQuestionRanked.deleteQuizQuestion"}},"/quiz-question-short-answer":{"post":{"summary":"Create QuizQuestionShortAnswer","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionShortAnswer.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionShortAnswer.findQuizQuestion"}},"/quiz-question-short-answer/{object_id}":{"get":{"summary":"Get QuizQuestionShortAnswer","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionShortAnswer"]}],"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"}}}}}}}},"operationId":"quizQuestionShortAnswer.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionShortAnswer","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionShortAnswer"]}],"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"}}}}}}}},"operationId":"quizQuestionShortAnswer.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionShortAnswer","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionShortAnswer"]}],"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"}}}}}}}},"operationId":"quizQuestionShortAnswer.deleteQuizQuestion"}},"/quiz-question-single-correct":{"post":{"summary":"Create QuizQuestionSingleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionSingleCorrect.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionSingleCorrect.findQuizQuestion"}},"/quiz-question-single-correct/{object_id}":{"get":{"summary":"Get QuizQuestionSingleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionSingleCorrect"]}],"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"}}}}}}}},"operationId":"quizQuestionSingleCorrect.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionSingleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionSingleCorrect"]}],"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"}}}}}}}},"operationId":"quizQuestionSingleCorrect.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionSingleCorrect","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionSingleCorrect"]}],"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"}}}}}}}},"operationId":"quizQuestionSingleCorrect.deleteQuizQuestion"}},"/quiz-question-spreadsheet":{"post":{"summary":"Create QuizQuestionSpreadsheet","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionSpreadsheet.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionSpreadsheet.findQuizQuestion"}},"/quiz-question-spreadsheet/{object_id}":{"get":{"summary":"Get QuizQuestionSpreadsheet","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionSpreadsheet"]}],"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"}}}}}}}},"operationId":"quizQuestionSpreadsheet.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionSpreadsheet","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionSpreadsheet"]}],"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"}}}}}}}},"operationId":"quizQuestionSpreadsheet.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionSpreadsheet","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionSpreadsheet"]}],"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"}}}}}}}},"operationId":"quizQuestionSpreadsheet.deleteQuizQuestion"}},"/quiz-question-summaries":{"get":{"summary":"List QuizQuestionSummaries","description":"A lightweight page of a quiz’s questions, in the quiz’s own order unless sorted, without options, feedback or media.","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","additionalProperties":false,"required":["quiz"],"properties":{"quiz":{"type":"string","description":"The quiz whose questions are listed. Requires read access to the quiz."},"type":{"oneOf":[{"type":"array","items":{"type":"string","enum":["audioRecording","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"]}},{"type":"string","enum":["audioRecording","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"]}],"description":"Only questions of one of these types, including older questions that predate the stored type."},"tag":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}],"description":"Only questions carrying one of the tags listed for each facet. Tags of the same facet are alternatives, and tags without a facet count as one facet of their own, so the question must match every facet that is named."},"section":{"type":"string","description":"Only the questions of this static section, by QuizSection id. A dynamic section selects questions by rule, so it matches none."},"emqGroup":{"type":"string","description":"Only the questions of this EMQ group."}}}},{"name":"search","in":"query","required":false,"allowReserved":true,"description":"Case-insensitive, literal match against the question’s name or its DOI, or an exact question id. The question’s stem is not searched. At most 200 characters without control characters, and a comma is part of the text searched. Applies together with the filters, and the total counts only matches.","schema":{"oneOf":[{"type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\x00-\\x08\\x0b\\x0c\\x0e-\\x1f]*$"},{"type":"array","minItems":2,"items":{"type":"string","pattern":"^[^\\x00-\\x08\\x0b\\x0c\\x0e-\\x1f]*$"}}]}},{"name":"sort","in":"query","required":false,"description":"Defaults to position, the quiz’s own order. A leading - sorts descending. questionType sorts by its code, such as clozeText, not by a label. Names sort without regard to case, and questions without a name sort last either way. Ties are listed in the order the questions were created. Questions that belong to the quiz but are not in its question order sort last by position. Sorting never changes the quiz’s own order.","schema":{"type":"string","enum":["position","-position","name","-name","questionType","-questionType","updatedAt","-updatedAt","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/QuizQuestionSummary"}},"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"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"quizQuestionSummaries.findQuizQuestionSummaries"}},"/quiz-question-text-selection":{"post":{"summary":"Create QuizQuestionTextSelection","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"QuizQuestionTextSelection","enum":["QuizQuestionTextSelection"]},"attributes":{"type":"object","required":["template","regions"],"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},"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":["textSelection"]},"template":{"type":"string","readOnly":false,"minLength":1,"maxLength":50000,"description":"The passage as rich text HTML, which is sanitised. Each region the candidate can select is an inline span carrying a data-text-selection-region attribute with its key, wrapped around the text it covers. The template holds keys only, never which regions are correct. Regions cannot overlap, nest, contain a block, link, form control or image, or repeat a key. Changing the template re-validates every region."},"regions":{"type":"array","readOnly":false,"minItems":2,"maxItems":100,"description":"One entry for every region in the template and no others. At least one region must be correct. Sent in full on update: the list replaces the stored regions. The text of a region comes from the template, never from the client, and is returned as content.","items":{"type":"object","additionalProperties":false,"required":["key","correct"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within the question. Letters, numbers, hyphens and underscores only. It must match the data-text-selection-region attribute of exactly one region in the template."},"correct":{"type":"boolean","readOnly":false,"description":"Whether selecting this region is correct."},"content":{"type":"string","readOnly":true,"maxLength":500,"description":"The plain text of the region, taken from the template with whitespace collapsed. Read only."}}}},"selectionLimitType":{"type":"string","readOnly":false,"enum":["any","max","exact"],"description":"any: the candidate can select any number of regions. max: up to as many regions as there are correct regions. exact: as many regions as there are correct regions are expected, although fewer are still marked. The number is derived when an attempt is generated, never authored. At the limit further selections are blocked.","default":"any"},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate","netCorrect"],"description":"exactMatch: full credit only when exactly the correct regions are selected. proportionate: credit for the share of regions judged correctly, counting a correct region selected and an incorrect region left alone. netCorrect: each correct region selected earns an equal share of the credit and each incorrect region selected takes one share away, never going below zero.","default":"exactMatch"}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionTextSelection"}}}}}},"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"}}}}}}}},"operationId":"quizQuestionTextSelection.createQuizQuestion"},"get":{"summary":"List QuizQuestionTextSelection","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"}}}}}}}},"operationId":"quizQuestionTextSelection.findQuizQuestion"}},"/quiz-question-text-selection/{object_id}":{"get":{"summary":"Get QuizQuestionTextSelection","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionTextSelection"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionTextSelection"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"quizQuestionTextSelection.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionTextSelection","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionTextSelection"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QuizQuestionTextSelection"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/QuizQuestionTextSelection"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"quizQuestionTextSelection.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionTextSelection","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionTextSelection"]}],"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"}}}}}}}},"operationId":"quizQuestionTextSelection.deleteQuizQuestion"}},"/quiz-question-true-or-false":{"post":{"summary":"Create QuizQuestionTrueOrFalse","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionTrueOrFalse.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionTrueOrFalse.findQuizQuestion"}},"/quiz-question-true-or-false/{object_id}":{"get":{"summary":"Get QuizQuestionTrueOrFalse","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionTrueOrFalse"]}],"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"}}}}}}}},"operationId":"quizQuestionTrueOrFalse.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionTrueOrFalse","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionTrueOrFalse"]}],"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"}}}}}}}},"operationId":"quizQuestionTrueOrFalse.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionTrueOrFalse","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionTrueOrFalse"]}],"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"}}}}}}}},"operationId":"quizQuestionTrueOrFalse.deleteQuizQuestion"}},"/quiz-question-video-recording":{"post":{"summary":"Create QuizQuestionVideoRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizQuestionVideoRecording.createQuizQuestion"},"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"}}}}}}}},"operationId":"quizQuestionVideoRecording.findQuizQuestion"}},"/quiz-question-video-recording/{object_id}":{"get":{"summary":"Get QuizQuestionVideoRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionVideoRecording"]}],"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"}}}}}}}},"operationId":"quizQuestionVideoRecording.getQuizQuestion"},"patch":{"summary":"Update QuizQuestionVideoRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionVideoRecording"]}],"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"}}}}}}}},"operationId":"quizQuestionVideoRecording.updateQuizQuestion"},"delete":{"summary":"Delete QuizQuestionVideoRecording","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizQuestionVideoRecording"]}],"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"}}}}}}}},"operationId":"quizQuestionVideoRecording.deleteQuizQuestion"}},"/quiz-sections":{"post":{"summary":"Create QuizSection","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizSections.createQuizSection"},"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"}}}}}}}},"operationId":"quizSections.findQuizSections"}},"/quiz-sections/{object_id}":{"get":{"summary":"Get QuizSection","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizSection"]},{"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"}}}}}}}},"operationId":"quizSections.getQuizSection"},"patch":{"summary":"Update QuizSection","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizSection"]}],"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"}}}}}}}},"operationId":"quizSections.updateQuizSection"},"delete":{"summary":"Delete QuizSection","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizSection"]}],"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"}}}}}}}},"operationId":"quizSections.deleteQuizSection"}},"/quiz-sections/{object_id}/relationships/questions":{"patch":{"summary":"Update quiz section questions.","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizSection"]}],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer","QuizQuestionCoding"],"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"}}}}}}}},"operationId":"quizSections.updateQuizSectionQuestions"},"post":{"summary":"Add quiz section questions.","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizSection"]}],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer","QuizQuestionCoding"],"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"}}}}}}}},"operationId":"quizSections.createQuizSectionQuestions"}},"/quiz-tag-breakdowns/{object_id}":{"get":{"summary":"Get QuizTagBreakdown","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["QuizTagBreakdown"]}],"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"}}}}}}}},"operationId":"quizTagBreakdowns.getQuizTagBreakdown"}},"/quizzes":{"post":{"summary":"Create Quiz","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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},"ignoreSkippedResponses":{"type":"boolean","readOnly":false},"reviewAndSubmitEnabled":{"type":"boolean","readOnly":false},"saveAndResumeEnabled":{"type":"boolean","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","failedSectionsOnly",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},"resitCloseMode":{"type":"string","enum":["sameAsExam","sameAsPreviousAttempt","delay"],"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":["rosalyn","synopticV2",null],"nullable":true},"proctorRequireSecondCamera":{"type":"boolean","readOnly":false,"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},"proctorLiveAiDetection":{"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,"maxItems":12,"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},"enabled":{"type":"boolean","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]},"proctorRoomScanCoverage":{"type":"string","enum":["off","workspace","full",null],"nullable":true},"proctorRoomScanDevice":{"type":"string","enum":["phone","webcam","either",null],"nullable":true},"identityCheckRequired":{"type":"boolean","readOnly":false,"nullable":false},"identityCheckFailureAction":{"type":"string","enum":["flag","block",null],"readOnly":false,"nullable":true},"identityCheckVendor":{"type":"string","enum":["stripe","entrust","internal",null],"readOnly":false,"nullable":true},"identityCheckAutomaticFaceMatch":{"type":"boolean","readOnly":false,"nullable":true,"description":"Internal identity checks only: compare the face on the ID with the candidate's photo automatically, instead of leaving every check for review."},"identityCheckNameComparison":{"type":"boolean","readOnly":false,"nullable":true,"description":"Internal identity checks only: compare the candidate's account name with the name on their ID automatically. Off unless set."},"identityCheckNameAction":{"type":"string","enum":["record","flag","block",null],"readOnly":false,"nullable":true,"description":"Internal identity checks only: what happens when the candidate's account name is not found on their ID. Defaults to flag."},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"}}}}}}}},"operationId":"quizzes.createQuiz"}},"/quizzes/{object_id}":{"get":{"summary":"Get Quiz","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Quiz"]},{"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"}}}}}}}},"operationId":"quizzes.getQuiz"},"patch":{"summary":"Update Quiz","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Quiz"]}],"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"}}}}}}}},"operationId":"quizzes.updateQuiz"},"delete":{"summary":"Delete Quiz","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Quiz"]}],"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"}}}}}}}},"operationId":"quizzes.deleteQuiz"}},"/quizzes/{object_id}/relationships/questions":{"patch":{"summary":"Update Quiz Questions","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Quiz"]}],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer","QuizQuestionCoding"],"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"}}}}}}}},"operationId":"quizzes.updateQuizQuestions"}},"/quizzes/{object_id}/relationships/sections":{"patch":{"summary":"Update Quiz Sections","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Quiz"]}],"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"}}}}}}}},"operationId":"quizzes.updateQuizSections"}},"/quizzes/{object_id}/relationships/source-content-quizzes":{"patch":{"summary":"Update Quiz Content Sources","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Quiz"]}],"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"}}}}}}}},"operationId":"quizzes.updateQuizContentSources"}},"/quizzes/{object_id}/relationships/source-settings-quiz":{"patch":{"summary":"Update Quiz Settings Source","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Quiz"]}],"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"}}}}}}}},"operationId":"quizzes.updateQuizSettingsSource"}},"/quizzes/{object_id}/relationships/sourceContentQuizzes":{"patch":{"summary":"Update Quiz Content Sources","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Quiz"]}],"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"}}}}}}}},"deprecated":true,"operationId":"quizzes.updateQuizContentSourcesDeprecated"}},"/quizzes/{object_id}/relationships/sourceSettingsQuiz":{"patch":{"summary":"Update Quiz Settings Source","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Quiz"]}],"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"}}}}}}}},"deprecated":true,"operationId":"quizzes.updateQuizSettingsSourceDeprecated"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Quiz"]}],"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"}}}}}}}},"operationId":"quizzes.addQuizCollaboratingUsers"},"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Quiz"]}],"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"}}}}}}}},"operationId":"quizzes.removeQuizCollaboratingUsers"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Quiz"]}],"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"}}}}}}}},"operationId":"quizzes.addQuizCollaboratingUserGroups"},"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Quiz"]}],"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"}}}}}}}},"operationId":"quizzes.removeQuizCollaboratingUserGroups"}},"/response-max-points-overrides":{"post":{"summary":"Create ResponseMaxPointsOverride","description":"Changes what one of an attempt's responses is worth, recalculates the attempt's score, section scores and grade, and reissues the certificate when the outcome changed. Requires the override-marking grant.","tags":["Marking"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"ResponseMaxPointsOverride","enum":["ResponseMaxPointsOverride"]},"attributes":{"type":"object","required":["maxPoints"],"properties":{"maxPoints":{"type":"number","minimum":0,"nullable":true},"notifyCandidate":{"type":"boolean","writeOnly":true,"description":"Off unless `true`. Email the candidate a short notice that their results were updated, with a link and no marks. Sent only for a released result once marking is final; the exam’s results-email setting and hidden-results page still apply. See `meta.notification`."},"previousMaxPoints":{"type":"number","nullable":true,"readOnly":true}}},"relationships":{"type":"object","required":["attempt","response"],"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"]}}}}},"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"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ResponseMaxPointsOverride"},"meta":{"type":"object","properties":{"certificate":{"type":"object","required":["action"],"properties":{"action":{"type":"string","enum":["unchanged","reissued","notIssued","deferred","failed"]},"certificateId":{"type":"string"},"reason":{"type":"string"}}},"notification":{"type":"object","required":["action"],"description":"The candidate email this write asked for. `requested` means it was handed to the notification queue after the exam’s own rules passed; it confirms neither that an email was queued nor that one was sent.","properties":{"action":{"type":"string","enum":["requested","skipped","failed"]},"reason":{"type":"string","description":"Why it was skipped (notRequested, outcomeUnchanged, notReleased, marksNotFinal, notExam, resultsEmailDisabled, resultsHidden) or failed."}}}}}}}}}},"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"},"meta":{"type":"object","properties":{"certificate":{"type":"object","required":["action"],"properties":{"action":{"type":"string","enum":["unchanged","reissued","notIssued","deferred","failed"]},"certificateId":{"type":"string"},"reason":{"type":"string"}}},"notification":{"type":"object","required":["action"],"description":"The candidate email this write asked for. `requested` means it was handed to the notification queue after the exam’s own rules passed; it confirms neither that an email was queued nor that one was sent.","properties":{"action":{"type":"string","enum":["requested","skipped","failed"]},"reason":{"type":"string","description":"Why it was skipped (notRequested, outcomeUnchanged, notReleased, marksNotFinal, notExam, resultsEmailDisabled, resultsHidden) or failed."}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"responseMaxPointsOverrides.createResponseMaxPointsOverride"}},"/room-scans":{"post":{"summary":"Create RoomScan","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"RoomScan","enum":["RoomScan"]},"attributes":{"type":"object","properties":{"key":{"type":"string","minLength":16,"maxLength":128,"writeOnly":true},"writerGeneration":{"type":"integer","minimum":1},"consent":{"type":"boolean","enum":[true],"writeOnly":true}},"required":["key","writerGeneration","consent"]},"relationships":{"type":"object","properties":{"preflightRun":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PreflightRun","enum":["PreflightRun"]}}}}}},"required":["preflightRun"]}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RoomScan"}}}}}},"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"}}}}}}}},"operationId":"roomScans.create"},"get":{"summary":"Find submitted RoomScans","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","properties":{"attempt":{"type":"string"}},"required":["attempt"]}},{"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/RoomScan"}},"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"}}}}}}}},"operationId":"roomScans.find"}},"/room-scans/{object_id}":{"patch":{"summary":"Update RoomScan","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["RoomScan"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RoomScan"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RoomScan"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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":"The setup journey, upload or scan state no longer permits this operation.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"operationId":"roomScans.review"},"get":{"summary":"Read RoomScan","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["RoomScan"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/RoomScan"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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":"The setup journey, upload or scan state no longer permits this operation.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"operationId":"roomScans.read"},"delete":{"summary":"Redact RoomScan","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["RoomScan"]}],"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"}}}}}}}},"operationId":"roomScans.redact"}},"/scorm-courses":{"post":{"summary":"Create ScormCourse","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"scormCourses.createScormCourse"}},"/scorm-courses/{object_id}":{"get":{"summary":"Get ScormCourse","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ScormCourse"]},{"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"}}}}}}}},"operationId":"scormCourses.getScormCourse"},"patch":{"summary":"Update ScormCourse","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ScormCourse"]}],"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"}}}}}}}},"operationId":"scormCourses.updateScormCourse"},"delete":{"summary":"Delete ScormCourse","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ScormCourse"]}],"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"}}}}}}}},"operationId":"scormCourses.deleteScormCourse"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ScormCourse"]}],"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"}}}}}}}},"operationId":"scormCourses.addScormCourseCollaboratingUsers"},"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ScormCourse"]}],"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"}}}}}}}},"operationId":"scormCourses.removeScormCourseCollaboratingUsers"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ScormCourse"]}],"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"}}}}}}}},"operationId":"scormCourses.addScormCourseCollaboratingUserGroups"},"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ScormCourse"]}],"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"}}}}}}}},"operationId":"scormCourses.removeScormCourseCollaboratingUserGroups"}},"/search-filter-configs":{"get":{"summary":"List SearchFilterConfigs","tags":["Search"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"searchFilterConfigs.findSearchFilterConfigs"}},"/search-results":{"get":{"summary":"Search","tags":["Search"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"searchResult.findSearchResults"}},"/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"}}}}}}}},"operationId":"sessionContexts.getSessionContext"}},"/store-offers/{object_id}":{"get":{"summary":"Get StoreOffer","tags":["Shop"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["StoreOffer"]}],"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"}}}}}}}},"operationId":"storeOffers.getStoreOffer"}},"/stripe-connect-sessions":{"post":{"summary":"Create StripeConnectSession","tags":["Integrations"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"StripeConnectSession","enum":["StripeConnectSession"]},"attributes":{"type":"object","properties":{"returnPath":{"type":"string","readOnly":false,"description":"Relative path on the portal to send the admin back to once Stripe has finished. Defaults to the integrations settings page."},"authoriseUrl":{"type":"string","readOnly":true,"description":"The Stripe page the admin must visit to connect their Stripe account."}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StripeConnectSession"}}}}}},"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"}}}}}}}},"operationId":"stripeConnectSessions.createStripeConnectSession"}},"/stripe-connections/{object_id}":{"delete":{"summary":"Disconnect Stripe","tags":["Integrations"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Integration"]}],"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"}}}}}}}},"operationId":"stripeConnections.deleteStripeConnection"}},"/studies/{object_id}":{"get":{"summary":"Get Study","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Study"]},{"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"}}}}}}}},"operationId":"study.getStudyById"},"patch":{"summary":"Update Study","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Study"]}],"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"}}}}}}}},"operationId":"study.updateStudy"}},"/studies":{"get":{"summary":"List Studies","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"study.getStudy"},"post":{"summary":"Create Study","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"study.createStudy"}},"/studies/{object_id}/relationships/items":{"post":{"summary":"Add StudyItems","tags":["Revision"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Study"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"study.addItems"},"delete":{"summary":"Remove StudyItems","tags":["Revision"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Study"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"study.removeItems"}},"/study-items/{object_id}":{"get":{"summary":"Get StudyItem","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["StudyItem"]},{"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"}}}}}}}},"operationId":"studyItem.getStudyItem"},"delete":{"summary":"Delete StudyItem","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["StudyItem"]}],"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"}}}}}}}},"operationId":"studyItem.deleteStudyItem"}},"/study-items":{"post":{"summary":"Create StudyItem","tags":["Revision"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"studyItem.createStudyItem"}},"/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"}}}}}}}},"operationId":"subPortal.createSubPortal"},"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"}}}}}}}},"operationId":"subPortal.findSubPortals"}},"/sub-portals/{object_id}":{"get":{"summary":"Get SubPortal","tags":["Portals"],"security":[],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["SubPortal"]}],"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"}}}}}}}},"operationId":"subPortal.getSubPortal"},"patch":{"summary":"Update SubPortal","tags":["Portals"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["SubPortal"]}],"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"}}}}}}}},"operationId":"subPortal.updateSubPortal"},"delete":{"summary":"Delete SubPortal","tags":["Portals"],"security":[{"SessionAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["SubPortal"]}],"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"}}}}}}}},"operationId":"subPortal.deleteSubPortal"}},"/subscriptions":{"get":{"summary":"List Subscriptions","tags":["Billing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"subscriptions.findSubscriptions"}},"/subscriptions/{object_id}":{"get":{"summary":"Get Subscription","tags":["Billing"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Subscription"]},{"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"}}}}}}}},"operationId":"subscriptions.getSubscription"}},"/survey-items":{"post":{"summary":"Create SurveyItem","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"surveyItems.createSurveyItem"}},"/survey-items/{object_id}":{"get":{"summary":"Get SurveyItem","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["SurveyItem"]}],"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"}}}}}}}},"operationId":"surveyItems.getSurveyItem"},"patch":{"summary":"Update SurveyItem","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["SurveyItem"]}],"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"}}}}}}}},"operationId":"surveyItems.updateSurveyItem"},"delete":{"summary":"Delete SurveyItem","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["SurveyItem"]}],"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"}}}}}}}},"operationId":"surveyItems.deleteSurveyItem"}},"/survey-pages":{"post":{"summary":"Create SurveyPage","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"surveyPages.createSurveyPage"}},"/survey-pages/{object_id}":{"get":{"summary":"Get SurveyPage","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["SurveyPage"]},{"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"}}}}}}}},"operationId":"surveyPages.getSurveyPage"},"patch":{"summary":"Update SurveyPage","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["SurveyPage"]}],"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"}}}}}}}},"operationId":"surveyPages.updateSurveyPage"},"delete":{"summary":"Delete SurveyPage","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["SurveyPage"]}],"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"}}}}}}}},"operationId":"surveyPages.deleteSurveyPage"}},"/survey-pages/{object_id}/relationships/items":{"patch":{"summary":"Update Survey Page Items","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["SurveyPage"]}],"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"}}}}}}}},"operationId":"surveyPages.updateSurveyPageItems"}},"/survey-responses":{"post":{"summary":"Create SurveyResponse","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"surveyResponses.createSurveyResponse"}},"/survey-responses/{object_id}":{"patch":{"summary":"Update SurveyResponse","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["SurveyResponse"]}],"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"}}}}}}}},"operationId":"surveyResponses.updateSurveyResponse"}},"/surveys":{"post":{"summary":"Create Survey","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"surveys.createSurvey"}},"/surveys/{object_id}":{"get":{"summary":"Get Survey","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Survey"]},{"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"}}}}}}}},"operationId":"surveys.getSurvey"},"patch":{"summary":"Update Survey","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Survey"]}],"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"}}}}}}}},"operationId":"surveys.updateSurvey"},"delete":{"summary":"Delete Survey","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Survey"]}],"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"}}}}}}}},"operationId":"surveys.deleteSurvey"}},"/surveys/{object_id}/relationships/pages":{"patch":{"summary":"Update Survey Pages","tags":["Library"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Survey"]}],"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"}}}}}}}},"operationId":"surveys.updateSurveyPages"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Survey"]}],"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"}}}}}}}},"operationId":"surveys.addSurveyCollaboratingUsers"},"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Survey"]}],"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"}}}}}}}},"operationId":"surveys.removeSurveyCollaboratingUsers"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Survey"]}],"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"}}}}}}}},"operationId":"surveys.addSurveyCollaboratingUserGroups"},"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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Survey"]}],"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"}}}}}}}},"operationId":"surveys.removeSurveyCollaboratingUserGroups"}},"/synoptic-ai-reviews":{"get":{"summary":"Find SynopticAiReview","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"synopticAiReviews.findSynopticAiReviews"}},"/synoptic-captures":{"get":{"summary":"Find SynopticCapture","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"synopticCaptures.findSynopticCaptures"}},"/synoptic-dom-recordings":{"get":{"summary":"Find SynopticDomRecording","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"synopticDomRecordings.findSynopticDomRecordings"}},"/synoptic-event-logs":{"get":{"summary":"Find SynopticEventLog","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"synopticEventLogs.findSynopticEventLogs"}},"/synoptic-sessions/{object_id}":{"get":{"summary":"Get SynopticSession","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["SynopticSession"]},{"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"}}}}}}}},"operationId":"synopticSessions.getSynopticSession"}},"/synoptic-sessions":{"post":{"summary":"Create SynopticSession","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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},"enabled":{"type":"boolean","nullable":true}}}},"onBreach":{"type":"string","enum":["freeze","silent"],"nullable":true},"liveProctoring":{"type":"boolean"},"secondCameraEnabled":{"type":"boolean","readOnly":true},"secondCameraRecordingStartedAt":{"type":"string","format":"date-time","readOnly":true},"secondCameraProcessingStatus":{"type":"string","enum":["pending","inProgress","completed","error"],"readOnly":true},"recordingStartedAt":{"type":"string","format":"date-time","readOnly":true},"domRecordingChunkCount":{"type":"number","readOnly":true,"description":"Number of recording chunks collated into domRecordingFile. Present only when the include is requested."}}},"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"]}}}}},"secondCameraFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}},"domRecordingFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"}}}}}}}},"operationId":"synopticSessions.createSynopticSession"},"get":{"summary":"Find SynopticSession","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"attempt":{"type":"string"},"exam":{"type":"string"},"candidate":{"type":"string"},"search":{"type":"string","maxLength":200},"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"},"watchable":{"type":"boolean","description":"Only sessions a proctor can watch live: the session has an attempt, live proctoring is on, and it is the current session of that attempt."}}}},{"name":"sort","in":"query","schema":{"type":"string","enum":["candidate","-candidate","sessionId","-sessionId","attemptId","-attemptId","peerConnectionStatus","-peerConnectionStatus","screenMonitoring","-screenMonitoring","webcamMonitoring","-webcamMonitoring"]}},{"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"}}}}}}}},"operationId":"synopticSessions.findSynopticSessions"}},"/synoptic-watch-tokens/{object_id}":{"get":{"summary":"Get SynopticWatchToken","tags":["Proctoring"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["SynopticWatchToken"]},{"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"}}}}}}}},"operationId":"synopticWatchTokens.getSynopticWatchToken"}},"/tag-sets":{"post":{"summary":"Create TagSet","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"tagSets.createTagSet"},"get":{"summary":"List TagSets","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"tagSets.findTagSets"}},"/tag-sets/{object_id}":{"get":{"summary":"Get TagSet","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["TagSet"]}],"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"}}}}}}}},"operationId":"tagSets.getTagSet"},"patch":{"summary":"Update TagSet","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["TagSet"]}],"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"}}}}}}}},"operationId":"tagSets.updateTagSet"},"delete":{"summary":"Delete TagSet","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["TagSet"]}],"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"}}}}}}}},"operationId":"tagSets.deleteTagSet"}},"/tags":{"post":{"summary":"Create Tag","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"tags.createTag"},"get":{"summary":"List Tags","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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."},"facet":{"oneOf":[{"type":"string","enum":["exam","module","subject","topic","subtopic","difficulty","skill","context","none"]},{"type":"array","minItems":1,"items":{"type":"string","enum":["exam","module","subject","topic","subtopic","difficulty","skill","context","none"]}}],"description":"Only tags of this facet, or of any of these facets. none matches tags that have no facet."}}}},{"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"}}}}}}}},"operationId":"tags.findTags"}},"/tags/{object_id}":{"get":{"summary":"Get Tag","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Tag"]}],"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"}}}}}}}},"operationId":"tags.getTag"},"patch":{"summary":"Update Tag","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Tag"]}],"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"}}}}}}}},"operationId":"tags.updateTag"},"delete":{"summary":"Delete Tag","tags":["Content Metadata"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Tag"]}],"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"}}}}}}}},"operationId":"tags.deleteTag"}},"/template-assets":{"get":{"summary":"List TemplateAssets","description":"The images and fonts of one template of the portal, newest first, for an educator, manager or admin. At most 100 are listed. When the template is a managed one that is not available to the sub-portal of the requester, because it is limited to another sub-portal or marked as unavailable to sub-portals, it is not found, exactly like an id that does not exist.","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","required":["template"],"properties":{"template":{"type":"string","description":"The id of the template whose files to list."},"status":{"type":"string","enum":["ready","pending","rejected","any"],"description":"Which files to list. Ready when it is left out. Pending lists the uploads that have not expired, and any lists every file that was recorded, expired uploads included."}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TemplateAsset"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"templateAssets.findTemplateAssets"},"post":{"summary":"Create TemplateAsset","description":"Starts the upload of an image or a font for a managed template, as an admin of the main portal. The answer says where to send the file in upload, and the file then has to be completed. The address of the file is made by the server from the template and the asset, never from what is sent here. An image is a PNG, JPEG or WebP of up to 8388608 bytes, with no side longer than 8192 pixels and no more than 41943040 pixels in all, and not animated, or an SVG of up to 10485760 bytes, which is cleaned up when it is completed: scripts, links to other files and anything that is not drawn are removed. A font is a WOFF2, WOFF, TTF or OTF file of up to 3145728 bytes. A template can have up to 40 files that are ready or still being uploaded, and an upload has 60 minutes. A legacy template has no files, and neither can an archived one be given any.","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"TemplateAsset","enum":["TemplateAsset"]},"attributes":{"type":"object","additionalProperties":false,"required":["filename","contentType","size"],"properties":{"filename":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the file, for people to recognise it by. It is not used to find the file, and what is not a letter or a number is left out of the address of the file."},"contentType":{"type":"string","description":"The type of the file: image/png, image/jpeg, image/webp, image/svg+xml, font/woff2, font/woff, font/ttf, font/otf. Anything else is refused with template-asset-type-not-allowed. The upload is pinned to it, and the file is checked against it when the asset is completed."},"size":{"type":"integer","description":"The size of the file in bytes, from 1 to 8388608 for a PNG, JPEG or WebP, 10485760 for an SVG and 3145728 for a font. Anything outside is refused with template-asset-empty or template-asset-too-large. The upload is pinned to exactly this size."}}},"relationships":{"type":"object","required":["template"],"properties":{"template":{"type":"object","description":"The managed template the file belongs to, which has to be in the portal of the requester, not archived. An asset belongs to one template and only that template can use it.","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":"Template","enum":["Template"]}}}}}}}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TemplateAsset"}}}}}},"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"}}}}}}}},"operationId":"templateAssets.createTemplateAsset"}},"/template-assets/{object_id}/complete":{"post":{"summary":"Complete TemplateAsset","description":"Checks the file that was uploaded, as an admin of the main portal, and when it is an acceptable image or font makes it ready, with its public address. A file that is not acceptable is refused with the code template-asset- followed by what is wrong (empty, size-mismatch, too-large, not-an-image, not-a-font, type-mismatch, corrupt, animated, dimensions or missing), and the asset is rejected for good. An upload that took longer than 60 minutes is refused with template-asset-expired. Completing a ready asset again answers it again, and completing a rejected one refuses it in the same way. When the check could not be made the answer is a server error and the asset stays pending, so completing it can be tried again.","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["TemplateAsset"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TemplateAsset"}}}}}},"400":{"description":"Bad Request. The file was refused, or the upload expired. The code says why, and the message can be shown to the person who uploaded it.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden: the requester is not an admin of the main portal.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"templateAssets.completeTemplateAsset"}},"/templates":{"get":{"summary":"List Templates","description":"Without a kind, the legacy templates of the portal and the built in ones for the usage, by name, which is what the certificate pickers offer, open to everyone who is signed in. For a usage of exam or assignment they carry only what the pickers read: the name, the html, whether it is a built in one, the orientation and the preview. A kind of managed lists the managed templates only and any lists both, by name then id, for an educator, manager or admin. Those listings, and a usage of any, also report the usage, the kind, the status, the parts, the draft, whether the template is archived and the other fields of managed templates. They leave out archived templates unless isArchived asks for them. They also depend on the sub-portal of the requester. Someone who is not in a sub-portal sees every managed template of the portal, those limited to a sub-portal included. Someone in a sub-portal sees the managed templates limited to that sub-portal and those of the whole portal that are not marked as unavailable to sub-portals, archived ones under the same rule, and nothing else. The legacy templates and the built in ones are the same for everyone.","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"object","properties":{"usage":{"type":"string","enum":["exam","assignment","any"],"description":"The usage to list. Exam when it is left out, and any lists both usages."},"kind":{"type":"string","enum":["legacy","managed","any"],"description":"Which templates to list. Legacy when it is left out. Managed and any need an educator, manager or admin, and list only the managed templates available to the sub-portal of the requester, when they are in one."},"isArchived":{"type":"string","enum":["true","false","any"],"description":"Omit or false for templates that are not archived, true for archived templates only, any for both. Legacy templates and the built in ones are never archived."}}}},{"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"}}}}}}}},"operationId":"templates.findTemplates"},"post":{"summary":"Create Template","description":"Creates a managed template in the portal of the requester, who must be an admin of the main portal and not of a sub-portal. The usage, the orientation and the sub-portal can only be set here. A sub-portal limits the template to it and has to belong to the portal, and a template with none is for the whole portal. When no draft is sent, the starter for the usage is used. A portal can have up to 100 managed templates that are not archived.","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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":"Template","enum":["Template"]},"attributes":{"type":"object","additionalProperties":false,"required":["name","usage","orientation"],"properties":{"name":{"type":"string","minLength":1,"maxLength":120,"description":"Up to 120 characters. It can be changed on a managed template, and not on a legacy one."},"htmlTemplate":{"type":"string","readOnly":true,"description":"The complete document of a legacy template. A managed template does not send it."},"isDefault":{"type":"boolean","readOnly":true,"description":"Whether this is one of the built in templates."},"orientation":{"type":"string","enum":["landscape","portrait"],"readOnly":false,"description":"The orientation certificates are issued in. It is set when a managed template is created, and changed by putting orientation in the draft and publishing the template."},"preview":{"type":"object","readOnly":true,"properties":{"svg":{"type":"string"},"image":{"type":"string"}}},"usage":{"type":"string","enum":["exam","assignment"],"readOnly":false,"description":"What the template is issued for. A template stored without a usage is reported as an exam template. It cannot change once a managed template exists."},"kind":{"type":"string","enum":["legacy","managed"],"readOnly":true,"description":"Managed templates are edited here. Legacy templates are written by Synap and cannot be edited, published or deleted here."},"status":{"type":"string","enum":["draft","published"],"readOnly":true,"description":"Draft until the first publish. Legacy templates are always published."},"hasUnpublishedChanges":{"type":"boolean","readOnly":true,"description":"Whether the draft differs from the published parts or stages a different orientation from the one being issued, or nothing has been published yet."},"shellVersion":{"type":"integer","nullable":true,"readOnly":true,"description":"The version of the Synap-owned shell the published parts were compiled with."},"parts":{"type":"object","required":["body","css"],"additionalProperties":false,"description":"The published parts. Managed templates only.","properties":{"body":{"type":"string","maxLength":200000,"description":"An HTML fragment that may contain Go template actions."},"css":{"type":"string","maxLength":200000,"description":"CSS, scoped to the content box when compiled."},"contentInset":{"type":"integer","minimum":0,"maximum":30,"default":10,"description":"Safe area inside the A4 sheet, in millimetres. Defaults to 10."},"background":{"type":"object","nullable":true,"required":["url","fit"],"additionalProperties":false,"description":"The image that fills the whole page behind the content. It can only be set here, as the style of the template cannot reach it. Null or left out for no background. The url has to be the address of an image uploaded to this template, and publishing or previewing refuses any address of another place.","properties":{"url":{"type":"string","minLength":1,"maxLength":2048,"description":"The url of an image uploaded to this template."},"fit":{"type":"string","enum":["cover","contain","stretch"],"description":"How the image fills the page. Cover scales it until it covers the page and crops what does not fit, contain scales it until all of it fits in the page, and stretch fills the page whatever the proportions of the image."}}}},"nullable":true,"readOnly":true},"draft":{"type":"object","required":["body","css"],"additionalProperties":false,"description":"The parts to start from. The starter for the usage is used when it is left out. The template is created with the orientation sent beside it, and the draft is staged with that orientation.","properties":{"body":{"type":"string","maxLength":200000,"description":"An HTML fragment that may contain Go template actions."},"css":{"type":"string","maxLength":200000,"description":"CSS, scoped to the content box when compiled."},"contentInset":{"type":"integer","minimum":0,"maximum":30,"default":10,"description":"Safe area inside the A4 sheet, in millimetres. Defaults to 10."},"background":{"type":"object","nullable":true,"required":["url","fit"],"additionalProperties":false,"description":"The image that fills the whole page behind the content. It can only be set here, as the style of the template cannot reach it. Null or left out for no background. The url has to be the address of an image uploaded to this template, and publishing or previewing refuses any address of another place.","properties":{"url":{"type":"string","minLength":1,"maxLength":2048,"description":"The url of an image uploaded to this template."},"fit":{"type":"string","enum":["cover","contain","stretch"],"description":"How the image fills the page. Cover scales it until it covers the page and crops what does not fit, contain scales it until all of it fits in the page, and stretch fills the page whatever the proportions of the image."}}}}},"isArchived":{"type":"boolean","readOnly":true,"description":"Whether the template has been archived. Archived templates are listed only when asked for, cannot be chosen for new settings and cannot be edited until they are unarchived. Send true to archive a published template and false to unarchive it, on its own, as an admin of the main portal. Sending the value it already has changes nothing. Legacy templates are never archived."},"availableToSubPortals":{"type":"boolean","description":"Whether sub-portals may use this template. Only a template that is not limited to a sub-portal has it: true unless it was set to false, and false means only the main portal may choose it for its exams and assignments, and the people of a sub-portal neither see it listed nor find it. Null for a template limited to a sub-portal and for a legacy template. It can be changed whenever the template is not archived, and only affects what is chosen from then on."},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}}},"relationships":{"type":"object","properties":{"subPortal":{"type":"object","description":"The sub-portal this template is limited to, which must belong to the portal of the requester. Empty for a template of the whole portal. It can only be set when the template is created. Only the people of that sub-portal and of the main portal see a template limited to a sub-portal.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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/Template"}}}}}},"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"}}}}}}}},"operationId":"templates.createTemplate"}},"/templates/catalogue":{"get":{"summary":"Get the TemplateCatalogue","description":"The values a template of this usage can print, with the Go template action that prints each, and the candidate attributes of the portal as a last group. Attributes are keyed by their label. For an educator, manager or admin.","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"object","required":["usage"],"properties":{"usage":{"type":"string","enum":["exam","assignment"]}}}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TemplateCatalogue"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}}},"operationId":"templates.getTemplateCatalogue"}},"/templates/{object_id}/preview":{"post":{"summary":"Preview a Template","description":"Renders unsaved parts to a PDF with sample data and the branding of the portal, and stores nothing. The requester must be an admin of the main portal and not of a sub-portal. The template has to be a managed template of the portal: it tells the usage the parts are rendered for and which images they may use, and nothing of it is read or changed. Parts that do not compile are not an error: the answer is 200 with valid false and the errors to fix.","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Template"]}],"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":"TemplatePreview","enum":["TemplatePreview"]},"attributes":{"type":"object","additionalProperties":false,"required":["orientation","parts"],"properties":{"orientation":{"type":"string","enum":["landscape","portrait"]},"parts":{"type":"object","required":["body","css"],"additionalProperties":false,"description":"The editable parts of a managed certificate template. Publishing compiles them, inside a shell owned by Synap, into the complete document.","properties":{"body":{"type":"string","maxLength":200000,"description":"An HTML fragment that may contain Go template actions."},"css":{"type":"string","maxLength":200000,"description":"CSS, scoped to the content box when compiled."},"contentInset":{"type":"integer","minimum":0,"maximum":30,"default":10,"description":"Safe area inside the A4 sheet, in millimetres. Defaults to 10."},"background":{"type":"object","nullable":true,"required":["url","fit"],"additionalProperties":false,"description":"The image that fills the whole page behind the content. It can only be set here, as the style of the template cannot reach it. Null or left out for no background. The url has to be the address of an image uploaded to this template, and publishing or previewing refuses any address of another place.","properties":{"url":{"type":"string","minLength":1,"maxLength":2048,"description":"The url of an image uploaded to this template."},"fit":{"type":"string","enum":["cover","contain","stretch"],"description":"How the image fills the page. Cover scales it until it covers the page and crops what does not fit, contain scales it until all of it fits in the page, and stretch fills the page whatever the proportions of the image."}}}}},"scenario":{"type":"string","enum":["standard","long-text","no-qr"],"default":"standard","description":"The sample data to render with. long-text uses very long names and titles to expose overflow, and no-qr leaves out the QR code and the expiry."}}},"relationships":{"type":"object","properties":{}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TemplatePreview"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden: the requester is not an admin of the main portal, or the template is a legacy template.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found: the template is not in the portal of the requester.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"templates.previewTemplate"}},"/templates/{object_id}":{"get":{"summary":"Get Template","description":"One legacy or managed template of the portal, archived ones included, for an educator, manager or admin. The built in templates are not found here. A managed template that is not available to the sub-portal of the requester, because it is limited to another sub-portal or marked as unavailable to sub-portals, is not found either, exactly like an id that does not exist.","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Template"]}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Template"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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"}}}}}}}},"operationId":"templates.getTemplate"},"patch":{"summary":"Update Template","description":"Changes the name, the draft, the availability to sub-portals or whether it is archived, of a managed template, as an admin of the main portal. The draft is replaced as a whole, and carries the orientation it will be published with. The orientation being issued only changes when the draft is published. The usage, the orientation and the sub-portal cannot be changed. Availability to sub-portals cannot be set on a template limited to a sub-portal. Sending isArchived archives a published template, or unarchives an archived one, and an archived template accepts nothing else: unarchive it first. Unarchiving is refused while the portal has the most templates it can have that are not archived, and when the sub-portal the template is limited to no longer exists. Sending the value it already has changes nothing. Legacy templates cannot be changed here.","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Template"]}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Template"}}}}}},"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Template"}}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BadRequestApiError"}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenApiError"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"templates.updateTemplate"},"delete":{"summary":"Delete Template","description":"Deletes a managed template that was never published, as an admin of the main portal. A published or archived template cannot be deleted: archive it instead. Legacy templates cannot be deleted here.","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Template"]}],"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"}}}}}}}},"operationId":"templates.deleteTemplate"}},"/templates/{object_id}/publish":{"post":{"summary":"Publish Template","description":"Compiles the draft of a managed template, with the orientation staged in it, and, when it compiles, stores it as the published parts, makes that orientation the one being issued and clears the draft. The requester must be an admin of the main portal and not of a sub-portal. When it does not compile nothing is stored and one error is answered for each problem found. An archived template has to be unarchived first. Legacy templates cannot be published.","tags":["Certificates"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Template"]}],"responses":{"200":{"description":"Published","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Template"}}}}}},"400":{"description":"Bad Request. When the draft did not compile, nothing was stored and one error is answered for each problem found, with the rule it broke and where it is in the draft.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"One error for each problem the compiler found, in the order it found them. The code of each is certificate-template-invalid-draft, and meta.rule says which rule of the compiler it broke.","items":{"type":"object","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"}}},"meta":{"type":"object","properties":{"rule":{"type":"string","description":"A stable, machine readable code of the compiler such as template.parse_error."},"pane":{"type":"string","description":"Where the problem is: html (the body), css, settings, or background (the page background)."},"line":{"type":"integer","description":"Starting at 1, within the source of that pane. 0 for settings. Left out for the background."},"column":{"type":"integer","description":"Starting at 1, within the source of that pane. 0 for settings. Left out for the background."}}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedApiError"}}}}}}},"403":{"description":"Forbidden: the requester is not an admin of the main portal, the template is a legacy template, it is archived, or there is no draft to publish.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/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":"The template was changed while it was being published, so nothing was stored.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"operationId":"templates.publishTemplate"}},"/tests/{object_id}":{"get":{"summary":"Get Test","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Test"]},{"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"}}}}}}}},"operationId":"tests.getTest"},"delete":{"summary":"Delete Test","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Test"]}],"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"}}}}}}}},"operationId":"tests.deleteTest"}},"/tests":{"get":{"summary":"List Tests","tags":["Quizzes"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"tests.findTests"}},"/tip-suggestions":{"post":{"summary":"Create TipSuggestion","tags":["User Feedback"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"tipSuggestions.createTipSuggestion"},"get":{"summary":"List TipSuggestions","tags":["User Feedback"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"tipSuggestions.findTipSuggestions"}},"/tokens/{object_id}":{"get":{"summary":"Get Token","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["Token"]}],"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"}}}}}}}},"operationId":"tokens.getToken"}},"/transactional-emails/{object_id}":{"get":{"summary":"Get TransactionalEmail","tags":["Notifications"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["TransactionalEmail"]},{"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"}}}}}}}},"operationId":"transactionalEmails.getTransactionalEmail"}},"/transactional-emails":{"get":{"summary":"List TransactionalEmails","tags":["Notifications"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"},"exam":{"type":"string"},"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/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"}}}}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundApiError"}}}}}}}},"operationId":"transactionalEmails.findTransactionalEmails"}},"/user-accounts/{object_id}":{"get":{"summary":"Get UserAccount","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["UserAccount"]}],"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"}}}}}}}},"operationId":"userAccounts.getUserAccount"}},"/user-engagement":{"get":{"summary":"List UserEngagement","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"filter","in":"query","required":true,"schema":{"anyOf":[{"type":"object","required":["userGroup","startDate","endDate"],"properties":{"userGroup":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"}}},{"type":"object","required":["userIds","startDate","endDate"],"properties":{"userIds":{"type":"array","maxItems":250,"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"}}}}}}}},"operationId":"userEngagement.findUserEngagement"}},"/user-group-exports":{"post":{"summary":"Create UserGroupExport","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"userGroupExports.createUserGroupExport"}},"/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"}}}}}}}},"operationId":"userGroupLinkAccess.createAccess"}},"/user-group-link-settings":{"get":{"summary":"List UserGroupLinkSettings","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"userGroupLinkSettings.findUserGroupLinkSettings"},"post":{"summary":"Create UserGroupLinkSetting","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"userGroupLinkSettings.createUserGroupLinkSettings"}},"/user-group-link-settings/{object_id}":{"get":{"summary":"Get UserGroupLinkSetting","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["UserGroupLinkSettings"]},{"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"}}}}}}}},"operationId":"userGroupLinkSettings.getUserGroupLinkSettings"},"patch":{"summary":"Update UserGroupLinkSetting","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["UserGroupLinkSettings"]}],"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"}}}}}}}},"operationId":"userGroupLinkSettings.updateUserGroupLinkSettings"}},"/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"}}}}}}}},"operationId":"userGroupLinkValidations.validate"}},"/user-group-links/{object_id}":{"get":{"summary":"Get UserGroupLink","tags":["User Groups"],"security":[],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["UserGroupLink"]},{"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"}}}}}}}},"operationId":"userGroupLink.getUserGroupLink"}},"/user-groups":{"post":{"summary":"Create UserGroup","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"userGroups.createUserGroup"},"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"}}},"search":{"description":"Groups whose name contains this text, in any case, or whose ID is exactly this value.","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"}}}}}}}},"operationId":"userGroups.findUserGroups"}},"/user-groups/{object_id}":{"get":{"summary":"Get UserGroup","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["UserGroup"]},{"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"}}}}}}}},"operationId":"userGroups.getUserGroup"},"patch":{"summary":"Update UserGroup","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["UserGroup"]}],"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"}}}}}}}},"operationId":"userGroups.updateUserGroup"},"delete":{"summary":"Delete UserGroup","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["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"}}}}}}}},"operationId":"userGroups.deleteUserGroup"}},"/user-groups/{object_id}/relationships/users":{"post":{"summary":"Add Users to UserGroup","tags":["User Groups"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["UserGroup"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"userGroups.addUsers"},"delete":{"summary":"Remove Users from UserGroup","tags":["User Groups"],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["UserGroup"]}],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"userGroups.removeUsers"}},"/user-imports":{"post":{"summary":"Create UserImport","tags":["User Groups"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"userImports.createUserImport"}},"/user-passwords":{"post":{"summary":"Create UserPassword","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"userPasswords.createUserPassword"}},"/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","zh-TW","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"}}}}}}}},"operationId":"userRegistrations.createUserRegistration"}},"/user-sessions/me":{"delete":{"summary":"Delete own UserSession","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"userSessions.deleteUserSession"}},"/user-stats/{object_id}":{"get":{"summary":"Get UserStat","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["UserStats"]}],"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"}}}}}}}},"operationId":"userStats.getUserStats"}},"/user-types":{"get":{"summary":"List UserTypes","tags":["User Groups","Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"userTypes.findUserTypes"}},"/user-types/{object_id}":{"get":{"summary":"Get UserType","tags":["User Groups","Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["UserType"]}],"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"}}}}}}}},"operationId":"userTypes.getUserType"},"patch":{"summary":"Update UserType","tags":["User Groups","Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["UserType"]}],"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"}}}}}}}},"operationId":"userTypes.updateUserType"}},"/users":{"get":{"summary":"List Users","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"]}]},"isDisabled":{"type":"string","enum":["true","false"]}}}},{"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"}}}}}}}},"operationId":"users.findUsers"}},"/users/{object_id}":{"get":{"summary":"Get User","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["User"]},{"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"}}}}}}}},"operationId":"users.getUser"},"patch":{"summary":"Update User","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["User"]}],"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"}}}}}}}},"operationId":"users.updateUser"},"delete":{"summary":"Delete User","tags":["Users"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["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"}}}}}}}},"operationId":"users.deleteUser"}},"/webhook-deliveries":{"get":{"summary":"List WebhookDeliveries","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"},"targetId":{"type":"string","minLength":1},"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"}}}}}}}},"operationId":"webhookDeliveries.findWebhookDeliveries"},"post":{"summary":"Create a test WebhookDelivery (\"send test webhook\")","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"webhookDeliveries.createWebhookDelivery"}},"/webhook-deliveries/{object_id}":{"get":{"summary":"Get a WebhookDelivery","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["WebhookDelivery"]}],"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"}}}}}}}},"operationId":"webhookDeliveries.getWebhookDelivery"},"patch":{"summary":"Pause, resume, resend or cancel a WebhookDelivery","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["WebhookDelivery"]}],"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"}}}}}}}},"operationId":"webhookDeliveries.updateWebhookDelivery"}},"/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":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"webhookDeliveryOperations.applyWebhookDeliveryOperations"}},"/webhook-subscriptions":{"post":{"summary":"Create WebhookSubscription","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"webhookSubscriptions.createWebhookSubscription"},"get":{"summary":"List WebhookSubscriptions","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"webhookSubscriptions.findWebhookSubscriptions"}},"/webhook-subscriptions/{object_id}":{"get":{"summary":"Get WebhookSubscription","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["WebhookSubscription"]}],"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"}}}}}}}},"operationId":"webhookSubscriptions.getWebhookSubscription"},"patch":{"summary":"Update WebhookSubscription","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["WebhookSubscription"]}],"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"}}}}}}}},"operationId":"webhookSubscriptions.updateWebhookSubscription"},"delete":{"summary":"Delete WebhookSubscription","tags":["Portals"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["WebhookSubscription"]}],"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"}}}}}}}},"operationId":"webhookSubscriptions.deleteWebhookSubscription"}},"/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":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["WebhookSubscription"]}],"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"}}}}}}}},"operationId":"webhookSubscriptions.getWebhookSubscriptionSamplePayload"}},"/zapier-api-keys":{"post":{"summary":"Create ZapierApiKey","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"zapierApiKeys.createZapierApiKey"},"get":{"summary":"List ZapierApiKeys","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"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"}}}}}}}},"operationId":"zapierApiKeys.findZapierApiKeys"}},"/zapier-api-keys/{object_id}":{"patch":{"summary":"Update ZapierApiKey","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ZapierApiKey"]}],"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"}}}}}}}},"operationId":"zapierApiKeys.updateZapierApiKey"},"delete":{"summary":"Delete ZapierApiKey","tags":["Authentication"],"security":[{"SessionAuth":[]},{"PATAuth":[]},{"AutomationAuth":[]},{"LegacySessionAuth":[]}],"parameters":[{"name":"object_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ObjectId"},"x-resource-types":["ZapierApiKey"]}],"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"}}}}}}}},"operationId":"zapierApiKeys.deleteZapierApiKey"}}},"components":{"securitySchemes":{"AutomationAuth":{"type":"http","scheme":"bearer","description":"Authorise the request with a short-lived token signed by the automations engine on behalf of a workflow owner.","bearerFormat":"a:<token>"},"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","identityCheck","invite","learningRecord","portal","question","emqGroup","session","store","tag","test","userGroup","subPortal","markingSession","markingState","markingEntry"],"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","attemptCertificateRevoked","started","marketingEmails","marketingEmailsRemoved","examUserRegistered","identityCheckCompleted","identityCheckReviewed","identityCheckFilesViewed","examActivated","examCancelled","examCompleted","examScheduled","sent","checked","accepted","cancelled","expired","flagPlanted","passkeyLoggedIn","passkeyRegistered","passkeyRevoked","loggedIn","restored","loggedOut","productUnlocked","viewed","questionAnswered","completed","discarded","testSubmitted","testReleased","testResultCorrected","userAdded","userRemoved","markingSessionStarted","markingSessionCompleted","markingSessionVoided","markingSessionFinalised","markingSessionSuspended","markingSessionResumed","markingSessionAdditionalPassStarted","markingSessionReassigned","markingStateUpdated","markingSourceNominated","markingSourceNominationCleared","markingMarksOverridden","markingEntrySuperseded","attemptResponseMaxPointsOverridden","attemptRegraded","attemptQuestionRemarked","examQuestionRemarked","markingReset","markingInherited"],"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},"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},"timeRemainingInMs":{"type":"number","readOnly":true,"minimum":0,"description":"Time remaining in milliseconds at the time of the request. Present only for in-progress attempts with a visible whole-attempt timer that has started."},"proctor":{"type":"object","readOnly":true,"additionalProperties":true,"deprecated":true,"description":"Deprecated. Use flattened fields such as `proctorEnabled`, `proctorVendor` etc instead."},"registration":{"type":"object","readOnly":true,"description":"How this attempt was created, with its initiating trigger when known. Absent on attempts whose origin was not recorded.","required":["method"],"properties":{"method":{"type":"string","enum":["userGroup","direct","examWindow","resit"]},"trigger":{"type":"string","enum":["lti","voucher","examCode"]}}},"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},"candidateFeedback":{"type":"string","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."},"questionsTotal":{"type":"number","readOnly":true,"description":"Questions in the attempt."},"setupTags":{"type":"array","readOnly":true,"description":"The tags the attempt was set up to draw from (`quizSetup.filters`), with their current labels; tags deleted since are left out. Only on the attempt list, and omitted when `fields[Attempt]` is sent without it.","items":{"type":"object","required":["id","label"],"properties":{"id":{"type":"string"},"label":{"type":"string"}}}},"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},"unlockedAt":{"type":"string","readOnly":true,"description":"When the attempt was last unlocked. Only present for staff viewers."},"unlockedMethod":{"type":"string","readOnly":true,"enum":["staff","passcode"],"description":"How the attempt was last unlocked. Only present for staff viewers."},"corrections":{"type":"object","readOnly":true,"description":"Post-hoc corrections to the result (overrides, re-grades, exam-version re-marks). Absent when the result was never corrected, or was corrected before this was recorded. Only present for staff viewers.","required":["count","lastAt","lastKind"],"properties":{"count":{"type":"integer","minimum":1},"lastAt":{"type":"string","format":"date-time"},"lastKind":{"type":"string","enum":["markingEntryOverride","maxPointsOverride","regrade","questionRemark","attemptOverride"]}}},"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},"resultsDeferredLocked":{"type":"boolean","readOnly":true,"description":"Whether the owner is not yet allowed to see this deferred result."},"proctorEnabled":{"type":"boolean","readOnly":false,"nullable":true},"proctorVendor":{"type":"string","enum":["synopticV2","rosalyn",null],"readOnly":false,"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},"proctorAiAnalysisStatus":{"type":"string","enum":["pending","completed","error"],"readOnly":true,"nullable":true},"proctorAiAnalysisPrompts":{"type":"array","readOnly":true,"nullable":true,"items":{"type":"object","properties":{"prompt":{"type":"string"},"slug":{"type":"string"},"colour":{"type":"string","nullable":true},"coverageRatio":{"type":"number","minimum":0,"maximum":1},"totalDurationS":{"type":"number","minimum":0,"nullable":true}}}},"proctorLiveProctoring":{"type":"boolean","readOnly":false,"nullable":true},"proctorRoomScanCoverage":{"type":"string","enum":["off","workspace","full",null],"nullable":true},"proctorRoomScanDevice":{"type":"string","enum":["phone","webcam","either",null],"nullable":true},"identityCheckRequired":{"type":"boolean","readOnly":false,"nullable":true},"identityCheckFailureAction":{"type":"string","enum":["flag","block",null],"readOnly":true,"nullable":true},"identityCheckVendor":{"type":"string","enum":["stripe","entrust","internal",null],"readOnly":true,"nullable":true},"identityCheckAutomaticFaceMatch":{"type":"boolean","readOnly":true,"nullable":true},"identityCheckNameAction":{"type":"string","enum":["record","flag","block",null],"readOnly":true,"nullable":true},"identityCheck":{"type":"object","readOnly":true,"nullable":true,"properties":{"status":{"type":"string","enum":["created","processing","verified","failed","cancelled","awaiting_review"],"readOnly":true},"checkId":{"type":"string","readOnly":true,"nullable":true},"sessionRef":{"type":"string","readOnly":true,"nullable":true},"checkedAt":{"type":"string","readOnly":true,"nullable":true},"failureCode":{"type":"string","readOnly":true,"nullable":true},"attemptsUsed":{"type":"integer","minimum":0,"readOnly":true},"redactedAt":{"type":"string","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":false,"nullable":true},"proctorScreenMonitoring":{"type":"string","enum":["none","recreation","recreationWithSnapshots","video",null],"readOnly":false,"nullable":true},"proctorWebcamMonitoring":{"type":"string","enum":["none","snapshots","audioVideo",null],"readOnly":false,"nullable":true},"proctorRequireSecondCamera":{"type":"boolean","readOnly":false,"nullable":true},"proctorRequireFullscreen":{"type":"boolean","readOnly":false,"nullable":true},"proctorRestrictTabs":{"type":"boolean","readOnly":false,"nullable":true},"proctorRestrictDisplays":{"type":"boolean","readOnly":false,"nullable":true},"proctorKeyboardShortcutsEnabled":{"type":"boolean","readOnly":false,"nullable":true},"proctorScreenshotPrevention":{"type":"boolean","readOnly":false,"nullable":true},"proctorAiReview":{"type":"boolean","readOnly":false,"nullable":true},"proctorLiveAiDetection":{"type":"boolean","readOnly":false,"nullable":true},"proctorAiFlagCandidateLeftFrame":{"type":"boolean","readOnly":false,"nullable":true},"proctorAiFlagMultiplePeopleInFrame":{"type":"boolean","readOnly":false,"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},"enabled":{"type":"boolean","nullable":true}}}},"proctorOnBreach":{"type":"string","enum":["freeze","silent",null],"readOnly":false,"nullable":true},"proctorBlockedApplicationsPolicy":{"type":"string","enum":["none","default",null],"readOnly":false,"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"]}}}}},"examWindow":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamWindow","enum":["ExamWindow"]}}}}},"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","PlayerMatchingResponse","PlayerImageLabellingDragAndDropResponse","PlayerImageLabellingDropDownResponse","PlayerImageLabellingTextResponse","PlayerClassificationResponse","PlayerChoiceMatrixResponse","PlayerTextSelectionResponse","PlayerCodingResponse","PlayerBowTieResponse","PlayerLikertResponse","PlayerNumericAnswerResponse"],"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"]}}}}},"unlockedBy":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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","schedule"]},"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},"schedule":{"type":"object","properties":{"oldValue":{"type":"object","properties":{"activateAt":{"type":"string","format":"date-time","nullable":true},"deactivateAt":{"type":"string","format":"date-time","nullable":true}},"nullable":true},"newValue":{"type":"object","properties":{"activateAt":{"type":"string","format":"date-time","nullable":true},"deactivateAt":{"type":"string","format":"date-time","nullable":true}}},"isOriginal":{"type":"boolean"}},"nullable":true,"readOnly":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"]}}}}}}}}},"AttemptRegrade":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptRegrade","enum":["AttemptRegrade"]},"attributes":{"type":"object","properties":{"previousOutcome":{"type":"object","readOnly":true,"description":"What the attempt held before.","properties":{"gradeLabel":{"type":"string","nullable":true},"isPass":{"type":"boolean","nullable":true},"score":{"type":"number","nullable":true}}},"outcome":{"type":"object","readOnly":true,"description":"What the attempt holds now.","properties":{"gradeLabel":{"type":"string","nullable":true},"isPass":{"type":"boolean","nullable":true},"score":{"type":"number","nullable":true}}},"boundariesChanged":{"type":"boolean","readOnly":true,"description":"False when the exam version already carried the boundaries the attempt was graded with; nothing was written."},"outcomeChanged":{"type":"boolean","readOnly":true},"gradeOverridden":{"type":"boolean","readOnly":true,"description":"An administrator's manual grade override stands; only the grade it records as actual moved."},"testVersion":{"type":"string","readOnly":true,"nullable":true},"unmatchedSectionIds":{"type":"array","readOnly":true,"items":{"type":"string"},"description":"Attempt sections the exam version no longer names; their boundaries were left as sat."}}},"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"]}}}}},"test":{"type":"object","description":"The exam version whose grade boundaries were applied.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}}}}}},"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"]}}}}}}}}},"AttemptResultNotification":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AttemptResultNotification","enum":["AttemptResultNotification"]},"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"]}}}}}}}}},"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","required":["label"],"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":{}}}},"AuditLog":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AuditLog","enum":["AuditLog"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"actorType":{"type":"string","enum":["user","personalAccessToken","apiKey","anonymous","automation"],"readOnly":true,"nullable":false},"actorIsAdmin":{"type":"boolean","readOnly":true,"nullable":true},"apiKeyId":{"type":"string","readOnly":true,"nullable":true},"method":{"type":"string","enum":["delete","get","head","options","patch","post","put","trace"],"readOnly":true,"nullable":false},"route":{"type":"string","readOnly":true,"nullable":false},"path":{"type":"string","readOnly":true,"nullable":false},"resource":{"type":"string","readOnly":true,"nullable":true},"params":{"type":"object","additionalProperties":true,"readOnly":true,"nullable":true},"query":{"type":"object","additionalProperties":true,"readOnly":true,"nullable":true},"targetType":{"type":"string","readOnly":true,"nullable":true},"targetId":{"type":"string","readOnly":true,"nullable":true},"targetRelationship":{"type":"string","readOnly":true,"nullable":true},"statusCode":{"type":"number","readOnly":true,"nullable":true},"outcome":{"type":"string","enum":["success","clientError","serverError","aborted"],"readOnly":true,"nullable":false},"errorCode":{"type":"string","readOnly":true,"nullable":true},"errorTitle":{"type":"string","readOnly":true,"nullable":true},"durationMs":{"type":"number","readOnly":true,"nullable":false},"ip":{"type":"string","readOnly":true,"nullable":true},"userAgent":{"type":"string","readOnly":true,"nullable":true},"requestId":{"type":"string","readOnly":true,"nullable":true},"traceId":{"type":"string","readOnly":true,"nullable":true},"appVersion":{"type":"string","readOnly":true,"nullable":true},"payloadBytes":{"type":"number","readOnly":true,"nullable":true},"payload":{"type":"object","additionalProperties":true,"readOnly":true,"nullable":true},"errorBody":{"type":"object","additionalProperties":true,"readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{"actor":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}},"subjectUser":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}},"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"]}}}}}}}}},"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":{}}}},"Automation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Automation","enum":["Automation"]},"attributes":{"type":"object","properties":{"name":{"type":"string","minLength":1,"readOnly":false,"nullable":false},"description":{"type":"string","maxLength":500,"readOnly":false,"nullable":true},"definition":{"type":"object","description":"The workflow definition: `WorkflowDefinitionSchema` from `@synap-ac/automations-contracts`. Validated structurally and against the current catalogue; every fault is reported as its own error with a `source.pointer` into the definition and the issue `code` in `meta`. Saving a new definition bumps `version` and re-derives `triggerEvent`.","additionalProperties":true,"readOnly":false,"nullable":false},"state":{"type":"string","enum":["draft","enabled","disabled","paused"],"description":"Writable to move the automation: `enabled`, `paused` (from enabled, with `waitingRuns`) or `disabled`. Created as `disabled`.","readOnly":false,"nullable":false},"waitingRuns":{"type":"string","enum":["pause","continue"],"description":"Required when pausing: whether runs waiting on a checkpoint pause with the automation or continue. Never returned.","writeOnly":true,"nullable":false},"pausedRuns":{"type":"string","enum":["resume","discard"],"description":"Required when enabling a paused automation: whether paused runs resume (on the current version) or are discarded. Never returned.","writeOnly":true,"nullable":false},"enabled":{"type":"boolean","readOnly":true,"nullable":false},"pausedReason":{"type":"string","enum":["health","blockRetired","entitlementRemoved",null],"readOnly":true,"nullable":true},"version":{"type":"integer","minimum":1,"readOnly":true,"nullable":false},"triggerEvent":{"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},"catalogueVersion":{"type":"string","readOnly":true,"nullable":false},"health":{"type":"object","required":["consecutiveFailures"],"properties":{"consecutiveFailures":{"type":"integer","minimum":0},"lastRunAt":{"type":"string","format":"date-time","readOnly":true},"lastRunStatus":{"type":"string","enum":["pending","running","waiting","paused","completed","skipped","failed","exhausted","cancelled"],"readOnly":true}},"readOnly":true,"nullable":false},"createdAt":{"type":"string","format":"date-time","readOnly":true,"nullable":false},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":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"]}}}}}}}}},"AutomationEvent":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AutomationEvent","enum":["AutomationEvent"]},"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},"payload":{"type":"object","description":"The webhook payload the event carries.","additionalProperties":true,"readOnly":true},"dedupeKey":{"type":"string","readOnly":true},"originRunId":{"type":"string","readOnly":true,"nullable":true},"depth":{"type":"integer","minimum":0,"readOnly":true},"status":{"type":"string","enum":["pending","claimed","processed","dropped"],"readOnly":true},"claimedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"processedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"expiresAt":{"type":"string","format":"date-time","readOnly":true},"createdAt":{"type":"string","format":"date-time","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"AutomationRun":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"AutomationRun","enum":["AutomationRun"]},"attributes":{"type":"object","properties":{"automationVersion":{"type":"integer","minimum":1,"readOnly":true},"upgradedFromVersion":{"type":"integer","minimum":1,"readOnly":true,"nullable":true},"catalogueVersion":{"type":"string","readOnly":true},"mode":{"type":"string","enum":["live","dryRun"],"readOnly":true},"triggerEventId":{"type":"string","readOnly":true},"status":{"type":"string","enum":["pending","running","waiting","paused","completed","skipped","failed","exhausted","cancelled"],"readOnly":true},"pausedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"cancelledReason":{"type":"string","enum":["manual","disabled","discarded",null],"readOnly":true,"nullable":true},"depth":{"type":"integer","minimum":0,"readOnly":true},"targetId":{"type":"string","readOnly":true,"nullable":true},"startedAt":{"type":"string","format":"date-time","readOnly":true},"finishedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"resumeAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"nextAttemptAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"attemptCount":{"type":"integer","minimum":0,"readOnly":true},"currentStepId":{"type":"string","readOnly":true,"nullable":true},"requestedRetryOfStepId":{"type":"string","readOnly":true,"nullable":true},"definition":{"type":"object","description":"The workflow definition snapshot the run executes. Present on a single run, absent from run listings.","additionalProperties":true,"readOnly":true},"steps":{"type":"array","description":"The step log. Present on a single run, absent from run listings.","readOnly":true,"items":{"type":"object","required":["stepId","status","attemptCount"],"properties":{"stepId":{"type":"string"},"status":{"type":"string","enum":["pending","running","succeeded","failed","skipped","waiting"]},"attemptCount":{"type":"integer","minimum":0},"startedAt":{"type":"string","format":"date-time"},"finishedAt":{"type":"string","format":"date-time"},"opId":{"type":"string"},"request":{"type":"object","required":["method","path"],"properties":{"method":{"type":"string"},"path":{"type":"string"},"body":{}}},"response":{"type":"object","required":["status"],"properties":{"status":{"type":"integer"},"body":{}}},"output":{},"error":{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","enum":["http4xx","http5xx","timeout","network","blockRetired","bindingUnresolved","invalidDefinition"]},"message":{"type":"string"}}}}}},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}}},"relationships":{"type":"object","properties":{"automation":{"type":"object","description":"This is a 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":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Automation","enum":["Automation"]}}}}}}}}},"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":{}}}},"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"}]}}}}}}}}}},"BillingUsageReport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"BillingUsageReport","enum":["BillingUsageReport"]},"attributes":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"portalName":{"type":"string","readOnly":true},"generatedAt":{"type":"string","format":"date-time","readOnly":true},"range":{"type":"object","additionalProperties":false,"properties":{"preset":{"type":"string","enum":["this-month","3-months","6-months","9-months","12-months","all-time","contract-year"]},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"required":["preset","from","to"],"readOnly":true},"currency":{"type":"string","readOnly":true},"dataFreshThrough":{"type":"string","format":"date-time","readOnly":true},"subscription":{"type":"object","additionalProperties":false,"properties":{"status":{"type":"string"},"nextChargeEstimateMinor":{"type":"number","description":"Estimated amount due on the next invoice, including current credits and charges. Omitted when unavailable."},"nextChargeAt":{"type":"string","format":"date-time"},"renewsAt":{"type":"string","format":"date-time"},"termStart":{"type":"string","format":"date-time"},"termEnd":{"type":"string","format":"date-time"},"billingPeriodUnit":{"type":"string","enum":["month","year"]}},"required":["status"],"readOnly":true},"planOptions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"tier":{"type":"string"},"options":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"priceMinor":{"type":"number"},"allowance":{"type":"number"},"perUnitMinor":{"type":"number"},"isCurrent":{"type":"boolean"}},"required":["id","name","isCurrent"]}}},"required":["options"]},"readOnly":true},"kind":{"type":"string","enum":["payg"],"readOnly":true},"plan":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"allowance":{"type":"number"},"annualPriceMinor":{"type":"number"},"perCreditMinor":{"type":"number"}},"required":["name"],"readOnly":true},"creditRates":{"type":"object","additionalProperties":false,"properties":{"unproctored":{"type":"number"},"study":{"type":"number"},"assignment":{"type":"number"},"rosalynLockdown":{"type":"number"},"synopticLockdown":{"type":"number"},"rosalynLive":{"type":"number"},"synopticRecorded":{"type":"number"},"synopticV2":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"tier":{"type":"string","enum":["noRecording","recreationAndSnapshots","videoAndAudioRecording","videoAndAudioRecordingWithAiReview"]},"label":{"type":"string"},"firstBlock":{"type":"number"},"additionalHour":{"type":"number"}},"required":["tier","label","firstBlock","additionalHour"]}}},"required":["unproctored","study","assignment","rosalynLockdown","synopticLockdown","rosalynLive","synopticRecorded","synopticV2"],"readOnly":true},"creditPool":{"type":"object","additionalProperties":false,"properties":{"allocated":{"type":"number"},"remaining":{"type":"number"},"includedCreditsUsed":{"type":"number"},"usageHistoryIncludedCreditsUsed":{"type":"number"},"totalCreditsUsed":{"type":"number"},"reconciliationDifference":{"type":"number"},"usedPercentage":{"type":"number"},"expiresAt":{"type":"string","format":"date-time"},"runRate":{"type":"object","additionalProperties":false,"properties":{"creditsPerMonth":{"type":"number"},"runwayMonths":{"type":"number"},"depletesAt":{"type":"string","format":"date-time"}},"required":["creditsPerMonth","runwayMonths","depletesAt"]}},"required":["allocated","remaining","includedCreditsUsed","usageHistoryIncludedCreditsUsed","totalCreditsUsed","reconciliationDifference","usedPercentage"],"readOnly":true},"batches":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"invoiceId":{"type":"string"},"credits":{"type":"number"},"balance":{"type":"number"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"}},"required":["invoiceId","credits","balance","validFrom","validUntil"]},"readOnly":true},"usageByMonth":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"month":{"type":"string","format":"date-time"},"inProgress":{"type":"boolean"},"unproctored":{"type":"number"},"study":{"type":"number"},"assignment":{"type":"number"},"rosalynLockdown":{"type":"object","additionalProperties":false,"properties":{"attempts":{"type":"number"},"creditsUsed":{"type":"number"}},"required":["attempts","creditsUsed"]},"synopticLockdown":{"type":"object","additionalProperties":false,"properties":{"attempts":{"type":"number"},"creditsUsed":{"type":"number"}},"required":["attempts","creditsUsed"]},"rosalynLive":{"type":"object","additionalProperties":false,"properties":{"attempts":{"type":"number"},"creditsUsed":{"type":"number"}},"required":["attempts","creditsUsed"]},"synopticRecorded":{"type":"object","additionalProperties":false,"properties":{"attempts":{"type":"number"},"creditsUsed":{"type":"number"}},"required":["attempts","creditsUsed"]},"synopticV2":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"tier":{"type":"string","enum":["noRecording","recreationAndSnapshots","videoAndAudioRecording","videoAndAudioRecordingWithAiReview"]},"label":{"type":"string"},"attempts":{"type":"number"},"firstBlockCreditsUsed":{"type":"number"},"additionalHours":{"type":"number"},"additionalHourCreditsUsed":{"type":"number"},"totalCreditsUsed":{"type":"number"}},"required":["tier","label","attempts","firstBlockCreditsUsed","additionalHours","additionalHourCreditsUsed","totalCreditsUsed"]}},"reviews":{"type":"number"},"totalCreditsUsed":{"type":"number"},"overageBilledMinor":{"type":"number"}},"required":["month","inProgress","unproctored","study","assignment","rosalynLockdown","synopticLockdown","rosalynLive","synopticRecorded","synopticV2","reviews","totalCreditsUsed","overageBilledMinor"]},"readOnly":true},"contractYears":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"inProgress":{"type":"boolean"},"creditsUsed":{"type":"number"},"pool":{"type":"number"},"billedBeyondPoolMinor":{"type":"number"}},"required":["start","end","inProgress","creditsUsed"]},"readOnly":true},"pendingOverageChargeMinor":{"type":"number"},"rosalynInUse":{"type":"boolean","readOnly":true}},"required":["kind","portalName","generatedAt","range","currency","subscription","planOptions","plan","creditRates","batches","usageByMonth","contractYears","rosalynInUse"]},{"type":"object","additionalProperties":false,"properties":{"portalName":{"type":"string","readOnly":true},"generatedAt":{"type":"string","format":"date-time","readOnly":true},"range":{"type":"object","additionalProperties":false,"properties":{"preset":{"type":"string","enum":["this-month","3-months","6-months","9-months","12-months","all-time","contract-year"]},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"required":["preset","from","to"],"readOnly":true},"currency":{"type":"string","readOnly":true},"dataFreshThrough":{"type":"string","format":"date-time","readOnly":true},"subscription":{"type":"object","additionalProperties":false,"properties":{"status":{"type":"string"},"nextChargeEstimateMinor":{"type":"number","description":"Estimated amount due on the next invoice, including current credits and charges. Omitted when unavailable."},"nextChargeAt":{"type":"string","format":"date-time"},"renewsAt":{"type":"string","format":"date-time"},"termStart":{"type":"string","format":"date-time"},"termEnd":{"type":"string","format":"date-time"},"billingPeriodUnit":{"type":"string","enum":["month","year"]}},"required":["status"],"readOnly":true},"planOptions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"tier":{"type":"string"},"options":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"priceMinor":{"type":"number"},"allowance":{"type":"number"},"perUnitMinor":{"type":"number"},"isCurrent":{"type":"boolean"}},"required":["id","name","isCurrent"]}}},"required":["options"]},"readOnly":true},"kind":{"type":"string","enum":["mau"],"readOnly":true},"plan":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"allowance":{"type":"number"},"priceMinor":{"type":"number"},"overageRateMinor":{"type":"number"}},"required":["name","allowance","overageRateMinor"],"readOnly":true},"currentPeriod":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"maus":{"type":"number"},"synopticRecorded":{"type":"number"},"rosalynLive":{"type":"number"},"estimatedOverageMinor":{"type":"number"}},"required":["start","end","maus","synopticRecorded","rosalynLive","estimatedOverageMinor"],"readOnly":true},"usageHistory":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"maus":{"type":"number"},"allowance":{"type":"number"},"over":{"type":"number"},"overageChargeMinor":{"type":"number"},"invoice":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"status":{"type":"string"},"totalMinor":{"type":"number"}},"required":["id","status","totalMinor"]}},"required":["start","end","maus","allowance","over"]},"readOnly":true},"periodsOverAllowance":{"type":"object","additionalProperties":false,"properties":{"count":{"type":"number"},"outOf":{"type":"number"}},"required":["count","outOf"],"readOnly":true},"latestInvoice":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"status":{"type":"string"},"date":{"type":"string","format":"date-time"},"lines":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"quantity":{"type":"number"},"unitAmountMinor":{"type":"number"},"amountMinor":{"type":"number"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"required":["description","amountMinor"]}},"discountMinor":{"type":"number"},"subTotalMinor":{"type":"number"},"taxMinor":{"type":"number"},"totalMinor":{"type":"number"}},"required":["id","status","lines","totalMinor"],"readOnly":true},"nextTier":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"priceMinor":{"type":"number"},"breakevenMaus":{"type":"number"}},"required":["name","priceMinor","breakevenMaus"],"readOnly":true}},"required":["kind","portalName","generatedAt","range","currency","subscription","planOptions","plan","usageHistory","periodsOverAllowance"]}]},"relationships":{"type":"object","additionalProperties":false,"properties":{}}}},"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},"revokedAt":{"type":"string","format":"date-time","readOnly":true,"description":"When the certificate was withdrawn in favour of `supersededBy`. Absent while it is live."}}},"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"]}}}}},"supersededBy":{"type":"object","description":"The certificate that replaced this one. It may itself have been withdrawn since, so follow the chain to the live certificate. Absent while this one is live.","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"]}}}}}}}}},"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 that is not embedded."},"paymentGatewayClientSecret":{"type":"string","readOnly":true,"nullable":true,"description":"The client secret that renders an embedded Checkout, only returned when creating a paid Checkout Session that is embedded."},"paymentGatewayAccountId":{"type":"string","readOnly":true,"nullable":true,"description":"The connected payment account an embedded Checkout is created in, only returned when creating an embedded 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},"ignoreSkippedResponses":{"type":"boolean","readOnly":false},"reviewAndSubmitEnabled":{"type":"boolean","readOnly":false},"saveAndResumeEnabled":{"type":"boolean","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","autoApproved","error"]},"proctorVendor":{"type":"string","nullable":true,"enum":["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},"isArchived":{"type":"boolean","readOnly":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},"corrections":{"type":"object","readOnly":true,"description":"Post-hoc corrections to the result (overrides, re-grades, exam-version re-marks). Absent when the result was never corrected, or was corrected before this was recorded. Only present for staff viewers.","required":["count","lastAt","lastKind"],"properties":{"count":{"type":"integer","minimum":1},"lastAt":{"type":"string","format":"date-time"},"lastKind":{"type":"string","enum":["markingEntryOverride","maxPointsOverride","regrade","questionRemark","attemptOverride"]}}},"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"},"markingShowAllMarkerFeedback":{"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},"markingModeratingMarkerGranularity":{"type":"string","enum":["attempt","question"],"nullable":true},"markingProvisionalMarkerGranularity":{"type":"string","enum":["attempt","question"],"nullable":true},"markingEscalationMarkerGranularity":{"type":"string","enum":["attempt","question"],"nullable":true},"ipAllowList":{"type":"array","readOnly":false,"nullable":true,"minItems":1,"items":{"type":"string"}},"lockedByDefault":{"type":"boolean","readOnly":false,"nullable":true},"lockedByDefaultScope":{"type":"string","enum":["allAttempts","excludeResits"],"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":"array","readOnly":false,"nullable":true,"description":"Corroborating details a per-attempt login code asks for. Empty means none. Ignored when codeLoginSharedCode is on.","items":{"type":"string","enum":["surname","externalId"]}},"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."},"candidateSource":{"type":"string","readOnly":false,"nullable":false,"enum":["defaultGroup","examWindows"],"description":"Where candidates come from. defaultGroup (the default when unset) issues an attempt to every member of the user group on publish; examWindows issues nothing on publish and leaves enrolment to Exam Windows. Can only be changed while the exam has no attempts."},"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":{"attemptIds":{"type":"array","items":{"type":"string"}},"filter":{"type":"object","properties":{"propertyFilters":{"type":"array","description":"Candidate attribute filters. Each attribute may appear only once.","items":{"type":"object","required":["attribute","value"],"properties":{"attribute":{"type":"string","pattern":"^filter\\.attr\\.[a-z0-9_-]+$"},"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"]}}}},"examStatus":{"type":"array","items":{"type":"string","enum":["enrolled","notified","preflight","started","submitted","revoked","expired","cancelled"]}},"markingStatus":{"type":"array","items":{"type":"string","enum":["notStarted","inProgress","readyToFinalise","finalised","completed"]}},"gradeStatus":{"type":"array","items":{"type":"string","enum":["passed","failed"]}},"proctorStatus":{"type":"array","items":{"type":"string","enum":["disabled","enabled","readyForReview","reviewNotRequired","autoApproved","inReview","passed","failed","error"]}},"resultStatus":{"type":"array","items":{"type":"string","enum":["pending","finalised","released"]}},"lockStatus":{"type":"array","items":{"type":"string","enum":["locked","unlocked","none"]}},"systemsCheckStatus":{"type":"array","items":{"type":"string","enum":["notRun","inProgress","passed","attention"]}},"subPortals":{"type":"array","items":{"type":"string"}},"testVersions":{"type":"array","items":{"type":"string"}},"isArchived":{"type":"boolean"},"isCompleted":{"type":"boolean"}}},"search":{"type":"string"}}},"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"]}}}}}}}}},"ExamEnrolment":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamEnrolment","enum":["ExamEnrolment"]},"attributes":{"type":"object","properties":{"issued":{"type":"integer","readOnly":true,"description":"Candidates issued a new attempt."},"alreadyIssued":{"type":"integer","readOnly":true,"description":"Candidates who already held an attempt in the window, or on the exam when registering directly."},"failedUserIds":{"type":"array","readOnly":true,"items":{"type":"string"},"description":"Candidates who could not be issued."}}},"relationships":{"type":"object","required":["examV2"],"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":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Exam-V-2","enum":["Exam-V-2"]}}}}},"examWindow":{"type":"object","description":"Omit to register candidates directly on an exam that allows it.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamWindow","enum":["ExamWindow"]}}}}},"users":{"type":"object","description":"Fewer than five are issued in the request; more are queued. Provide this or `userGroup`.","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"}]}}}}}},"userGroup":{"type":"object","description":"Every current member is queued for issue. Provide this or `users`.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}}}}}},"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","failedSectionsOnly",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":["rosalyn","synopticV2",null],"readOnly":true,"nullable":true},"proctorRequireSecondCamera":{"type":"boolean","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},"proctorLiveAiDetection":{"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},"enabled":{"type":"boolean","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},"proctorRoomScanCoverage":{"type":"string","enum":["off","workspace","full",null],"nullable":true},"proctorRoomScanDevice":{"type":"string","enum":["phone","webcam","either",null],"nullable":true},"identityCheckRequired":{"type":"boolean","readOnly":true},"identityCheckFailureAction":{"type":"string","enum":["flag","block",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"]}}}}}}}}},"ExamModerationReadinessReport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamModerationReadinessReport","enum":["ExamModerationReadinessReport"]},"attributes":{"type":"object","properties":{"ready":{"type":"boolean","readOnly":true},"advisory":{"type":"boolean","readOnly":true,"description":"Always true. Readiness is a time-of-check answer, never a lock: an attempt can start or a marking session can open immediately after this read."},"inProgressAttempts":{"type":"object","readOnly":true,"properties":{"count":{"type":"number"},"attemptIds":{"type":"array","items":{"type":"string"}},"attemptIdsTruncated":{"type":"boolean","description":"True when attemptIds is a clipped sample, so count is larger than its length. Every count in this report is uncapped; only the itemised samples are."}}},"openMarkingSessions":{"type":"object","readOnly":true,"properties":{"markerCount":{"type":"number"},"sessionCount":{"type":"number"},"responseCount":{"type":"number"},"questionScopedSessionCount":{"type":"number","description":"Reads as 0 until question-scoped marking sessions are persisted; no flow creates them yet."},"markers":{"type":"array","items":{"type":"object","properties":{"markerId":{"type":"string"},"sessionCount":{"type":"number"},"sessionIds":{"type":"array","items":{"type":"string"}},"sessionIdsTruncated":{"type":"boolean"},"responseCount":{"type":"number"},"questionScopedSessionCount":{"type":"number"},"questionCount":{"type":"number"},"questionsTruncated":{"type":"boolean"},"questions":{"type":"array","description":"Per-question breakdown of the marker's question-scoped sessions, heaviest first. Empty until question-scoped marking sessions are persisted; no flow creates them yet.","items":{"type":"object","properties":{"questionId":{"type":"string"},"sessionCount":{"type":"number"}}}}}}}}},"blockers":{"type":"array","readOnly":true,"description":"The blockers a hard moderation gate would raise, verbatim. Empty when ready.","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"},"meta":{"type":"object","additionalProperties":true}}}}}},"relationships":{"type":"object","properties":{}}}},"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"]}}}}}}}}},"ExamQuestionRemark":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamQuestionRemark","enum":["ExamQuestionRemark"]},"attributes":{"type":"object","properties":{"dryRun":{"type":"boolean","default":false,"description":"Report what the run would touch (see `meta.preview`) and write nothing; answered with 200 and no background job."},"notifyCandidates":{"type":"boolean","default":false,"description":"Email each released candidate whose marks or outcome moved a short notice that their results were updated, with a link and no marks; the exam’s results-email setting and hidden-results page still apply."},"testVersion":{"type":"string","readOnly":true,"nullable":true,"description":"The exam version the question belongs to."},"testIds":{"type":"array","readOnly":true,"items":{"type":"string"},"description":"The version’s test and its dynamic variants, which share the question."},"isLiveVersion":{"type":"boolean","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-V-2","enum":["Exam-V-2"]}}}}},"question":{"type":"object","description":"The question as edited on the version; it names the version, so one call covers that version and its variants and no other.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"Question","enum":["Question"]}}}}},"backgroundJob":{"type":"object","description":"The queued run; poll `GET /v3/background-jobs/{id}` for progress and its `result`. Absent on a dry run.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}}}}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","maxItems":50,"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"]}}}}}}}}},"ExamTagStatsExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamTagStatsExport","enum":["ExamTagStatsExport"]},"attributes":{"type":"object","properties":{"examId":{"type":"string"},"version":{"type":"string","pattern":"^[0-9]+$"},"versions":{"type":"array","maxItems":50,"items":{"type":"string","pattern":"^[0-9]+$"}}}},"relationships":{"type":"object","properties":{}}}},"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},"isArchived":{"type":"boolean","readOnly":false},"dynamicIsSectioned":{"type":"boolean","nullable":true},"dynamicFiltersWeightingType":{"type":"string","enum":["absolute","percentage",null],"nullable":true},"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}}}}]}]}}}}},"lockedByDefault":{"type":"boolean","nullable":true},"lockedByDefaultScope":{"type":"string","enum":["allAttempts","excludeResits"],"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},"markingShowAllMarkerFeedback":{"type":"boolean","nullable":true},"markingProvisionalMarkerAllocation":{"type":"string","nullable":true},"markingModeratingMarkerAllocation":{"type":"string","nullable":true},"markingEscalationMarkerAllocation":{"type":"string","nullable":true},"markingProvisionalMarkerGranularity":{"type":"string","nullable":true},"markingModeratingMarkerGranularity":{"type":"string","nullable":true},"markingEscalationMarkerGranularity":{"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},"resitCloseMode":{"type":"string","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},"proctorRequireSecondCamera":{"type":"boolean","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},"proctorLiveAiDetection":{"type":"boolean","nullable":true},"proctorAiPrompts":{"type":"array","nullable":true,"maxItems":12,"items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true},"enabled":{"type":"boolean","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},"proctorRoomScanCoverage":{"type":"string","enum":["off","workspace","full",null],"nullable":true},"proctorRoomScanDevice":{"type":"string","enum":["phone","webcam","either",null],"nullable":true},"identityCheckRequired":{"type":"boolean","nullable":true},"identityCheckFailureAction":{"type":"string","enum":["flag","block",null],"nullable":true},"identityCheckVendor":{"type":"string","enum":["stripe","entrust","internal",null],"nullable":true},"identityCheckAutomaticFaceMatch":{"type":"boolean","nullable":true},"identityCheckNameComparison":{"type":"boolean","nullable":true},"identityCheckNameAction":{"type":"string","enum":["record","flag","block",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},"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},"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"]}}}}}}}}},"ExamWindow":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamWindow","enum":["ExamWindow"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","minLength":1,"maxLength":255},"activateAt":{"type":"string","format":"date-time","description":"When candidates enrolled through this window may start. Independent of the selected test’s own dates."},"deactivateAt":{"type":"string","format":"date-time","nullable":true,"description":"Last start time for this window. Omit for no close."},"relativeCloseTimeInMs":{"type":"integer","minimum":1,"nullable":true,"description":"How long each candidate has once their attempt opens, in milliseconds. An attempt opens with the window, or on enrolment if that is later, and never closes after the window does. Omit for attempts that take the window’s dates."},"isArchived":{"type":"boolean","readOnly":false,"description":"An archived window accepts no new candidates. Existing attempts are unaffected."},"isCancelled":{"type":"boolean","readOnly":false,"description":"A cancelled window accepts no new candidates, and its attempts that have not started are cancelled. Attempts in progress can finish. Cancelling cannot be undone."},"isDraft":{"type":"boolean","readOnly":true,"description":"A draft issues no attempts until it is published through exam-window-publications. Defaults to true; false creates the window published."},"attemptCount":{"type":"integer","readOnly":true,"nullable":true,"description":"How many attempts the window has issued. Null when the caller can't read the exam's attempts."},"candidateCount":{"type":"integer","readOnly":true,"nullable":true,"description":"How many people the window has issued attempts to. Null when the caller can't read the exam's attempts."},"attemptCountsByStatus":{"type":"object","readOnly":true,"nullable":true,"description":"The window's attempts by exam status. Statuses with no attempts are left out. Null when the caller can't read the exam's attempts.","properties":{"enrolled":{"type":"integer"},"notified":{"type":"integer"},"preflight":{"type":"integer"},"started":{"type":"integer"},"submitted":{"type":"integer"},"revoked":{"type":"integer"},"expired":{"type":"integer"},"cancelled":{"type":"integer"}},"additionalProperties":false}}},"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"]}}}}},"test":{"type":"object","description":"The released exam version candidates will sit. Optional for a draft; publication uses the exam’s published version. Changing it after publication affects future enrolments only.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}},"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":"Sub-portal staff can only create windows in their own sub-portal. Root staff can choose any sub-portal, or omit it for a root window. It cannot change later.","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"]}}}}},"selectedUsers":{"type":"object","description":"Candidates picked for the draft, replaced whole on each save. Cleared when the window is published.","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"}]}}}}}},"selectedUserGroups":{"type":"object","description":"Groups picked for the draft, replaced whole on each save. Their members at publication are issued attempts, and the list is cleared.","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"}]}}}}}}}}}},"ExamWindowPublication":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamWindowPublication","enum":["ExamWindowPublication"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","required":["examWindow"],"properties":{"examWindow":{"type":"object","description":"The draft window to publish.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ExamWindow","enum":["ExamWindow"]}}}}}}}}},"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"},"attemptIds":{"type":"array","items":{"type":"string"}},"isArchived":{"type":"string","enum":["true","false","any"],"description":"Omit or any for archived and live attempts together, false for live attempts only, true for archived attempts only."},"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","subPortal","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","tagPerformance"]}},"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},"customLabel":{"type":"string","nullable":true,"maxLength":100,"description":"Custom display term for this facet. An empty value restores the default label."},"facet":{"type":"string","enum":["exam","module","subject","topic","subtopic","difficulty","skill","context"],"readOnly":false},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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},"lockedByDefaultScope":{"type":"string","enum":["allAttempts","excludeResits"],"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},"markingShowAllMarkerFeedback":{"type":"boolean","nullable":true},"markingProvisionalMarkerAllocation":{"type":"string","nullable":true},"markingModeratingMarkerAllocation":{"type":"string","nullable":true},"markingEscalationMarkerAllocation":{"type":"string","nullable":true},"markingProvisionalMarkerGranularity":{"type":"string","nullable":true},"markingModeratingMarkerGranularity":{"type":"string","nullable":true},"markingEscalationMarkerGranularity":{"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},"resitCloseMode":{"type":"string","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},"proctorRequireSecondCamera":{"type":"boolean","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},"proctorLiveAiDetection":{"type":"boolean","nullable":true},"proctorAiPrompts":{"type":"array","nullable":true,"maxItems":12,"items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true},"enabled":{"type":"boolean","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},"proctorRoomScanCoverage":{"type":"string","enum":["off","workspace","full",null],"nullable":true},"proctorRoomScanDevice":{"type":"string","enum":["phone","webcam","either",null],"nullable":true},"identityCheckRequired":{"type":"boolean","nullable":true},"identityCheckFailureAction":{"type":"string","enum":["flag","block",null],"nullable":true},"identityCheckVendor":{"type":"string","enum":["stripe","entrust","internal",null],"nullable":true},"identityCheckAutomaticFaceMatch":{"type":"boolean","nullable":true},"identityCheckNameComparison":{"type":"boolean","nullable":true},"identityCheckNameAction":{"type":"string","enum":["record","flag","block",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":{}}}},"IdentityCheck":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"IdentityCheck","enum":["IdentityCheck"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["created","processing","verified","failed","cancelled","awaiting_review"],"readOnly":true},"vendor":{"type":"string","enum":["stripe","entrust","internal"],"readOnly":true},"vendorSessionRef":{"type":"string","readOnly":true,"nullable":true,"description":"The vendor's reference for this check's session, which some vendors' capture flows need alongside the client secret."},"failureCode":{"type":"string","readOnly":true,"nullable":true},"attemptNumber":{"type":"integer","minimum":1,"readOnly":true},"attemptsUsed":{"type":"integer","minimum":0,"readOnly":true},"consentAt":{"type":"string","readOnly":true,"nullable":true},"submittedAt":{"type":"string","readOnly":true,"nullable":true},"checkedAt":{"type":"string","readOnly":true,"nullable":true},"redactAfter":{"type":"string","readOnly":true,"nullable":true},"redactedAt":{"type":"string","readOnly":true,"nullable":true},"consent":{"type":"boolean","writeOnly":true,"description":"Must be true on create: the candidate has explicitly agreed to their ID and selfie being processed."},"submitted":{"type":"boolean","writeOnly":true,"description":"Set true on update to reconcile the outcome with the vendor after the capture flow closes. Idempotent."},"clientSecret":{"type":"string","readOnly":true,"nullable":true,"description":"Vendor client secret for the capture flow. Only present on the create response; never stored or served again."},"documentImage":{"type":"string","writeOnly":true,"description":"Internal checks only: a JPEG or PNG photo of the candidate's ID, base64 encoded. Sent with faceImage on update, or on its own to the photo-checks route to screen just this photo."},"faceImage":{"type":"string","writeOnly":true,"description":"Internal checks only: a JPEG or PNG photo of the candidate's face, base64 encoded. Sent with documentImage on update, or on its own to the photo-checks route to screen just this photo."},"reviewOutcome":{"type":"string","enum":["verified","failed"],"writeOnly":true,"description":"Internal checks only: a reviewer's decision on the candidate's identity, which replaces the automatic outcome."},"captureIssues":{"type":"array","readOnly":true,"nullable":true,"items":{"type":"string","enum":["document_not_found","document_too_small","document_cut_off","document_face_not_found","document_text_not_readable","face_not_found","multiple_faces","face_obscured","too_far_from_camera","face_angle"]},"description":"Why the submitted photos could not be used. Only present on the update response that submitted them, and on a photo-checks response, where it lists the problems with that one photo."},"capturesRemaining":{"type":"integer","minimum":0,"readOnly":true,"nullable":true,"description":"Photo submissions left before an internal check fails. Null once the check has an outcome, and for vendor checks."},"faceMatchSimilarity":{"type":"number","minimum":0,"maximum":100,"readOnly":true,"nullable":true,"description":"How closely the face on the ID matched the candidate's photo, when the check compared them automatically."},"captureReport":{"type":"object","readOnly":true,"nullable":true,"description":"What the automatic checks found in the photos of an internal check, so a reviewer can sense-check them. Only served to reviewers.","properties":{"selfie":{"type":"object","required":["faceDetected","faceCount"],"properties":{"faceDetected":{"type":"boolean"},"faceCount":{"type":"integer","minimum":0},"faceHeight":{"type":"number","nullable":true,"description":"How tall the face is, as a fraction of the photo."},"covered":{"type":"boolean","nullable":true,"description":"Whether a mask, hand or dark sunglasses cover the face. Absent when the check was unsure."},"eyesOpen":{"type":"boolean","nullable":true,"description":"Whether the eyes are open. Absent when the check was unsure."},"yaw":{"type":"number","nullable":true,"description":"Degrees the head is turned to one side."},"pitch":{"type":"number","nullable":true,"description":"Degrees the head is tilted up or down."},"brightness":{"type":"number","nullable":true,"description":"How well lit the face is, from 0 to 100."},"sharpness":{"type":"number","nullable":true,"description":"How sharp the face is, from 0 to 100."}}},"document":{"type":"object","required":["detected","isIdentityDocument","portraitFound"],"properties":{"detected":{"type":"boolean"},"type":{"type":"string","nullable":true,"description":"What the document was recognised as, such as Driving License."},"typeConfidence":{"type":"number","nullable":true,"description":"How sure the check was of the type, from 0 to 100."},"isIdentityDocument":{"type":"boolean"},"wholeInFrame":{"type":"boolean","nullable":true,"description":"Whether the whole document is in the photo. Absent when it could not be placed."},"portraitFound":{"type":"boolean"},"portraitBrightness":{"type":"number","nullable":true,"description":"How well lit the photo on the document is, from 0 to 100."},"portraitSharpness":{"type":"number","nullable":true,"description":"How sharp the photo on the document is, from 0 to 100."},"wordCount":{"type":"integer","minimum":0,"nullable":true,"description":"How many words the check could read on the document. The text itself is never kept."},"nameOnDocument":{"type":"string","enum":["found","not_found","not_checked",null],"nullable":true,"description":"Whether the candidate's name appears in the text read from the document, or not_checked when the account holds no usable name or the text could not be read."}}}}},"history":{"type":"array","readOnly":true,"description":"Every settled outcome of an internal check, oldest first: the automatic result and each reviewer decision. Only served to reviewers.","items":{"type":"object","required":["source","status","at"],"properties":{"source":{"type":"string","enum":["automatic","reviewer"]},"status":{"type":"string","enum":["created","processing","verified","failed","cancelled","awaiting_review"]},"failureCode":{"type":"string","nullable":true},"faceMatchSimilarity":{"type":"number","minimum":0,"maximum":100,"nullable":true},"at":{"type":"string","format":"date-time"},"byUserId":{"type":"string","nullable":true}}}},"documentImageUrl":{"type":"string","readOnly":true,"nullable":true,"description":"A short-lived link to the ID photo of an internal check. Only served to reviewers, and never after redaction."},"faceImageUrl":{"type":"string","readOnly":true,"nullable":true,"description":"A short-lived link to the face photo of an internal check. Only served to reviewers, and never after redaction."},"reviewedAt":{"type":"string","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"]}}}}},"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"]}}}}},"reviewedBy":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}}}}}},"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"]}}}}}}}}},"InsightsTagDistribution":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"InsightsTagDistribution","enum":["InsightsTagDistribution"]},"attributes":{"type":"object","description":"The distribution of average scores across a cohort for one value of one facet. Every score is a percentage, 0-100.","properties":{"facet":{"type":"string","enum":["subject","topic","subtopic","skill","difficulty"],"readOnly":true},"value":{"type":"string","nullable":true,"readOnly":true,"description":"The facet value. Null covers both a hidden tag and responses carrying no value for this facet, which the group charts draw as a single \"--\" category."},"n":{"type":"number","readOnly":true,"description":"Number of scores the distribution was taken over."},"mean":{"type":"number","readOnly":true},"min":{"type":"number","readOnly":true,"description":"The lowest score in the distribution. Whiskers are drawn at whiskerLow/whiskerHigh, not here."},"max":{"type":"number","readOnly":true,"description":"The highest score in the distribution."},"q1":{"type":"number","readOnly":true},"median":{"type":"number","readOnly":true},"q3":{"type":"number","readOnly":true},"whiskerLow":{"type":"number","readOnly":true,"description":"The Tukey fence q1 - 1.5 x IQR, raised to min when the fence sits below the lowest score."},"whiskerHigh":{"type":"number","readOnly":true,"description":"The Tukey fence q3 + 1.5 x IQR, lowered to max when the fence sits above the highest score."},"outliers":{"type":"array","readOnly":true,"items":{"type":"object","required":["score","count"],"properties":{"score":{"type":"number"},"count":{"type":"integer","minimum":1}}},"description":"Each score outside the whiskers, lowest first, with how many data points scored it."},"outlierCount":{"type":"number","readOnly":true,"description":"Number of data points outside the whiskers."},"deciles":{"type":"array","readOnly":true,"minItems":10,"maxItems":10,"items":{"type":"number"},"description":"Score counts in ten buckets, 0-10 through 91-100, lowest first. Each bucket after 0-10 starts at its lower label, so a score between two labels such as 10.5 counts in the lower bucket. A score of exactly 100 counts in 91-100; a score above 100 counts in none."}}},"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":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"]}}}}}}}}},"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","properties":{"slug":{"type":"string","nullable":true},"label":{"type":"string"},"maxCredits":{"type":"number","minimum":0},"description":{"type":"string","nullable":true}}},"readOnly":true},"rubricMarks":{"type":"object","readOnly":false,"nullable":true},"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","adminMarked","superseded"],"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},"collision":{"type":"object","description":"Present when entries of the same role tied on this response, listing the colliding entries the reader can see. The entry with `final: true` sourced the mark.","properties":{"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"markingEntryIds":{"type":"array","items":{"type":"string"}}},"required":["role","markingEntryIds"],"readOnly":true},"timeMarked":{"type":"string","readOnly":true},"final":{"type":"boolean","readOnly":true},"selectedAsFinal":{"type":"boolean","description":"True when an administrator chose this entry as the source of the response final mark. Writable on its own: sending it with any other attribute is rejected.","readOnly":false},"selectedAt":{"type":"string","description":"When this entry was chosen as the source mark.","readOnly":true},"candidateFeedback":{"type":"string","readOnly":false,"nullable":true},"notes":{"type":"string","readOnly":false,"nullable":true},"marksWithheld":{"type":"boolean","description":"True when this entry's marks belong to another marker and are not yet submitted.","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"]}}}}},"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"]}}}}},"selectedBy":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"]}}}}}}}}},"MarkingInheritance":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingInheritance","enum":["MarkingInheritance"]},"attributes":{"type":"object","properties":{"role":{"type":"string","readOnly":true,"enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"],"description":"The marker role of the session that was written into."},"inheritedResponseCount":{"type":"integer","readOnly":true,"description":"Responses whose marks were copied."},"inheritedResponseIds":{"type":"array","readOnly":true,"items":{"type":"string"},"description":"Responses whose marks, rubric marks and candidate feedback now match the earlier session. Each entry records what it was copied from."},"skippedResponseIds":{"type":"array","readOnly":true,"items":{"type":"string"},"description":"Responses this session covers that the earlier session had not marked; they are still to mark."},"settledResponseIds":{"type":"array","readOnly":true,"items":{"type":"string"},"description":"Responses this session covers whose marking is no longer the marker’s to change — an administrator’s override, or an escalation. Nothing was written to them."},"markingSessionStatus":{"type":"string","readOnly":true,"enum":["pending","locked","inProgress","inConflict","escalated","completed","rejected","finalised","voided","suspended"],"description":"The session's status after the copy."}}},"relationships":{"type":"object","properties":{"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"]}}}}},"sourceSession":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}},"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"]}}}}}}}}},"MarkingReset":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingReset","enum":["MarkingReset"]},"attributes":{"type":"object","properties":{"role":{"type":"string","readOnly":true,"enum":["moderating","escalation","backReading"]},"reason":{"type":"string","readOnly":true},"voidedSessionIds":{"type":"array","readOnly":true,"items":{"type":"string"},"description":"The role's sessions that were voided."},"cascadedSessionIds":{"type":"array","readOnly":true,"items":{"type":"string"},"description":"Unstarted sessions of the roles that build on this one, voided with it; the marking flow creates them again when the reset pass completes."},"disabledEntryCount":{"type":"integer","readOnly":true,"description":"Marking entries retired by the reset. None is deleted; each stays queryable with `disabled: true`."},"withdrawnResponseCount":{"type":"integer","readOnly":true,"description":"Responses whose published mark came from a retired entry and now read as pending again."},"markingStateStatus":{"type":"string","readOnly":true,"enum":["pending","inProgress","marksSubmitted","finalised"]},"markingStatus":{"type":"string","readOnly":true,"nullable":true,"enum":["notStarted","inProgress","readyToFinalise","finalised","completed"],"description":"The attempt's marking status after the reset."}}},"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"]}}}}},"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"]}}}}}}}}},"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"},"candidateFeedback":{"type":"string","nullable":true,"readOnly":false},"notes":{"type":"string","nullable":true,"readOnly":false},"feedbackWithheld":{"type":"boolean","description":"True when this session's overall feedback belongs to another marker whose session is still open.","readOnly":true},"feedbackFinal":{"type":"boolean","description":"True when this session's overall feedback is the one published onto the attempt. Only set on attempt-scoped listings.","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"]}}}}},"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"]}}}}},"predecessor":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}},"replaces":{"type":"object","description":"This is a 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":"MarkingSession","enum":["MarkingSession"]}}}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}}},"MarkingSessionExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"MarkingSessionExport","enum":["MarkingSessionExport"]},"attributes":{"type":"object","properties":{"attemptIds":{"type":"array","items":{"type":"string"}},"filter":{"type":"object","properties":{"propertyFilters":{"type":"array","description":"Candidate attribute filters. Each attribute may appear only once.","items":{"type":"object","required":["attribute","value"],"properties":{"attribute":{"type":"string","pattern":"^filter\\.attr\\.[a-z0-9_-]+$"},"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"]}}}},"examStatus":{"type":"array","items":{"type":"string","enum":["enrolled","notified","preflight","started","submitted","revoked","expired","cancelled"]}},"markingStatus":{"type":"array","items":{"type":"string","enum":["notStarted","inProgress","readyToFinalise","finalised","completed"]}},"gradeStatus":{"type":"array","items":{"type":"string","enum":["passed","failed"]}},"proctorStatus":{"type":"array","items":{"type":"string","enum":["disabled","enabled","readyForReview","reviewNotRequired","autoApproved","inReview","passed","failed","error"]}},"resultStatus":{"type":"array","items":{"type":"string","enum":["pending","finalised","released"]}},"lockStatus":{"type":"array","items":{"type":"string","enum":["locked","unlocked","none"]}},"systemsCheckStatus":{"type":"array","items":{"type":"string","enum":["notRun","inProgress","passed","attention"]}},"subPortals":{"type":"array","items":{"type":"string"}},"testVersions":{"type":"array","items":{"type":"string"}},"isArchived":{"type":"boolean"},"isCompleted":{"type":"boolean"}}},"search":{"type":"string"}}},"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"]}}}}}}}}},"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"},"finalisation":{"type":"object"}}},"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","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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":{}}}},"NetworkCheck":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"NetworkCheck","enum":["NetworkCheck"]},"attributes":{"type":"object","properties":{"key":{"type":"string","minLength":16,"maxLength":128,"writeOnly":true,"description":"The key held by the browser or desktop app reporting this run. Required for runs issued with a key."},"writerGeneration":{"type":"integer","minimum":1,"writeOnly":true,"description":"The reporting generation issued when the run was created or resumed. Send the same generation when starting and completing a check."},"downloadUrl":{"type":"string","readOnly":true,"description":"The file to download. Only on the response that starts a check; add a query string that changes each time so nothing is served from the browser’s cache."},"downloadBytes":{"type":"integer","minimum":1,"readOnly":true,"description":"How many bytes the download file holds."},"expiresAt":{"type":"string","format":"date-time","readOnly":true,"description":"When the upload addresses stop working. Only on the response that starts a check."},"uploads":{"type":"array","readOnly":true,"description":"Where to upload to, with a PUT of exactly sizeBytes of data and the stated content type. The same address may be used repeatedly until it expires. Only on the response that starts a check.","items":{"type":"object","required":["name","url","sizeBytes","contentType"],"properties":{"name":{"type":"string"},"url":{"type":"string"},"sizeBytes":{"type":"integer","minimum":1},"contentType":{"type":"string"}}}},"probes":{"type":"array","readOnly":true,"description":"Addresses of the exam’s own hosts. Request each with a plain no-cors GET: any answer at all, even an error page, means the host can be reached. Only on the response that starts a check.","items":{"type":"object","required":["name","url"],"properties":{"name":{"type":"string","enum":["files","storage"]},"url":{"type":"string"}}}},"services":{"type":"array","readOnly":true,"description":"The proctoring connections a proctored exam depends on, each to be tried the way the exam uses it: a WebSocket is opened and must answer, and the video relay must hand out a relay candidate to a peer connection that only accepts relayed ones. Left out for an exam that is not proctored. Only on the response that starts a check.","items":{"type":"object","required":["name","kind"],"properties":{"name":{"type":"string","enum":["synoptic","turn"]},"kind":{"type":"string","enum":["websocket","turn"]},"url":{"type":"string","description":"The WebSocket address, for a websocket service."},"urls":{"type":"array","items":{"type":"string"},"description":"The ICE server addresses, for a turn service."},"username":{"type":"string"},"credential":{"type":"string"}}}},"metrics":{"type":"object","additionalProperties":false,"required":["durationMs"],"description":"What the candidate’s browser measured. Every part is optional except how long the check took, and a part the browser could not measure is left out.","properties":{"durationMs":{"type":"number","minimum":0,"maximum":600000},"reachability":{"type":"object","additionalProperties":false,"description":"Whether the browser got any answer at all from the exam’s own hosts, which the probes it was handed point at. A part the browser could not test is left out.","properties":{"files":{"type":"boolean","description":"The host exam media is served from."},"storage":{"type":"boolean","description":"The accelerated storage endpoint answers are uploaded to."},"synoptic":{"type":"boolean","description":"The proctoring server answered over a WebSocket. Only for a proctored attempt."},"turn":{"type":"boolean","description":"The video relay handed out a relay candidate. Only for a proctored attempt."}}},"synopticSocket":{"type":"object","additionalProperties":false,"required":["heldMs","closedEarly"],"description":"How the proctoring socket fared once it had answered: the browser holds it open for the rest of the check, so a network that lets a WebSocket open and then cuts it off shows up here. Left out when the socket never answered.","properties":{"heldMs":{"type":"number","minimum":0,"maximum":600000,"description":"How long the socket stayed open before the browser let it go, or before the network closed it."},"closedEarly":{"type":"boolean","description":"The network closed the socket before the browser let it go."},"closeCode":{"type":"integer","minimum":0,"maximum":65535,"description":"The WebSocket close code, when the network closed it."}}},"probes":{"type":"object","additionalProperties":false,"required":["attempts","failures"],"description":"Every small request made during the check: reachability probes, API pings and the latency requests.","properties":{"attempts":{"type":"integer","minimum":0,"maximum":10000},"failures":{"type":"integer","minimum":0,"maximum":10000}}},"api":{"type":"object","additionalProperties":false,"required":["count","failures"],"properties":{"count":{"type":"integer","minimum":0,"maximum":10000},"failures":{"type":"integer","minimum":0,"maximum":10000},"medianMs":{"type":"number","minimum":0,"maximum":600000},"p95Ms":{"type":"number","minimum":0,"maximum":600000}},"description":"Authenticated pings of the API."},"latency":{"type":"object","additionalProperties":false,"description":"Small requests to the download host, while nothing else was moving and while a transfer was.","properties":{"idle":{"type":"object","additionalProperties":false,"required":["count","failures"],"properties":{"count":{"type":"integer","minimum":0,"maximum":10000},"failures":{"type":"integer","minimum":0,"maximum":10000},"medianMs":{"type":"number","minimum":0,"maximum":600000},"p95Ms":{"type":"number","minimum":0,"maximum":600000}}},"loaded":{"type":"object","additionalProperties":false,"required":["count","failures"],"properties":{"count":{"type":"integer","minimum":0,"maximum":10000},"failures":{"type":"integer","minimum":0,"maximum":10000},"medianMs":{"type":"number","minimum":0,"maximum":600000},"p95Ms":{"type":"number","minimum":0,"maximum":600000}}}}},"download":{"type":"object","additionalProperties":false,"required":["bytes","durationMs","failed","aborted"],"properties":{"bytes":{"type":"number","minimum":0,"maximum":1000000000},"durationMs":{"type":"number","minimum":0,"maximum":600000},"throughputMbps":{"type":"number","minimum":0,"maximum":100000},"longestStallMs":{"type":"number","minimum":0,"maximum":600000,"description":"The longest stretch in which no data moved while the transfer was under way."},"failed":{"type":"boolean","description":"The request errored."},"aborted":{"type":"boolean","description":"The client gave up because no data moved for several seconds. A transfer that was only cut off by the time allowed, while still moving, is neither failed nor aborted."}}},"upload":{"type":"object","additionalProperties":false,"required":["bytes","durationMs","failed","aborted"],"properties":{"bytes":{"type":"number","minimum":0,"maximum":1000000000},"durationMs":{"type":"number","minimum":0,"maximum":600000},"throughputMbps":{"type":"number","minimum":0,"maximum":100000},"longestStallMs":{"type":"number","minimum":0,"maximum":600000,"description":"The longest stretch in which no data moved while the transfer was under way."},"failed":{"type":"boolean","description":"The request errored."},"aborted":{"type":"boolean","description":"The client gave up because no data moved for several seconds. A transfer that was only cut off by the time allowed, while still moving, is neither failed nor aborted."}}},"connection":{"type":"object","additionalProperties":false,"description":"What the browser says about the connection, kept as context only.","properties":{"effectiveType":{"type":"string","maxLength":16},"downlinkMbps":{"type":"number","minimum":0,"maximum":100000},"rttMs":{"type":"number","minimum":0,"maximum":600000},"saveData":{"type":"boolean"}}}},"writeOnly":true},"overall":{"type":"string","enum":["ok","warn","error"],"readOnly":true,"description":"How the candidate’s connection looks, from the results that clearly mean trouble. Only on the response that completes a check."}}},"relationships":{"type":"object","properties":{"preflightRun":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PreflightRun","enum":["PreflightRun"]}}}}}}}}},"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},"credentialId":{"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},"passwordStyle":{"type":"string","enum":["strong","simple"],"description":"Which kind of password to generate for an instant reset. `simple` returns a short, readable password that is easy to pass on verbally. Defaults to `strong`.","readOnly":true},"newPassword":{"type":"string","description":"The users new password. On create it can only be supplied alongside `instant`, and not alongside `passwordStyle`.","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"}}},"examSynopticV2NoRecordingBase":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}},"examSynopticV2NoRecordingExtra":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}},"examSynopticV2RecreationBase":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}},"examSynopticV2RecreationExtra":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}},"examSynopticV2RecordedBase":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}},"examSynopticV2RecordedExtra":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}},"examSynopticV2AiReviewBase":{"type":"object","properties":{"creditsPerItem":{"type":"number"},"instances":{"type":"number"},"creditsUsed":{"type":"number"}}},"examSynopticV2AiReviewExtra":{"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":{}}}},"PhoneCapture":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PhoneCapture","enum":["PhoneCapture"]},"attributes":{"type":"object","properties":{"ready":{"type":"boolean","readOnly":true},"region":{"type":"string","readOnly":true},"generation":{"type":"string","format":"uuid","readOnly":true},"writerGeneration":{"type":"integer","minimum":1,"readOnly":true},"paired":{"type":"boolean","readOnly":true},"publisherEnabled":{"type":"boolean","readOnly":true},"secondCameraRequired":{"type":"boolean","readOnly":true},"roomScanId":{"type":"string","readOnly":true},"pairExpiresAt":{"type":"string","format":"date-time","readOnly":true},"capabilityExpiresAt":{"type":"string","format":"date-time","readOnly":true},"sessionId":{"type":"string","readOnly":true},"pairToken":{"type":"string","readOnly":true,"description":"Single-use pairing secret returned only when pairing is created."},"capability":{"type":"string","readOnly":true,"description":"Scoped phone secret returned only when the phone claims pairing."},"publisher":{"type":"object","readOnly":true,"properties":{"token":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["token","expiresAt"]}},"required":["region","generation","writerGeneration","paired","secondCameraRequired","pairExpiresAt"]},"relationships":{"type":"object","properties":{}}}},"PhoneCaptureCapability":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PhoneCaptureCapability","enum":["PhoneCaptureCapability"]},"attributes":{"type":"object","properties":{"ready":{"type":"boolean","readOnly":true},"region":{"type":"string","readOnly":true},"generation":{"type":"string","format":"uuid","readOnly":true},"writerGeneration":{"type":"integer","minimum":1,"readOnly":true},"paired":{"type":"boolean","readOnly":true},"publisherEnabled":{"type":"boolean","readOnly":true},"secondCameraRequired":{"type":"boolean","readOnly":true},"roomScanId":{"type":"string","readOnly":true},"pairExpiresAt":{"type":"string","format":"date-time","readOnly":true},"capabilityExpiresAt":{"type":"string","format":"date-time","readOnly":true},"sessionId":{"type":"string","readOnly":true},"pairToken":{"type":"string","readOnly":true,"description":"Single-use pairing secret returned only when pairing is created."},"capability":{"type":"string","readOnly":true,"description":"Scoped phone secret returned only when the phone claims pairing."},"publisher":{"type":"object","readOnly":true,"properties":{"token":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["token","expiresAt"]}},"required":["region","generation","writerGeneration","paired","secondCameraRequired","pairExpiresAt"]},"relationships":{"type":"object","properties":{}}}},"PhoneCaptureRoomScan":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PhoneCaptureRoomScan","enum":["PhoneCaptureRoomScan"]},"attributes":{"type":"object","properties":{"preflightRunId":{"type":"string","readOnly":true},"writerGeneration":{"type":"integer","minimum":1},"key":{"type":"string","minLength":16,"maxLength":128,"writeOnly":true},"prepareUpload":{"type":"boolean","enum":[true],"writeOnly":true,"description":"Prepare an upload and return its signed details. Requires method, key and writerGeneration; webcam uploads also require contentType and size."},"contentType":{"type":"string","enum":["video/mp4","video/webm"],"writeOnly":true},"size":{"type":"integer","minimum":1,"maximum":262144000,"writeOnly":true},"uploadId":{"type":"string","format":"uuid"},"uploadUrl":{"type":"string","format":"uri","readOnly":true},"uploadFields":{"type":"object","additionalProperties":{"type":"string"},"readOnly":true},"uploadExpiresAt":{"type":"string","format":"date-time","readOnly":true},"isSubmitted":{"type":"boolean","enum":[true],"writeOnly":true,"description":"Submit the current upload. Requires uploadId, key and writerGeneration. Cannot be combined with review or other candidate updates."},"cancelUpload":{"type":"boolean","enum":[true],"writeOnly":true,"description":"Discard an unsubmitted upload. Requires key and writerGeneration."},"attemptId":{"type":"string","readOnly":true},"coverage":{"type":"string","enum":["off","workspace","full"],"readOnly":true},"device":{"type":"string","enum":["phone","webcam","either"],"readOnly":true},"state":{"type":"string","enum":["created","uploaded","ready"],"readOnly":true},"availability":{"type":"string","enum":["available","pending","expired","redacted"],"readOnly":true},"finding":{"type":"string","enum":["notReviewed","green","amber","red"]},"reasons":{"type":"array","items":{"type":"string","enum":["poorImageQuality","inadequateCoverage","prohibitedItems"]}},"comment":{"type":"string","maxLength":4000},"submittedAt":{"type":"string","format":"date-time","readOnly":true},"reviewedAt":{"type":"string","format":"date-time","readOnly":true},"reviewedBy":{"type":"string","readOnly":true},"redactedAt":{"type":"string","format":"date-time","readOnly":true},"redactedBy":{"type":"string","readOnly":true},"expiresAt":{"type":"string","format":"date-time","readOnly":true},"maximumBytes":{"type":"integer","readOnly":true},"minimumDurationSeconds":{"type":"number","readOnly":true},"maximumDurationSeconds":{"type":"number","readOnly":true},"method":{"type":"string","enum":["phone","webcam"]},"reportedRecordedAt":{"type":"string","format":"date-time"},"browser":{"type":"string","maxLength":120},"os":{"type":"string","maxLength":120},"playbackUrl":{"type":"string","readOnly":true},"authoritative":{"type":"boolean","readOnly":true},"reviewGuidance":{"type":"string","readOnly":true},"canReview":{"type":"boolean","readOnly":true},"locale":{"type":"string","readOnly":true},"providerName":{"type":"string","readOnly":true}}},"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":["synopticV2","rosalyn"],"readOnly":true},"proctorRequireSecondCamera":{"type":"boolean","readOnly":true,"nullable":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},"candidateFeedback":{"type":"string","readOnly":true},"resultsUpdatedAt":{"type":"string","format":"date-time","readOnly":true,"description":"When the released result was last corrected after its release. Absent when it never was, before release, and wherever marks are not shown."},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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},"reviewAndSubmitEnabled":{"type":"boolean","readOnly":true},"ignoreSkippedResponses":{"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","failedSectionsOnly"],"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","PlayerMatchingResponse","PlayerImageLabellingDragAndDropResponse","PlayerImageLabellingDropDownResponse","PlayerImageLabellingTextResponse","PlayerClassificationResponse","PlayerChoiceMatrixResponse","PlayerTextSelectionResponse","PlayerCodingResponse","PlayerBowTieResponse","PlayerLikertResponse","PlayerNumericAnswerResponse"],"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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"]}}}}}}}}},"PlayerBowTieResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerBowTieResponse","enum":["PlayerBowTieResponse"]},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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},"optionFormat":{"type":"string","readOnly":true,"enum":["plainText","richText"],"description":"Always plainText: bow tie options are plain text only, and options saved as rich text are returned as plain text."},"groups":{"type":"array","readOnly":true,"description":"The three groups in left, centre, right order, each with its own pool of options.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","enum":["left","centre","right"],"readOnly":true},"label":{"type":"string","readOnly":true,"description":"The plain text heading shown above the group."},"selectCount":{"type":"integer","readOnly":true,"description":"How many options the candidate selects from this group."},"options":{"type":"array","readOnly":true,"description":"The options of this group, in the order this candidate sees them.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"content":{"type":"string","readOnly":true,"description":"Plain text, to be shown as typed. Options of questions saved as rich text before bow tie options became plain text only are returned as plain text, with the markup removed."}}}}}}},"answers":{"type":"array","readOnly":false,"nullable":true,"description":"The option placed in each slot. A slot that is left out is empty. Null clears every answer. A group can use an option once only.","items":{"type":"object","additionalProperties":false,"required":["groupKey","slot","optionKey"],"properties":{"groupKey":{"type":"string","enum":["left","centre","right"]},"slot":{"type":"integer","minimum":0,"description":"The zero-based slot of the group: 0 or 1 for left and right, 0 for centre."},"optionKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"}}}},"correctAnswers":{"type":"array","readOnly":true,"nullable":true,"description":"The correct options of each group, in left, centre, right order. Only present once the answers can be revealed. The order of the options within a group is not significant.","items":{"type":"object","readOnly":true,"properties":{"groupKey":{"type":"string","enum":["left","centre","right"],"readOnly":true},"optionKeys":{"type":"array","readOnly":true,"items":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","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"}]}}}}}}}}}},"PlayerChoiceMatrixResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerChoiceMatrixResponse","enum":["PlayerChoiceMatrixResponse"]},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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},"selectionMode":{"type":"string","readOnly":true,"enum":["single","multiple"]},"rowFormat":{"type":"string","readOnly":true,"enum":["plainText","richText"]},"optionFormat":{"type":"string","readOnly":true,"enum":["plainText","richText"]},"rows":{"type":"array","readOnly":true,"description":"The rows, in the order they are shown.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"content":{"type":"string","readOnly":true,"description":"Plain text or rich text HTML, as set by rowFormat for a row and by optionFormat for an option."}}}},"options":{"type":"array","readOnly":true,"description":"The options shared by every row, in the order they are shown.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"content":{"type":"string","readOnly":true,"description":"Plain text or rich text HTML, as set by rowFormat for a row and by optionFormat for an option."}}}},"answers":{"type":"array","readOnly":false,"nullable":true,"description":"The options selected in each answered row. A row that is left out, or sent with no options, is unanswered. When selectionMode is single a row has at most one option. Null clears every answer.","items":{"type":"object","additionalProperties":false,"required":["rowKey","optionKeys"],"properties":{"rowKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"},"optionKeys":{"type":"array","items":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"}}}}},"correctAnswers":{"type":"array","readOnly":true,"nullable":true,"description":"The correct options for each row. Only present once the answers can be revealed.","items":{"type":"object","additionalProperties":false,"required":["rowKey","optionKeys"],"properties":{"rowKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"},"optionKeys":{"type":"array","items":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"}}},"readOnly":true}},"rowResults":{"type":"array","readOnly":true,"nullable":true,"description":"Whether the selection in each row equals its correct options. Only present once the answers can be revealed.","items":{"type":"object","readOnly":true,"properties":{"rowKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"correct":{"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"}]}}}}}}}}}},"PlayerClassificationResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerClassificationResponse","enum":["PlayerClassificationResponse"]},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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},"itemFormat":{"type":"string","readOnly":true,"enum":["plainText","richText"]},"items":{"type":"array","readOnly":true,"description":"The items, in the order this candidate sees them.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"content":{"type":"string","readOnly":true,"description":"Plain text or rich text HTML for an item, as set by itemFormat. Plain text for a category."}}}},"categories":{"type":"array","readOnly":true,"description":"The categories, in the order this candidate sees them.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"content":{"type":"string","readOnly":true,"description":"Plain text or rich text HTML for an item, as set by itemFormat. Plain text for a category."}}}},"answers":{"type":"array","readOnly":false,"nullable":true,"description":"The category chosen for each classified item. An item that is left out is unclassified. Null clears every answer.","items":{"type":"object","additionalProperties":false,"required":["itemKey","categoryKey"],"properties":{"itemKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"},"categoryKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"}}}},"correctAnswers":{"type":"array","readOnly":true,"nullable":true,"description":"The correct category for each item. Only present once the answers can be revealed.","items":{"type":"object","additionalProperties":false,"required":["itemKey","categoryKey"],"properties":{"itemKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"},"categoryKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"}},"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"}]}}}}}}}}}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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"}]}}}}}}}}}},"PlayerCodingResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerCodingResponse","enum":["PlayerCodingResponse"]},"attributes":{"type":"object","additionalProperties":false,"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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},"language":{"type":"string","readOnly":true,"enum":["javascript","typescript","html","css","python"],"description":"The language the code editor highlights."},"template":{"type":"string","readOnly":true,"nullable":true,"description":"The starting code from the question, as plain text. Seed the editor with it only while code is null; a saved code, including an empty string, is never replaced."},"code":{"type":"string","readOnly":false,"nullable":true,"maxLength":100000,"description":"The candidate code as plain text, stored exactly as sent with no trimming or encoding. An empty string is a saved, emptied answer. Null clears the saved answer. Null when nothing has been saved. Not returned in the response to an update."}}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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"]}}}}}}}}},"PlayerImageLabellingDragAndDropResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerImageLabellingDragAndDropResponse","enum":["PlayerImageLabellingDragAndDropResponse"]},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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},"optionFormat":{"type":"string","readOnly":true,"enum":["plainText","richText"]},"allowOptionReuse":{"type":"boolean","readOnly":true},"tileWidth":{"type":"number","readOnly":true,"description":"The width of every slot and answer tile as a percentage of the image width."},"tileHeight":{"type":"number","readOnly":true,"description":"The height of every slot and answer tile as a percentage of the image height."},"transparentSlots":{"type":"boolean","readOnly":true},"backgroundAltText":{"type":"string","readOnly":true,"nullable":true},"optionGroups":{"type":"array","readOnly":true,"description":"The option groups, in the order the author set. Empty when the options are not split into groups.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"label":{"type":"string","readOnly":true}}}},"slots":{"type":"array","readOnly":true,"description":"The slots, in the order the author set.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"centerX":{"type":"number","readOnly":true,"description":"The horizontal centre of the slot as a percentage of the image width."},"centerY":{"type":"number","readOnly":true,"description":"The vertical centre of the slot as a percentage of the image height."},"groupKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true,"description":"The key of the option group this belongs to. Only present when the question splits its options into groups."}}}},"options":{"type":"array","readOnly":true,"description":"The answers a candidate chooses from, in the order this candidate sees them.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"content":{"type":"string","readOnly":true,"description":"Plain text or rich text HTML, as set by the answer format of the question."},"groupKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true,"description":"The key of the option group this belongs to. Only present when the question splits its options into groups."}}}},"answers":{"type":"array","readOnly":false,"nullable":true,"description":"The answer placed in each filled slot. A slot that is left out is empty. Null clears every answer.","items":{"type":"object","additionalProperties":false,"required":["slotKey","optionKey"],"properties":{"slotKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"},"optionKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"}}}},"correctAnswers":{"type":"array","readOnly":true,"nullable":true,"description":"The accepted answers for each slot, one entry per accepted answer. Only present once the answers can be revealed.","items":{"type":"object","additionalProperties":false,"required":["slotKey","optionKey"],"properties":{"slotKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"},"optionKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"}},"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"]}}}}}}}}},"PlayerImageLabellingDropDownResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerImageLabellingDropDownResponse","enum":["PlayerImageLabellingDropDownResponse"]},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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},"fieldWidth":{"type":"number","readOnly":true,"nullable":true,"description":"The width of every field as a percentage of the image width. Null means each field fits its longest choice."},"fieldHeight":{"type":"number","readOnly":true,"nullable":true,"description":"The height of every field as a percentage of the image height. Null means each field fits its content."},"backgroundAltText":{"type":"string","readOnly":true,"nullable":true},"slots":{"type":"array","readOnly":true,"description":"The fields, in the order the author set.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"centerX":{"type":"number","readOnly":true,"description":"The horizontal centre of the field as a percentage of the image width."},"centerY":{"type":"number","readOnly":true,"description":"The vertical centre of the field as a percentage of the image height."},"choices":{"type":"array","readOnly":true,"description":"The choices of this field, in the order this candidate sees them.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"content":{"type":"string","readOnly":true,"description":"Plain text."}}}}}}},"answers":{"type":"array","readOnly":false,"nullable":true,"maxItems":30,"description":"The choice made in each answered field. A field that is left out is unanswered. Null clears every answer.","items":{"type":"object","additionalProperties":false,"required":["slotKey","choiceKey"],"properties":{"slotKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"},"choiceKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"}}}},"correctAnswers":{"type":"array","readOnly":true,"nullable":true,"description":"The correct choice of each field. Only present once the answers can be revealed.","items":{"type":"object","additionalProperties":false,"required":["slotKey","choiceKey"],"properties":{"slotKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"},"choiceKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"}},"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"]}}}}}}}}},"PlayerImageLabellingTextResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerImageLabellingTextResponse","enum":["PlayerImageLabellingTextResponse"]},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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},"fieldWidth":{"type":"number","readOnly":true,"nullable":true,"description":"The width of every field as a percentage of the image width. Null means each field fits its longest accepted answer."},"fieldHeight":{"type":"number","readOnly":true,"nullable":true,"description":"The height of every field as a percentage of the image height. Null means each field fits its content."},"caseSensitive":{"type":"boolean","readOnly":true},"disableSpellcheck":{"type":"boolean","readOnly":true},"backgroundAltText":{"type":"string","readOnly":true,"nullable":true},"slots":{"type":"array","readOnly":true,"description":"The fields, in the order the author set.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"centerX":{"type":"number","readOnly":true,"description":"The horizontal centre of the field as a percentage of the image width."},"centerY":{"type":"number","readOnly":true,"description":"The vertical centre of the field as a percentage of the image height."}}}},"answers":{"type":"array","readOnly":false,"nullable":true,"maxItems":30,"description":"The text typed into each answered field. A field that is left out is unanswered. Null clears every answer.","items":{"type":"object","additionalProperties":false,"required":["slotKey","text"],"properties":{"slotKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"},"text":{"type":"string","maxLength":200,"description":"The text typed into the field. Blank text counts as unanswered."}}}},"correctAnswers":{"type":"array","readOnly":true,"nullable":true,"description":"The accepted answers of each field. Only present once the answers can be revealed.","items":{"type":"object","readOnly":true,"properties":{"slotKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"acceptedAnswers":{"type":"array","readOnly":true,"items":{"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"}]}}}}}},"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"]}}}}}}}}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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"}]}}}}}}}}}},"PlayerLikertResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerLikertResponse","enum":["PlayerLikertResponse"]},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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},"options":{"type":"array","readOnly":true,"description":"The points of the scale as they were when the attempt was created, in scale order. A point value is its position in this list, starting at 1.","items":{"type":"object","readOnly":true,"properties":{"content":{"type":"string","readOnly":true,"description":"The plain text label of the point."}}}},"answers":{"type":"array","readOnly":false,"nullable":true,"maxItems":1,"description":"The point the candidate chose, as its 1-based position in the scale. At most one. Null clears the answer. A Likert response is never marked: its outcome is always excluded.","items":{"type":"object","additionalProperties":false,"required":["value"],"properties":{"value":{"type":"integer","minimum":1,"maximum":10}}}}}},"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"}]}}}}}}}}}},"PlayerMatchingResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerMatchingResponse","enum":["PlayerMatchingResponse"]},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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},"promptFormat":{"type":"string","readOnly":true,"enum":["plainText","richText"]},"optionFormat":{"type":"string","readOnly":true,"enum":["plainText","richText"]},"allowOptionReuse":{"type":"boolean","readOnly":true},"prompts":{"type":"array","readOnly":true,"description":"The prompts, in the order this candidate sees them.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"content":{"type":"string","readOnly":true,"description":"Plain text or rich text HTML, as set by the matching format of its list."}}}},"options":{"type":"array","readOnly":true,"description":"The options, in the order this candidate sees them.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"content":{"type":"string","readOnly":true,"description":"Plain text or rich text HTML, as set by the matching format of its list."}}}},"answers":{"type":"array","readOnly":false,"nullable":true,"description":"The option chosen for each answered prompt. A prompt that is left out is unanswered. Null clears every answer.","items":{"type":"object","additionalProperties":false,"required":["promptKey","optionKey"],"properties":{"promptKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"},"optionKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"}}}},"correctAnswers":{"type":"array","readOnly":true,"nullable":true,"description":"The correct option for each prompt. Only present once the answers can be revealed.","items":{"type":"object","additionalProperties":false,"required":["promptKey","optionKey"],"properties":{"promptKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"},"optionKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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"}]}}}}}}}}}},"PlayerNumericAnswerResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerNumericAnswerResponse","enum":["PlayerNumericAnswerResponse"]},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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},"prefix":{"type":"string","readOnly":true,"maxLength":20,"description":"Plain text shown before the answer box. Display only: it is not part of the answer."},"suffix":{"type":"string","readOnly":true,"maxLength":20,"description":"Plain text shown after the answer box. Display only: it is not part of the answer."},"precisionMode":{"type":"string","readOnly":true,"enum":["none","exactDecimalPlaces","maxDecimalPlaces"],"description":"The format requirement the candidate was given: none, exactly decimalPlaces or at most decimalPlaces digits after the decimal point. The entry is never rounded."},"decimalPlaces":{"type":"integer","readOnly":true,"minimum":0,"maximum":10,"description":"The decimal places used by precisionMode. Absent when precisionMode is none."},"answers":{"type":"array","readOnly":false,"nullable":true,"maxItems":1,"description":"The number the candidate entered. At most one element. Null or an empty list clears the answer: a blank is never zero.","items":{"type":"object","additionalProperties":false,"required":["entry"],"properties":{"entry":{"type":"string","description":"A plain decimal number written as a string, for example \"42\", \"-0.5\" or \"12.50\": no plus sign, grouping commas, exponent, spaces, or a decimal point without digits on either side. At most 30 characters, not counting a leading minus. Trailing zeros are kept as sent."}}}},"formatValid":{"type":"boolean","readOnly":true,"nullable":true,"description":"Whether the entry met the format requirement, decided when the response was marked. A value that matches a rule but fails the format scores zero. Null when nothing was entered or the answers cannot be revealed yet; always true when there is no format requirement. Only present once the answers can be revealed."},"correctAnswers":{"type":"array","readOnly":true,"nullable":true,"description":"The accepted answers, one row per rule. Only present once the answers can be revealed.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","readOnly":true},"matchType":{"type":"string","readOnly":true,"enum":["exact","range"]},"exact":{"type":"string","readOnly":true,"pattern":"^-?(0|[1-9]\\d*)(\\.\\d+)?$","description":"The accepted value of an exact rule."},"minimum":{"type":"string","readOnly":true,"pattern":"^-?(0|[1-9]\\d*)(\\.\\d+)?$","description":"The lowest accepted value, inclusive."},"maximum":{"type":"string","readOnly":true,"pattern":"^-?(0|[1-9]\\d*)(\\.\\d+)?$","description":"The highest accepted value, inclusive."},"toleranceType":{"type":"string","readOnly":true,"enum":["absolute","percentage"]},"tolerance":{"type":"string","readOnly":true,"pattern":"^-?(0|[1-9]\\d*)(\\.\\d+)?$","description":"How far from exact an exact rule still accepts, inclusive. Only with toleranceType."},"credit":{"type":"number","readOnly":true,"description":"Only present when the question scores by choice."},"feedback":{"type":"string","readOnly":true,"description":"Rich text feedback of the rule, when it has any."}}}},"awardedRule":{"type":"object","readOnly":true,"nullable":true,"description":"The rule that was awarded: the accepted rule with the highest credit. Null when no rule accepted the entry or nothing was entered. Only present once the answers can be revealed.","properties":{"key":{"type":"string","readOnly":true},"matchType":{"type":"string","readOnly":true,"enum":["exact","range"]},"credit":{"type":"number","readOnly":true},"feedback":{"type":"string","readOnly":true,"description":"Rich text feedback of the awarded rule."}}}}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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","PlayerMatchingResponse","PlayerImageLabellingDragAndDropResponse","PlayerImageLabellingDropDownResponse","PlayerImageLabellingTextResponse","PlayerClassificationResponse","PlayerChoiceMatrixResponse","PlayerTextSelectionResponse","PlayerCodingResponse","PlayerBowTieResponse","PlayerLikertResponse","PlayerNumericAnswerResponse"],"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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"}]}}}}}}}}}},"PlayerTextSelectionResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PlayerTextSelectionResponse","enum":["PlayerTextSelectionResponse"]},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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,"description":"The passage as sanitised HTML. Each selectable region is a span with a data-text-selection-region attribute holding its key. The passage never says which regions are correct."},"selectionLimitType":{"type":"string","readOnly":true,"enum":["any","max","exact"],"description":"any: no limit on the number of regions selected. max: up to selectionLimit regions. exact: selectionLimit regions are expected."},"selectionLimit":{"type":"integer","readOnly":true,"nullable":true,"description":"The number of regions the candidate can select: the number of correct regions, derived when the attempt is generated. Null when selectionLimitType is any."},"regions":{"type":"array","readOnly":true,"description":"The regions in the order they appear in the passage.","items":{"type":"object","readOnly":true,"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":true},"content":{"type":"string","readOnly":true,"description":"The plain text of the region."}}}},"answers":{"type":"array","readOnly":false,"nullable":true,"maxItems":100,"description":"The regions selected, without repeats. Every key must be a region of the question and the list cannot be longer than selectionLimit when selectionLimitType is max or exact. An empty list or null clears every selection.","items":{"type":"object","additionalProperties":false,"required":["regionKey"],"properties":{"regionKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"}}}},"correctAnswers":{"type":"array","readOnly":true,"nullable":true,"description":"The correct regions. Only present once the answers can be revealed.","items":{"type":"object","additionalProperties":false,"required":["regionKey"],"properties":{"regionKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"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},"markerFeedback":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","role","feedback"],"properties":{"id":{"type":"string"},"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"feedback":{"type":"string"}}}},"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"]},"synoptic":{"type":"string","enum":["lockdown","full"]},"personalAccessToken":{"type":"boolean"},"customAttributes":{"type":"number"},"advancedGrading":{"type":"boolean"},"examVoucher":{"type":"boolean"},"codeLogin":{"type":"boolean"},"examTemplates":{"type":"boolean"},"automations":{"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":{"ignoreSkippedResponses":{"type":"boolean"},"reviewAndSubmitEnabled":{"type":"boolean"},"saveAndResumeEnabled":{"type":"boolean"},"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":{"ignoreSkippedResponses":{"type":"boolean"},"reviewAndSubmitEnabled":{"type":"boolean"},"saveAndResumeEnabled":{"type":"boolean"},"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"]},"registrationSettingsLoginLayout":{"type":"string","enum":["legacy","stacked","stacked-wide","split",null],"nullable":true},"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},"studyConfigIgnoreSkippedResponses":{"type":"boolean","readOnly":false},"studyConfigTakeTest":{"type":"object","properties":{"ignoreSkippedResponses":{"type":"boolean"},"reviewAndSubmitEnabled":{"type":"boolean"},"saveAndResumeEnabled":{"type":"boolean"},"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":{"ignoreSkippedResponses":{"type":"boolean"},"reviewAndSubmitEnabled":{"type":"boolean"},"saveAndResumeEnabled":{"type":"boolean"},"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"}]},"PreflightRun":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"PreflightRun","enum":["PreflightRun"]},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["exam_preflight","exam_systems_check"],"description":"What the run is for. exam_preflight leads into the exam and is refused before the entry window opens. exam_systems_check is a practice check a candidate can run at any time before submitting: it never starts the exam and never counts towards admission."},"createdAt":{"type":"string","format":"date-time","readOnly":true},"client":{"type":"object","readOnly":true,"nullable":true,"description":"What the candidate was using when the run began. Only served to reviewers.","properties":{"ipAddress":{"type":"string"},"userAgent":{"type":"string"},"region":{"type":"string"},"webVersion":{"type":"string"},"desktopVersion":{"type":"string"},"extensionVersion":{"type":"string"},"os":{"type":"string"},"browser":{"type":"string"},"timezone":{"type":"string"},"locale":{"type":"string"},"synopticLevel":{"type":"string"},"systemsCheckRunId":{"type":"string"}}},"payloadRedactedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"When the personal details of client (IP address, user agent, time zone and locale) were removed. Only served to reviewers."},"authoritative":{"type":"boolean","readOnly":true,"description":"Whether this is the newest preflight of its attempt. Progress updates also return false when another browser or desktop session has resumed the run and replaced the writer."},"writerGeneration":{"type":"integer","minimum":1,"description":"Issued on creation and resume. Progress updates must send the generation issued to that reporter; resuming invalidates earlier generations."},"requestSequence":{"type":"integer","minimum":1,"maximum":9007199254740991,"writeOnly":true,"description":"Increasing request number within the issued writer generation. Older or repeated updates are ignored."},"source":{"type":"string","enum":["browser","desktop"],"writeOnly":true,"description":"Create or resume: whether this reporter is the browser or desktop app."},"progress":{"type":"object","readOnly":true,"nullable":true,"description":"Where the candidate is up to in the preflight journey. Only served to reviewers.","required":["lastSeenAt"],"properties":{"lastSeenAt":{"type":"string","format":"date-time"},"writer":{"type":"object","required":["generation","source","startedAt"],"properties":{"generation":{"type":"integer","minimum":1},"source":{"type":"string","enum":["browser","desktop"]},"startedAt":{"type":"string","format":"date-time"},"environment":{"type":"object","properties":{"webVersion":{"type":"string"},"desktopVersion":{"type":"string"},"extensionVersion":{"type":"string"},"os":{"type":"string"},"browser":{"type":"string"}}}}},"requestSequence":{"type":"integer","minimum":1,"maximum":9007199254740991},"currentStep":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$","description":"The key of a preflight journey step."},"visible":{"type":"boolean","description":"Whether the preflight page was visible when last seen."},"route":{"type":"string","maxLength":128},"completedAt":{"type":"string","format":"date-time"},"plannedSteps":{"type":"array","maxItems":30,"description":"The steps the journey will take the candidate through, in order.","items":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$","description":"The key of a preflight journey step."}},"device":{"type":"object","required":["clientTime","screenWidth","screenHeight","windowWidth","windowHeight","isFullscreen"],"description":"What the candidate's device reported when it last checked in: its clock, screen and window size, whether the page is full screen, and its connection.","properties":{"clientTime":{"type":"string","format":"date-time","description":"The time on the device's own clock."},"pageUrl":{"type":"string","maxLength":300,"description":"The address the candidate is using, without any query string or fragment."},"screenWidth":{"type":"integer","minimum":0,"maximum":32768},"screenHeight":{"type":"integer","minimum":0,"maximum":32768},"windowWidth":{"type":"integer","minimum":0,"maximum":32768},"windowHeight":{"type":"integer","minimum":0,"maximum":32768},"windowX":{"type":"integer","description":"Distance from the left of the screen to the browser window.","minimum":-32768,"maximum":32768},"windowY":{"type":"integer","description":"Distance from the top of the screen to the browser window.","minimum":-32768,"maximum":32768},"isExtendedDisplay":{"type":"boolean","description":"Whether the device has more than one screen, when the browser says."},"mediaDevices":{"type":"array","description":"The cameras and microphones the browser can see.","maxItems":20,"items":{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["audioinput","videoinput"]},"label":{"type":"string","maxLength":120},"selectable":{"type":"boolean","description":"Whether this device appears in the candidate picker after filtering and deduplication."}}}},"screenShare":{"type":"object","description":"The active screen capture track, when available. This does not identify a primary or external display.","required":["active"],"properties":{"active":{"type":"boolean"},"label":{"type":"string","maxLength":120},"surface":{"type":"string","enum":["monitor","window","browser"]},"width":{"type":"integer","minimum":0,"maximum":32768},"height":{"type":"integer","minimum":0,"maximum":32768}}},"pixelRatio":{"type":"number","minimum":0,"maximum":16},"isFullscreen":{"type":"boolean"},"memoryGb":{"type":"number","minimum":0},"cpuCores":{"type":"integer","minimum":0},"architecture":{"type":"string","maxLength":16},"bitness":{"type":"string","maxLength":8},"connection":{"type":"object","description":"What the browser reports about the connection. Not every browser reports it.","properties":{"effectiveType":{"type":"string","enum":["slow-2g","2g","3g","4g"]},"type":{"type":"string","maxLength":16},"downlinkMbps":{"type":"number","minimum":0},"rttMs":{"type":"integer","minimum":0},"saveData":{"type":"boolean"}}}}},"status":{"type":"object","description":"A snapshot of what the candidate page can see right now. It replaces the previous snapshot.","properties":{"stage":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$","description":"Where the candidate is within the current step."},"blockedApps":{"type":"array","maxItems":20,"description":"Names of prohibited apps found running. Only a systems check reports these, and only reviewers see them.","items":{"type":"string","maxLength":60}},"facts":{"type":"object","description":"Things that are true or false right now, such as whether the camera is live.","additionalProperties":{"type":"boolean"}},"checks":{"type":"object","description":"The live readiness of each requirement the journey checks before the exam can start.","additionalProperties":{"type":"string","enum":["ok","attention","blocked"]}}}},"steps":{"type":"object","additionalProperties":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["started","completed","failed","skipped"]},"startedAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","format":"date-time"},"errorCode":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,63}$","description":"The key of the error the candidate was shown."}}}},"events":{"type":"array","description":"The most recent milestones, oldest first.","items":{"type":"object","required":["at","type"],"properties":{"at":{"type":"string","format":"date-time"},"writerGeneration":{"type":"integer","minimum":1},"source":{"type":"string","enum":["browser","desktop"]},"type":{"type":"string","enum":["step_started","step_completed","step_failed","step_skipped","journey_completed","restarted","handed_off"]},"step":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$","description":"The key of a preflight journey step."},"errorCode":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,63}$","description":"The key of the error the candidate was shown."}}}}}},"network":{"type":"object","readOnly":true,"nullable":true,"description":"How the network checks of this run went, including the results the candidate is not shown. Only served to reviewers.","properties":{"checksStarted":{"type":"integer","minimum":0},"checks":{"type":"array","description":"The most recent checks, oldest first.","items":{"type":"object","required":["id","tier","startedAt"],"properties":{"id":{"type":"string"},"tier":{"type":"string","enum":["basic","audio","video"],"description":"What the exam asks of the candidate’s connection: nothing recorded, audio, or video."},"startedAt":{"type":"string","format":"date-time"},"writerGeneration":{"type":"integer","minimum":1},"completedAt":{"type":"string","format":"date-time"},"metrics":{"type":"object","additionalProperties":false,"required":["durationMs"],"description":"What the candidate’s browser measured. Every part is optional except how long the check took, and a part the browser could not measure is left out.","properties":{"durationMs":{"type":"number","minimum":0,"maximum":600000},"reachability":{"type":"object","additionalProperties":false,"description":"Whether the browser got any answer at all from the exam’s own hosts, which the probes it was handed point at. A part the browser could not test is left out.","properties":{"files":{"type":"boolean","description":"The host exam media is served from."},"storage":{"type":"boolean","description":"The accelerated storage endpoint answers are uploaded to."},"synoptic":{"type":"boolean","description":"The proctoring server answered over a WebSocket. Only for a proctored attempt."},"turn":{"type":"boolean","description":"The video relay handed out a relay candidate. Only for a proctored attempt."}}},"synopticSocket":{"type":"object","additionalProperties":false,"required":["heldMs","closedEarly"],"description":"How the proctoring socket fared once it had answered: the browser holds it open for the rest of the check, so a network that lets a WebSocket open and then cuts it off shows up here. Left out when the socket never answered.","properties":{"heldMs":{"type":"number","minimum":0,"maximum":600000,"description":"How long the socket stayed open before the browser let it go, or before the network closed it."},"closedEarly":{"type":"boolean","description":"The network closed the socket before the browser let it go."},"closeCode":{"type":"integer","minimum":0,"maximum":65535,"description":"The WebSocket close code, when the network closed it."}}},"probes":{"type":"object","additionalProperties":false,"required":["attempts","failures"],"description":"Every small request made during the check: reachability probes, API pings and the latency requests.","properties":{"attempts":{"type":"integer","minimum":0,"maximum":10000},"failures":{"type":"integer","minimum":0,"maximum":10000}}},"api":{"type":"object","additionalProperties":false,"required":["count","failures"],"properties":{"count":{"type":"integer","minimum":0,"maximum":10000},"failures":{"type":"integer","minimum":0,"maximum":10000},"medianMs":{"type":"number","minimum":0,"maximum":600000},"p95Ms":{"type":"number","minimum":0,"maximum":600000}},"description":"Authenticated pings of the API."},"latency":{"type":"object","additionalProperties":false,"description":"Small requests to the download host, while nothing else was moving and while a transfer was.","properties":{"idle":{"type":"object","additionalProperties":false,"required":["count","failures"],"properties":{"count":{"type":"integer","minimum":0,"maximum":10000},"failures":{"type":"integer","minimum":0,"maximum":10000},"medianMs":{"type":"number","minimum":0,"maximum":600000},"p95Ms":{"type":"number","minimum":0,"maximum":600000}}},"loaded":{"type":"object","additionalProperties":false,"required":["count","failures"],"properties":{"count":{"type":"integer","minimum":0,"maximum":10000},"failures":{"type":"integer","minimum":0,"maximum":10000},"medianMs":{"type":"number","minimum":0,"maximum":600000},"p95Ms":{"type":"number","minimum":0,"maximum":600000}}}}},"download":{"type":"object","additionalProperties":false,"required":["bytes","durationMs","failed","aborted"],"properties":{"bytes":{"type":"number","minimum":0,"maximum":1000000000},"durationMs":{"type":"number","minimum":0,"maximum":600000},"throughputMbps":{"type":"number","minimum":0,"maximum":100000},"longestStallMs":{"type":"number","minimum":0,"maximum":600000,"description":"The longest stretch in which no data moved while the transfer was under way."},"failed":{"type":"boolean","description":"The request errored."},"aborted":{"type":"boolean","description":"The client gave up because no data moved for several seconds. A transfer that was only cut off by the time allowed, while still moving, is neither failed nor aborted."}}},"upload":{"type":"object","additionalProperties":false,"required":["bytes","durationMs","failed","aborted"],"properties":{"bytes":{"type":"number","minimum":0,"maximum":1000000000},"durationMs":{"type":"number","minimum":0,"maximum":600000},"throughputMbps":{"type":"number","minimum":0,"maximum":100000},"longestStallMs":{"type":"number","minimum":0,"maximum":600000,"description":"The longest stretch in which no data moved while the transfer was under way."},"failed":{"type":"boolean","description":"The request errored."},"aborted":{"type":"boolean","description":"The client gave up because no data moved for several seconds. A transfer that was only cut off by the time allowed, while still moving, is neither failed nor aborted."}}},"connection":{"type":"object","additionalProperties":false,"description":"What the browser says about the connection, kept as context only.","properties":{"effectiveType":{"type":"string","maxLength":16},"downlinkMbps":{"type":"number","minimum":0,"maximum":100000},"rttMs":{"type":"number","minimum":0,"maximum":600000},"saveData":{"type":"boolean"}}}}},"verdict":{"type":"object","required":["thresholdsVersion","overall","candidateOverall","findings"],"properties":{"thresholdsVersion":{"type":"integer","minimum":1},"overall":{"type":"string","enum":["ok","warn","error"]},"candidateOverall":{"type":"string","enum":["ok","warn","error"],"description":"What the candidate was shown, which only counts the results that clearly mean trouble."},"findings":{"type":"array","items":{"type":"object","required":["id","status","candidateVisible"],"properties":{"id":{"type":"string"},"status":{"type":"string","enum":["ok","warn","error"]},"reason":{"type":"string"},"candidateVisible":{"type":"boolean"}}}}}}}}}}},"systemsCheckRunId":{"type":"string","maxLength":64,"writeOnly":true,"description":"Preflight create only: the id of the systems check the candidate completed in this browser. Kept on the run when it is a completed systems check of the same attempt, and ignored otherwise."},"webVersion":{"type":"string","writeOnly":true,"description":"The version of the web app in use. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"desktopVersion":{"type":"string","writeOnly":true,"description":"The version of the desktop proctoring application, when one is in use. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"extensionVersion":{"type":"string","writeOnly":true,"description":"The version of the browser extension, when one is in use. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"os":{"type":"string","writeOnly":true,"description":"The operating system, as the browser reports it. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"browser":{"type":"string","writeOnly":true,"description":"The browser, as it reports itself. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"timezone":{"type":"string","writeOnly":true,"description":"The time zone of the device. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"locale":{"type":"string","writeOnly":true,"description":"The language the device is set to. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"synopticLevel":{"type":"string","writeOnly":true,"description":"The level of proctoring software the journey is running in. Best effort: it is cut to 64 characters if longer and never causes the run to be refused."},"resumeRunId":{"type":"string","maxLength":64,"writeOnly":true,"description":"Create: the run this browser holds the key for, to resume it instead of starting another."},"resumeKey":{"type":"string","minLength":16,"maxLength":128,"writeOnly":true,"description":"Create: the key issued when that run was created."},"takeover":{"type":"boolean","writeOnly":true,"description":"Create: end a preflight that is in progress on another device and start one here."},"key":{"type":"string","minLength":16,"maxLength":128,"description":"Returned once, when a run is created, and never again. The browser keeps it and sends it with every progress update, so only that browser can write to the run."},"resumed":{"type":"boolean","readOnly":true,"description":"True when creating returned a run that was already in progress on this browser, restarted, rather than a new one."},"completedAt":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"When the journey was completed, if it has been."},"currentStep":{"type":"string","enum":["welcome","connect","confirm","system","network","displays","apps","tabs","media","speakers","room-scan","second-camera","identity","screen","full-screen","ready","results"],"description":"Progress update: the step the candidate is on. Sent with every heartbeat.","writeOnly":true},"visible":{"type":"boolean","writeOnly":true,"description":"Progress update: whether the preflight page is visible to the candidate."},"route":{"type":"string","maxLength":128,"writeOnly":true,"description":"Progress update: the name of the route the candidate is on, never a URL."},"plannedSteps":{"type":"array","writeOnly":true,"maxItems":30,"description":"Progress update: the steps the journey will take the candidate through, in order. Sent when it starts and whenever it changes.","items":{"type":"string","enum":["welcome","connect","confirm","system","network","displays","apps","tabs","media","speakers","room-scan","second-camera","identity","screen","full-screen","ready","results"],"description":"The key of a preflight journey step."}},"device":{"type":"object","required":["clientTime","screenWidth","screenHeight","windowWidth","windowHeight","isFullscreen"],"description":"What the candidate's device reported when it last checked in: its clock, screen and window size, whether the page is full screen, and its connection.","properties":{"clientTime":{"type":"string","format":"date-time","description":"The time on the device's own clock."},"pageUrl":{"type":"string","maxLength":300,"description":"The address the candidate is using, without any query string or fragment."},"screenWidth":{"type":"integer","minimum":0,"maximum":32768},"screenHeight":{"type":"integer","minimum":0,"maximum":32768},"windowWidth":{"type":"integer","minimum":0,"maximum":32768},"windowHeight":{"type":"integer","minimum":0,"maximum":32768},"windowX":{"type":"integer","description":"Distance from the left of the screen to the browser window.","minimum":-32768,"maximum":32768},"windowY":{"type":"integer","description":"Distance from the top of the screen to the browser window.","minimum":-32768,"maximum":32768},"isExtendedDisplay":{"type":"boolean","description":"Whether the device has more than one screen, when the browser says."},"mediaDevices":{"type":"array","description":"The cameras and microphones the browser can see.","maxItems":20,"items":{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["audioinput","videoinput"]},"label":{"type":"string","maxLength":120},"selectable":{"type":"boolean","description":"Whether this device appears in the candidate picker after filtering and deduplication."}}}},"screenShare":{"type":"object","description":"The active screen capture track, when available. This does not identify a primary or external display.","required":["active"],"properties":{"active":{"type":"boolean"},"label":{"type":"string","maxLength":120},"surface":{"type":"string","enum":["monitor","window","browser"]},"width":{"type":"integer","minimum":0,"maximum":32768},"height":{"type":"integer","minimum":0,"maximum":32768}}},"pixelRatio":{"type":"number","minimum":0,"maximum":16},"isFullscreen":{"type":"boolean"},"memoryGb":{"type":"number","minimum":0},"cpuCores":{"type":"integer","minimum":0},"architecture":{"type":"string","maxLength":16},"bitness":{"type":"string","maxLength":8},"connection":{"type":"object","description":"What the browser reports about the connection. Not every browser reports it.","properties":{"effectiveType":{"type":"string","enum":["slow-2g","2g","3g","4g"]},"type":{"type":"string","maxLength":16},"downlinkMbps":{"type":"number","minimum":0},"rttMs":{"type":"integer","minimum":0},"saveData":{"type":"boolean"}}}},"writeOnly":true},"status":{"type":"object","description":"A snapshot of what the candidate page can see right now. It replaces the previous snapshot.","properties":{"stage":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$","description":"Where the candidate is within the current step."},"blockedApps":{"type":"array","maxItems":20,"description":"Names of prohibited apps found running. Only a systems check reports these, and only reviewers see them.","items":{"type":"string","maxLength":60}},"facts":{"type":"object","description":"Things that are true or false right now, such as whether the camera is live.","additionalProperties":{"type":"boolean"}},"checks":{"type":"object","description":"The live readiness of each requirement the journey checks before the exam can start.","additionalProperties":{"type":"string","enum":["ok","attention","blocked"]}}},"writeOnly":true},"events":{"type":"array","writeOnly":true,"maxItems":20,"description":"Progress update: milestones since the last update. step is required for every type except journey_completed.","items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["step_started","step_completed","step_failed","step_skipped","journey_completed","restarted","handed_off"]},"step":{"type":"string","enum":["welcome","connect","confirm","system","network","displays","apps","tabs","media","speakers","room-scan","second-camera","identity","screen","full-screen","ready","results"],"description":"The key of a preflight journey step."},"errorCode":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,63}$","description":"The key of the error the candidate was shown."}}}}}},"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"]}}}}},"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"]}}}}}}}}},"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"]}}}}}}}}},"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},"revokedAt":{"type":"string","format":"date-time","readOnly":true,"description":"When the certificate was withdrawn in favour of a replacement. Absent while it is live."}}},"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},"ignoreSkippedResponses":{"type":"boolean","readOnly":false},"reviewAndSubmitEnabled":{"type":"boolean","readOnly":false},"saveAndResumeEnabled":{"type":"boolean","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","failedSectionsOnly",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},"resitCloseMode":{"type":"string","enum":["sameAsExam","sameAsPreviousAttempt","delay"],"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":["rosalyn","synopticV2",null],"nullable":true},"proctorRequireSecondCamera":{"type":"boolean","readOnly":false,"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},"proctorLiveAiDetection":{"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,"maxItems":12,"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},"enabled":{"type":"boolean","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]},"proctorRoomScanCoverage":{"type":"string","enum":["off","workspace","full",null],"nullable":true},"proctorRoomScanDevice":{"type":"string","enum":["phone","webcam","either",null],"nullable":true},"identityCheckRequired":{"type":"boolean","readOnly":false,"nullable":false},"identityCheckFailureAction":{"type":"string","enum":["flag","block",null],"readOnly":false,"nullable":true},"identityCheckVendor":{"type":"string","enum":["stripe","entrust","internal",null],"readOnly":false,"nullable":true},"identityCheckAutomaticFaceMatch":{"type":"boolean","readOnly":false,"nullable":true,"description":"Internal identity checks only: compare the face on the ID with the candidate's photo automatically, instead of leaving every check for review."},"identityCheckNameComparison":{"type":"boolean","readOnly":false,"nullable":true,"description":"Internal identity checks only: compare the candidate's account name with the name on their ID automatically. Off unless set."},"identityCheckNameAction":{"type":"string","enum":["record","flag","block",null],"readOnly":false,"nullable":true,"description":"Internal identity checks only: what happens when the candidate's account name is not found on their ID. Defaults to flag."},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","nullable":true,"additionalProperties":false,"description":"The in-progress attempt at this quiz for the requesting user. Null when they have none; omitted when it was not looked up.","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":{"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"]}}}}},"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,"maxItems":500,"items":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"},{"enum":["Attempt"],"example":"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionBowTie":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionBowTie","enum":["QuizQuestionBowTie"]},"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},"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":["bowTie"]},"optionFormat":{"type":"string","readOnly":false,"enum":["plainText","richText"],"description":"How option content is written. Bow tie options are plain text only, so this is always plainText and richText is rejected on update. Options of questions saved as rich text before that are returned as plain text, with the markup removed, and are stored as plain text on their next update. Group labels are always plain text."},"groups":{"type":"array","readOnly":false,"minItems":3,"maxItems":3,"description":"Exactly three groups, one for each of left, centre, right, sent in any order and stored in that order. The candidate picks 2, 1 and 2 options from the left, centre and right pools. Sent in full on update: the list replaces the stored groups.","items":{"type":"object","additionalProperties":false,"required":["key","label","options","correctOptionKeys"],"properties":{"key":{"type":"string","readOnly":false,"enum":["left","centre","right"],"description":"The position of the group in the bow tie."},"label":{"type":"string","readOnly":false,"minLength":1,"maxLength":100,"description":"The heading candidates see above the group. Plain text, saved exactly as sent apart from trimming surrounding whitespace, up to 100 characters."},"options":{"type":"array","readOnly":false,"maxItems":30,"description":"The pool of options the candidate chooses from for this group: at least 3 for left, 2 for centre and 3 for right, and at most 30. Options that are not correct are the distractors. Options must be unique within a group: the comparison ignores case, markup, zero-width characters and extra whitespace.","items":{"type":"object","additionalProperties":false,"required":["key","content"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its group. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":10000,"description":"Plain text, saved exactly as sent apart from trimming surrounding whitespace, of up to 500 characters. It is never parsed as HTML, so characters such as < and & are kept as typed."}}}},"correctOptionKeys":{"type":"array","readOnly":false,"items":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its group. Letters, numbers, hyphens and underscores only."},"description":"The keys of the correct options of this group: exactly 2 for left, 1 for centre and 2 for right. They must be distinct options of the same group."}}}},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"],"description":"Whether each pool is shuffled for every candidate. The three pools shuffle independently; the groups themselves never move."},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate"],"description":"exactMatch awards the credits only when every group has exactly its correct options. proportionate awards a fifth of the credits for each correct option the candidate selected; the groups are scored independently and nothing is deducted."}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionBulkAction":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionBulkAction","enum":["QuizQuestionBulkAction"]},"attributes":{"type":"object","additionalProperties":false,"required":["scope","action"],"properties":{"scope":{"description":"Which of the quiz's questions to change: either an explicit list of at most 5000 question ids, or everything matching a filter and search, which are read as they are for the quiz's list of QuizQuestionSummaries. An empty filter and no search selects every question. A selection of more than 5000 questions is refused.","oneOf":[{"type":"object","additionalProperties":false,"required":["questionIds"],"properties":{"questionIds":{"type":"array","minItems":1,"maxItems":5000,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"filter":{"type":"object","additionalProperties":false,"properties":{"type":{"oneOf":[{"type":"array","items":{"type":"string","enum":["audioRecording","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"]}},{"type":"string","enum":["audioRecording","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"]}],"description":"Only questions of one of these types, including older questions that predate the stored type."},"tag":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}],"description":"Only questions carrying one of the tags listed for each facet. Tags of the same facet are alternatives, and tags without a facet count as one facet of their own, so the question must match every facet that is named."},"section":{"type":"string","description":"Only the questions of this static section, by QuizSection id. A dynamic section selects questions by rule, so it matches none."},"emqGroup":{"type":"string","description":"Only the questions of this EMQ group."}}},"search":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\x00-\\x08\\x0b\\x0c\\x0e-\\x1f]*$"}}}]},"action":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"type":"string","enum":["updateTags"],"description":"updateTags adds the tags in addTagIds that a question lacks and removes the tags in removeTagIds that it has. At least one tag is needed between the two lists, and no tag may be in both."},"addTagIds":{"type":"array","maxItems":50,"items":{"type":"string"},"description":"Tags to add. They are in the quiz’s portal and the caller can read them."},"removeTagIds":{"type":"array","maxItems":50,"items":{"type":"string"},"description":"Tags to remove. They are in the quiz’s portal and the caller can read them."}}}}},"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"]}}}}}}}}},"QuizQuestionChoiceMatrix":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionChoiceMatrix","enum":["QuizQuestionChoiceMatrix"]},"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},"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":["choiceMatrix"]},"selectionMode":{"type":"string","readOnly":false,"enum":["single","multiple"],"description":"single: the candidate selects exactly one option in each row and every row has exactly one correct option. multiple: the candidate selects one or more options in each row and every row has one or more correct options. The mode applies to every row. Changing it re-validates the stored rows."},"rowFormat":{"type":"string","readOnly":false,"enum":["plainText","richText"],"description":"How row content is written: plainText (the default) is text that is stored and shown exactly as typed, richText is HTML from the rich text editor, which is sanitised. Images are not allowed in either."},"optionFormat":{"type":"string","readOnly":false,"enum":["plainText","richText"],"description":"How option content is written, with the same rules as rowFormat."},"rows":{"type":"array","readOnly":false,"minItems":2,"maxItems":30,"description":"The statements the candidate answers, in the order they are shown. Rows must be unique: the comparison ignores case, markup, zero-width characters and extra whitespace. Sent in full on update: the list replaces the stored rows. Changing rowFormat requires sending the rows again.","items":{"type":"object","additionalProperties":false,"required":["key","content","correctOptionKeys"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":10000,"description":"Plain text when rowFormat is plainText: saved exactly as sent, apart from trimming surrounding whitespace. It is never parsed as HTML, so characters such as < and & are kept as typed, and it can have up to 500 characters. Otherwise rich text HTML of up to 10000 characters, without images or other embedded content."},"correctOptionKeys":{"type":"array","readOnly":false,"minItems":1,"maxItems":10,"description":"The keys of the options that are correct for this row, each one an existing option, without repeats. Exactly one when selectionMode is single, one or more when it is multiple. A row is only correct when the candidate selects exactly these options.","items":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."}}}}},"options":{"type":"array","readOnly":false,"minItems":2,"maxItems":10,"description":"The options the candidate chooses from, shared by every row, in the order they are shown. An option such as \"None apply\" is an ordinary option. Options must be unique: the comparison ignores case, markup, zero-width characters and extra whitespace. Sent in full on update: the list replaces the stored options. Changing optionFormat requires sending the options again.","items":{"type":"object","additionalProperties":false,"required":["key","content"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":10000,"description":"Plain text when optionFormat is plainText: saved exactly as sent, apart from trimming surrounding whitespace. It is never parsed as HTML, so characters such as < and & are kept as typed, and it can have up to 500 characters. Otherwise rich text HTML of up to 10000 characters, without images or other embedded content."}}}},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate"],"description":"exactMatch: full credit only when every row is correct. proportionate: credit for the share of rows that are correct. A row is correct only when the selected options equal its correct options."}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionClassification":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionClassification","enum":["QuizQuestionClassification"]},"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},"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":["classification"]},"itemFormat":{"type":"string","readOnly":false,"enum":["plainText","richText"],"description":"How item content is written: plainText (the default) is text that is stored and shown exactly as typed, richText is HTML from the rich text editor, which is sanitised. Images are not allowed in either. Category content is always plain text."},"items":{"type":"array","readOnly":false,"minItems":2,"maxItems":30,"description":"The items a candidate sorts into categories. Items must be unique: the comparison ignores case, markup, zero-width characters and extra whitespace. Sent in full on update: the list replaces the stored items.","items":{"type":"object","additionalProperties":false,"required":["key","content","correctCategoryKey"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":10000,"description":"Plain text when itemFormat is plainText: saved exactly as sent, apart from trimming surrounding whitespace. It is never parsed as HTML, so characters such as < and & are kept as typed, and it can have up to 500 characters. Otherwise rich text HTML of up to 10000 characters, without images or other embedded content."},"correctCategoryKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"The key of the category this item belongs to. Every item belongs to exactly one category."}}}},"categories":{"type":"array","readOnly":false,"minItems":2,"maxItems":30,"description":"The categories the items are sorted into. A category that no item belongs to is valid. Categories must be unique: the comparison ignores case, zero-width characters and extra whitespace. Sent in full on update: the list replaces the stored categories.","items":{"type":"object","additionalProperties":false,"required":["key","content"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":500,"description":"Plain text, saved exactly as sent apart from trimming surrounding whitespace. It is never parsed as HTML, and it can have up to 500 characters."}}}},"itemShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"]},"categoryShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"]},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate"]}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionCoding":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionCoding","enum":["QuizQuestionCoding"]},"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},"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":["coding"]},"language":{"type":"string","readOnly":false,"enum":["javascript","typescript","html","css","python"],"description":"The language the code editor highlights. It is the only editor setting an author controls."},"template":{"type":"string","readOnly":false,"nullable":true,"maxLength":100000,"description":"The starting code the editor opens with for a candidate who has not saved an answer. Plain text: it is stored exactly as sent and never run or rendered as HTML."}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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"]}}}}}}}}},"QuizQuestionImageLabellingDragAndDrop":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionImageLabellingDragAndDrop","enum":["QuizQuestionImageLabellingDragAndDrop"]},"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},"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":["imageLabellingDragAndDrop"]},"optionFormat":{"type":"string","readOnly":false,"enum":["plainText","richText"],"description":"How answer content is written: plainText (the default) is text that is stored and shown exactly as typed, richText is HTML from the rich text editor, which is sanitised. Images are not allowed in either."},"slots":{"type":"array","readOnly":false,"minItems":1,"maxItems":30,"description":"The fixed slots a candidate places options into, positioned over the background image. Sent in full on update: the list replaces the stored slots.","items":{"type":"object","additionalProperties":false,"required":["key","centerX","centerY","acceptedOptionKeys"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"groupKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"The key of the option group this belongs to. Required when optionGroups is set and not allowed otherwise."},"centerX":{"type":"number","readOnly":false,"minimum":0,"maximum":100,"description":"The horizontal centre of the slot as a percentage of the image width."},"centerY":{"type":"number","readOnly":false,"minimum":0,"maximum":100,"description":"The vertical centre of the slot as a percentage of the image height."},"acceptedOptionKeys":{"type":"array","readOnly":false,"minItems":1,"description":"The keys of the options that are correct for this slot. At least one is needed. When option groups are used they must all belong to the slot's own group.","items":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."}}}}},"options":{"type":"array","readOnly":false,"minItems":2,"maxItems":30,"description":"The options a candidate chooses from. Options that no slot accepts act as distractors. Options must be unique: the comparison ignores case, markup, zero-width characters and extra whitespace. Sent in full on update: the list replaces the stored options.","items":{"type":"object","additionalProperties":false,"required":["key","content"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"groupKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"The key of the option group this belongs to. Required when optionGroups is set and not allowed otherwise."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":10000,"description":"Plain text when optionFormat is plainText: saved exactly as sent, apart from trimming surrounding whitespace. It is never parsed as HTML, so characters such as < and & are kept as typed, and it can have up to 500 characters. Otherwise rich text HTML of up to 10000 characters, without images or other embedded content."}}}},"optionGroups":{"type":"array","readOnly":false,"nullable":true,"description":"Optional named groups of options, 2 to 6 of them when used. Each slot belongs to one group and only accepts options from it, and the candidate sees one bank of options per group. When set, every option and slot needs a groupKey, and each group needs at least one slot and one option. Group labels must be unique, ignoring case and extra whitespace. Sent in full on update: the list replaces the stored groups, and null removes the groups.","items":{"type":"object","additionalProperties":false,"required":["key","label"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"label":{"type":"string","readOnly":false,"minLength":1,"maxLength":100,"description":"Plain text shown as the heading of the group."}}}},"allowOptionReuse":{"type":"boolean","readOnly":false,"description":"Whether the same answer can be placed in more than one slot. It applies to every option group."},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"]},"tileWidth":{"type":"number","readOnly":false,"exclusiveMinimum":true,"minimum":0,"maximum":100,"description":"The width of every slot and answer tile as a percentage of the image width."},"tileHeight":{"type":"number","readOnly":false,"exclusiveMinimum":true,"minimum":0,"maximum":100,"description":"The height of every slot and answer tile as a percentage of the image height."},"transparentSlots":{"type":"boolean","readOnly":false,"description":"Show slots without a border or background, for diagrams that already draw the empty boxes."},"backgroundAltText":{"type":"string","readOnly":false,"nullable":true,"maxLength":500,"description":"An optional description of the background image for screen readers. It must not give away the options."},"pointPerSlot":{"type":"number","readOnly":false,"nullable":true,"minimum":0,"description":"The points for each correctly filled slot. Required when scoring is matchPerBlank."},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate","matchPerBlank"],"description":"exactMatch needs every slot right, proportionate awards credit in proportion to the slots filled correctly, and matchPerBlank awards pointPerSlot for each slot filled correctly."}}},"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":"QuizQuestionImageLabellingDragAndDrop","enum":["QuizQuestionImageLabellingDragAndDrop"]}}}}},"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"]}}}}}}}}},"QuizQuestionImageLabellingDropDown":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionImageLabellingDropDown","enum":["QuizQuestionImageLabellingDropDown"]},"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},"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":["imageLabellingDropDown"]},"slots":{"type":"array","readOnly":false,"minItems":1,"maxItems":30,"description":"The slots a candidate answers, positioned over the background image. Each slot has its own dropdown. Sent in full on update: the list replaces the stored slots.","items":{"type":"object","additionalProperties":false,"required":["key","centerX","centerY","choices"],"properties":{"key":{"type":"string","readOnly":false,"minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"centerX":{"type":"number","readOnly":false,"minimum":0,"maximum":100,"description":"The horizontal centre of the slot as a percentage of the image width."},"centerY":{"type":"number","readOnly":false,"minimum":0,"maximum":100,"description":"The vertical centre of the slot as a percentage of the image height."},"choices":{"type":"array","readOnly":false,"minItems":2,"maxItems":10,"description":"The choices in the dropdown of this slot. Exactly one is correct. Choices must be unique within the slot: the comparison ignores case, zero-width characters and extra whitespace.","items":{"type":"object","additionalProperties":false,"required":["key","content","correct"],"properties":{"key":{"type":"string","readOnly":false,"minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":200,"description":"Plain text, saved exactly as sent apart from trimming surrounding whitespace. It is never parsed as HTML. Up to 200 characters."},"correct":{"type":"boolean","readOnly":false,"description":"Whether this is the correct choice for the slot."}}}}}}},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"],"description":"Whether the choices of each slot are shuffled for every candidate. Slots keep their order."},"fieldWidth":{"type":"number","readOnly":false,"nullable":true,"exclusiveMinimum":true,"minimum":0,"maximum":100,"description":"The width of every slot as a percentage of the image width. Null fits each slot to its longest choice."},"fieldHeight":{"type":"number","readOnly":false,"nullable":true,"exclusiveMinimum":true,"minimum":0,"maximum":100,"description":"The height of every slot as a percentage of the image height. Null fits each slot to its content."},"backgroundAltText":{"type":"string","readOnly":false,"nullable":true,"maxLength":500,"description":"An optional description of the background image for screen readers. It must not give away the answers."},"pointPerSlot":{"type":"number","readOnly":false,"nullable":true,"minimum":0,"description":"The points for each correctly answered slot. Required when scoring is matchPerBlank."},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate","matchPerBlank"],"description":"exactMatch needs every slot right, proportionate awards credit in proportion to the slots answered correctly, and matchPerBlank awards pointPerSlot for each slot answered correctly."}}},"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":"QuizQuestionImageLabellingDropDown","enum":["QuizQuestionImageLabellingDropDown"]}}}}},"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"]}}}}}}}}},"QuizQuestionImageLabellingText":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionImageLabellingText","enum":["QuizQuestionImageLabellingText"]},"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},"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":["imageLabellingText"]},"slots":{"type":"array","readOnly":false,"minItems":1,"maxItems":30,"description":"The slots a candidate types an answer into, positioned over the background image. Sent in full on update: the list replaces the stored slots.","items":{"type":"object","additionalProperties":false,"required":["key","centerX","centerY","acceptedAnswers"],"properties":{"key":{"type":"string","readOnly":false,"minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"centerX":{"type":"number","readOnly":false,"minimum":0,"maximum":100,"description":"The horizontal centre of the slot as a percentage of the image width."},"centerY":{"type":"number","readOnly":false,"minimum":0,"maximum":100,"description":"The vertical centre of the slot as a percentage of the image height."},"acceptedAnswers":{"type":"array","readOnly":false,"minItems":1,"maxItems":10,"description":"The answers that are correct for this slot. They must be unique after trimming, collapsing whitespace and Unicode normalisation, ignoring case unless caseSensitive is set.","items":{"type":"string","readOnly":false,"minLength":1,"maxLength":200}}}}},"caseSensitive":{"type":"boolean","readOnly":false,"description":"Whether the capitalisation of a typed answer has to match."},"disableSpellcheck":{"type":"boolean","readOnly":false,"description":"Whether spellcheck and autocorrect are switched off in the answer slots."},"fieldWidth":{"type":"number","readOnly":false,"nullable":true,"exclusiveMinimum":true,"minimum":0,"maximum":100,"description":"The width of every slot as a percentage of the image width. Null fits each slot to its longest accepted answer."},"fieldHeight":{"type":"number","readOnly":false,"nullable":true,"exclusiveMinimum":true,"minimum":0,"maximum":100,"description":"The height of every slot as a percentage of the image height. Null fits each slot to its content."},"backgroundAltText":{"type":"string","readOnly":false,"nullable":true,"maxLength":500,"description":"An optional description of the background image for screen readers. It must not give away the answers."},"pointPerSlot":{"type":"number","readOnly":false,"nullable":true,"minimum":0,"description":"The points for each correctly answered slot. Required when scoring is matchPerBlank."},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate","matchPerBlank"],"description":"exactMatch needs every slot right, proportionate awards credit in proportion to the slots answered correctly, and matchPerBlank awards pointPerSlot for each slot answered correctly."}}},"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":"QuizQuestionImageLabellingText","enum":["QuizQuestionImageLabellingText"]}}}}},"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"]}}}}}}}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionLikert":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionLikert","enum":["QuizQuestionLikert"]},"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]},"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},"questionType":{"type":"string","readOnly":true,"enum":["likert"]},"options":{"type":"array","readOnly":false,"minItems":2,"maxItems":10,"description":"The points of the scale in order, from first to last: 2 to 10 of them. The candidate chooses exactly one. A point's value is its position, starting at 1, so reordering the labels changes what existing responses mean. A Likert question is never marked: it has no correct answer, credits, penalties, scoring strategy or option shuffling, and every response is excluded from scoring. Sent in full on update: the list replaces the stored scale.","items":{"type":"object","additionalProperties":false,"required":["content"],"properties":{"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":100,"description":"The label of the point. Plain text, saved exactly as sent apart from trimming surrounding whitespace and shown as text, never as HTML, up to 100 characters. Labels must be unique: the comparison ignores case, zero-width characters and extra whitespace."}}}}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionMatching":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionMatching","enum":["QuizQuestionMatching"]},"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},"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":["matching"]},"promptFormat":{"type":"string","readOnly":false,"enum":["plainText","richText"],"description":"How prompt content is written: plainText (the default) is text that is stored and shown exactly as typed, richText is HTML from the rich text editor, which is sanitised. Images are not allowed in either."},"optionFormat":{"type":"string","readOnly":false,"enum":["plainText","richText"],"description":"How option content is written: plainText (the default) is text that is stored and shown exactly as typed, richText is HTML from the rich text editor, which is sanitised. Images are not allowed in either."},"prompts":{"type":"array","readOnly":false,"minItems":2,"maxItems":30,"description":"The prompts a candidate matches to options. Sent in full on update: the list replaces the stored prompts.","items":{"type":"object","additionalProperties":false,"required":["key","content","correctOptionKey"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":10000,"description":"Plain text when promptFormat is plainText: saved exactly as sent, apart from trimming surrounding whitespace. It is never parsed as HTML, so characters such as < and & are kept as typed, and it can have up to 500 characters. Otherwise rich text HTML of up to 10000 characters, without images or other embedded content."},"correctOptionKey":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"The key of the option that is the correct match for this prompt."}}}},"options":{"type":"array","readOnly":false,"minItems":2,"maxItems":30,"description":"The options shared by all prompts. Options that no prompt matches act as distractors. Options must be unique: the comparison ignores case, markup, zero-width characters and extra whitespace. Sent in full on update: the list replaces the stored options.","items":{"type":"object","additionalProperties":false,"required":["key","content"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within its list. Letters, numbers, hyphens and underscores only."},"content":{"type":"string","readOnly":false,"minLength":1,"maxLength":10000,"description":"Plain text when optionFormat is plainText: saved exactly as sent, apart from trimming surrounding whitespace. It is never parsed as HTML, so characters such as < and & are kept as typed, and it can have up to 500 characters. Otherwise rich text HTML of up to 10000 characters, without images or other embedded content."}}}},"allowOptionReuse":{"type":"boolean","readOnly":false,"description":"Whether several prompts can have the same option as their correct match."},"optionShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"]},"promptShuffling":{"type":"string","readOnly":false,"enum":["disabled","random"]},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate"]}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionNumericAnswer":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionNumericAnswer","enum":["QuizQuestionNumericAnswer"]},"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},"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},"markingScoreByChoiceEnabled":{"type":"boolean","readOnly":false,"description":"When false (the default) any accepted answer earns the question credit. When true each rule may carry its own credit and the highest matching rule credit is awarded."},"questionType":{"type":"string","readOnly":true,"enum":["numericAnswer"]},"prefix":{"type":"string","readOnly":false,"nullable":true,"maxLength":20,"description":"Text shown before the answer box, such as a currency symbol. Plain text, display only: it is never part of the candidate's answer and never marked. Trimmed, up to 20 characters. Send null or an empty string to clear it."},"suffix":{"type":"string","readOnly":false,"nullable":true,"maxLength":20,"description":"Text shown after the answer box, such as a unit like kg. Plain text, display only: there is no unit conversion and it is never marked. Trimmed, up to 20 characters. Send null or an empty string to clear it."},"precisionMode":{"type":"string","readOnly":false,"enum":["none","exactDecimalPlaces","maxDecimalPlaces"],"description":"The format requirement for the candidate's entry. none (the default) has no requirement. exactDecimalPlaces requires exactly decimalPlaces digits after the decimal point, so 1.50 satisfies 2 and 1.5 does not. maxDecimalPlaces requires at most decimalPlaces digits. The entry is never rounded or changed. The value is marked against the rules first; a value that matches a rule but does not meet the format scores zero and is recorded as formatValid false."},"decimalPlaces":{"type":"integer","readOnly":false,"minimum":0,"maximum":10,"description":"The number of decimal places the format requires, 0 to 10 (0 means a whole number). Required when precisionMode is not none and rejected when it is none. Changing precisionMode to none clears it."},"rules":{"type":"array","readOnly":false,"minItems":1,"maxItems":20,"description":"The accepted answers: 1 to 20 rules. Rules may overlap. When several rules accept the entry the rule with the highest credit is awarded, once (credits only count with markingScoreByChoiceEnabled): credits are never added up and the order of the rules does not matter. When no rule accepts it the answer is incorrect, and a blank entry is skipped, never zero. Where rules with equal credit accept the same entry, the rule that accepts the narrower interval wins (a plain exact value is the narrowest), then an exact rule beats a range of the same width, then the key in ascending order. Sent in full on update: the list replaces the stored rules.","items":{"type":"object","additionalProperties":false,"required":["key","matchType"],"properties":{"key":{"type":"string","readOnly":false,"minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","description":"Identifier set by the client, unique within the question. Letters, numbers, hyphens and underscores only."},"matchType":{"type":"string","readOnly":false,"enum":["exact","range"],"description":"exact accepts one value, or a value within a tolerance of it, and needs exact. range accepts every value from minimum to maximum inclusive and needs minimum and maximum. The fields that belong to the other match type are rejected."},"exact":{"type":"string","readOnly":false,"description":"The accepted value of an exact rule. A plain decimal number written as a string with a decimal point, for example \"42\", \"-0.5\" or \"12.50\": no plus sign, grouping commas, exponent, spaces, or a decimal point without digits on either side. At most 30 characters, not counting a leading minus. Trailing zeros are kept as sent."},"minimum":{"type":"string","readOnly":false,"description":"The lowest accepted value of a range rule, inclusive. A plain decimal number written as a string with a decimal point, for example \"42\", \"-0.5\" or \"12.50\": no plus sign, grouping commas, exponent, spaces, or a decimal point without digits on either side. At most 30 characters, not counting a leading minus. Trailing zeros are kept as sent."},"maximum":{"type":"string","readOnly":false,"description":"The highest accepted value of a range rule, inclusive. It cannot be lower than minimum. A plain decimal number written as a string with a decimal point, for example \"42\", \"-0.5\" or \"12.50\": no plus sign, grouping commas, exponent, spaces, or a decimal point without digits on either side. At most 30 characters, not counting a leading minus. Trailing zeros are kept as sent."},"toleranceType":{"type":"string","readOnly":false,"enum":["absolute","percentage"],"description":"Only for an exact rule, and only together with tolerance. absolute accepts values within tolerance of exact, bounds included. percentage accepts values within tolerance percent of the size of exact, so an exact of 0 accepts only exactly 0."},"tolerance":{"type":"string","readOnly":false,"description":"Only for an exact rule, and only together with toleranceType. How far from exact the rule still accepts, bounds included. Greater than 0, and for a percentage at most 10000. A plain decimal number written as a string with a decimal point, for example \"42\", \"-0.5\" or \"12.50\": no plus sign, grouping commas, exponent, spaces, or a decimal point without digits on either side. At most 30 characters, not counting a leading minus. Trailing zeros are kept as sent."},"credit":{"type":"number","readOnly":false,"exclusiveMinimum":true,"minimum":0,"maximum":100000,"description":"Optional. Only used when markingScoreByChoiceEnabled is true, and ignored otherwise: the marks awarded when this rule is the one that accepts the entry, more than 0 and up to 100000. Left out it defaults to the credit of the question. The question is worth the highest of these."},"feedback":{"type":"string","readOnly":false,"nullable":true,"maxLength":10000,"description":"Optional rich text feedback, sanitised like option feedback. Shown to the candidate only with the rest of the answers, and only for the rule that was awarded."}}}}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"example":"QuizQuestion"}]}}}}}}}}},"QuizQuestionSummary":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionSummary","enum":["QuizQuestionSummary"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"questionType":{"type":"string","enum":["audioRecording","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing","matching","imageLabellingDragAndDrop","imageLabellingDropDown","imageLabellingText","classification","bowTie","likert","numericAnswer","choiceMatrix","textSelection","coding"],"readOnly":true},"name":{"type":"string","readOnly":true},"stemExcerpt":{"type":"string","readOnly":true,"description":"The stem as plain text, without markup, cut to 200 characters with a trailing ellipsis when it is longer."},"leadInExcerpt":{"type":"string","readOnly":true,"description":"The lead-in as plain text, without markup, cut to 200 characters with a trailing ellipsis when it is longer. Absent when the question has no lead-in."},"doi":{"type":"string","readOnly":true},"position":{"type":"integer","minimum":1,"nullable":true,"readOnly":true,"description":"The question’s one-based place in the quiz’s own question order, whichever way the list is sorted. Null for a question that belongs to the quiz but is not in its question order."},"availableMarks":{"type":"number","readOnly":true,"description":"The most a candidate can score on the question under the quiz’s own marking defaults, falling back to the portal’s, and the question’s own marking where it sets any. It is not the denominator of an exam attempt, as it ignores custom marking and any ceiling set on an attempt. Informational questions carry none."}}},"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":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"]}}}}},"section":{"type":"object","description":"The static section the question belongs to. Empty when the quiz has no sections or the question is only reached through a dynamic section.","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":"QuizSection","enum":["QuizSection"]}}}}},"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":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"]}}}}},"owner":{"type":"object","description":"The question’s author. Empty when the question has none.","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"]}}}}},"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"}]}}}}}}}}}},"QuizQuestionTextSelection":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"QuizQuestionTextSelection","enum":["QuizQuestionTextSelection"]},"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},"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":["textSelection"]},"template":{"type":"string","readOnly":false,"minLength":1,"maxLength":50000,"description":"The passage as rich text HTML, which is sanitised. Each region the candidate can select is an inline span carrying a data-text-selection-region attribute with its key, wrapped around the text it covers. The template holds keys only, never which regions are correct. Regions cannot overlap, nest, contain a block, link, form control or image, or repeat a key. Changing the template re-validates every region."},"regions":{"type":"array","readOnly":false,"minItems":2,"maxItems":100,"description":"One entry for every region in the template and no others. At least one region must be correct. Sent in full on update: the list replaces the stored regions. The text of a region comes from the template, never from the client, and is returned as content.","items":{"type":"object","additionalProperties":false,"required":["key","correct"],"properties":{"key":{"type":"string","minLength":2,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$","readOnly":false,"description":"Identifier set by the client, unique within the question. Letters, numbers, hyphens and underscores only. It must match the data-text-selection-region attribute of exactly one region in the template."},"correct":{"type":"boolean","readOnly":false,"description":"Whether selecting this region is correct."},"content":{"type":"string","readOnly":true,"maxLength":500,"description":"The plain text of the region, taken from the template with whitespace collapsed. Read only."}}}},"selectionLimitType":{"type":"string","readOnly":false,"enum":["any","max","exact"],"description":"any: the candidate can select any number of regions. max: up to as many regions as there are correct regions. exact: as many regions as there are correct regions are expected, although fewer are still marked. The number is derived when an attempt is generated, never authored. At the limit further selections are blocked."},"scoring":{"type":"string","readOnly":false,"enum":["exactMatch","proportionate","netCorrect"],"description":"exactMatch: full credit only when exactly the correct regions are selected. proportionate: credit for the share of regions judged correctly, counting a correct region selected and an incorrect region left alone. netCorrect: each correct region selected earns an equal share of the credit and each incorrect region selected takes one share away, never going below zero. Questions saved with the retired perCorrectSelection scoring are returned and marked as proportionate."},"pointPerCorrectSelection":{"type":"number","readOnly":false,"nullable":true,"minimum":0,"description":"Legacy. The points for each correct region of a question saved with the retired perCorrectSelection scoring, and null for every other question. It is ignored for marking and cannot be set: only null is accepted on update, which clears it."}}},"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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","QuizQuestionMatching","QuizQuestionImageLabellingDragAndDrop","QuizQuestionImageLabellingDropDown","QuizQuestionImageLabellingText","QuizQuestionClassification","QuizQuestionChoiceMatrix","QuizQuestionTextSelection","QuizQuestionCoding","QuizQuestionBowTie","QuizQuestionLikert","QuizQuestionNumericAnswer"],"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":{}}}},"ResponseMaxPointsOverride":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"ResponseMaxPointsOverride","enum":["ResponseMaxPointsOverride"]},"attributes":{"type":"object","properties":{"maxPoints":{"type":"number","minimum":0,"nullable":true},"notifyCandidate":{"type":"boolean","writeOnly":true,"description":"Off unless `true`. Email the candidate a short notice that their results were updated, with a link and no marks. Sent only for a released result once marking is final; the exam’s results-email setting and hidden-results page still apply. See `meta.notification`."},"previousMaxPoints":{"type":"number","nullable":true,"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"]}}}}},"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"]}}}}}}}}},"RoomScan":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"RoomScan","enum":["RoomScan"]},"attributes":{"type":"object","properties":{"preflightRunId":{"type":"string","readOnly":true},"writerGeneration":{"type":"integer","minimum":1},"key":{"type":"string","minLength":16,"maxLength":128,"writeOnly":true},"prepareUpload":{"type":"boolean","enum":[true],"writeOnly":true,"description":"Prepare an upload and return its signed details. Requires method, key and writerGeneration; webcam uploads also require contentType and size."},"contentType":{"type":"string","enum":["video/mp4","video/webm"],"writeOnly":true},"size":{"type":"integer","minimum":1,"maximum":262144000,"writeOnly":true},"uploadId":{"type":"string","format":"uuid"},"uploadUrl":{"type":"string","format":"uri","readOnly":true},"uploadFields":{"type":"object","additionalProperties":{"type":"string"},"readOnly":true},"uploadExpiresAt":{"type":"string","format":"date-time","readOnly":true},"isSubmitted":{"type":"boolean","enum":[true],"writeOnly":true,"description":"Submit the current upload. Requires uploadId, key and writerGeneration. Cannot be combined with review or other candidate updates."},"cancelUpload":{"type":"boolean","enum":[true],"writeOnly":true,"description":"Discard an unsubmitted upload. Requires key and writerGeneration."},"attemptId":{"type":"string","readOnly":true},"coverage":{"type":"string","enum":["off","workspace","full"],"readOnly":true},"device":{"type":"string","enum":["phone","webcam","either"],"readOnly":true},"state":{"type":"string","enum":["created","uploaded","ready"],"readOnly":true},"availability":{"type":"string","enum":["available","pending","expired","redacted"],"readOnly":true},"finding":{"type":"string","enum":["notReviewed","green","amber","red"]},"reasons":{"type":"array","items":{"type":"string","enum":["poorImageQuality","inadequateCoverage","prohibitedItems"]}},"comment":{"type":"string","maxLength":4000},"submittedAt":{"type":"string","format":"date-time","readOnly":true},"reviewedAt":{"type":"string","format":"date-time","readOnly":true},"reviewedBy":{"type":"string","readOnly":true},"redactedAt":{"type":"string","format":"date-time","readOnly":true},"redactedBy":{"type":"string","readOnly":true},"expiresAt":{"type":"string","format":"date-time","readOnly":true},"maximumBytes":{"type":"integer","readOnly":true},"minimumDurationSeconds":{"type":"number","readOnly":true},"maximumDurationSeconds":{"type":"number","readOnly":true},"method":{"type":"string","enum":["phone","webcam"]},"reportedRecordedAt":{"type":"string","format":"date-time"},"browser":{"type":"string","maxLength":120},"os":{"type":"string","maxLength":120},"playbackUrl":{"type":"string","readOnly":true},"authoritative":{"type":"boolean","readOnly":true},"reviewGuidance":{"type":"string","readOnly":true},"canReview":{"type":"boolean","readOnly":true},"locale":{"type":"string","readOnly":true},"providerName":{"type":"string","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"}}},"defaultValue":{"anyOf":[{"type":"string","nullable":true},{"type":"number","nullable":true},{"type":"boolean","nullable":true}],"readOnly":true,"description":"The option value applied until the user removes the filter. Absent when the filter starts empty."},"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"]}}}}}}}}},"StripeConnectSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"StripeConnectSession","enum":["StripeConnectSession"]},"attributes":{"type":"object","properties":{"returnPath":{"type":"string","readOnly":true,"description":"Relative path on the portal to send the admin back to once Stripe has finished. Defaults to the integrations settings page."},"authoriseUrl":{"type":"string","readOnly":true,"description":"The Stripe page the admin must visit to connect their Stripe account."}}},"relationships":{"type":"object","properties":{}}}},"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},"enabled":{"type":"boolean","nullable":true}}}},"onBreach":{"type":"string","enum":["freeze","silent"],"nullable":true},"liveProctoring":{"type":"boolean"},"secondCameraEnabled":{"type":"boolean","readOnly":true},"secondCameraRecordingStartedAt":{"type":"string","format":"date-time","readOnly":true},"secondCameraProcessingStatus":{"type":"string","enum":["pending","inProgress","completed","error"],"readOnly":true},"recordingStartedAt":{"type":"string","format":"date-time","readOnly":true},"domRecordingChunkCount":{"type":"number","readOnly":true,"description":"Number of recording chunks collated into domRecordingFile. Present only when the include is requested."}}},"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"]}}}}},"secondCameraFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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"]}}}}},"domRecordingFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","externalDocs":{"url":"https://jsonapi.org/format/#document-resource-object-linkage"},"readOnly":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","additionalProperties":false,"properties":{"name":{"type":"string","description":"Up to 120 characters. It can be changed on a managed template, and not on a legacy one."},"htmlTemplate":{"type":"string","readOnly":true,"description":"The complete document of a legacy template. A managed template does not send it."},"isDefault":{"type":"boolean","readOnly":true,"description":"Whether this is one of the built in templates."},"orientation":{"type":"string","enum":["landscape","portrait"],"readOnly":true,"description":"The orientation certificates are issued in. It is set when a managed template is created, and changed by putting orientation in the draft and publishing the template."},"preview":{"type":"object","readOnly":true,"properties":{"svg":{"type":"string"},"image":{"type":"string"}}},"usage":{"type":"string","enum":["exam","assignment"],"readOnly":true,"description":"What the template is issued for. A template stored without a usage is reported as an exam template. It cannot change once a managed template exists."},"kind":{"type":"string","enum":["legacy","managed"],"readOnly":true,"description":"Managed templates are edited here. Legacy templates are written by Synap and cannot be edited, published or deleted here."},"status":{"type":"string","enum":["draft","published"],"readOnly":true,"description":"Draft until the first publish. Legacy templates are always published."},"hasUnpublishedChanges":{"type":"boolean","readOnly":true,"description":"Whether the draft differs from the published parts or stages a different orientation from the one being issued, or nothing has been published yet."},"shellVersion":{"type":"integer","nullable":true,"readOnly":true,"description":"The version of the Synap-owned shell the published parts were compiled with."},"parts":{"type":"object","required":["body","css"],"additionalProperties":false,"description":"The published parts. Managed templates only.","properties":{"body":{"type":"string","maxLength":200000,"description":"An HTML fragment that may contain Go template actions."},"css":{"type":"string","maxLength":200000,"description":"CSS, scoped to the content box when compiled."},"contentInset":{"type":"integer","minimum":0,"maximum":30,"default":10,"description":"Safe area inside the A4 sheet, in millimetres. Defaults to 10."},"background":{"type":"object","nullable":true,"required":["url","fit"],"additionalProperties":false,"description":"The image that fills the whole page behind the content. It can only be set here, as the style of the template cannot reach it. Null or left out for no background. The url has to be the address of an image uploaded to this template, and publishing or previewing refuses any address of another place.","properties":{"url":{"type":"string","minLength":1,"maxLength":2048,"description":"The url of an image uploaded to this template."},"fit":{"type":"string","enum":["cover","contain","stretch"],"description":"How the image fills the page. Cover scales it until it covers the page and crops what does not fit, contain scales it until all of it fits in the page, and stretch fills the page whatever the proportions of the image."}}}},"nullable":true,"readOnly":true},"draft":{"type":"object","required":["body","css"],"additionalProperties":false,"description":"The parts being edited, with the orientation they will be published with, not yet published. Replaced as a whole when sent. Managed templates only.","properties":{"body":{"type":"string","maxLength":200000,"description":"An HTML fragment that may contain Go template actions."},"css":{"type":"string","maxLength":200000,"description":"CSS, scoped to the content box when compiled."},"contentInset":{"type":"integer","minimum":0,"maximum":30,"default":10,"description":"Safe area inside the A4 sheet, in millimetres. Defaults to 10."},"background":{"type":"object","nullable":true,"required":["url","fit"],"additionalProperties":false,"description":"The image that fills the whole page behind the content. It can only be set here, as the style of the template cannot reach it. Null or left out for no background. The url has to be the address of an image uploaded to this template, and publishing or previewing refuses any address of another place.","properties":{"url":{"type":"string","minLength":1,"maxLength":2048,"description":"The url of an image uploaded to this template."},"fit":{"type":"string","enum":["cover","contain","stretch"],"description":"How the image fills the page. Cover scales it until it covers the page and crops what does not fit, contain scales it until all of it fits in the page, and stretch fills the page whatever the proportions of the image."}}},"orientation":{"type":"string","enum":["landscape","portrait"],"description":"The orientation the template is issued in once this draft is published. When a request leaves it out, the orientation already staged in the draft is kept, or the orientation being issued when nothing is staged."}},"nullable":true},"isArchived":{"type":"boolean","readOnly":false,"description":"Whether the template has been archived. Archived templates are listed only when asked for, cannot be chosen for new settings and cannot be edited until they are unarchived. Send true to archive a published template and false to unarchive it, on its own, as an admin of the main portal. Sending the value it already has changes nothing. Legacy templates are never archived."},"availableToSubPortals":{"type":"boolean","nullable":true,"description":"Whether sub-portals may use this template. Only a template that is not limited to a sub-portal has it: true unless it was set to false, and false means only the main portal may choose it for its exams and assignments, and the people of a sub-portal neither see it listed nor find it. Null for a template limited to a sub-portal and for a legacy template. It can be changed whenever the template is not archived, and only affects what is chosen from then on."},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}}},"relationships":{"type":"object","properties":{"subPortal":{"type":"object","description":"The sub-portal this template is limited to, which must belong to the portal of the requester. Empty for a template of the whole portal. It can only be set when the template is created. Only the people of that sub-portal and of the main portal see a template limited to a sub-portal.","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"]}}}}},"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"]}}}}}}}}},"TemplateAsset":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TemplateAsset","enum":["TemplateAsset"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"status":{"type":"string","enum":["pending","ready","rejected"],"readOnly":true,"description":"Pending until the file has been checked by completing the asset, ready when it was accepted, rejected when it was refused. Only a ready asset can be used in a template."},"filename":{"type":"string","readOnly":true,"description":"The name of the file as it was uploaded, without control characters and up to 120 characters."},"contentType":{"type":"string","enum":["image/png","image/jpeg","image/webp","image/svg+xml","font/woff2","font/woff","font/ttf","font/otf"],"readOnly":true},"size":{"type":"integer","readOnly":true,"description":"The size in bytes that was declared for the upload."},"bytes":{"type":"integer","nullable":true,"readOnly":true,"description":"The size in bytes of the file as it is stored. An SVG is stored after it has been cleaned up, so this can differ from the size that was declared. Null until the asset is ready."},"width":{"type":"integer","nullable":true,"readOnly":true,"description":"In pixels. For an SVG it is read from its width and height, or from its viewBox. Null until the asset is ready, and always null for a font."},"height":{"type":"integer","nullable":true,"readOnly":true,"description":"In pixels. For an SVG it is read from its width and height, or from its viewBox. Null until the asset is ready, and always null for a font."},"url":{"type":"string","nullable":true,"readOnly":true,"description":"The public address of the file. A template refers to the file by this address and by no other, and the address always is the same file. Null until the asset is ready."},"rejectionCode":{"type":"string","nullable":true,"readOnly":true,"description":"The code of the error that refused the file, such as template-asset-dimensions. Null unless the asset is rejected."},"expiresAt":{"type":"string","format":"date-time","readOnly":true,"description":"The time the upload has to be completed by, 60 minutes after the asset was created. An asset that has not been completed by then cannot be, and no longer counts towards the 40 a template can have."},"createdAt":{"type":"string","format":"date-time","readOnly":true},"upload":{"type":"object","readOnly":true,"required":["url","method","headers"],"description":"How to send the file, in the answer to creating the asset only. Send the file as the body of a request to the url with this method and exactly these headers, then complete the asset. The url can be used for an hour.","properties":{"url":{"type":"string","description":"The address the file is sent to."},"method":{"type":"string","enum":["PUT"]},"headers":{"type":"object","required":["Content-Type"],"description":"The headers to send with the file. The upload is refused unless the Content-Type is exactly this value and the body is exactly the size that was declared.","properties":{"Content-Type":{"type":"string","enum":["image/png","image/jpeg","image/webp","image/svg+xml","font/woff2","font/woff","font/ttf","font/otf"]}}}}}}},"relationships":{"type":"object","properties":{"template":{"type":"object","description":"The managed template the file belongs to, which has to be in the portal of the requester, not archived. An asset belongs to one template and only that template can use it.","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":{"type":"string","description":"Identifies the Resource.","example":"Template","enum":["Template"]}}}}}}}}},"TemplateCatalogue":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TemplateCatalogue","enum":["TemplateCatalogue"]},"attributes":{"type":"object","additionalProperties":false,"required":["usage","shellVersion","groups","dates","iterables"],"properties":{"usage":{"type":"string","enum":["exam","assignment"],"readOnly":true},"shellVersion":{"type":"integer","readOnly":true},"groups":{"type":"array","readOnly":true,"description":"The values a template can print, in groups. The last group lists the candidate attributes of the portal.","items":{"type":"object","required":["id","label","variables"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"variables":{"type":"array","items":{"type":"object","required":["id","label","kind","path","insert"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"kind":{"type":"string","description":"text, number, boolean (for use with if) or image-url. Dates are listed apart."},"path":{"type":"string","description":"Where the value is in the data."},"insert":{"type":"string","description":"The Go template action to put in the body."}}}}}}},"dates":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","label","path","formats"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"path":{"type":"string"},"formats":{"type":"array","items":{"type":"object","required":["id","label","example","insert"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"example":{"type":"string"},"insert":{"type":"string"}}}}}}},"iterables":{"type":"array","readOnly":true,"items":{"type":"object","required":["id","label","path","insert"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"path":{"type":"string"},"insert":{"type":"string"}}}}}},"relationships":{"type":"object","properties":{}}}},"TemplatePreview":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","example":"TemplatePreview","enum":["TemplatePreview"]},"attributes":{"type":"object","additionalProperties":false,"required":["valid","errors"],"properties":{"valid":{"type":"boolean","description":"false when the parts did not compile. That is not a failure of the request: the errors say what to fix."},"errors":{"type":"array","items":{"type":"object","required":["pane","code","message"],"properties":{"pane":{"type":"string","description":"Where the problem is: html (the body), css, settings, or background (the page background)."},"line":{"type":"integer","description":"Starting at 1, within the source of that pane. 0 for settings. Left out for the background."},"column":{"type":"integer","description":"Starting at 1, within the source of that pane. 0 for settings. Left out for the background."},"code":{"type":"string","description":"A stable, machine readable code such as template.parse_error."},"message":{"type":"string"}}}},"pdf":{"type":"string","description":"The rendered PDF, base64 encoded. Only when valid."},"pageCount":{"type":"integer"},"engine":{"type":"string","description":"The renderer that produced the PDF."},"scenario":{"type":"string","enum":["standard","long-text","no-qr"]},"shellVersion":{"type":"integer","description":"The version of the Synap-owned shell it was compiled with."}}},"relationships":{"type":"object","properties":{}}}},"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},"result":{"type":"object","properties":{"status":{"type":"string"}},"readOnly":true},"examId":{"type":"string","readOnly":true},"attemptId":{"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},"isAllowedNativeReadAloud":{"type":"boolean","readOnly":false}}},"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","zh-TW","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},"targetId":{"type":"string","readOnly":true,"nullable":true},"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":"Automation","description":"Endpoints for building and running automations: the block catalogue the workflow builder and the automations engine work from."},{"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":"Preflight","description":"Endpoints related to the checks a candidate runs before an exam."},{"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."}]}