> For the complete documentation index, see [llms.txt](https://synap.ac/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://synap.ac/docs/api/reference/models.md).

# Models

## The AccessMigration object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AccessMigration":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AccessPolicy object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AccessPolicy":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"inheritedFromUserGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"associations":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}},"deprecated":true},"targetResource":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["TargetResource"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The AccessPolicyReset object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AccessPolicyReset":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The AccountClosure object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AccountClosure":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AccountClosure"]},"attributes":{"type":"object","properties":{"confirmationToken":{"type":"string","readOnly":false}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AccountClosureRequest object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AccountClosureRequest":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AccountClosureRequest"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ActionLog object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ActionLog":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ActionLog"]},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["access","account","attempt","attemptCertificate","attemptOverride","assignment","collection","collectionItem","consent","exam","flag","invite","learningRecord","portal","question","emqGroup","session","store","tag","test","userGroup","subPortal","markingSession","markingState","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","started","marketingEmails","marketingEmailsRemoved","examUserRegistered","examActivated","examCancelled","examCompleted","examScheduled","sent","checked","accepted","cancelled","expired","flagPlanted","passkeyLoggedIn","passkeyRegistered","passkeyRevoked","loggedIn","restored","loggedOut","productUnlocked","viewed","questionAnswered","completed","discarded","testSubmitted","testReleased","userAdded","userRemoved","markingSessionStarted","markingSessionCompleted","markingSessionVoided","markingSessionFinalised","markingSessionSuspended","markingSessionResumed","markingStateUpdated","markingSourceNominated","markingSourceNominationCleared","markingMarksOverridden","markingEntrySuperseded","attemptResponseMaxPointsOverridden"],"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Annotation object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Annotation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ApiError object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ApiError":{"type":"object","description":"This is an error response structure. The id, status, code, title and detail will vary based on the error situation.","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"}}}}}}}}
```

## The Assignment object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Assignment":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"folders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"certificate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Certificate"]}}}}},"certificateFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The AssignmentFolder object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentFolder":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The AssignmentGroup object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentGroup":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentGroup"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false,"minLength":1},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"image":{"type":"object","readOnly":false,"deprecated":true,"description":"This property is deprecated. Use the relation \"coverImage\" instead.","properties":{"url":{"type":"string"}}},"absoluteDeadline":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"relativeDeadline":{"type":"string","readOnly":false,"nullable":true,"deprecated":true,"description":"This property is deprecated. Use the property \"relativeDeadlineMs\" instead."},"relativeDeadlineMs":{"type":"number","minimum":3600000,"maximum":31536000000,"readOnly":false,"nullable":true,"description":"The relative deadline in milliseconds, minimum 1 hour, maximum 1 year"},"deadlineType":{"type":"string","enum":["indefinite","absolute","relative"],"readOnly":false},"progressionType":{"type":"string","enum":["fixed-linear","flexible-linear","flexible-open"],"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false},"isActive":{"deprecated":true,"description":"This property is deprecated. Use the property \"status\" instead.","type":"boolean","readOnly":true},"isPendingActivation":{"deprecated":true,"description":"This property is deprecated. Use the property \"status\" instead.","type":"boolean","readOnly":true},"isCompleted":{"deprecated":true,"description":"This property is deprecated. Use the property \"status\" instead.","type":"boolean","readOnly":true},"isArchived":{"type":"boolean","readOnly":false},"status":{"type":"string","readOnly":false,"enum":["inactive","pendingActivation","active","complete","cancelled","closed"],"nullable":false},"certificateTemplateId":{"type":"string","readOnly":false,"nullable":true},"certificateIgnoreSubPortalBranding":{"type":"boolean","readOnly":false,"nullable":false},"certificateShareList":{"type":"array","readOnly":false,"nullable":true,"maxItems":4,"items":{"type":"object","required":["label","urlPrefix"],"properties":{"label":{"type":"string","minLength":1,"maxLength":100},"urlPrefix":{"type":"string"}}}},"startDate":{"type":"string","nullable":true},"endDate":{"type":"string","nullable":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"sourceCourse":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"reviewers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentGroupCourseVersion object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentGroupCourseVersion":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentGroup"]}}}}},"backgroundJob":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["BackgroundJob"]}}}}},"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentGroupDataExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentGroupDataExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentGroup"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentGroupHeadlineInsight object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentGroupHeadlineInsight":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentHeadlineInsight object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentHeadlineInsight":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentItemAudio object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentItemAudio":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"audio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentItemDocument object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentItemDocument":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentItemEmbed object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentItemEmbed":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"embed":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentItemNote object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentItemNote":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"note":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Note"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentItemPulse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentItemPulse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The AssignmentItemQuiz object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentItemQuiz":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"firstAttempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"latestAttempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentItemReview object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentItemReview":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","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"]}]}}}}},"supportingContent":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The AssignmentItemScorm object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentItemScorm":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"scorm":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ScormCourse"]}}}}},"result":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentScormResult"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentItemSelfAssessmentOutcome object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentItemSelfAssessmentOutcome":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemSurvey"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentItemSurvey object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentItemSurvey":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"survey":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Survey"]}}}}},"response":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SurveyResponse"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentItemTextEntry object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentItemTextEntry":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentItemUpload object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentItemUpload":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"upload":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentItemVideo object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentItemVideo":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"video":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentItemZip object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentItemZip":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"internalReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"sharedReview":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemReview"]}}}}},"bar":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Bar"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentManualReview object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentManualReview":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentReattempt object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentReattempt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}},"newAssignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentReset object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentReset":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentRevocation object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentRevocation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentScormResult object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentScormResult":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemScorm"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AssignmentSelfAssessmentReport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AssignmentSelfAssessmentReport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Attempt object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Attempt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]},"attributes":{"type":"object","properties":{"title":{"type":"string","readOnly":true},"loginCode":{"type":"string","readOnly":true,"nullable":true,"description":"The candidate's code-login credential. Only present for requesters who can edit the exam, and only on attempts of exams with code login enabled."},"createdAt":{"type":"string","readOnly":true},"isCompleted":{"type":"boolean","readOnly":true},"timeStarted":{"type":"string","readOnly":true},"timeCompleted":{"type":"string","readOnly":true},"proctor":{"type":"object","readOnly":true,"additionalProperties":true,"deprecated":true,"description":"Deprecated. Use flattened fields such as `proctorEnabled`, `proctorVendor` etc instead."},"resitCount":{"type":"number","readOnly":true,"description":"Can be used to generate a resit attempt. If not provided, the attempt will be a new attempt. All requests by students are determined as resit requests, even if this is omitted."},"attemptsAllowed":{"type":"number","nullable":true,"readOnly":true},"schedule":{"type":"object","readOnly":true,"properties":{"activateAt":{"type":"string"},"deactivateAt":{"type":"string","nullable":true}}},"candidateOpenDate":{"type":"string","readOnly":true,"description":"Earliest date at which candidate could have started their exam. Useful for displaying a \"user friendly\" open date for indefinite/ongoing exams with rolling registrations"},"status":{"type":"string","readOnly":true,"enum":["draft","scheduled","active","completed","cancelled"]},"submissionType":{"type":"string","readOnly":true,"nullable":true,"enum":["user","system","moderator","userTimedOut","abandoned",null]},"settings":{"type":"object","readOnly":true,"additionalProperties":true},"state":{"type":"object","readOnly":true,"additionalProperties":true},"quizSetup":{"type":"object","readOnly":true,"additionalProperties":true},"grade":{"type":"object","readOnly":true,"nullable":true,"additionalProperties":true},"examStatus":{"type":"string","readOnly":true},"proctorStatus":{"type":"string","readOnly":true},"score":{"type":"number","readOnly":true},"marks":{"type":"object","nullable":true,"properties":{"points":{"type":"number","readOnly":true},"maxPoints":{"type":"number","readOnly":true},"credits":{"type":"number","readOnly":true},"penalties":{"type":"number","readOnly":true}}},"isRevoked":{"type":"boolean","readOnly":false},"isArchived":{"type":"boolean","readOnly":false,"description":"Hides the attempt from the candidate's exam list. The result remains valid, unlike revoking."},"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},"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","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},"proctorRosalynRuleUsePrivateTestArea":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleVisibleFace":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowInteractionWithOthers":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowOtherMaterials":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowNoiseMakingDevices":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowAdditionalDevices":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleAllowMouseKeyboardMonitorOnly":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowAppsOrBroswerTabs":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowExamContentSharing":{"type":"boolean","readOnly":true,"nullable":true},"proctorRosalynRuleDoNotAllowTextPrediction":{"type":"boolean","readOnly":true,"nullable":true},"proctorSynopticLevel":{"type":"string","enum":["web","browser","desktop",null],"readOnly":true,"nullable":true},"proctorScreenMonitoring":{"type":"string","enum":["none","recreation","recreationWithSnapshots","video",null],"readOnly":true,"nullable":true},"proctorWebcamMonitoring":{"type":"string","enum":["none","snapshots","audioVideo",null],"readOnly":true,"nullable":true},"proctorRequireFullscreen":{"type":"boolean","readOnly":true,"nullable":true},"proctorRestrictTabs":{"type":"boolean","readOnly":true,"nullable":true},"proctorRestrictDisplays":{"type":"boolean","readOnly":true,"nullable":true},"proctorKeyboardShortcutsEnabled":{"type":"boolean","readOnly":true,"nullable":true},"proctorScreenshotPrevention":{"type":"boolean","readOnly":true,"nullable":true},"proctorAiReview":{"type":"boolean","readOnly":true,"nullable":true},"proctorAiFlagCandidateLeftFrame":{"type":"boolean","readOnly":true,"nullable":true},"proctorAiFlagMultiplePeopleInFrame":{"type":"boolean","readOnly":true,"nullable":true},"proctorAiPrompts":{"type":"array","readOnly":true,"nullable":true,"items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}},"examVoucher":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ExamVoucher"]}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Test"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}},"assignmentItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItem"]}}}}},"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"collectionItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionItem"]}}}}},"collectionMock":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionMock"]}}}}},"study":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Study"]}}}}},"studyItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["StudyItem"]}}}}},"responses":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"responsesV2":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"marker":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"markingState":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MarkingState"]}}}}},"assignedMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"assignedProvisionalMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"assignedModeratingMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"assignedEscalatingMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"assignedAuditingMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"assignedBackReadingMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"certificate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Certificate"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The AttemptActiveDuration object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptActiveDuration":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptChart object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptChart":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptCodeLogin object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptCodeLogin":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptInsight object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptInsight":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptLock object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptLock":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptMarking object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptMarking":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptMarksSubmission object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptMarksSubmission":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptOverride object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptOverride":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AttemptOverride"]},"attributes":{"type":"object","properties":{"overrides":{"type":"array","items":{"type":"string","enum":["score","points","credits","penalties","grade"]},"nullable":true},"comment":{"type":"string","readOnly":true},"grade":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"score":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"points":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"credits":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"penalties":{"type":"object","properties":{"oldValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"newValue":{"anyOf":[{"type":"string"},{"type":"number"}]},"isOriginal":{"type":"boolean"}},"nullable":true},"reverted":{"type":"boolean"}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptPlayerState object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptPlayerState":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptResultConfig object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptResultConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptRevokeReversal object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptRevokeReversal":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptSchedule object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptSchedule":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptSitting object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptSitting":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptSubmission object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptSubmission":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptTagLabel object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptTagLabel":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"parent":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AttemptTagLabel"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptTimer object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptTimer":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttemptTimerReset object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttemptTimerReset":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AttributeConfig object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AttributeConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AuthenticationOption object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"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"}]},"AuthenticationOptionLocal":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"AuthenticationOptionAuth0":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"AuthenticationOptionAdfs":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"AuthenticationOptionJwt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"AuthenticationOptionLti1p1":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","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.","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":{}}}}}}}
```

## The AuthenticationOptionAdfs object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AuthenticationOptionAdfs":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AuthenticationOptionAuth0 object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AuthenticationOptionAuth0":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AuthenticationOptionJwt object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AuthenticationOptionJwt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AuthenticationOptionLocal object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AuthenticationOptionLocal":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AuthenticationOptionLti1p1 object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AuthenticationOptionLti1p1":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AuthenticationOptionLti1p3 object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AuthenticationOptionLti1p3":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AuthenticationOptionSaml object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AuthenticationOptionSaml":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The AvailableAccessPolicy object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"AvailableAccessPolicy":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The BackgroundJob object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"BackgroundJob":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The BadRequestApiError object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"BadRequestApiError":{"type":"object","description":"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"}}}}}}}}
```

## The BillingInfo object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"BillingInfo":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The BillingUsageReport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"BillingUsageReport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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","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"},"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"}},"required":["kind","portalName","generatedAt","range","currency","subscription","planOptions","plan","creditRates","batches","usageByMonth","contractYears"]},{"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","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"},"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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The BotSession object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"BotSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["BotUser"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The BotUser object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"BotUser":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Certificate object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Certificate":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Certificate"]},"attributes":{"type":"object","properties":{"html":{"type":"string","readOnly":true},"documentKey":{"type":"string","readOnly":true},"expiryDate":{"type":"string","readOnly":true},"validationUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Document"]}}}}},"template":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Template"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"assignment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Assignment"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ChartJs object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ChartJs":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CheckoutSession object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CheckoutSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CheckoutSession"]},"attributes":{"type":"object","required":["isCheckoutCompleted"],"properties":{"productIdentifier":{"type":"string","readOnly":true,"description":"Deprecated on create — send the `product` relationship instead, as an identifier is not unique across portals. One of the two is required."},"currency":{"type":"string","enum":["gbp","eur","usd"],"readOnly":true,"description":"The currency to charge in. Defaults to the product's default currency. Must be one of the currencies the product is priced in, otherwise the request is rejected."},"customerData":{"type":"object","nullable":true,"properties":{"id":{"type":"string","nullable":true,"description":"The external payment gateway customer ID"},"email":{"type":"string","nullable":true,"description":"Can be used to link the payment gateway Customer."}}},"paymentGatewayToken":{"type":"string","readOnly":true,"nullable":true,"description":"The payment gateway token, only for paid products."},"paymentGatewayUrl":{"type":"string","readOnly":true,"nullable":true,"description":"The hosted payment gateway Checkout URL, only returned when creating a paid Checkout Session."},"isCheckoutCompleted":{"type":"boolean","readOnly":false,"nullable":false,"description":"Indicates if the user has completed the checkout form and is ready for processing."},"isPaymentSuccessful":{"type":"boolean","readOnly":true,"nullable":true,"description":"Indicates if the payment gateway checkout was successful."},"processedAt":{"type":"string","readOnly":true,"nullable":true,"description":"The date and time the subscription was processed."},"processingError":{"type":"string","nullable":true,"readOnly":true,"description":"If the payment was successful but the subscription was not created, this will contain the error message."}}},"relationships":{"type":"object","properties":{"storeOffer":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["StoreOffer"]}}}}},"product":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Product"]}}}}},"subscription":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Subscription"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CloneJob object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CloneJob":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Collection object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Collection":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false,"nullable":false,"minLength":1},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"settings":{"type":"object","deprecated":true,"properties":{"takeTest":{"type":"object","additionalProperties":true},"playerView":{"type":"object","properties":{"enabled":{"type":"boolean"},"hideOverviewPage":{"type":"boolean"}}},"trackedProgress":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"annotations":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"export":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"generatedAttempts":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"mocks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string","nullable":true},"filters":{"type":"object","additionalProperties":true},"quizLength":{"type":"number","minimum":1},"passScore":{"type":"number","minimum":0,"maximum":100,"nullable":true},"examSittingAttrs":{"type":"object","additionalProperties":true}}}},"restrictedAccess":{"type":"object","properties":{"label":{"type":"string"}}},"sorting":{"type":"object","properties":{"prioritise":{"type":"boolean"}}}}},"attr":{"type":"object","readOnly":false,"nullable":true},"extraInformation":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"isArchived":{"type":"boolean","readOnly":false,"nullable":true},"generatedAttemptsEnabled":{"type":"boolean","readOnly":false},"mocks":{"type":"array","nullable":true,"items":{"type":"object","required":["id","filters","quizLength"],"properties":{"id":{"type":"string"},"title":{"type":"string","nullable":true,"minLength":1,"maxLength":120},"filters":{"type":"object","additionalProperties":true,"properties":{"weightingType":{"type":"string","enum":["absolute","percentage"]},"filterRules":{"type":"array","minItems":0,"maxItems":125,"description":"Array of filter rules to apply to the dynamic quiz content.","items":{"type":"object","properties":{"weighting":{"type":"number"},"matchingRules":{"type":"array","minItems":0,"maxItems":20,"description":"Array of matching rules to apply to the filter rule. Each rule will be treated as an AND operation. Matching rules can not be a mix of tag and EMQ rules.","items":{"anyOf":[{"type":"object","required":["tagId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["tagId"],"properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}}}]}}}}}}},"quizLength":{"type":"number","minimum":1},"passScore":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"examSittingAttrs":{"type":"object","nullable":true,"additionalProperties":true},"timeInMs":{"type":"number","nullable":true,"minimum":1}}}},"annotationsEnabled":{"type":"boolean","readOnly":false},"exportEnabled":{"type":"boolean","readOnly":false},"playerViewEnabled":{"type":"boolean","readOnly":false},"playerViewHideOverviewPage":{"type":"boolean","readOnly":false},"restrictedAccessLabel":{"type":"string","readOnly":false,"nullable":true},"sortingPrioritise":{"type":"boolean","readOnly":false},"takeTestSettings":{"type":"object","nullable":true,"additionalProperties":true,"deprecated":true,"description":"deprecated, use top level setting fields instead"},"allowedModes":{"type":"array","nullable":true,"items":{"type":"string","enum":["practice","exam","timedExam"]},"minItems":1,"maxItems":3},"allowedLengths":{"type":"array","items":{"type":"string","enum":["default","quick","medium","long","extraLong"]}},"allowedPlayers":{"type":"array","items":{"type":"string","enum":["default","ucat","usmle"]}},"allowedTagSets":{"type":"array","nullable":true,"items":{"type":"string"}},"allowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","skill","difficulty","context"]}},"calculatorEnabled":{"type":"boolean","readOnly":false},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"],"readOnly":false},"allowMultipleTagSelection":{"type":"boolean","readOnly":false},"excludeUntaggedQuestions":{"type":"boolean","readOnly":false},"showMasteryFilters":{"type":"boolean","readOnly":false},"calculatorType":{"type":"string","enum":["basic","scientific"]},"notepadEnabled":{"type":"boolean","readOnly":false},"strikethroughEnabled":{"type":"boolean","readOnly":false},"highlightingEnabled":{"type":"boolean","readOnly":false},"bookmarkingEnabled":{"type":"boolean","readOnly":false},"labValuesEnabled":{"type":"boolean","readOnly":false},"labValuesHtml":{"type":"string","readOnly":false},"flaggingEnabled":{"type":"boolean","readOnly":false},"resultsMessageCompleted":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageSettingHideTitle":{"type":"boolean","readOnly":false},"resultsMetricScoreEnabled":{"type":"boolean","readOnly":false},"resultsMetricTimeSpentEnabled":{"type":"boolean","readOnly":false},"resultsMetricGradeEnabled":{"type":"boolean","readOnly":false},"resultsMetricQuestionBreakdownDisplayLevel":{"type":"string","enum":["full","hideStemAndOptions","hideCorrectOptions","incorrectOnlyHideCorrectOptions","none"],"readOnly":false},"resultsMetricAnalyticsCohort":{"type":"string","enum":["exam","test","sourceTest"]},"resultsMetricCohortAverageEnabled":{"type":"boolean","readOnly":false},"resultsMetricCohortPercentileEnabled":{"type":"boolean","readOnly":false},"resultsMetricCohortScoreDistributionEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagBreakdownEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagProgressEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagProgressFacetsEnabled":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"subject":{"type":"boolean","readOnly":false},"topic":{"type":"boolean","readOnly":false},"subtopic":{"type":"boolean","readOnly":false},"skill":{"type":"boolean","readOnly":false},"difficulty":{"type":"boolean","readOnly":false}}},"resultsEducatorViewAsAdminEnabled":{"type":"boolean","readOnly":false},"trackedProgressEnabled":{"type":"boolean","readOnly":false},"accessLevel":{"type":"string","enum":["editor","none","full","restricted"],"readOnly":true},"totalItems":{"type":"number","readOnly":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"lockedItems":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"folders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"icon":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"collectionAccess":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The CollectionAccess object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionAccess":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CollectionFolder object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionFolder":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The CollectionItem object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"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.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"audio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"CollectionItemDocument":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"CollectionItemEmbed":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"embed":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"CollectionItemNote":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"note":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Note"]}}}}}}}}},"CollectionItemQuiz":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"quizAttemptSetupConfig":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizAttemptSetupConfig"]}}}}}}}}},"CollectionItemVideo":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"video":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"CollectionItemZip":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"zip":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}}}}}
```

## The CollectionItemAudio object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionItemAudio":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"audio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CollectionItemDocument object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionItemDocument":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CollectionItemEmbed object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionItemEmbed":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"embed":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CollectionItemNote object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionItemNote":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"note":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Note"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CollectionItemPdfExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionItemPdfExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The CollectionItemQuiz object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionItemQuiz":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"quizAttemptSetupConfig":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizAttemptSetupConfig"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CollectionItemVideo object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionItemVideo":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"video":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CollectionItemZip object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionItemZip":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"zip":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CollectionMock object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionMock":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CollectionPdfExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionPdfExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CollectionProgress object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionProgress":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CollectionSubFolder object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionSubFolder":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The CollectionTagBreakdown object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CollectionTagBreakdown":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Content object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Content":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"attachment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"embedData":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ContentEmbedDatum"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The ContentEmbedDatum object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ContentEmbedDatum":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Course object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Course":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"folders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The CourseFolder object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CourseFolder":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The CourseItem object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"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.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"audio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"CourseItemDocument":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"CourseItemEmbed":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"embed":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"CourseItemNote":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"note":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Note"]}}}}}}}}},"CourseItemQuiz":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}}}}}},"CourseItemScorm":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"scorm":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ScormCourse"]}}}}}}}}},"CourseItemSurvey":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"survey":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Survey"]}}}}}}}}},"CourseItemTextEntry":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}}}}}},"CourseItemUpload":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}}}}}},"CourseItemVideo":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"video":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"CourseItemZip":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"zip":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}}}}}
```

## The CourseItemAudio object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CourseItemAudio":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"audio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CourseItemDocument object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CourseItemDocument":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CourseItemEmbed object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CourseItemEmbed":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"embed":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CourseItemNote object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CourseItemNote":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"note":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Note"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CourseItemQuiz object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CourseItemQuiz":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CourseItemScorm object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CourseItemScorm":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"scorm":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ScormCourse"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CourseItemSurvey object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CourseItemSurvey":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"survey":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Survey"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CourseItemTextEntry object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CourseItemTextEntry":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CourseItemUpload object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CourseItemUpload":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CourseItemVideo object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CourseItemVideo":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"video":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CourseItemZip object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CourseItemZip":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CourseFolder"]}}}}},"zip":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Content"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The CustomInsight object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"CustomInsight":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CustomInsight"]},"attributes":{"type":"object","properties":{"insightType":{"type":"string","readOnly":true,"enum":["studentProgress"]},"insightData":{"type":"array","items":{}}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Document object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Document":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The EmailVerification object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"EmailVerification":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["EmailVerification"]},"attributes":{"type":"object","properties":{"verified":{"type":"boolean","enum":[true],"readOnly":false}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The EmqGroupExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"EmqGroupExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The EmqGroupImport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"EmqGroupImport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["BackgroundJob"]}}}}},"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Test"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The EmqGroupImportValidation object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"EmqGroupImportValidation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Test"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The EnrichedAttempt object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"EnrichedAttempt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["EnrichedAttempt"]},"attributes":{"type":"object","properties":{"testId":{"type":"string"},"testName":{"type":"string"},"examId":{"type":"string","nullable":true},"examName":{"type":"string","nullable":true},"examStatus":{"type":"string","nullable":true,"enum":["enrolled","expired","notified","preflight","revoked","started","submitted","cancelled"]},"submissionType":{"type":"string","nullable":true,"enum":["user","system","moderator","userTimedOut","abandoned",null]},"schedule":{"type":"object","properties":{"activateAt":{"type":"string"},"deactivateAt":{"type":"string","nullable":true}}},"certificateLink":{"type":"string"},"grade":{"nullable":true,"type":"object","properties":{"label":{"type":"string"},"isPass":{"type":"boolean"}}},"marks":{"nullable":true,"readOnly":true,"type":"object","properties":{"points":{"type":"number"},"maxPoints":{"type":"number"},"credits":{"type":"number"},"penalties":{"type":"number"}}},"createdAt":{"type":"string","nullable":true,"readOnly":true},"timeStarted":{"type":"string","nullable":true},"timeCompleted":{"type":"string","nullable":true},"timeTaken":{"type":"number","nullable":true},"proctorStatus":{"type":"string","nullable":true,"enum":["disabled","enabled","failed","inReview","passed","readyForReview","reviewNotRequired","error"]},"proctorVendor":{"type":"string","nullable":true,"enum":["internal","rosalyn","synopticV2"]},"proctorSessionId":{"type":"string","nullable":true},"proctorBreaches":{"type":"number","nullable":true},"markingStatus":{"type":"string","nullable":true,"enum":["completed","inProgress","notStarted","readyToFinalise","finalised"]},"resultsStatus":{"type":"string","nullable":true,"enum":["finalised","pending","released"]},"resultsPageHidden":{"type":"boolean","nullable":true},"resultsScoreHidden":{"type":"boolean","nullable":true},"score":{"type":"number","nullable":true},"passFailEnabled":{"type":"boolean","nullable":true},"releasedBy":{"type":"string","nullable":true},"finalisedBy":{"type":"string","nullable":true},"finalisedAt":{"type":"string","nullable":true},"releasedAt":{"type":"string","nullable":true},"version":{"type":"string","readOnly":true},"loginCode":{"type":"string","readOnly":true,"nullable":true,"description":"The candidate's code-login credential. Only present for requesters who can edit the exam, and only on attempts of exams with code login enabled."}}},"relationships":{"type":"object","properties":{"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"finalisedBy":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"releasedBy":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"assignedMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"assignedModeratingMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"assignedProvisionalMarkers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The EnrichedAttemptOption object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"EnrichedAttemptOption":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Exam-V-2 object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Exam-V-2":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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},"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."},"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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"markers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"moderatingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"escalatingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"auditingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"backReadingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"setupJob":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["BackgroundJob"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"publishedVersion":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"currentVersion":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The ExamAttemptHeadlineInsight object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamAttemptHeadlineInsight":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExamCandidateExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamCandidateExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ExamCandidateExport"]},"attributes":{"type":"object","properties":{"attemptIds":{"type":"array","items":{"type":"string"}},"filter":{"type":"object","properties":{"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","inReview","passed","failed","error"]}},"resultStatus":{"type":"array","items":{"type":"string","enum":["pending","finalised","released"]}},"lockStatus":{"type":"array","items":{"type":"string","enum":["locked","unlocked","none"]}},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExamHall object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamHall":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ExamHall"]},"attributes":{"type":"object","properties":{"ip":{"type":"object","properties":{"address":{"type":"string"},"allowed":{"type":"boolean"}}},"resume":{"type":"object","properties":{"allowed":{"type":"boolean"},"sessionMismatch":{"type":"boolean"}}},"includesAudioQuestions":{"type":"boolean","readOnly":true,"nullable":false},"includesVideoQuestions":{"type":"boolean","readOnly":true,"nullable":false},"includesWebcamCaptureQuestions":{"type":"boolean","readOnly":true,"nullable":false},"includesAudioStems":{"type":"boolean","readOnly":true,"nullable":false},"questionsSettings":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"questionId":{"type":"string","readOnly":true},"questionSettings":{"type":"object","properties":{"timerTimeInMs":{"type":"number","readOnly":true,"nullable":true}}}}}},"extraTimeMultiplier":{"type":"number","readOnly":true,"nullable":true},"title":{"type":"string","readOnly":true},"status":{"type":"string","enum":["draft","published","cancelled","closed"],"readOnly":true},"scheduleOpenDate":{"type":"string","readOnly":true,"nullable":true},"scheduleCloseDate":{"type":"string","readOnly":true,"nullable":true},"scheduleSubmissionDueDate":{"type":"string","readOnly":true,"nullable":true},"resitType":{"type":"string","enum":["continuous","fixedDate","onDemand","rolling",null],"readOnly":true,"nullable":true},"resitMode":{"type":"string","enum":["standard","fixed","progressive","preferUnseen",null],"readOnly":true,"nullable":true},"resitGradeIndependent":{"type":"boolean","readOnly":true,"nullable":true},"resitAllowedAttempts":{"type":"number","readOnly":true,"nullable":true},"legalEnabled":{"type":"boolean","readOnly":true},"legalTitle":{"type":"string","readOnly":true,"nullable":true},"legalBody":{"type":"string","readOnly":true,"nullable":true},"legalCheckboxLabel":{"type":"string","readOnly":true,"nullable":true},"legalConfirmationType":{"type":"string","enum":["checkbox","staticText","candidateName"],"readOnly":true,"nullable":true},"legalConfirmationStaticText":{"type":"string","readOnly":true,"nullable":true},"proctorEnabled":{"type":"boolean","readOnly":true},"proctorVendor":{"type":"string","enum":["internal","rosalyn","synopticV2",null],"readOnly":true,"nullable":true},"proctorRequireFullscreen":{"type":"boolean","readOnly":true},"proctorRestrictTabs":{"type":"boolean","readOnly":true},"proctorRestrictDisplays":{"type":"boolean","readOnly":true},"proctorRecordSession":{"type":"boolean","readOnly":true},"proctorRecordSnapshots":{"type":"boolean","readOnly":true},"proctorRecordDesktop":{"type":"boolean","readOnly":true},"proctorSynopticLevel":{"type":"string","enum":["web","browser","desktop"],"readOnly":true},"proctorScreenMonitoring":{"type":"string","enum":["none","recreation","recreationWithSnapshots","video"],"readOnly":true},"proctorWebcamMonitoring":{"type":"string","enum":["none","snapshots","audioVideo"],"readOnly":true},"proctorRestrictKeyboardShortcuts":{"type":"boolean","readOnly":true},"proctorScreenshotPrevention":{"type":"boolean","readOnly":true,"nullable":true},"proctorAiReview":{"type":"boolean","readOnly":true},"proctorAiFlagCandidateLeftFrame":{"type":"boolean","readOnly":true},"proctorAiFlagMultiplePeopleInFrame":{"type":"boolean","readOnly":true},"proctorAiPrompts":{"type":"array","readOnly":true,"nullable":true,"items":{"type":"object","properties":{"prompt":{"type":"string"},"level":{"type":"string","enum":["info","warning","breach"]},"colour":{"type":"string","nullable":true},"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}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}},"attemptLock":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AttemptLock"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExamineeNotification object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamineeNotification":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam"]}}}}},"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExamModerationReadinessReport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamModerationReadinessReport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExamPreview object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamPreview":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExamQuestionStats object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamQuestionStats":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","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"]}]}}}}},"sourceQuestion":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["EmqGroup"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Section"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The ExamQuestionStatsExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamQuestionStatsExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExamSchedule object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamSchedule":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExamStats object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamStats":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExamTemplate object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamTemplate":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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},"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},"legalEnabled":{"type":"boolean","nullable":true},"legalConfirmationType":{"type":"string","nullable":true},"legalTitle":{"type":"string","nullable":true},"legalBody":{"type":"string","nullable":true},"legalCheckboxLabel":{"type":"string","nullable":true},"legalConfirmationStaticText":{"type":"string","nullable":true},"proctorEnabled":{"type":"boolean","nullable":true},"proctorVendor":{"type":"string","nullable":true},"proctorRequireFullscreen":{"type":"boolean","nullable":true},"proctorRestrictTabs":{"type":"boolean","nullable":true},"proctorRestrictDisplays":{"type":"boolean","nullable":true},"proctorWebcamMonitoring":{"type":"string","nullable":true},"proctorScreenMonitoring":{"type":"string","nullable":true},"proctorSynopticLevel":{"type":"string","nullable":true},"proctorScreenshotPrevention":{"type":"boolean","nullable":true},"proctorRecordSession":{"type":"boolean","nullable":true},"proctorRecordSnapshots":{"type":"boolean","nullable":true},"proctorRecordDesktop":{"type":"boolean","nullable":true},"proctorAiReview":{"type":"boolean","nullable":true},"proctorAiPrompts":{"type":"array","nullable":true,"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},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"globalDefaultSettings":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["GlobalExamTemplate"]}}}}},"sections":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"markers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"moderatingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"escalatingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"backReadingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"auditingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The ExamTemplateSection object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamTemplateSection":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ExamTemplate"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"outroAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExamVoucher object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamVoucher":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"redeemedBy":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExamVoucherBatchJob object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamVoucherBatchJob":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExamVoucherExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExamVoucherExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExportEnrichedAttempt object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExportEnrichedAttempt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ExportEnrichedAttempt"]},"attributes":{"type":"object","properties":{"backgroundJobId":{"type":"string"},"filter":{"type":"object","properties":{"portalId":{"type":"string"},"attemptIds":{"type":"array","items":{"type":"string"}},"origin":{"type":"object","properties":{"type":{"type":"string","enum":["assignmentGroup","assignment","collection","collectionItem","exam","test"]},"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"propertyFilters":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["assignedMarker","assignedModeratingMarker","assignedProvisionalMarker","attemptStatus","examStatus","grade","markingStatus","proctorStatus","quiz","quizVersion","resultsStatus","user","userGroup"]},"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}},"dateFilter":{"type":"object","properties":{"type":{"type":"string","enum":["completedAt","createdAt","finalisedAt","releasedAt","startedAt"]},"start":{"type":"string"},"end":{"type":"string"}}},"sort":{"type":"object","properties":{"type":{"type":"string","enum":["createdAt","finalisedAt","releasedAt","timeCompleted","timeStarted","score"]},"order":{"type":"string","enum":["ascending","descending"]}}}}},"breakdown":{"type":"string","enum":["question","score","none"]},"includes":{"type":"array","items":{"type":"string","enum":["sections","userAttributes","examAttributes","attemptAttributes"]}},"useSource":{"type":"boolean"}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExternalExamSitting object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExternalExamSitting":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionMock"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExternalProctorSession object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExternalProctorSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ExternalProctorSessionResults object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ExternalProctorSessionResults":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ExternalProctorSessionResults"]},"attributes":{"type":"object","properties":{"resultsUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The FacetConfig object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"FacetConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["FacetConfig"]},"attributes":{"type":"object","properties":{"label":{"type":"string","readOnly":true},"facet":{"type":"string","enum":["exam","module","subject","topic","subtopic","difficulty","skill","context"],"readOnly":true},"description":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["TagSet"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The File object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"File":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Flag object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Flag":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"question":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}},"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The FlagExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"FlagExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]}}}}},"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Test"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ForbiddenApiError object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ForbiddenApiError":{"type":"object","description":"Forbidden 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"}}}}}}}}
```

## The GeneratedAccount object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"GeneratedAccount":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The GeneratedTest object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"GeneratedTest":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Test"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["TagSet"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The GenerateTestJob object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"GenerateTestJob":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Test"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["TagSet"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The GenericNotification object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"GenericNotification":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"attempts":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"users":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The GenericResource object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"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"}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."},"Relationship":{"type":"object","description":"Describes a relationship object that references the related resource.","properties":{"data":{"anyOf":[{"$ref":"#/components/schemas/ResourceIdentifierObject"},{"$ref":"#/components/schemas/ResourceIdentifierArray"}]},"links":{"$ref":"#/components/schemas/RelationLink"},"meta":{"type":"object","additionalProperties":true}}},"ResourceIdentifierObject":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"$ref":"#/components/schemas/ResourceType"}}},"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"}},"RelationLink":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}}}}}
```

## The GlobalExamTemplate object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"GlobalExamTemplate":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["GlobalExamTemplate"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"lockedByDefault":{"type":"boolean","nullable":true},"ipAllowList":{"type":"array","items":{"type":"string"},"nullable":true},"resumeAllowed":{"type":"boolean","nullable":true},"resumeSameSession":{"type":"boolean","nullable":true},"passcodeEnabled":{"type":"boolean","nullable":true},"passcodeValue":{"type":"string","nullable":true},"hideFromCandidateList":{"type":"boolean","nullable":true},"allowedMode":{"type":"string","nullable":true},"allowedPlayers":{"type":"array","items":{"type":"string"},"nullable":true},"passFailEnabled":{"type":"boolean","nullable":true},"calculatorEnabled":{"type":"boolean","nullable":true},"calculatorType":{"type":"string","nullable":true},"notepadEnabled":{"type":"boolean","nullable":true},"resizableQuestionPanelsEnabled":{"type":"boolean","nullable":true},"strikethroughEnabled":{"type":"boolean","nullable":true},"highlightingEnabled":{"type":"boolean","nullable":true},"bookmarkingEnabled":{"type":"boolean","nullable":true},"flaggingEnabled":{"type":"boolean","nullable":true},"micEnabled":{"type":"boolean","nullable":true},"resumeLaterButtonEnabled":{"type":"boolean","nullable":true},"labValuesEnabled":{"type":"boolean","nullable":true},"labValuesHtml":{"type":"string","nullable":true},"additionalInformationEnabled":{"type":"boolean","nullable":true},"additionalInformationHtml":{"type":"string","nullable":true},"additionalInformationTitle":{"type":"string","nullable":true},"additionalInformationIcon":{"type":"string","nullable":true},"externalPlayerType":{"type":"string","nullable":true},"deferResultEnabled":{"type":"boolean","nullable":true},"deferResultAlwaysRelease":{"type":"boolean","nullable":true},"deferResultMessage":{"type":"string","nullable":true},"optionShuffling":{"type":"string","nullable":true},"questionShuffling":{"type":"string","nullable":true},"sectionShufflingEnabled":{"type":"boolean","nullable":true},"softSectionsEnabled":{"type":"boolean","nullable":true},"sectionGradesEnabled":{"type":"boolean","nullable":true},"advancedGradingEnabled":{"type":"boolean","nullable":true},"availableMarksEnabled":{"type":"boolean","nullable":true},"pinnedMessageDuringTest":{"type":"string","nullable":true},"excludeInformationalQuestionsFromCounts":{"type":"boolean","nullable":true},"timerEnabled":{"type":"boolean","nullable":true},"timerTimeInMs":{"type":"number","nullable":true},"timerUseSections":{"type":"boolean","nullable":true},"timerUseQuestions":{"type":"boolean","nullable":true},"timerEnforceFullTime":{"type":"boolean","nullable":true},"timerExtraTimeMultiplier":{"type":"number","nullable":true},"timerSoftTimer":{"type":"boolean","nullable":true},"disableCopying":{"type":"boolean","nullable":true},"disablePasting":{"type":"boolean","nullable":true},"disableRightClick":{"type":"boolean","nullable":true},"disableNavigation":{"type":"boolean","nullable":true},"disableControlPanel":{"type":"boolean","nullable":true},"disableNotifications":{"type":"boolean","nullable":true},"styleTheme":{"type":"string","nullable":true},"styleFontSize":{"type":"string","nullable":true},"creditsPerQuestion":{"type":"number","nullable":true},"enablePenalties":{"type":"boolean","nullable":true},"penaltiesPerQuestion":{"type":"number","nullable":true},"partialCreditsPerQuestion":{"type":"number","nullable":true},"grades":{"type":"array","nullable":true,"items":{"type":"object","required":["label","minScore"],"properties":{"label":{"type":"string"},"description":{"type":"string","nullable":true},"minScore":{"type":"number","nullable":true},"isPass":{"type":"boolean","nullable":true},"advancedCriteria":{"type":"object","nullable":true,"properties":{"sectionRequirements":{"type":"object","nullable":true,"properties":{"type":{"type":"string"},"count":{"type":"number","nullable":true},"sectionIds":{"type":"array","items":{"type":"string"},"nullable":true}}},"excludeFromResitAttempts":{"type":"boolean","nullable":true}}}}}},"instructionsEnabled":{"type":"boolean","nullable":true},"instructionsTitle":{"type":"string","nullable":true},"instructionsBody":{"type":"string","nullable":true},"instructionsTimerDurationMs":{"type":"number","nullable":true},"instructionsEnforcedTimer":{"type":"string","nullable":true},"instructionsAudioAutoAdvance":{"type":"string","nullable":true},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","minimum":0,"maximum":3600000,"nullable":true},"instructionsAudioAutoPlay":{"type":"boolean","nullable":true},"instructionsDisableAudioControls":{"type":"boolean","nullable":true},"resultDetailedViewEnabled":{"type":"boolean","nullable":true},"resultEducatorsViewAsAdminEnabled":{"type":"boolean","nullable":true},"resultHideResultsPage":{"type":"boolean","nullable":true},"resultGlobalHideScore":{"type":"boolean","nullable":true},"resultScoreEnabled":{"type":"boolean","nullable":true},"resultTimeSpentEnabled":{"type":"boolean","nullable":true},"resultGradeEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownGradeEnabled":{"type":"boolean","nullable":true},"resultSectionBreakdownScoreEnabled":{"type":"boolean","nullable":true},"resultQuestionBreakdownDisplay":{"type":"string","nullable":true},"resultAnalyticsCohort":{"type":"string","nullable":true},"resultCohortAverageEnabled":{"type":"boolean","nullable":true},"resultPercentileEnabled":{"type":"boolean","nullable":true},"resultScoreDistributionEnabled":{"type":"boolean","nullable":true},"resultTagBreakdownEnabled":{"type":"boolean","nullable":true},"resultProgressEnabled":{"type":"boolean","nullable":true},"resultFacetSubjectEnabled":{"type":"boolean","nullable":true},"resultFacetTopicEnabled":{"type":"boolean","nullable":true},"resultFacetSubtopicEnabled":{"type":"boolean","nullable":true},"resultFacetSkillEnabled":{"type":"boolean","nullable":true},"resultFacetDifficultyEnabled":{"type":"boolean","nullable":true},"resultMessagePassed":{"type":"string","nullable":true},"resultMessageFailed":{"type":"string","nullable":true},"resultMessageResitsRemaining":{"type":"string","nullable":true},"resultMessageNoResitsRemaining":{"type":"string","nullable":true},"resultMessageCompleted":{"type":"string","nullable":true},"resultMessageSettingHideTitle":{"type":"boolean","nullable":true},"resultHiddenMessage":{"type":"string","nullable":true},"resultHiddenSettingHideTitle":{"type":"boolean","nullable":true},"resultOverviewWhenPassedMessage":{"type":"string","nullable":true},"resultOverviewWhenFailedHasResitsMessage":{"type":"string","nullable":true},"resultOverviewWhenFailedNoResitsMessage":{"type":"string","nullable":true},"resultOverviewWhenCompleteNoGradesMessage":{"type":"string","nullable":true},"resultOverviewWhenCompletedNeutralGradesMessage":{"type":"string","nullable":true},"markingDoubleEnabled":{"type":"boolean","nullable":true},"markingDoubleAllocation":{"type":"string","nullable":true},"markingDoubleMinMarkers":{"type":"number","nullable":true},"markingDoubleSequence":{"type":"string","nullable":true},"markingBlindProvisionalMarker":{"type":"boolean","nullable":true},"markingBlindModeratingMarker":{"type":"boolean","nullable":true},"markingBlindEscalationMarker":{"type":"boolean","nullable":true},"markingBlindBackReadingMarker":{"type":"boolean","nullable":true},"markingBlindAuditingMarker":{"type":"boolean","nullable":true},"markingBlindIsolate":{"type":"boolean","nullable":true},"markerConcealmentProvisional":{"type":"boolean","nullable":true},"markerConcealmentModerating":{"type":"boolean","nullable":true},"markerConcealmentEscalation":{"type":"boolean","nullable":true},"markerConcealmentAuditing":{"type":"boolean","nullable":true},"markingEscalationEnabled":{"type":"boolean","nullable":true},"markingEscalationModeratorsCanEscalate":{"type":"boolean","nullable":true},"markingEscalationReasons":{"type":"array","nullable":true,"items":{"type":"object","required":["label","description"],"properties":{"slug":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}},"markingBackReadingEnabled":{"type":"boolean","nullable":true},"markingAuditingEnabled":{"type":"boolean","nullable":true},"markingResolutionEnabled":{"type":"boolean","nullable":true},"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},"legalEnabled":{"type":"boolean","nullable":true},"legalConfirmationType":{"type":"string","nullable":true},"legalTitle":{"type":"string","nullable":true},"legalBody":{"type":"string","nullable":true},"legalCheckboxLabel":{"type":"string","nullable":true},"legalConfirmationStaticText":{"type":"string","nullable":true},"proctorEnabled":{"type":"boolean","nullable":true},"proctorVendor":{"type":"string","nullable":true},"proctorRequireFullscreen":{"type":"boolean","nullable":true},"proctorRestrictTabs":{"type":"boolean","nullable":true},"proctorRestrictDisplays":{"type":"boolean","nullable":true},"proctorWebcamMonitoring":{"type":"string","nullable":true},"proctorScreenMonitoring":{"type":"string","nullable":true},"proctorSynopticLevel":{"type":"string","nullable":true},"proctorScreenshotPrevention":{"type":"boolean","nullable":true},"proctorRecordSession":{"type":"boolean","nullable":true},"proctorRecordSnapshots":{"type":"boolean","nullable":true},"proctorRecordDesktop":{"type":"boolean","nullable":true},"proctorAiReview":{"type":"boolean","nullable":true},"proctorAiPrompts":{"type":"array","nullable":true,"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},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Highlight object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Highlight":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The IceCandidate object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"IceCandidate":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The InsightsTagBreakdown object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"InsightsTagBreakdown":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["TagSet"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Integration object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Integration":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Invite object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Invite":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"invitee":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The InviteExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"InviteExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Invoice object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Invoice":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The LearningRecord object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"LearningRecord":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The LearningRecordExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"LearningRecordExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The LegacyAccessUpgradeOption object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"LegacyAccessUpgradeOption":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The LoginQrCode object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"LoginQrCode":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["LoginQrCode"]},"attributes":{"type":"object","properties":{"qrCode":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ManageBillingSession object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ManageBillingSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MarketingConsent object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MarketingConsent":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MarketingConsent"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MarkingEntry object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MarkingEntry":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MarkingEntry"]},"attributes":{"type":"object","properties":{"rubricAreas":{"type":"array","items":{"type":"object"},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"candidate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"selectedBy":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"response":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Response"]}}}}},"question":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}},"markingSession":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MarkingSession"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The MarkingSession object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MarkingSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MarkingSession"]},"attributes":{"type":"object","properties":{"role":{"type":"string","enum":["provisional","moderating","backReading","escalation","auditing","system","viewer"]},"mode":{"type":"string","enum":["attempt","question"]},"status":{"type":"string","enum":["pending","locked","inProgress","inConflict","escalated","completed","rejected","finalised","voided","suspended"]},"suspendedFromStatus":{"type":"string","enum":["pending","locked","inProgress","inConflict","escalated","completed","rejected","finalised","voided","suspended"]},"suspendedAt":{"type":"string"},"createdAt":{"type":"string"},"timeStarted":{"type":"string"},"timeCompleted":{"type":"string"},"responseCount":{"type":"number"}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"candidate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"markingEntries":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]}}}}},"responses":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"questions":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The MarkingSessionExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MarkingSessionExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MarkingSessionExport"]},"attributes":{"type":"object","properties":{"attemptIds":{"type":"array","items":{"type":"string"}},"filter":{"type":"object","properties":{"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","inReview","passed","failed","error"]}},"resultStatus":{"type":"array","items":{"type":"string","enum":["pending","finalised","released"]}},"lockStatus":{"type":"array","items":{"type":"string","enum":["locked","unlocked","none"]}},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MarkingState object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MarkingState":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MarkingState"]},"attributes":{"type":"object","properties":{"status":{"type":"string"},"statusDetail":{"type":"object"},"provisionalScore":{"type":"number"},"finalisation":{"type":"object"}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MAUPortalUsage object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MAUPortalUsage":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MfaActivation object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MfaActivation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MfaActivation"]},"attributes":{"type":"object","properties":{"enabled":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MfaConfig object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MfaConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MfaDeactivation object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MfaDeactivation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MfaDeactivation"]},"attributes":{"type":"object","properties":{"code":{"type":"number","readOnly":false},"recoveryCode":{"type":"string","readOnly":false}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MobileAttempt object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MobileAttempt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The MobileAudioContent object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MobileAudioContent":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MobileAudioContent"]},"attributes":{"type":"object","properties":{"path":{"type":"string","nullable":false,"readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MobileCollection object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MobileCollection":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"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"]}]}}}}}},"collectionItems":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The MobileCollectionFolder object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MobileCollectionFolder":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"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"]}]}}}}}},"subFolders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The MobileCollectionItem object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MobileCollectionItem":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MobileQuiz"]}}}}},"note":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MobileNote"]}}}}},"audio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MobileAudioContent"]}}}}},"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MobileDocumentContent"]}}}}},"embed":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MobileHtmlEmbedContent"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MobileCollectionSubFolder object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MobileCollectionSubFolder":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The MobileConfig object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MobileConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MobileNote object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MobileNote":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MobileQuiz object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MobileQuiz":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MobileResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MobileResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MobileResponse"]},"attributes":{"type":"object","properties":{"questionType":{"type":"string","enum":["audioRecording","videoRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","shortAnswer","informational","multipleCorrect","ranked","singleCorrect","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"nullable":true},"status":{"type":"string","nullable":false},"leadIn":{"type":"string","nullable":true},"stem":{"type":"string","nullable":true},"feedback":{"type":"string","nullable":true},"emqInstructions":{"type":"string","nullable":true},"emqFeedback":{"type":"string","nullable":true},"options":{"type":"array","items":{"type":"object"}},"chosenOptions":{"type":"array","items":{"type":"object"},"nullable":true},"correctOptions":{"type":"array","items":{"type":"object"}},"outcome":{"type":"string","nullable":true}}},"relationships":{}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MobileSession object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MobileSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MobileSession"]},"attributes":{"type":"object","properties":{"sessionToken":{"type":"string"}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MobileSpacedLearning object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MobileSpacedLearning":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["MobileQuiz"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MobileStudyItem object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MobileStudyItem":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The MobileUser object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"MobileUser":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Note object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Note":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The NotFoundApiError object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"NotFoundApiError":{"type":"object","description":"The request 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"}}}}}}}}
```

## The NotificationGroup object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"NotificationGroup":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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."}}}}
```

## The ObjectId object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Passkey object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Passkey":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Passkey"]},"attributes":{"type":"object","properties":{"name":{"type":"string","maxLength":64,"readOnly":false},"rpId":{"type":"string","readOnly":true},"deviceType":{"type":"string","readOnly":true,"nullable":true},"backedUp":{"type":"boolean","readOnly":true,"nullable":true},"createdAt":{"type":"string","readOnly":true,"nullable":true},"lastUsedAt":{"type":"string","readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PasskeyAuthentication object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PasskeyAuthentication":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PasskeyAuthentication"]},"attributes":{"type":"object","properties":{"sessionToken":{"type":"string","readOnly":true},"subPortalId":{"type":"string","readOnly":true,"nullable":true}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PasskeyAuthenticationOptions object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PasskeyAuthenticationOptions":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PasskeyAuthenticationOptions"]},"attributes":{"type":"object","properties":{"options":{"type":"object","readOnly":true,"additionalProperties":true}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PasskeyEnrolmentDeferral object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PasskeyEnrolmentDeferral":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PasskeyEnrolmentDeferral"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PasskeyRegistrationOptions object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PasskeyRegistrationOptions":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PasskeyRegistrationOptions"]},"attributes":{"type":"object","properties":{"options":{"type":"object","readOnly":true,"additionalProperties":true}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PasskeyRevocation object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PasskeyRevocation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PasskeyRevocation"]},"attributes":{"type":"object","properties":{"passkeyId":{"type":"string","readOnly":false}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PasswordReset object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PasswordReset":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PasswordResetRequest object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PasswordResetRequest":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PAYGPortalUsage object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PAYGPortalUsage":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PdfAnnotation object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PdfAnnotation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PersonalAccessToken object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PersonalAccessToken":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PlayerAttempt object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerAttempt":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerAttempt"]},"attributes":{"type":"object","properties":{"title":{"type":"string","readOnly":true},"quizMode":{"type":"string","enum":["exam","practice","timedExam"],"readOnly":true},"timeStarted":{"type":"string","readOnly":false},"activeTime":{"type":"object","readOnly":true,"additionalProperties":false,"description":"Recorded cumulative active-millisecond counters, for seeding the player ledgers on resume. The maps are keyed by sectionId; attemptInstructionsMs covers the attempt-level instructions screen.","properties":{"sectionMs":{"type":"object","additionalProperties":{"type":"integer","minimum":0}},"sectionInstructionsMs":{"type":"object","additionalProperties":{"type":"integer","minimum":0}},"sectionOutroMs":{"type":"object","additionalProperties":{"type":"integer","minimum":0}},"attemptInstructionsMs":{"type":"integer","minimum":0}}},"timeCompleted":{"type":"string","readOnly":false},"theme":{"type":"string","enum":["default","ucat"],"readOnly":true},"fontSize":{"type":"string","enum":["xLarge","large","medium","small","xSmall"],"readOnly":true},"pinnedMessage":{"type":"string","readOnly":true},"disableNavigation":{"type":"boolean","readOnly":true},"disableControlPanel":{"type":"boolean","readOnly":true},"disableNotifications":{"type":"boolean","readOnly":true},"proctorEnabled":{"type":"boolean","readOnly":true},"proctorVendor":{"type":"string","enum":["internal","synopticV2","rosalyn"],"readOnly":true},"proctorSessionId":{"type":"string","readOnly":true},"examStatus":{"type":"string","enum":["enrolled","expired","notified","preflight","revoked","started","submitted","cancelled"],"readOnly":false},"status":{"type":"string","readOnly":false,"enum":["completed","inProgress","instructionsInProgress","instructionsCompleted","locked","notStarted","revoked","scheduled"]},"submissionType":{"type":"string","readOnly":false,"nullable":true,"enum":["user","system","moderator","userTimedOut","abandoned",null]},"scheduleStatus":{"type":"string","enum":["active","cancelled","completed","draft","scheduled"],"readOnly":true},"attr":{"type":"object","readOnly":true},"openTime":{"type":"string","readOnly":true},"closeTime":{"type":"string","readOnly":true},"certificateStatus":{"type":"string","nullable":true,"readOnly":true,"enum":["pending","generated","notEligible",null]},"credits":{"type":"number","readOnly":true},"penalties":{"type":"number","readOnly":true},"maxPoints":{"type":"number","readOnly":true},"points":{"type":"number","readOnly":true},"showAvailableMarks":{"type":"boolean","readOnly":true},"score":{"type":"number","readOnly":true},"questionBreakdownDisplay":{"type":"string","readOnly":true,"enum":["full","hideStemAndOptions","hideCorrectOptions","incorrectOnlyHideCorrectOptions","none"]},"resultsEducatorViewAsAdminEnabled":{"type":"boolean","readOnly":true},"resultsDetailedViewEnabled":{"type":"boolean","readOnly":true},"resultsHiddenMessage":{"type":"string","nullable":true,"readOnly":true},"resultsHiddenSettingHideTitle":{"type":"boolean","readOnly":true},"isDynamic":{"type":"boolean","readOnly":true},"timerEnabled":{"type":"boolean","readOnly":true},"timerDuration":{"type":"number","readOnly":true},"timerType":{"type":"string","enum":["questions","sections","default"],"readOnly":true},"enforceFullTime":{"type":"boolean","readOnly":true},"softTimer":{"type":"boolean","readOnly":true},"extraTimeMultiplier":{"type":"number","readOnly":true},"features":{"type":"array","items":{"type":"string","enum":["bookmarking","resizableQuestionPanels","strikeThrough","highlighting","notepad","calculator","scientificCalculator","flagging","resumeLater","softSections","micSettings"]},"readOnly":true},"externalPlayer":{"type":"string","enum":["default","ucat","usmle"],"readOnly":true},"disableCopying":{"type":"boolean","readOnly":true,"nullable":false},"disablePasting":{"type":"boolean","readOnly":true,"nullable":false},"disableRightClick":{"type":"boolean","readOnly":true,"nullable":false},"labValues":{"type":"string","readOnly":true,"nullable":true},"additionalInformation":{"type":"string","readOnly":true,"nullable":true},"additionalInformationTitle":{"type":"string","readOnly":true,"nullable":true},"additionalInformationIcon":{"type":"string","readOnly":true,"nullable":true},"markingPenaltiesEnabled":{"type":"boolean","readOnly":true,"nullable":false},"instructionsEnabled":{"type":"boolean","readOnly":true,"nullable":false},"instructionsTitle":{"type":"string","nullable":true,"readOnly":true,"minLength":1,"maxLength":300},"instructionsBody":{"type":"string","nullable":true,"readOnly":true,"minLength":1,"maxLength":25000},"instructionsTimeStarted":{"type":"string","readOnly":true},"instructionsTimeCompleted":{"type":"string","readOnly":true},"instructionsTimerDurationMs":{"type":"number","nullable":true,"readOnly":true,"minimum":1,"maximum":86400000},"instructionsEnforcedTimer":{"type":"string","readOnly":true,"enum":["afterAudioStarts","immediately"]},"instructionsAudioAutoAdvance":{"type":"string","readOnly":true,"enum":["disabled","afterDefinedTime","immediately"]},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":true,"minimum":0,"maximum":3600000},"instructionsAudioAutoPlay":{"type":"boolean","readOnly":true,"nullable":true},"instructionsDisableAudioControls":{"type":"boolean","readOnly":true,"nullable":true},"excludeInformationalQuestionsFromCounts":{"type":"boolean","readOnly":true,"nullable":true},"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"],"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Test"]}}}}},"exam":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"audioInstructions":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"responses":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"sections":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"certificate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Certificate"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerAudioResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerAudioResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerAudioResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"answer":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerClozeDragAndDropResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerClozeDragAndDropResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerClozeDragAndDropResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerClozeDropDownResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerClozeDropDownResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerClozeDropDownResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerClozeTextResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerClozeTextResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerClozeTextResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerDrawingResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerDrawingResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerDrawingResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"backgroundImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerEmqGroup object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerEmqGroup":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"audioInstructions":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PlayerFileUploadResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerFileUploadResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerFileUploadResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"answers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerFlashcardResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerFlashcardResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerFlashcardResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerFreeTextResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerFreeTextResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerFreeTextResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerImageHotspotResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerImageHotspotResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerImageHotspotResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"hotspotImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerInformationalResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerInformationalResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerInformationalResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerMultipleChoiceResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerMultipleChoiceResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerMultipleChoiceResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerOffPlatformResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerOffPlatformResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerOffPlatformResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerRankedResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerRankedResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerRankedResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerSection object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerSection":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"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"]}]}}}}}},"instructionsAudioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"outroAudioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerShortAnswerResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerShortAnswerResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerShortAnswerResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerSingleChoiceResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerSingleChoiceResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSingleChoiceResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerSpreadsheetResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerSpreadsheetResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSpreadsheetResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerTrueOrFalseResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerTrueOrFalseResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerTrueOrFalseResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PlayerVideoResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PlayerVideoResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerVideoResponse"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["unanswered","answered","submitted","locked"],"readOnly":false,"nullable":true},"activeDurationMs":{"type":"integer","minimum":0,"readOnly":true,"description":"Cumulative active milliseconds on this question, for seeding the player ledger on resume."},"resultStatus":{"type":"string","enum":["correct","excluded","incorrect","partial","pending","skipped","unsure"],"readOnly":true,"nullable":true},"questionType":{"type":"string","enum":["audioRecording","clozeDragAndDrop","clozeDropDown","clozeText","fileUpload","freeText","informational","multipleCorrect","ranked","singleCorrect","shortAnswer","videoRecording","spreadsheet","imageHotspot","offPlatform","flashcard","trueOrFalse","drawing"],"readOnly":true},"questionReferenceId":{"type":"string","readOnly":true},"questionReferenceDoi":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"leadIn":{"type":"string","readOnly":true,"nullable":true},"stem":{"type":"string","readOnly":true,"nullable":true},"timerDurationMs":{"type":"number","readOnly":true,"nullable":true},"hideStemImage":{"type":"boolean","readOnly":true},"layout":{"type":"string","enum":["swimLane","topDown","default"],"readOnly":true},"scoreByChoice":{"type":"boolean","readOnly":true},"mediaStemType":{"type":"string","enum":["audio","video",null],"readOnly":true,"nullable":true},"mediaStemPlaybackCount":{"type":"number","readOnly":false},"audioStemPlaybackLimit":{"type":"number","readOnly":true},"audioStemAutoPlay":{"type":"boolean","readOnly":true},"audioStemDisableProgression":{"type":"boolean","readOnly":true},"audioStemHideOptions":{"type":"boolean","readOnly":true},"audioStemAutoAdvance":{"type":"string","enum":["afterDefinedTime","disabled","immediately"],"readOnly":true},"audioStemAutoAdvanceEnforceFullTime":{"type":"boolean","readOnly":true},"audioStemAutoAdvanceDelay":{"type":"number","readOnly":true},"audioStemDisableControls":{"type":"boolean","readOnly":true},"hideStemDuration":{"type":"number","readOnly":true,"nullable":true},"feedback":{"type":"string","readOnly":true,"nullable":true},"candidateFeedback":{"type":"string","readOnly":true,"nullable":false},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerSection"]}}}}},"emqGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PlayerEmqGroup"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"answer":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The Portal object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Portal":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"subdomain":{"type":"string","readOnly":true},"hostname":{"type":"string","readOnly":true},"subPortalDomain":{"type":"string","readOnly":false,"nullable":true,"maxLength":253,"description":"Optional suffix for sub-portal hostnames (slug.suffix). When unset, sub-portals use the portal hostname as the suffix."},"entitlements":{"type":"object","readOnly":true,"properties":{"branding":{"type":"boolean"},"doubleBlindMarking":{"type":"boolean"},"marking":{"type":"string","enum":["basic","standard","advanced"]},"textVariables":{"type":"boolean"},"integration":{"type":"boolean"},"userGroupAdvanced":{"type":"boolean"},"sso":{"type":"boolean"},"whiteLabeling":{"type":"boolean"},"mobileApp":{"type":"boolean"},"recordOfLearning":{"type":"boolean"},"subPortal":{"type":"boolean"},"zapier":{"type":"boolean"},"tagSets":{"type":"boolean"},"webhooks":{"type":"boolean"},"permissions":{"type":"string","enum":["basic","advanced","legacy"]},"synoptic":{"type":"string","enum":["lockdown","full"]},"personalAccessToken":{"type":"boolean"},"customAttributes":{"type":"number"},"advancedGrading":{"type":"boolean"},"examVoucher":{"type":"boolean"},"codeLogin":{"type":"boolean"}}},"isActive":{"type":"boolean","readOnly":true},"headerIcon":{"type":"object","readOnly":false,"nullable":true,"properties":{"__type":{"type":"string","enum":["File"]},"name":{"type":"string"},"url":{"type":"string"}}},"favicon":{"type":"object","readOnly":false,"nullable":true,"properties":{"__type":{"type":"string","enum":["File"]},"name":{"type":"string"},"url":{"type":"string"}}},"squareIcon":{"type":"object","readOnly":false,"nullable":true,"properties":{"__type":{"type":"string","enum":["File"]},"name":{"type":"string"},"url":{"type":"string"}}},"extraInformation":{"type":"object","deprecated":true,"readOnly":false,"additionalProperties":true},"emailSettings":{"type":"object","deprecated":true,"readOnly":false,"properties":{"fromEmail":{"type":"string","format":"email"},"fromName":{"type":"string"},"marketingEmailsConsent":{"type":"object","properties":{"enabled":{"type":"boolean"},"requireEmailConfirmation":{"type":"boolean"},"defaultAgree":{"type":"boolean"},"customLabel":{"type":"string"}}},"isDisabled":{"type":"boolean"},"welcomeEmail":{"type":"object","properties":{"subject":{"type":"string","maxLength":100,"nullable":true},"body":{"type":"string","maxLength":5000,"nullable":true}}},"header":{"type":"object","properties":{"logoUrl":{"type":"string","format":"uri","nullable":true,"maxLength":500}}},"maxPerWeek":{"type":"integer","minimum":0},"address":{"type":"string"}}},"externalApi":{"type":"object","deprecated":true,"readOnly":false,"properties":{"intercom":{"type":"object","properties":{"idvKey":{"type":"string","maxLength":1000,"writeOnly":true}}},"segment":{"type":"object","properties":{"apiKey":{"type":"string"},"webKey":{"type":"string"},"trackMiniEvents":{"type":"boolean"},"ingestionRegion":{"type":"string","enum":["us_oregon","eu_dublin"]},"cookieConsentEnabled":{"type":"boolean"}}},"googleAnalytics":{"type":"object","properties":{"webKey":{"type":"string"}}}}},"hostnameWhitelist":{"type":"array","readOnly":false,"maxItems":50,"items":{"type":"string","maxLength":100}},"registrationSettings":{"type":"object","deprecated":true,"readOnly":false,"properties":{"pageTitle":{"type":"string","maxLength":200},"pageDescription":{"type":"string","minLength":0,"maxLength":2000},"registerMethod":{"type":"string","enum":["open","closed"]},"collectAttrs":{"type":"array","nullable":true,"items":{"type":"string","maxLength":20},"maxItems":10},"selectUserGroup":{"type":"object","properties":{"label":{"type":"string"},"options":{"type":"array","maxItems":20,"items":{"type":"string","minLength":1,"maxLength":20}}}},"emailVerification":{"type":"boolean"},"headerBackgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{3,6}$"},"headerBorderBottomColor":{"type":"string","pattern":"^#[0-9a-fA-F]{3,6}$"},"backgroundImageUrl":{"type":"string","format":"uri","maxLength":300},"domainWhitelist":{"type":"array","maxItems":200,"items":{"type":"string","maxLength":60}},"localeConfig":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"externalAuth":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"label":{"type":"string"}}}}},"affiliation":{"type":"object","deprecated":true,"readOnly":false,"properties":{"twitter":{"type":"object","properties":{"url":{"type":"string","nullable":true}}},"facebook":{"type":"object","properties":{"url":{"type":"string","nullable":true}}},"linkedIn":{"type":"object","properties":{"url":{"type":"string","nullable":true}}},"youtube":{"type":"object","properties":{"url":{"type":"string","nullable":true}}}}},"webMetaInfo":{"type":"object","deprecated":true,"readOnly":false,"properties":{"site":{"type":"object","properties":{"siteName":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true,"maxLength":300},"imageUrl":{"type":"string","format":"uri","nullable":true}}}}},"styleConfig":{"type":"object","deprecated":true,"readOnly":false,"properties":{"brand":{"type":"object","properties":{"primary":{"type":"string"},"secondary":{"type":"string"}}},"font":{"type":"object","properties":{"color":{"type":"object","properties":{"link":{"type":"string"}}}}},"button":{"type":"object","properties":{"color":{"type":"object","properties":{"primary":{"type":"string"},"secondary":{"type":"string"}}},"text":{"type":"object","properties":{"primary":{"type":"string"},"secondary":{"type":"string"}}}}},"chart":{"type":"object","properties":{"color":{"type":"object","properties":{"primary":{"type":"string"}}}}},"navigationBar":{"type":"object","properties":{"background":{"type":"string"},"border":{"type":"string"}}},"ui":{"type":"object","properties":{"defaultCardImageUrl":{"type":"string","format":"uri","nullable":true}}}}},"notificationConfig":{"type":"object","readOnly":false,"properties":{"enabled":{"type":"boolean"},"groups":{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean"},"config":{"type":"object","additionalProperties":{"type":"boolean"}},"overrides":{"type":"array","items":{"type":"object","properties":{"enabled":{"type":"boolean"},"id":{"type":"string"},"config":{"type":"object","additionalProperties":{"type":"boolean"}}},"required":["enabled","id"]}}}}}}},"legalLinks":{"type":"object","deprecated":true,"readOnly":false,"properties":{"terms":{"type":"object","required":["hidden"],"properties":{"hidden":{"type":"boolean"},"url":{"type":"string","format":"uri","nullable":true},"noteId":{"type":"string","nullable":true}}},"privacy":{"type":"object","required":["hidden"],"properties":{"hidden":{"type":"boolean"},"url":{"type":"string","format":"uri","nullable":true},"noteId":{"type":"string","nullable":true}}}}},"generalSettings":{"type":"object","readOnly":false,"properties":{"availableExternalPlayers":{"type":"array","items":{"type":"string","enum":["default","ucat","usmle"]}},"defaultExternalPlayer":{"type":"object","properties":{"type":{"type":"string","enum":["default","ucat","usmle"]}}},"defaultFontSize":{"type":"string","enum":["xSmall","small","medium","large","xLarge"],"deprecated":true,"description":"Use generalSettingsDefaultFontSize instead"},"customGlossary":{"type":"object","properties":{"quizModePractice":{"type":"string","enum":["practice","tutor"],"nullable":true},"tagSetNoTagSet":{"type":"string","nullable":true}}},"mobileApp":{"type":"object","properties":{"appStoreLinks":{"type":"object","properties":{"android":{"type":"string"},"ios":{"type":"string"}}},"name":{"type":"string"},"image":{"type":"string"}}},"study":{"type":"object","deprecated":true,"properties":{"allowedFacets":{"type":"array","deprecated":true,"items":{"type":"string","enum":["subject","topic","subtopic","difficulty","skill","context"]}},"takeTest":{"type":"object","properties":{"flagging":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"calculator":{"type":"object","properties":{"enabled":{"type":"boolean"},"type":{"type":"string","enum":["basic","scientific"]}}},"notepad":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"strikethrough":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"highlighting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"bookmarking":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"labValues":{"type":"object","properties":{"enabled":{"type":"boolean"},"html":{"type":"string","nullable":true}}},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"]},"allowMultipleTagSelection":{"type":"boolean"},"excludeUntaggedQuestions":{"type":"boolean"}},"deprecated":true},"studyControls":{"type":"boolean","deprecated":true}}},"style":{"type":"object","properties":{"availableQuizThemes":{"type":"array","items":{"type":"string","enum":["default","ucat"]}}}},"takeTest":{"type":"object","properties":{"flagging":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"calculator":{"type":"object","properties":{"enabled":{"type":"boolean"},"type":{"type":"string","enum":["basic","scientific"]}}},"notepad":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"strikethrough":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"highlighting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"bookmarking":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"labValues":{"type":"object","properties":{"enabled":{"type":"boolean"},"html":{"type":"string","nullable":true}}},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"]},"allowMultipleTagSelection":{"type":"boolean"},"excludeUntaggedQuestions":{"type":"boolean"}},"deprecated":true},"userAccountManagement":{"type":"object","deprecated":true,"description":"Use generalSettingsUserAccountManagement(fields) instead","properties":{"preventUserAccountDeletion":{"type":"boolean"},"preventUserEmailEditing":{"type":"boolean"},"preventUserNameEditing":{"type":"boolean"}}},"logoutUrl":{"type":"string","format":"uri","nullable":true,"deprecated":true,"description":"Use generalSettingsLogoutUrl instead"}}},"localeConfig":{"type":"object","deprecated":true,"readOnly":false,"properties":{"defaultLocale":{"type":"string"},"defaultTimezone":{"type":"string"},"userPreferences":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}},"homepage":{"type":"string","readOnly":false},"affiliationFacebookUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"affiliationLinkedInUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"affiliationTwitterUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"affiliationYoutubeUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"emailSettingsFromName":{"type":"string","nullable":true,"readOnly":false},"emailSettingsFromEmail":{"type":"string","format":"email","nullable":true,"readOnly":false},"emailSettingsFooterText":{"type":"string","nullable":true,"readOnly":false},"emailSettingsHeaderLogoUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"emailSettingsWelcomeEmailEnabled":{"type":"boolean","readOnly":false},"emailSettingsWelcomeEmailSubject":{"type":"string","nullable":true,"readOnly":false},"emailSettingsWelcomeEmailBody":{"type":"string","nullable":true,"readOnly":false},"emailSettingsMarketingEmailsConsentEnabled":{"type":"boolean","readOnly":false},"emailSettingsMarketingEmailsConsentDefaultAgree":{"type":"boolean","readOnly":false},"emailSettingsMarketingEmailsConsentCustomLabel":{"type":"string","nullable":true,"readOnly":false},"emailSettingsMarketingEmailsConsentRequireEmailConfirmation":{"type":"boolean","readOnly":false},"externalApiGoogleAnalyticsWebKey":{"type":"string","nullable":true,"readOnly":false},"externalApiIntercomIdvKey":{"type":"string","nullable":true,"writeOnly":true},"externalApiIntercomIdvKeyIsSet":{"type":"boolean","readOnly":true},"externalApiSegmentApiKey":{"type":"string","nullable":true,"readOnly":false},"externalApiSegmentCookieConsentEnabled":{"type":"boolean","readOnly":false},"externalApiSegmentIngestionRegion":{"type":"string","enum":["us_oregon","eu_dublin"],"nullable":true,"readOnly":false},"externalApiSegmentTrackMiniEvents":{"type":"boolean","readOnly":false},"extraInformationDisplayMobileAppLink":{"type":"boolean","readOnly":false},"extraInformationHideFooter":{"type":"boolean","readOnly":false},"generalSettingsDefaultFontSize":{"type":"string","enum":["xSmall","small","medium","large","xLarge"],"nullable":true,"readOnly":false},"generalSettingsLogoutUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"generalSettingsUserAccountManagementPreventUserAccountDeletion":{"type":"boolean","readOnly":false},"generalSettingsUserAccountManagementPreventUserEmailEditing":{"type":"boolean","readOnly":false},"generalSettingsUserAccountManagementPreventUserNameEditing":{"type":"boolean","readOnly":false},"generalSettingsSubPortalSimplifiedExamManagement":{"type":"boolean","readOnly":false},"generalSettingsStudyAllowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","difficulty","skill","context"]}},"legalLinksPrivacyHidden":{"type":"boolean"},"legalLinksPrivacyNoteId":{"type":"string","nullable":true,"readOnly":false},"legalLinksPrivacyUrl":{"type":"string","nullable":true,"readOnly":false},"legalLinksTermsHidden":{"type":"boolean"},"legalLinksTermsNoteId":{"type":"string","nullable":true,"readOnly":false},"legalLinksTermsUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"localeConfigDefaultLocale":{"type":"string","readOnly":false,"nullable":true},"localeConfigDefaultTimezone":{"type":"string","readOnly":false,"nullable":true},"localeConfigUserPreferencesEnabled":{"type":"boolean","readOnly":false},"localeConfigCustomGlossaryQuizModePractice":{"type":"string","nullable":true,"readOnly":false},"localeConfigCustomGlossaryTagSetNoTagSet":{"type":"string","nullable":true,"readOnly":false},"localeConfigCustomGlossaryExternalId":{"type":"string","nullable":true,"readOnly":false,"description":"What this portal calls a user's external ID (e.g. ULN, SID), shown wherever the field appears."},"mobileAppAndroidStoreLink":{"type":"string","format":"uri","nullable":true,"readOnly":false},"mobileAppIosStoreLink":{"type":"string","format":"uri","nullable":true,"readOnly":false},"mobileAppName":{"type":"string","nullable":true,"readOnly":false},"mobileAppImageUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"mobileAppDisplayLink":{"type":"boolean","readOnly":false},"registrationSettingsLocaleConfigEnabled":{"type":"boolean","readOnly":false},"registrationSettingsExamVoucherLoginEnabled":{"type":"boolean","readOnly":false},"registrationSettingsRegisterMethod":{"type":"string","enum":["open","closed"]},"registrationSettingsDomainWhitelist":{"type":"array","maxItems":200,"items":{"type":"string","maxLength":60}},"registrationSettingsPageTitle":{"type":"string","maxLength":200},"registrationSettingsPageDescription":{"type":"string","minLength":0,"maxLength":2000,"nullable":true},"registrationSettingsBackgroundImageUrl":{"type":"string","format":"uri","maxLength":300,"nullable":true},"registrationSettingsHeaderBackgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{3,6}$","nullable":true},"registrationSettingsHeaderBorderBottomColor":{"type":"string","pattern":"^#[0-9a-fA-F]{3,6}$","nullable":true},"registrationSettingsSelectUserGroup":{"type":"object","nullable":true,"properties":{"label":{"type":"string"},"options":{"type":"array","items":{"type":"string"}}}},"securitySettingsMfaEnforcementAdmins":{"type":"boolean","readOnly":false},"securitySettingsMfaEnforcementModerators":{"type":"boolean","readOnly":false},"securitySettingsMfaEnforcementStudents":{"type":"boolean","readOnly":false},"securitySettingsPasskeysEnabled":{"type":"boolean","readOnly":false},"styleConfigBrandPrimary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"styleConfigBrandSecondary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"styleConfigButtonColorPrimary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"styleConfigButtonColorSecondary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"styleConfigChartColorPrimary":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"styleConfigFontColorLink":{"oneOf":[{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}([0-9]{0,2})$","readOnly":false,"nullable":true},{"type":"string","enum":["{brand.primary}","{brand.secondary}","white","black","whitesmoke"],"readOnly":false,"nullable":true}]},"styleConfigUiDefaultCardImageUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"studyConfigAllowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","difficulty","skill","context"]}},"studyConfigAvailableExternalPlayers":{"type":"array","nullable":true,"items":{"type":"string","enum":["default","ucat","usmle"]}},"studyConfigAvailableQuizThemes":{"type":"array","nullable":true,"items":{"type":"string","enum":["default","ucat"]}},"studyConfigDefaultExternalPlayer":{"type":"string","nullable":true,"enum":["default","ucat","usmle"]},"studyConfigStudyControls":{"type":"boolean","readOnly":false},"studyConfigIgnoreSkippedResponses":{"type":"boolean","readOnly":false},"studyConfigTakeTest":{"type":"object","properties":{"flagging":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"calculator":{"type":"object","properties":{"enabled":{"type":"boolean"},"type":{"type":"string","enum":["basic","scientific"]}}},"notepad":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"strikethrough":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"highlighting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"bookmarking":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"labValues":{"type":"object","properties":{"enabled":{"type":"boolean"},"html":{"type":"string","nullable":true}}},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"]},"allowMultipleTagSelection":{"type":"boolean"},"excludeUntaggedQuestions":{"type":"boolean"}}},"studyConfigSelfPracticeTakeTest":{"type":"object","properties":{"flagging":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"calculator":{"type":"object","properties":{"enabled":{"type":"boolean"},"type":{"type":"string","enum":["basic","scientific"]}}},"notepad":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"strikethrough":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"highlighting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"bookmarking":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"labValues":{"type":"object","properties":{"enabled":{"type":"boolean"},"html":{"type":"string","nullable":true}}},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"]},"allowMultipleTagSelection":{"type":"boolean"},"excludeUntaggedQuestions":{"type":"boolean"}}},"webMetaInfoDescription":{"type":"string","nullable":true,"maxLength":300,"readOnly":false},"webMetaInfoImageUrl":{"type":"string","format":"uri","nullable":true,"readOnly":false},"webMetaInfoSiteName":{"type":"string","nullable":true,"maxLength":100,"readOnly":false}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"adminsGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"managersGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"educatorsGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"markersGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"studentsGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"allUsersGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"subscription":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Subscription"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PortalStore object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PortalStore":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PortalUsage object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PortalUsage":{"anyOf":[{"$ref":"#/components/schemas/PAYGPortalUsage"},{"$ref":"#/components/schemas/MAUPortalUsage"}]},"PAYGPortalUsage":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"MAUPortalUsage":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]}}}}}}}}}}}}
```

## The ProctorCapture object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ProctorCapture":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ProctorCapture"]},"attributes":{"type":"object","anyOf":[{"properties":{"desktop":{"type":"string","readOnly":true},"start":{"type":"string","readOnly":true},"end":{"type":"string","readOnly":true},"duration":{"type":"number","readOnly":true}}},{"properties":{"webcam":{"type":"string","readOnly":true},"start":{"type":"string","readOnly":true},"end":{"type":"string","readOnly":true},"duration":{"type":"number","readOnly":true}}},{"properties":{"webcam":{"type":"string","readOnly":true},"desktop":{"type":"string","readOnly":true},"start":{"type":"string","readOnly":true},"end":{"type":"string","readOnly":true},"duration":{"type":"number","readOnly":true}}}]},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"proctorSession":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ProctorSession"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ProctorEventLog object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ProctorEventLog":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ProctorEventLog"]},"attributes":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true},"action":{"type":"string","readOnly":true},"delta":{"type":"object","readOnly":true,"properties":{"before":{"type":"object","readOnly":true,"properties":{"numberOfDisplays":{"readOnly":true,"type":"number"},"fullscreen":{"readOnly":true,"type":"boolean"},"focus":{"readOnly":true,"type":"boolean"},"numberOfTabs":{"readOnly":true,"type":"number"},"injectedToken":{"readOnly":true,"type":"string"},"examConnected":{"readOnly":true,"type":"boolean"},"questionData":{"readOnly":true,"type":"object","properties":{"questionId":{"readOnly":true,"type":"string"},"questionDoi":{"readOnly":true,"type":"string"},"sectionId":{"readOnly":true,"type":"string"},"sectionDoi":{"readOnly":true,"type":"string"}}}}},"after":{"type":"object","readOnly":true,"properties":{"numberOfDisplays":{"readOnly":true,"type":"number"},"fullscreen":{"readOnly":true,"type":"boolean"},"focus":{"readOnly":true,"type":"boolean"},"numberOfTabs":{"readOnly":true,"type":"number"},"injectedToken":{"readOnly":true,"type":"string"},"examConnected":{"readOnly":true,"type":"boolean"},"questionData":{"readOnly":true,"type":"object","properties":{"questionId":{"readOnly":true,"type":"string"},"questionDoi":{"readOnly":true,"type":"string"},"sectionId":{"readOnly":true,"type":"string"},"sectionDoi":{"readOnly":true,"type":"string"}}}}}}},"message":{"type":"string","readOnly":true},"questionData":{"readOnly":true,"type":"object","properties":{"questionId":{"readOnly":true,"type":"string"},"questionDoi":{"readOnly":true,"type":"string"},"sectionId":{"readOnly":true,"type":"string"},"sectionDoi":{"readOnly":true,"type":"string"}}},"timestamp":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ProctorReview object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ProctorReview":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ProctorSession object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ProctorSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ProctorSession"]},"attributes":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"sessionId":{"type":"string","readOnly":true},"token":{"type":"string","readOnly":true},"enabled":{"type":"boolean","readOnly":true},"breaches":{"type":"number","readOnly":true},"requiresReview":{"type":"boolean","readOnly":true},"isApproved":{"type":"boolean","readOnly":true},"url":{"type":"string","readOnly":true},"isFinalised":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}},"user":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Product object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Product":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ProductList object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ProductList":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The PublicAttributeConfig object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PublicAttributeConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PublicAuthenticationOption object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PublicAuthenticationOption":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The PublicCertificate object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"PublicCertificate":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["PublicCertificate"]},"attributes":{"type":"object","properties":{"html":{"type":"string","readOnly":true},"documentKey":{"type":"string","readOnly":true},"expiryDate":{"type":"string","readOnly":true},"validationUrl":{"type":"string","readOnly":true},"sharingImageUrl":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"document":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Document"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"examV2":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Exam-V-2"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The QuestionExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuestionExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The QuestionImport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuestionImport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["BackgroundJob"]}}}}},"test":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Test"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The QuestionImportValidation object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuestionImportValidation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Test"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The QuestionSummary object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuestionSummary":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"tagSets":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The Quiz object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Quiz":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":false,"minLength":1,"maxLength":300},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"description":{"type":"string","nullable":true,"readOnly":false,"maxLength":50000},"shortDescription":{"type":"string","nullable":true,"readOnly":false,"minLength":0,"maxLength":1500},"totalQuestions":{"type":"number","nullable":false,"readOnly":true},"instructionsEnabled":{"type":"boolean","readOnly":false,"nullable":false},"instructionsTitle":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":300},"instructionsBody":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":25000},"instructionsTimerDurationMs":{"type":"number","nullable":true,"readOnly":false,"minimum":1,"maximum":86400000},"instructionsEnforcedTimer":{"type":"string","readOnly":false,"enum":["afterAudioStarts","immediately"]},"instructionsAudioAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"instructionsAudioAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"instructionsDisableAudioControls":{"type":"boolean","readOnly":false,"nullable":true},"markingCreditsPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0},"markingPartialCreditsPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0},"markingPenaltiesPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0},"markingPenaltiesEnabled":{"type":"boolean","nullable":true,"readOnly":false},"grades":{"type":"array","nullable":true,"items":{"type":"object","properties":{"label":{"type":"string","readOnly":false},"minScore":{"type":"number","readOnly":false},"isPass":{"type":"boolean","readOnly":false,"nullable":true},"description":{"type":"string","readOnly":false,"nullable":true},"advancedCriteria":{"type":"object","readOnly":false,"nullable":true,"properties":{"sectionRequirements":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","enum":["none","requiredCount","allPass","selectedPass"],"readOnly":false,"nullable":true},"count":{"type":"number","readOnly":false,"nullable":true},"sectionIds":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"string","readOnly":false,"nullable":true}}}},"excludeFromResitAttempts":{"type":"boolean","readOnly":false,"nullable":true}}}}}},"allowedModes":{"type":"array","nullable":true,"items":{"type":"string","enum":["practice","exam","timedExam"]},"minItems":1,"maxItems":3},"allowedLengths":{"type":"array","items":{"type":"string","enum":["default","quick","medium","long","extraLong"]}},"allowedPlayers":{"type":"array","items":{"type":"string","enum":["default","ucat","usmle"]}},"allowedTagSets":{"type":"array","nullable":true,"items":{"type":"string"}},"allowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","skill","difficulty","context"]}},"calculatorEnabled":{"type":"boolean","readOnly":false},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"],"readOnly":false},"allowMultipleTagSelection":{"type":"boolean","readOnly":false},"excludeUntaggedQuestions":{"type":"boolean","readOnly":false},"showMasteryFilters":{"type":"boolean","readOnly":false},"calculatorType":{"type":"string","enum":["basic","scientific"]},"securityDisableCopying":{"type":"boolean","readOnly":false},"securityDisablePasting":{"type":"boolean","readOnly":false},"securityDisableRightClick":{"type":"boolean","readOnly":false},"navigationDisableNavigation":{"type":"boolean","readOnly":false},"navigationDisableControlPanel":{"type":"boolean","readOnly":false},"navigationDisableNotifications":{"type":"boolean","readOnly":false},"softSectionsEnabled":{"type":"boolean","readOnly":false},"notepadEnabled":{"type":"boolean","readOnly":false},"resizableQuestionPanelsEnabled":{"type":"boolean","readOnly":false},"strikethroughEnabled":{"type":"boolean","readOnly":false},"highlightingEnabled":{"type":"boolean","readOnly":false},"bookmarkingEnabled":{"type":"boolean","readOnly":false},"micSettingsEnabled":{"type":"boolean","readOnly":false},"labValuesEnabled":{"type":"boolean","readOnly":false},"labValuesHtml":{"type":"string","readOnly":false},"additionalInformationEnabled":{"type":"boolean","readOnly":false},"additionalInformationTitle":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":120},"additionalInformationIcon":{"type":"string","readOnly":false,"nullable":true},"additionalInformationHtml":{"type":"string","readOnly":false},"resumeLaterButtonEnabled":{"type":"boolean","readOnly":false},"flaggingEnabled":{"type":"boolean","readOnly":false},"showAvailableMarks":{"type":"boolean","readOnly":false},"playerType":{"type":"string","enum":["default","ucat","usmle"]},"theme":{"type":"string"},"fontSize":{"type":"string","enum":["xSmall","small","medium","large","xLarge"]},"pinnedMessageDuringTest":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":1500},"deferResultsEnabled":{"type":"boolean","readOnly":false},"deferResultsMessage":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":25000},"deferResultsAlwaysRelease":{"type":"boolean","readOnly":false},"whenCompleteNoGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000,"deprecated":true},"completedMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000,"deprecated":true},"resultsHideResults":{"type":"boolean","readOnly":false},"resultsGlobalHideScore":{"type":"boolean","readOnly":false},"resultsDetailedViewEnabled":{"type":"boolean","readOnly":false},"resultsOverviewWhenPassedMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenFailedHasResitsMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenFailedNoResitsMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenCompleteNoGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenCompletedNeutralGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessagePassed":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageFailed":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageResitsRemaining":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageNoResitsRemaining":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageCompleted":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageSettingHideTitle":{"type":"boolean","readOnly":false},"resultsHiddenMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsHiddenSettingHideTitle":{"type":"boolean","readOnly":false},"resultsMetricScoreEnabled":{"type":"boolean","readOnly":false},"resultsMetricTimeSpentEnabled":{"type":"boolean","readOnly":false},"resultsMetricGradeEnabled":{"type":"boolean","readOnly":false},"resultsMetricProgressEnabled":{"type":"boolean","readOnly":false,"deprecated":true,"description":"Use resultsMetricTagProgressEnabled instead"},"resultsMetricQuestionBreakdownDisplayLevel":{"type":"string","enum":["full","hideStemAndOptions","hideCorrectOptions","incorrectOnlyHideCorrectOptions","none"],"readOnly":false},"resultsMetricAnalyticsCohort":{"type":"string","enum":["exam","test","sourceTest"]},"resultsMetricCohortAverageEnabled":{"type":"boolean","readOnly":false},"resultsMetricCohortPercentileEnabled":{"type":"boolean","readOnly":false},"resultsMetricCohortScoreDistributionEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagBreakdownEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagProgressEnabled":{"type":"boolean","readOnly":false},"resultsMetricSectionBreakdownEnabled":{"type":"boolean","readOnly":false},"resultsMetricSectionBreakdownGradeEnabled":{"type":"boolean","readOnly":false},"resultsMetricSectionBreakdownScoreEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagProgressFacetsEnabled":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"subject":{"type":"boolean","readOnly":false},"topic":{"type":"boolean","readOnly":false},"subtopic":{"type":"boolean","readOnly":false},"skill":{"type":"boolean","readOnly":false},"difficulty":{"type":"boolean","readOnly":false}}},"resultsEducatorViewAsAdminEnabled":{"type":"boolean","readOnly":false},"timerEnabled":{"type":"boolean","readOnly":false},"timerHidden":{"type":"boolean","readOnly":false},"timerUseQuestions":{"type":"boolean","readOnly":false},"timerUseSections":{"type":"boolean","readOnly":false},"timerEnforceFullTime":{"type":"boolean","readOnly":false},"timerTimeInMs":{"type":"number","nullable":true,"readOnly":false,"minimum":1,"maximum":86400000},"timerExtraTimeMultiplier":{"type":"number","readOnly":false,"nullable":true},"timerSoftTimer":{"type":"boolean","readOnly":false},"mutexLockKey":{"type":"string","readOnly":true,"nullable":true},"mutexLockExpiresAt":{"type":"string","readOnly":true,"nullable":true},"mutexLockType":{"type":"string","enum":["write","full",null],"readOnly":true,"nullable":true},"certificatesEnabled":{"type":"boolean","readOnly":false},"certificatesTemplateId":{"type":"string","nullable":true,"readOnly":false},"certificatesQrCode":{"type":"boolean","nullable":true,"readOnly":false},"certificatesTtl":{"type":"number","nullable":true,"readOnly":false},"certificatesIgnoreSubPortalBranding":{"type":"boolean","nullable":true,"readOnly":false},"certificatesIssueOnFail":{"type":"boolean","nullable":true,"readOnly":false},"certificatesResultsPage":{"type":"boolean","nullable":true,"readOnly":false},"certificatesSharingImageUrl":{"type":"string","nullable":true,"readOnly":false},"resitEnabled":{"type":"boolean","nullable":false,"readOnly":false},"resitType":{"type":"string","enum":["continuous","fixedDate","onDemand","rolling",null],"nullable":true,"readOnly":false},"resitMode":{"type":"string","enum":["standard","fixed","progressive","preferUnseen",null],"readOnly":false,"nullable":true},"resitGradeIndependent":{"type":"boolean","nullable":true,"readOnly":false},"resitAllowedAttempts":{"type":"number","nullable":true,"readOnly":false},"resitDelay":{"type":"number","nullable":true,"readOnly":false},"resitCloseDelay":{"type":"number","nullable":true,"readOnly":false},"resitScheduleActivateAt":{"type":"string","nullable":true,"readOnly":false},"resitScheduleDeactivateAt":{"type":"string","nullable":true,"readOnly":false},"proctorEnabled":{"type":"boolean","readOnly":false,"nullable":false},"proctorVendor":{"type":"string","readOnly":false,"enum":["internal","rosalyn","synopticV2",null],"nullable":true},"proctorRequireFullscreen":{"type":"boolean","readOnly":false,"nullable":false},"proctorRestrictTabs":{"type":"boolean","readOnly":false,"nullable":false},"proctorRestrictDisplays":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordSession":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordSnapshots":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordDesktop":{"type":"boolean","readOnly":false,"nullable":false},"proctorSynopticLevel":{"type":"string","readOnly":false,"nullable":false,"enum":["web","browser","desktop"]},"proctorScreenMonitoring":{"type":"string","readOnly":false,"nullable":false,"enum":["none","recreation","recreationWithSnapshots","video"]},"proctorWebcamMonitoring":{"type":"string","readOnly":false,"nullable":false,"enum":["none","snapshots","audioVideo"]},"proctorRestrictKeyboardShortcuts":{"type":"boolean","readOnly":false,"nullable":false},"proctorScreenshotPrevention":{"type":"boolean","readOnly":false,"nullable":true},"proctorAiReview":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiFlagCandidateLeftFrame":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiFlagMultiplePeopleInFrame":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiPrompts":{"type":"array","readOnly":false,"nullable":true,"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]},"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.","readOnly":false,"properties":{"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"]}]}}}}}},"emqGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"sections":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"sourceContentQuizzes":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"sourceSettingsQuiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["TagSet"]}}}}},"setupValidation":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSetupValidation"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizAttemptSetupConfig object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizAttemptSetupConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizAttemptSetupConfig"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"allowMultipleTagSelection":{"type":"boolean"},"allowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","skill","difficulty","context",null]}},"allowedLengths":{"type":"array","nullable":true,"items":{"type":"string","enum":["default","quick","medium","long","extraLong",null]}},"allowedModes":{"type":"array","nullable":true,"items":{"type":"string","enum":["practice","exam","timedExam",null]}},"allowedPlayers":{"type":"array","nullable":true,"items":{"type":"string","enum":["default","ucat","usmle",null]}},"allowedTagSets":{"type":"array","nullable":true,"items":{"type":"string"}},"deferResultsEnabled":{"type":"boolean"},"description":{"type":"string"},"excludeUntaggedQuestions":{"type":"boolean"},"inProgressAttempt":{"type":"object","additionalProperties":false,"description":"The in-progress attempt at this quiz for the requesting user, if there is one.","properties":{"id":{"type":"string"},"timeStarted":{"type":"string","format":"date-time"},"quizMode":{"type":"string","enum":["practice","exam","timedExam","test"]},"questionsAnswered":{"type":"number"},"questionsTotal":{"type":"number"},"timeSpentMs":{"type":"number","description":"Active time on the attempt in milliseconds. Omitted when none has been recorded."},"savedAt":{"type":"string","format":"date-time","description":"When the student last left this attempt. Omitted when that cannot be derived."}}},"instructionsEnabled":{"type":"boolean"},"isGenerated":{"type":"boolean"},"questionIdList":{"type":"array","items":{"type":"string"}},"sectionCount":{"type":"number"},"sectionList":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"title":{"type":"string","nullable":true},"questionCount":{"type":"number"},"instructionsEnabled":{"type":"boolean"},"timerInferFromQuestions":{"type":"boolean"},"timerDurationMs":{"type":"number","nullable":true},"instructionsTimerDurationMs":{"type":"number","nullable":true}}}},"showMasteryFilters":{"type":"boolean"},"softSectionsEnabled":{"type":"boolean"},"tagSelectionDisplayMode":{"type":"string"},"timeAllowedForInstructionsMs":{"type":"number","nullable":true,"description":"Total time allowed for all instructions, including that of any sections."},"timeAllowedForQuestionsMs":{"type":"number","nullable":true,"description":"Total time allowed for all questions in a non-sectioned quiz. Excludes instruction timers."},"timeAllowedForSectionsMs":{"type":"number","nullable":true,"description":"Total time allowed for all questions in a sectioned quiz. Excludes instruction timers."},"timeAllowedOverallMs":{"type":"number","nullable":true,"description":"Total time allowed for setup, including instruction/section/question allocations."},"timerEnabled":{"type":"boolean"},"timerEnforceFullTime":{"type":"boolean"},"timerTimeInMs":{"type":"number","nullable":true},"timerUseQuestions":{"type":"boolean"},"timerUseSections":{"type":"boolean"},"title":{"type":"string"},"totalQuestions":{"type":"number"}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The QuizEmqGroup object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizEmqGroup":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"audioInstructions":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The QuizPdfAttemptExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizPdfAttemptExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizPdfAttemptExport"]},"attributes":{"type":"object","properties":{"url":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"attempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The QuizPdfExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizPdfExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The QuizQuestionAudioRecording object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionAudioRecording":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionClozeDragAndDrop object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionClozeDragAndDrop":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionClozeDropDown object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionClozeDropDown":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionClozeText object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionClozeText":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionDrawing object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionDrawing":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizQuestionDrawing"]}}}}},"backgroundImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionFileUpload object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionFileUpload":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionFlashcard object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionFlashcard":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionFreeText object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionFreeText":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionImageHotspot object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionImageHotspot":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizQuestionImageHotspot"]}}}}},"hotspotImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionInformational object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionInformational":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionMultipleCorrect object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionMultipleCorrect":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionOffPlatform object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionOffPlatform":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionRanked object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionRanked":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionShortAnswer object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionShortAnswer":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionSingleCorrect object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionSingleCorrect":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionSpreadsheet object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionSpreadsheet":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionTrueOrFalse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionTrueOrFalse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizQuestionVideoRecording object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizQuestionVideoRecording":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizEmqGroup"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"section":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSection"]}}}}},"audioStem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"source":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizSection object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizSection":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"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"]}]}}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"outroAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"setupValidation":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSetupValidation"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The QuizSetupValidation object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizSetupValidation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The QuizTagBreakdown object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"QuizTagBreakdown":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The RelationLink object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"RelationLink":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}}}}}
```

## The Relationship object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Relationship":{"type":"object","description":"Describes a relationship object that references the related resource.","properties":{"data":{"anyOf":[{"$ref":"#/components/schemas/ResourceIdentifierObject"},{"$ref":"#/components/schemas/ResourceIdentifierArray"}]},"links":{"$ref":"#/components/schemas/RelationLink"},"meta":{"type":"object","additionalProperties":true}}},"ResourceIdentifierObject":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"$ref":"#/components/schemas/ResourceType"}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."},"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"}},"RelationLink":{"type":"object","properties":{"self":{"type":"string"},"related":{"type":"string"}}}}}}
```

## The ResourceIdentifierArray object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"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.","nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"$ref":"#/components/schemas/ResourceType"}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The ResourceIdentifierObject object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ResourceIdentifierObject":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"$ref":"#/components/schemas/ResourceType"}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The ResourceType object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The Response object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Response":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ResponseMaxPointsOverride object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ResponseMaxPointsOverride":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ResponseMaxPointsOverride"]},"attributes":{"type":"object","properties":{"maxPoints":{"type":"number","minimum":0,"nullable":true},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"response":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Response"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ScormCourse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ScormCourse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"scormFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The SearchFilterConfig object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"SearchFilterConfig":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SearchFilterConfig"]},"attributes":{"type":"object","required":["target","attribute","label","options"],"properties":{"target":{"type":"string","description":"The target resource to filter on.","readOnly":true,"enum":["AssignmentGroup","Collection","Course","Exam","LibraryItem","Tag","User","UserGroup"]},"attribute":{"type":"string","readOnly":true},"label":{"type":"string","readOnly":true},"options":{"type":"array","items":{"type":"object","required":["label","value"],"properties":{"label":{"type":"string"},"value":{"anyOf":[{"type":"string","nullable":true},{"type":"number","nullable":true},{"type":"boolean","nullable":true}]},"thumbnail":{"type":"string","description":"Optional thumbnail URL for visual display (e.g. user profile picture)."}}}},"placeholder":{"type":"string","readOnly":true},"explanation":{"type":"string","readOnly":true},"search":{"type":"object","properties":{"className":{"type":"string"},"labelPath":{"type":"string"}}},"single":{"type":"boolean","readOnly":true,"description":"Legacy: true when only one option can be selected. Prefer capabilities.cardinality."},"capabilities":{"type":"object","readOnly":true,"required":["kind","cardinality","valueEncoding"],"properties":{"kind":{"type":"string","enum":["option","text","number","date"],"description":"Input / value kind: option, text, number, or date."},"cardinality":{"type":"string","enum":["one","many"],"description":"How many values the user can pick: one or many."},"valueEncoding":{"type":"string","enum":["scalar","range"],"description":"How the value is encoded for the operator: scalar or range (e.g. for number/date ranges)."}}}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The SearchResult object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"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"}]},"Tag":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["TagSet"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"User":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"emailAddress":{"type":"string","readOnly":false},"externalId":{"type":"string","readOnly":false},"profilePicture":{"type":"object","readOnly":false,"nullable":true,"properties":{"__type":{"type":"string","enum":["File"]},"name":{"type":"string"},"url":{"type":"string","readOnly":false}}},"preferences":{"type":"object","readOnly":false},"featureRollouts":{"type":"object","readOnly":false,"additionalProperties":{"type":"string","enum":["on","off"]}},"accessibility":{"type":"object","readOnly":false,"properties":{"extraTimeMultiplier":{"type":"number","readOnly":false,"nullable":true}}},"attr":{"type":"object","readOnly":false},"timeZone":{"type":"string","readOnly":false},"notificationConfig":{"type":"object","readOnly":false},"marketingEmailsConsent":{"type":"string","readOnly":false,"nullable":true},"lastSeen":{"type":"string","readOnly":true},"emailVerified":{"type":"boolean","readOnly":true},"isDisabled":{"type":"boolean","readOnly":false},"authData":{"type":"object","readOnly":true},"firstName":{"type":"string","readOnly":true},"lastName":{"type":"string","readOnly":true},"userGroupsMetadata":{"type":"object","readOnly":true,"additionalProperties":{"type":"object","properties":{"dateJoined":{"type":"string","format":"date-time"}}}}}},"relationships":{"type":"object","properties":{"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"userAttributes":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"userGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ResourceType":{"type":"string","description":"Identifies the Resource."},"Exam-V-2":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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},"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."},"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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"markers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"moderatingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"escalatingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"auditingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"backReadingMarkers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"setupJob":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["BackgroundJob"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"publishedVersion":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"currentVersion":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}}},"UserGroup":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"userType":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserType"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}}}}}},"SubPortal":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"AssignmentGroup":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentGroup"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false,"minLength":1},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"image":{"type":"object","readOnly":false,"deprecated":true,"description":"This property is deprecated. Use the relation \"coverImage\" instead.","properties":{"url":{"type":"string"}}},"absoluteDeadline":{"type":"string","format":"date-time","readOnly":false,"nullable":true},"relativeDeadline":{"type":"string","readOnly":false,"nullable":true,"deprecated":true,"description":"This property is deprecated. Use the property \"relativeDeadlineMs\" instead."},"relativeDeadlineMs":{"type":"number","minimum":3600000,"maximum":31536000000,"readOnly":false,"nullable":true,"description":"The relative deadline in milliseconds, minimum 1 hour, maximum 1 year"},"deadlineType":{"type":"string","enum":["indefinite","absolute","relative"],"readOnly":false},"progressionType":{"type":"string","enum":["fixed-linear","flexible-linear","flexible-open"],"readOnly":false},"isReviewRequired":{"type":"boolean","readOnly":false},"isActive":{"deprecated":true,"description":"This property is deprecated. Use the property \"status\" instead.","type":"boolean","readOnly":true},"isPendingActivation":{"deprecated":true,"description":"This property is deprecated. Use the property \"status\" instead.","type":"boolean","readOnly":true},"isCompleted":{"deprecated":true,"description":"This property is deprecated. Use the property \"status\" instead.","type":"boolean","readOnly":true},"isArchived":{"type":"boolean","readOnly":false},"status":{"type":"string","readOnly":false,"enum":["inactive","pendingActivation","active","complete","cancelled","closed"],"nullable":false},"certificateTemplateId":{"type":"string","readOnly":false,"nullable":true},"certificateIgnoreSubPortalBranding":{"type":"boolean","readOnly":false,"nullable":false},"certificateShareList":{"type":"array","readOnly":false,"nullable":true,"maxItems":4,"items":{"type":"object","required":["label","urlPrefix"],"properties":{"label":{"type":"string","minLength":1,"maxLength":100},"urlPrefix":{"type":"string"}}}},"startDate":{"type":"string","nullable":true},"endDate":{"type":"string","nullable":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"sourceCourse":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"userGroup":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":false,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"reviewers":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"UserType":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"Assignment":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"course":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Course"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"folders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"certificate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Certificate"]}}}}},"certificateFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}}}}}},"Course":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"folders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"TagSet":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"Content":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"attachment":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"embedData":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["ContentEmbedDatum"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}}},"Note":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}}},"Quiz":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"title":{"type":"string","readOnly":false,"minLength":1,"maxLength":300},"attr":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"description":{"type":"string","nullable":true,"readOnly":false,"maxLength":50000},"shortDescription":{"type":"string","nullable":true,"readOnly":false,"minLength":0,"maxLength":1500},"totalQuestions":{"type":"number","nullable":false,"readOnly":true},"instructionsEnabled":{"type":"boolean","readOnly":false,"nullable":false},"instructionsTitle":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":300},"instructionsBody":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":25000},"instructionsTimerDurationMs":{"type":"number","nullable":true,"readOnly":false,"minimum":1,"maximum":86400000},"instructionsEnforcedTimer":{"type":"string","readOnly":false,"enum":["afterAudioStarts","immediately"]},"instructionsAudioAutoAdvance":{"type":"string","readOnly":false,"enum":["disabled","afterDefinedTime","immediately"]},"instructionsAudioAutoAdvanceDelayMs":{"type":"number","nullable":true,"readOnly":false,"minimum":0,"maximum":3600000},"instructionsAudioAutoPlay":{"type":"boolean","readOnly":false,"nullable":true},"instructionsDisableAudioControls":{"type":"boolean","readOnly":false,"nullable":true},"markingCreditsPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0},"markingPartialCreditsPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0},"markingPenaltiesPerQuestion":{"type":"number","nullable":true,"readOnly":false,"minimum":0},"markingPenaltiesEnabled":{"type":"boolean","nullable":true,"readOnly":false},"grades":{"type":"array","nullable":true,"items":{"type":"object","properties":{"label":{"type":"string","readOnly":false},"minScore":{"type":"number","readOnly":false},"isPass":{"type":"boolean","readOnly":false,"nullable":true},"description":{"type":"string","readOnly":false,"nullable":true},"advancedCriteria":{"type":"object","readOnly":false,"nullable":true,"properties":{"sectionRequirements":{"type":"object","readOnly":false,"nullable":true,"properties":{"type":{"type":"string","enum":["none","requiredCount","allPass","selectedPass"],"readOnly":false,"nullable":true},"count":{"type":"number","readOnly":false,"nullable":true},"sectionIds":{"type":"array","readOnly":false,"nullable":true,"items":{"type":"string","readOnly":false,"nullable":true}}}},"excludeFromResitAttempts":{"type":"boolean","readOnly":false,"nullable":true}}}}}},"allowedModes":{"type":"array","nullable":true,"items":{"type":"string","enum":["practice","exam","timedExam"]},"minItems":1,"maxItems":3},"allowedLengths":{"type":"array","items":{"type":"string","enum":["default","quick","medium","long","extraLong"]}},"allowedPlayers":{"type":"array","items":{"type":"string","enum":["default","ucat","usmle"]}},"allowedTagSets":{"type":"array","nullable":true,"items":{"type":"string"}},"allowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","skill","difficulty","context"]}},"calculatorEnabled":{"type":"boolean","readOnly":false},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"],"readOnly":false},"allowMultipleTagSelection":{"type":"boolean","readOnly":false},"excludeUntaggedQuestions":{"type":"boolean","readOnly":false},"showMasteryFilters":{"type":"boolean","readOnly":false},"calculatorType":{"type":"string","enum":["basic","scientific"]},"securityDisableCopying":{"type":"boolean","readOnly":false},"securityDisablePasting":{"type":"boolean","readOnly":false},"securityDisableRightClick":{"type":"boolean","readOnly":false},"navigationDisableNavigation":{"type":"boolean","readOnly":false},"navigationDisableControlPanel":{"type":"boolean","readOnly":false},"navigationDisableNotifications":{"type":"boolean","readOnly":false},"softSectionsEnabled":{"type":"boolean","readOnly":false},"notepadEnabled":{"type":"boolean","readOnly":false},"resizableQuestionPanelsEnabled":{"type":"boolean","readOnly":false},"strikethroughEnabled":{"type":"boolean","readOnly":false},"highlightingEnabled":{"type":"boolean","readOnly":false},"bookmarkingEnabled":{"type":"boolean","readOnly":false},"micSettingsEnabled":{"type":"boolean","readOnly":false},"labValuesEnabled":{"type":"boolean","readOnly":false},"labValuesHtml":{"type":"string","readOnly":false},"additionalInformationEnabled":{"type":"boolean","readOnly":false},"additionalInformationTitle":{"type":"string","readOnly":false,"nullable":true,"minLength":1,"maxLength":120},"additionalInformationIcon":{"type":"string","readOnly":false,"nullable":true},"additionalInformationHtml":{"type":"string","readOnly":false},"resumeLaterButtonEnabled":{"type":"boolean","readOnly":false},"flaggingEnabled":{"type":"boolean","readOnly":false},"showAvailableMarks":{"type":"boolean","readOnly":false},"playerType":{"type":"string","enum":["default","ucat","usmle"]},"theme":{"type":"string"},"fontSize":{"type":"string","enum":["xSmall","small","medium","large","xLarge"]},"pinnedMessageDuringTest":{"type":"string","nullable":true,"readOnly":false,"minLength":1,"maxLength":1500},"deferResultsEnabled":{"type":"boolean","readOnly":false},"deferResultsMessage":{"type":"string","readOnly":false,"nullable":true,"minLength":0,"maxLength":25000},"deferResultsAlwaysRelease":{"type":"boolean","readOnly":false},"whenCompleteNoGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000,"deprecated":true},"completedMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000,"deprecated":true},"resultsHideResults":{"type":"boolean","readOnly":false},"resultsGlobalHideScore":{"type":"boolean","readOnly":false},"resultsDetailedViewEnabled":{"type":"boolean","readOnly":false},"resultsOverviewWhenPassedMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenFailedHasResitsMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenFailedNoResitsMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenCompleteNoGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsOverviewWhenCompletedNeutralGradesMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessagePassed":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageFailed":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageResitsRemaining":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageNoResitsRemaining":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageCompleted":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageSettingHideTitle":{"type":"boolean","readOnly":false},"resultsHiddenMessage":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsHiddenSettingHideTitle":{"type":"boolean","readOnly":false},"resultsMetricScoreEnabled":{"type":"boolean","readOnly":false},"resultsMetricTimeSpentEnabled":{"type":"boolean","readOnly":false},"resultsMetricGradeEnabled":{"type":"boolean","readOnly":false},"resultsMetricProgressEnabled":{"type":"boolean","readOnly":false,"deprecated":true,"description":"Use resultsMetricTagProgressEnabled instead"},"resultsMetricQuestionBreakdownDisplayLevel":{"type":"string","enum":["full","hideStemAndOptions","hideCorrectOptions","incorrectOnlyHideCorrectOptions","none"],"readOnly":false},"resultsMetricAnalyticsCohort":{"type":"string","enum":["exam","test","sourceTest"]},"resultsMetricCohortAverageEnabled":{"type":"boolean","readOnly":false},"resultsMetricCohortPercentileEnabled":{"type":"boolean","readOnly":false},"resultsMetricCohortScoreDistributionEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagBreakdownEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagProgressEnabled":{"type":"boolean","readOnly":false},"resultsMetricSectionBreakdownEnabled":{"type":"boolean","readOnly":false},"resultsMetricSectionBreakdownGradeEnabled":{"type":"boolean","readOnly":false},"resultsMetricSectionBreakdownScoreEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagProgressFacetsEnabled":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"subject":{"type":"boolean","readOnly":false},"topic":{"type":"boolean","readOnly":false},"subtopic":{"type":"boolean","readOnly":false},"skill":{"type":"boolean","readOnly":false},"difficulty":{"type":"boolean","readOnly":false}}},"resultsEducatorViewAsAdminEnabled":{"type":"boolean","readOnly":false},"timerEnabled":{"type":"boolean","readOnly":false},"timerHidden":{"type":"boolean","readOnly":false},"timerUseQuestions":{"type":"boolean","readOnly":false},"timerUseSections":{"type":"boolean","readOnly":false},"timerEnforceFullTime":{"type":"boolean","readOnly":false},"timerTimeInMs":{"type":"number","nullable":true,"readOnly":false,"minimum":1,"maximum":86400000},"timerExtraTimeMultiplier":{"type":"number","readOnly":false,"nullable":true},"timerSoftTimer":{"type":"boolean","readOnly":false},"mutexLockKey":{"type":"string","readOnly":true,"nullable":true},"mutexLockExpiresAt":{"type":"string","readOnly":true,"nullable":true},"mutexLockType":{"type":"string","enum":["write","full",null],"readOnly":true,"nullable":true},"certificatesEnabled":{"type":"boolean","readOnly":false},"certificatesTemplateId":{"type":"string","nullable":true,"readOnly":false},"certificatesQrCode":{"type":"boolean","nullable":true,"readOnly":false},"certificatesTtl":{"type":"number","nullable":true,"readOnly":false},"certificatesIgnoreSubPortalBranding":{"type":"boolean","nullable":true,"readOnly":false},"certificatesIssueOnFail":{"type":"boolean","nullable":true,"readOnly":false},"certificatesResultsPage":{"type":"boolean","nullable":true,"readOnly":false},"certificatesSharingImageUrl":{"type":"string","nullable":true,"readOnly":false},"resitEnabled":{"type":"boolean","nullable":false,"readOnly":false},"resitType":{"type":"string","enum":["continuous","fixedDate","onDemand","rolling",null],"nullable":true,"readOnly":false},"resitMode":{"type":"string","enum":["standard","fixed","progressive","preferUnseen",null],"readOnly":false,"nullable":true},"resitGradeIndependent":{"type":"boolean","nullable":true,"readOnly":false},"resitAllowedAttempts":{"type":"number","nullable":true,"readOnly":false},"resitDelay":{"type":"number","nullable":true,"readOnly":false},"resitCloseDelay":{"type":"number","nullable":true,"readOnly":false},"resitScheduleActivateAt":{"type":"string","nullable":true,"readOnly":false},"resitScheduleDeactivateAt":{"type":"string","nullable":true,"readOnly":false},"proctorEnabled":{"type":"boolean","readOnly":false,"nullable":false},"proctorVendor":{"type":"string","readOnly":false,"enum":["internal","rosalyn","synopticV2",null],"nullable":true},"proctorRequireFullscreen":{"type":"boolean","readOnly":false,"nullable":false},"proctorRestrictTabs":{"type":"boolean","readOnly":false,"nullable":false},"proctorRestrictDisplays":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordSession":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordSnapshots":{"type":"boolean","readOnly":false,"nullable":false},"proctorRecordDesktop":{"type":"boolean","readOnly":false,"nullable":false},"proctorSynopticLevel":{"type":"string","readOnly":false,"nullable":false,"enum":["web","browser","desktop"]},"proctorScreenMonitoring":{"type":"string","readOnly":false,"nullable":false,"enum":["none","recreation","recreationWithSnapshots","video"]},"proctorWebcamMonitoring":{"type":"string","readOnly":false,"nullable":false,"enum":["none","snapshots","audioVideo"]},"proctorRestrictKeyboardShortcuts":{"type":"boolean","readOnly":false,"nullable":false},"proctorScreenshotPrevention":{"type":"boolean","readOnly":false,"nullable":true},"proctorAiReview":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiFlagCandidateLeftFrame":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiFlagMultiplePeopleInFrame":{"type":"boolean","readOnly":false,"nullable":false},"proctorAiPrompts":{"type":"array","readOnly":false,"nullable":true,"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]},"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.","readOnly":false,"properties":{"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"]}]}}}}}},"emqGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"sections":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"sourceContentQuizzes":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"sourceSettingsQuiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["TagSet"]}}}}},"setupValidation":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizSetupValidation"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}}},"ScormCourse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"scormFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}}},"Survey":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"pages":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}}},"Collection":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false,"nullable":false,"minLength":1},"description":{"type":"string","readOnly":false,"nullable":true},"shortDescription":{"type":"string","readOnly":false,"nullable":true},"settings":{"type":"object","deprecated":true,"properties":{"takeTest":{"type":"object","additionalProperties":true},"playerView":{"type":"object","properties":{"enabled":{"type":"boolean"},"hideOverviewPage":{"type":"boolean"}}},"trackedProgress":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"annotations":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"export":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"generatedAttempts":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"mocks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string","nullable":true},"filters":{"type":"object","additionalProperties":true},"quizLength":{"type":"number","minimum":1},"passScore":{"type":"number","minimum":0,"maximum":100,"nullable":true},"examSittingAttrs":{"type":"object","additionalProperties":true}}}},"restrictedAccess":{"type":"object","properties":{"label":{"type":"string"}}},"sorting":{"type":"object","properties":{"prioritise":{"type":"boolean"}}}}},"attr":{"type":"object","readOnly":false,"nullable":true},"extraInformation":{"type":"object","readOnly":false,"nullable":true,"additionalProperties":true},"isArchived":{"type":"boolean","readOnly":false,"nullable":true},"generatedAttemptsEnabled":{"type":"boolean","readOnly":false},"mocks":{"type":"array","nullable":true,"items":{"type":"object","required":["id","filters","quizLength"],"properties":{"id":{"type":"string"},"title":{"type":"string","nullable":true,"minLength":1,"maxLength":120},"filters":{"type":"object","additionalProperties":true,"properties":{"weightingType":{"type":"string","enum":["absolute","percentage"]},"filterRules":{"type":"array","minItems":0,"maxItems":125,"description":"Array of filter rules to apply to the dynamic quiz content.","items":{"type":"object","properties":{"weighting":{"type":"number"},"matchingRules":{"type":"array","minItems":0,"maxItems":20,"description":"Array of matching rules to apply to the filter rule. Each rule will be treated as an AND operation. Matching rules can not be a mix of tag and EMQ rules.","items":{"anyOf":[{"type":"object","required":["tagId"],"description":"A single filter rule to be applied as part of an AND operation","properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}},{"type":"array","minItems":1,"maxItems":150,"description":"An array of OR filter rules to be applied as part of a single operation or AND operation","items":{"type":"object","required":["tagId"],"properties":{"tagId":{"type":"string","minLength":5,"maxLength":32},"exclude":{"type":"boolean"}}}}]}}}}}}},"quizLength":{"type":"number","minimum":1},"passScore":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"examSittingAttrs":{"type":"object","nullable":true,"additionalProperties":true},"timeInMs":{"type":"number","nullable":true,"minimum":1}}}},"annotationsEnabled":{"type":"boolean","readOnly":false},"exportEnabled":{"type":"boolean","readOnly":false},"playerViewEnabled":{"type":"boolean","readOnly":false},"playerViewHideOverviewPage":{"type":"boolean","readOnly":false},"restrictedAccessLabel":{"type":"string","readOnly":false,"nullable":true},"sortingPrioritise":{"type":"boolean","readOnly":false},"takeTestSettings":{"type":"object","nullable":true,"additionalProperties":true,"deprecated":true,"description":"deprecated, use top level setting fields instead"},"allowedModes":{"type":"array","nullable":true,"items":{"type":"string","enum":["practice","exam","timedExam"]},"minItems":1,"maxItems":3},"allowedLengths":{"type":"array","items":{"type":"string","enum":["default","quick","medium","long","extraLong"]}},"allowedPlayers":{"type":"array","items":{"type":"string","enum":["default","ucat","usmle"]}},"allowedTagSets":{"type":"array","nullable":true,"items":{"type":"string"}},"allowedFacets":{"type":"array","nullable":true,"items":{"type":"string","enum":["subject","topic","subtopic","skill","difficulty","context"]}},"calculatorEnabled":{"type":"boolean","readOnly":false},"tagSelectionDisplayMode":{"type":"string","enum":["dropdown","toggle"],"readOnly":false},"allowMultipleTagSelection":{"type":"boolean","readOnly":false},"excludeUntaggedQuestions":{"type":"boolean","readOnly":false},"showMasteryFilters":{"type":"boolean","readOnly":false},"calculatorType":{"type":"string","enum":["basic","scientific"]},"notepadEnabled":{"type":"boolean","readOnly":false},"strikethroughEnabled":{"type":"boolean","readOnly":false},"highlightingEnabled":{"type":"boolean","readOnly":false},"bookmarkingEnabled":{"type":"boolean","readOnly":false},"labValuesEnabled":{"type":"boolean","readOnly":false},"labValuesHtml":{"type":"string","readOnly":false},"flaggingEnabled":{"type":"boolean","readOnly":false},"resultsMessageCompleted":{"type":"string","nullable":true,"readOnly":false,"maxLength":25000},"resultsMessageSettingHideTitle":{"type":"boolean","readOnly":false},"resultsMetricScoreEnabled":{"type":"boolean","readOnly":false},"resultsMetricTimeSpentEnabled":{"type":"boolean","readOnly":false},"resultsMetricGradeEnabled":{"type":"boolean","readOnly":false},"resultsMetricQuestionBreakdownDisplayLevel":{"type":"string","enum":["full","hideStemAndOptions","hideCorrectOptions","incorrectOnlyHideCorrectOptions","none"],"readOnly":false},"resultsMetricAnalyticsCohort":{"type":"string","enum":["exam","test","sourceTest"]},"resultsMetricCohortAverageEnabled":{"type":"boolean","readOnly":false},"resultsMetricCohortPercentileEnabled":{"type":"boolean","readOnly":false},"resultsMetricCohortScoreDistributionEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagBreakdownEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagProgressEnabled":{"type":"boolean","readOnly":false},"resultsMetricTagProgressFacetsEnabled":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"subject":{"type":"boolean","readOnly":false},"topic":{"type":"boolean","readOnly":false},"subtopic":{"type":"boolean","readOnly":false},"skill":{"type":"boolean","readOnly":false},"difficulty":{"type":"boolean","readOnly":false}}},"resultsEducatorViewAsAdminEnabled":{"type":"boolean","readOnly":false},"trackedProgressEnabled":{"type":"boolean","readOnly":false},"accessLevel":{"type":"string","enum":["editor","none","full","restricted"],"readOnly":true},"totalItems":{"type":"number","readOnly":true}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"lockedItems":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"folders":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"icon":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"collectionAccess":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"instructionsAudio":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"CollectionItemQuiz":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"folder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionFolder"]}}}}},"subFolder":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["CollectionSubFolder"]}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"quizAttemptSetupConfig":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["QuizAttemptSetupConfig"]}}}}}}}}}}}}
```

## The SessionContext object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"SessionContext":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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."},"regionalApiUrl":{"type":"string","readOnly":true,"description":"Region specific API endpoint."},"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"userType":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserType"]}}}}},"studyType":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserType"]}}}}},"pinnedNotes":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The StoreOffer object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"StoreOffer":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Study object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Study":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"latestAttempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The StudyItem object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"StudyItem":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"quiz":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Quiz"]}}}}},"collection":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Collection"]}}}}},"study":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Study"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The SubPortal object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"SubPortal":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Subscription object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Subscription":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Product"]}}}}},"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Survey object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Survey":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"pages":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUsers":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}},"collaboratingUserGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The SurveyItem object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"SurveyItem":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SurveyPage"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The SurveyPage object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"SurveyPage":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":true,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Survey"]}}}}},"items":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The SurveyResponse object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"SurveyResponse":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Survey"]}}}}},"assignmentItem":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AssignmentItemSurvey"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The SynopticAiReview object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"SynopticAiReview":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SynopticSession"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The SynopticCapture object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"SynopticCapture":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SynopticSession"]}}}}},"file":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The SynopticDomRecording object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"SynopticDomRecording":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SynopticSession"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The SynopticEventLog object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"SynopticEventLog":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SynopticSession"]}}}}},"sender":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The SynopticSession object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"SynopticSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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"},"recordingStartedAt":{"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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}},"candidate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"desktopFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"avFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"maskFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"avPeaksFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}},"legacyDomRecordingFile":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The SynopticWatchToken object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"SynopticWatchToken":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SynopticSession"]}}}}},"iceCandidate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["IceCandidate"]}}}}},"candidate":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Tag object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Tag":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"tagSet":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["TagSet"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The TagSet object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"TagSet":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"tags":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The Template object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Template":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Template"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"htmlTemplate":{"type":"string","readOnly":true},"isDefault":{"type":"boolean","readOnly":true},"orientation":{"type":"string","readOnly":true,"enum":["portrait","landscape"]},"preview":{"type":"object","readOnly":true,"properties":{"svg":{"type":"string"},"image":{"type":"string"}}}}},"relationships":{"type":"object","properties":{"owner":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Test object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Test":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"questions":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"coverImage":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Image"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The TipSuggestion object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"TipSuggestion":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The Token object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"Token":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Token"]},"attributes":{"type":"object","properties":{"type":{"type":"string","readOnly":true,"enum":["closeAccount","checkoutSession","oidcState","verifyEmail","lti1p1Launch","lti1p3DeepLink"]}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The TransactionalEmail object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"TransactionalEmail":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["TransactionalEmail"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"toEmail":{"type":"string","readOnly":true},"success":{"type":"boolean","readOnly":true},"recipientData":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"}}},"readOnly":true},"globalData":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"content":{"type":"string"}}},"readOnly":true},"templateName":{"type":"string","readOnly":true},"error":{"type":"string","readOnly":true},"subject":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true},"fromName":{"type":"string","readOnly":true},"fromEmail":{"type":"string","readOnly":true}}},"relationships":{"type":"object","properties":{"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]}}}}},"toUser":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"sendingUser":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The UnauthorizedApiError object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UnauthorizedApiError":{"type":"object","description":"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"}}}}}}}}
```

## The UrlLink object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UrlLink":{"type":"object","description":"This field should be a valid Link.","nullable":true}}}}
```

## The UrlString object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UrlString":{"type":"string","description":"This field should be a valid URL."}}}}
```

## The User object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"User":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]},"attributes":{"type":"object","properties":{"createdAt":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"emailAddress":{"type":"string","readOnly":false},"externalId":{"type":"string","readOnly":false},"profilePicture":{"type":"object","readOnly":false,"nullable":true,"properties":{"__type":{"type":"string","enum":["File"]},"name":{"type":"string"},"url":{"type":"string","readOnly":false}}},"preferences":{"type":"object","readOnly":false},"featureRollouts":{"type":"object","readOnly":false,"additionalProperties":{"type":"string","enum":["on","off"]}},"accessibility":{"type":"object","readOnly":false,"properties":{"extraTimeMultiplier":{"type":"number","readOnly":false,"nullable":true}}},"attr":{"type":"object","readOnly":false},"timeZone":{"type":"string","readOnly":false},"notificationConfig":{"type":"object","readOnly":false},"marketingEmailsConsent":{"type":"string","readOnly":false,"nullable":true},"lastSeen":{"type":"string","readOnly":true},"emailVerified":{"type":"boolean","readOnly":true},"isDisabled":{"type":"boolean","readOnly":false},"authData":{"type":"object","readOnly":true},"firstName":{"type":"string","readOnly":true},"lastName":{"type":"string","readOnly":true},"userGroupsMetadata":{"type":"object","readOnly":true,"additionalProperties":{"type":"object","properties":{"dateJoined":{"type":"string","format":"date-time"}}}}}},"relationships":{"type":"object","properties":{"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"userAttributes":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"userGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The UserAccount object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserAccount":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The UserAttribute object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserAttribute":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["AttributeConfig"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The UserEngagement object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserEngagement":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"portal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Portal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The UserGroup object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserGroup":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}},"userType":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserType"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The UserGroupExport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserGroupExport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The UserGroupLink object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserGroupLink":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The UserGroupLinkAccess object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserGroupLinkAccess":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroupLink"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The UserGroupLinkSettings object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserGroupLinkSettings":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The UserGroupLinkValidation object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserGroupLinkValidation":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroupLink"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The UserImport object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserImport":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserGroup"]}}}}},"csv":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["File"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The UserPassword object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserPassword":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserPassword"]},"attributes":{"type":"object","properties":{"oldPassword":{"type":"string"},"newPassword":{"type":"string"}}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The UserRegistration object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserRegistration":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserRegistration"]},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"emailAddress":{"type":"string","readOnly":true},"password":{"type":"string","readOnly":true,"description":"Minimum 8 characters; 1 upper, 1 lower and 1 digit"},"registrationSource":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["self","externalAuth"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["generated"]},"token":{"type":"string"}}},{"type":"object","required":["type","inviteId"],"properties":{"type":{"type":"string","enum":["invite"]},"inviteId":{"type":"string"}}},{"type":"object","required":["type","productId"],"properties":{"type":{"type":"string","enum":["product"]},"productId":{"type":"string"}}},{"type":"object","required":["type","code"],"properties":{"type":{"type":"string","enum":["examVoucher"]},"code":{"type":"string"}}}]},"welcomeEmailDisabled":{"type":"boolean","readOnly":true,"description":"If true the welcome email will not be sent."},"welcomeEmailCustomMessage":{"type":"string","readOnly":true,"nullable":true,"description":"Custom message to include in generated account notifications"},"marketingEmailsConsent":{"type":"string","readOnly":true,"nullable":true},"locale":{"type":"string","enum":["en","en-GB","de-DE","el-GR","es-ES","fr-FR","it-IT","ja-JP","nl-NL","pt-BR","pt-PT","zh-CN","nb-NO","sl-SI","ar-SA","th-TH","hr-HR","ru-RU","id-ID","lv-LV","et-EE","pl-PL","sq-AL","cy-GB","vi-VN"],"readOnly":true,"nullable":true},"fontSize":{"type":"string","readOnly":true,"nullable":true,"enum":["xSmall","small","medium","large","xLarge"]},"extraTimeMultiplier":{"type":"number","readOnly":true,"nullable":true,"description":"Extra time multiplier for the user (e.g. 1.5 for 50% extra time)"},"timeZone":{"type":"string","readOnly":true,"nullable":true,"description":"IANA Time Zone Format (e.g. Europe/Rome)"},"attr":{"type":"object","readOnly":true,"nullable":true},"utm":{"type":"object","readOnly":true,"nullable":true},"externalId":{"type":"string","readOnly":true,"nullable":true,"description":"External identifier for the user"},"allowInauthenticEmails":{"type":"boolean","readOnly":true,"description":"When true and emailAddress is omitted, a placeholder email is generated from externalId. Only valid for generated accounts. Requires externalId."},"signUpSource":{"type":"string","enum":["Web","Mobile","API"],"readOnly":true,"deprecated":true,"description":"Deprecated. This value will be ignored. This field will be removed in the future."},"registration":{"type":"object","readOnly":true,"nullable":true,"deprecated":true,"description":"Deprecated. Use registrationSource | welcomeEmailDisabled instead. This field will be removed in the future."},"preferences":{"type":"object","readOnly":true,"nullable":true,"deprecated":true,"description":"Deprecated. Use locale | fontSize instead. This field will be removed in the future."}}},"relationships":{"type":"object","properties":{"userGroups":{"type":"object","description":"This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.","readOnly":false,"properties":{"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"]}]}}}}}},"subPortal":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["SubPortal"]}}}}},"generatedAttempt":{"type":"object","description":"This is a resource linkage for a to-one relationship. It is like a Parse Pointer.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["Attempt"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."},"ResourceType":{"type":"string","description":"Identifies the Resource."}}}}
```

## The UserSession object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserSession":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["UserSession"]},"attributes":{"type":"object","properties":{}},"relationships":{"type":"object","properties":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The UserStats object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserStats":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["User"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The UserType object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"UserType":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The WebhookDelivery object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"WebhookDelivery":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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.","readOnly":false,"properties":{"data":{"type":"object","required":["id","type"],"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","enum":["WebhookSubscription"]}}}}}}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The WebhookSamplePayload object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"WebhookSamplePayload":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The WebhookSubscription object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"WebhookSubscription":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```

## The ZapierApiKey object

```json
{"openapi":"3.0.1","info":{"title":"Synap API","version":"3.0.0"},"components":{"schemas":{"ZapierApiKey":{"type":"object","required":["id","type"],"properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","description":"Identifies the Resource.","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":{}}}},"ObjectId":{"type":"string","description":"The primary key for each resource."}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://synap.ac/docs/api/reference/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.