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

# Models

## The AboutModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"AboutModel":{"type":"object","properties":{"Heading":{"type":"string","nullable":true},"Body":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The AchievementMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"AchievementMatch":{"type":"object","properties":{"AchievementId":{"type":"string","format":"uuid"},"AchievementTitle":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The AchievementModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"AchievementModel":{"type":"object","properties":{"AchievementId":{"type":"string","format":"uuid"},"AchievementAllowSelfDeclared":{"type":"boolean"},"AchievementIsEnabled":{"type":"boolean"},"AchievementReportingDisabled":{"type":"boolean"},"HasBadgeImage":{"type":"boolean","nullable":true},"AchievementDescription":{"type":"string","nullable":true},"AchievementLabel":{"type":"string","nullable":true},"AchievementTitle":{"type":"string","nullable":true},"AchievementType":{"type":"string","nullable":true},"BadgeImageUrl":{"type":"string","nullable":true},"CertificateLayoutCode":{"type":"string","nullable":true},"ExpirationLifetimeUnit":{"type":"string","nullable":true},"ExpirationType":{"type":"string","nullable":true},"ExpirationLifetimeQuantity":{"type":"integer","format":"int32","nullable":true},"ExpirationFixedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The AttemptMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"AttemptMatch":{"type":"object","properties":{"AttemptId":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The AttemptModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"AttemptModel":{"type":"object","properties":{"AttemptId":{"type":"string","format":"uuid"},"AttemptNumber":{"type":"integer","format":"int32"},"FormCode":{"type":"string","nullable":true},"FormId":{"type":"string","format":"uuid"},"FormName":{"type":"string","nullable":true},"RegistrationId":{"type":"string","format":"uuid","nullable":true},"AssessorUserId":{"type":"string","format":"uuid"},"GradingAssessorUserId":{"type":"string","format":"uuid","nullable":true},"LearnerUserId":{"type":"string","format":"uuid"},"AttemptGrade":{"type":"string","nullable":true},"AttemptIsPassing":{"type":"boolean"},"AttemptStatus":{"type":"string","nullable":true},"AttemptTag":{"type":"string","nullable":true},"AttemptDuration":{"type":"number","format":"double","nullable":true},"AttemptPoints":{"type":"number","format":"double","nullable":true},"AttemptScore":{"type":"number","format":"double","nullable":true},"FormPoints":{"type":"number","format":"double","nullable":true},"ActiveQuestionIndex":{"type":"integer","format":"int32","nullable":true},"ActiveSectionIndex":{"type":"integer","format":"int32","nullable":true},"FormSectionsCount":{"type":"integer","format":"int32","nullable":true},"SectionsAsTabsEnabled":{"type":"boolean"},"SingleQuestionPerTabEnabled":{"type":"boolean"},"TabNavigationEnabled":{"type":"boolean"},"TabTimeLimit":{"type":"string","nullable":true},"AttemptLanguage":{"type":"string","nullable":true},"AttemptPingInterval":{"type":"integer","format":"int32","nullable":true},"AttemptTimeLimit":{"type":"integer","format":"int32","nullable":true},"UserAgent":{"type":"string","nullable":true},"AttemptGraded":{"type":"string","format":"date-time","nullable":true},"AttemptImported":{"type":"string","format":"date-time","nullable":true},"AttemptPinged":{"type":"string","format":"date-time","nullable":true},"AttemptStarted":{"type":"string","format":"date-time","nullable":true},"AttemptSubmitted":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The BankMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"BankMatch":{"type":"object","properties":{"BankId":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The BankModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"BankModel":{"type":"object","properties":{"BankId":{"type":"string","format":"uuid"},"DepartmentId":{"type":"string","format":"uuid","nullable":true},"FrameworkId":{"type":"string","format":"uuid","nullable":true},"IsActive":{"type":"boolean"},"BankEdition":{"type":"string","nullable":true},"BankLevel":{"type":"string","nullable":true},"BankName":{"type":"string","nullable":true},"BankStatus":{"type":"string","nullable":true},"BankTitle":{"type":"string","nullable":true},"BankType":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"AssetNumber":{"type":"integer","format":"int32"},"AttachmentCount":{"type":"integer","format":"int32"},"BankSize":{"type":"integer","format":"int32"},"CommentCount":{"type":"integer","format":"int32"},"FormCount":{"type":"integer","format":"int32"},"OptionCount":{"type":"integer","format":"int32"},"QuestionCount":{"type":"integer","format":"int32"},"SetCount":{"type":"integer","format":"int32"},"SpecCount":{"type":"integer","format":"int32"},"LastChangeTime":{"type":"string","format":"date-time"}},"additionalProperties":false}}}}
```

## The BlockContentModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"BlockContentModel":{"type":"object","properties":{"BlockId":{"type":"string","format":"uuid"},"BlockIdNumber":{"type":"integer","format":"int32","nullable":true},"BlockType":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Hook":{"type":"string","nullable":true},"Content":{"$ref":"#/components/schemas/ContentContainer"}},"additionalProperties":false},"ContentContainer":{"type":"object","properties":{"Count":{"type":"integer","format":"int32","readOnly":true},"IsEmpty":{"type":"boolean","readOnly":true},"HasItems":{"type":"boolean","readOnly":true},"IsLoaded":{"type":"boolean"},"Languages":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"Title":{"$ref":"#/components/schemas/ContentContainerItem"},"Summary":{"$ref":"#/components/schemas/ContentContainerItem"},"Description":{"$ref":"#/components/schemas/ContentContainerItem"},"Feedback":{"$ref":"#/components/schemas/ContentContainerItem"},"FeedbackWhenNotSelected":{"$ref":"#/components/schemas/ContentContainerItem"},"Hint":{"$ref":"#/components/schemas/ContentContainerItem"},"Body":{"$ref":"#/components/schemas/ContentContainerItem"}},"additionalProperties":false},"ContentContainerItem":{"type":"object","properties":{"Text":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"Html":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"Snip":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"IsEmpty":{"type":"boolean","readOnly":true},"HasItems":{"type":"boolean","readOnly":true},"Languages":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"Key":{"type":"string","nullable":true},"Value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BreadcrumbModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"BreadcrumbModel":{"type":"object","properties":{"Text":{"type":"string","nullable":true},"Url":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CaseMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CaseMatch":{"type":"object","properties":{"CaseId":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The CaseModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CaseModel":{"type":"object","properties":{"AdministratorUserId":{"type":"string","format":"uuid","nullable":true},"EmployerGroupId":{"type":"string","format":"uuid","nullable":true},"CaseClosedBy":{"type":"string","format":"uuid","nullable":true},"CaseId":{"type":"string","format":"uuid"},"CaseOpenedBy":{"type":"string","format":"uuid","nullable":true},"CaseStatusId":{"type":"string","format":"uuid","nullable":true},"LastChangeUser":{"type":"string","format":"uuid"},"LawyerUserId":{"type":"string","format":"uuid","nullable":true},"OwnerUserId":{"type":"string","format":"uuid","nullable":true},"ResponseSessionId":{"type":"string","format":"uuid","nullable":true},"TopicUserId":{"type":"string","format":"uuid","nullable":true},"CaseDescription":{"type":"string","nullable":true},"CaseSource":{"type":"string","nullable":true},"CaseStatusCategory":{"type":"string","nullable":true},"CaseTitle":{"type":"string","nullable":true},"CaseType":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"AttachmentCount":{"type":"integer","format":"int32"},"CommentCount":{"type":"integer","format":"int32"},"GroupCount":{"type":"integer","format":"int32"},"CaseNumber":{"type":"integer","format":"int32"},"PersonCount":{"type":"integer","format":"int32"},"CaseClosed":{"type":"string","format":"date-time","nullable":true},"CaseOpened":{"type":"string","format":"date-time"},"CaseReported":{"type":"string","format":"date-time","nullable":true},"CaseStatusEffective":{"type":"string","format":"date-time","nullable":true},"LastChangeTime":{"type":"string","format":"date-time"}},"additionalProperties":false}}}}
```

## The CaseStatusMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CaseStatusMatch":{"type":"object","properties":{"StatusId":{"type":"string","format":"uuid"},"StatusName":{"type":"string","nullable":true},"CaseType":{"type":"string","nullable":true},"StatusCategory":{"type":"string","nullable":true},"StatusSequence":{"type":"integer","format":"int32"}},"additionalProperties":false}}}}
```

## The CaseStatusModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CaseStatusModel":{"type":"object","properties":{"CaseType":{"type":"string","nullable":true},"StatusId":{"type":"string","format":"uuid"},"StatusName":{"type":"string","nullable":true},"StatusSequence":{"type":"integer","format":"int32"},"StatusCategory":{"type":"string","nullable":true},"ReportCategory":{"type":"string","nullable":true},"StatusDescription":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CollectAchievements object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectAchievements":{"type":"object","properties":{"AchievementTitle":{"type":"string","nullable":true},"ExpirationFixedDateSince":{"type":"string","format":"date-time","nullable":true},"ExpirationFixedDateBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectAttempts object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectAttempts":{"type":"object","properties":{"AttemptStatus":{"type":"string","nullable":true},"AttemptGradedSince":{"type":"string","format":"date-time","nullable":true},"AttemptGradedBefore":{"type":"string","format":"date-time","nullable":true},"AttemptImportedSince":{"type":"string","format":"date-time","nullable":true},"AttemptImportedBefore":{"type":"string","format":"date-time","nullable":true},"AttemptPingedSince":{"type":"string","format":"date-time","nullable":true},"AttemptPingedBefore":{"type":"string","format":"date-time","nullable":true},"AttemptStartedSince":{"type":"string","format":"date-time","nullable":true},"AttemptStartedBefore":{"type":"string","format":"date-time","nullable":true},"AttemptSubmittedSince":{"type":"string","format":"date-time","nullable":true},"AttemptSubmittedBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectBanks object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectBanks":{"type":"object","properties":{"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"IsActive":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The CollectCaseStatuses object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectCaseStatuses":{"type":"object","properties":{"CaseTypeContains":{"type":"string","nullable":true},"CaseTypeExact":{"type":"string","nullable":true},"StatusNameContains":{"type":"string","nullable":true},"StatusNameExact":{"type":"string","nullable":true},"StatusCategoryContains":{"type":"string","nullable":true},"StatusCategoryExact":{"type":"string","nullable":true},"ReportCategoryContains":{"type":"string","nullable":true},"ReportCategoryExact":{"type":"string","nullable":true},"StatusSequenceSince":{"type":"integer","format":"int32","nullable":true},"StatusSequenceBefore":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false}}}}
```

## The CollectCases object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectCases":{"type":"object","properties":{"CaseClosedSince":{"type":"string","format":"date-time","nullable":true},"CaseClosedBefore":{"type":"string","format":"date-time","nullable":true},"CaseOpenedSince":{"type":"string","format":"date-time","nullable":true},"CaseOpenedBefore":{"type":"string","format":"date-time","nullable":true},"CaseReportedSince":{"type":"string","format":"date-time","nullable":true},"CaseReportedBefore":{"type":"string","format":"date-time","nullable":true},"CaseStatusEffectiveSince":{"type":"string","format":"date-time","nullable":true},"CaseStatusEffectiveBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectCourses object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectCourses":{"type":"object","properties":{"ClosedSince":{"type":"string","format":"date-time","nullable":true},"ClosedBefore":{"type":"string","format":"date-time","nullable":true},"CreatedSince":{"type":"string","format":"date-time","nullable":true},"CreatedBefore":{"type":"string","format":"date-time","nullable":true},"ModifiedSince":{"type":"string","format":"date-time","nullable":true},"ModifiedBefore":{"type":"string","format":"date-time","nullable":true},"IsPublished":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The CollectCredentials object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectCredentials":{"type":"object","properties":{"AchievementId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid","nullable":true},"ModifiedFrom":{"type":"string","format":"date-time","nullable":true},"ModifiedBefore":{"type":"string","format":"date-time","nullable":true},"PersonCode":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CollectEvents object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectEvents":{"type":"object","properties":{"DistributionExpectedSince":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedBefore":{"type":"string","format":"date-time","nullable":true},"DistributionOrderedSince":{"type":"string","format":"date-time","nullable":true},"DistributionOrderedBefore":{"type":"string","format":"date-time","nullable":true},"DistributionShippedSince":{"type":"string","format":"date-time","nullable":true},"DistributionShippedBefore":{"type":"string","format":"date-time","nullable":true},"DistributionTrackedSince":{"type":"string","format":"date-time","nullable":true},"DistributionTrackedBefore":{"type":"string","format":"date-time","nullable":true},"EventScheduledEndSince":{"type":"string","format":"date-time","nullable":true},"EventScheduledEndBefore":{"type":"string","format":"date-time","nullable":true},"EventScheduledStartSince":{"type":"string","format":"date-time","nullable":true},"EventScheduledStartBefore":{"type":"string","format":"date-time","nullable":true},"ExamMaterialReturnShipmentReceivedSince":{"type":"string","format":"date-time","nullable":true},"ExamMaterialReturnShipmentReceivedBefore":{"type":"string","format":"date-time","nullable":true},"ExamStartedSince":{"type":"string","format":"date-time","nullable":true},"ExamStartedBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationDeadlineSince":{"type":"string","format":"date-time","nullable":true},"RegistrationDeadlineBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationLockedSince":{"type":"string","format":"date-time","nullable":true},"RegistrationLockedBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationStartSince":{"type":"string","format":"date-time","nullable":true},"RegistrationStartBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectFiles object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectFiles":{"type":"object","properties":{"ObjectId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid","nullable":true},"FileIds":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"ObjectTypeExact":{"type":"string","nullable":true},"ObjectIdentifierContains":{"type":"string","nullable":true},"FileNameContains":{"type":"string","nullable":true},"DocumentNameContains":{"type":"string","nullable":true},"FileUploadedSince":{"type":"string","format":"date-time","nullable":true},"FileUploadedBefore":{"type":"string","format":"date-time","nullable":true},"HasClaims":{"type":"boolean","nullable":true},"FileTag":{"$ref":"#/components/schemas/FileTag"}},"additionalProperties":false},"FileTag":{"enum":["PersonImport"],"type":"string"}}}}
```

## The CollectForms object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectForms":{"type":"object","properties":{"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"SurveyFormClosedSince":{"type":"string","format":"date-time","nullable":true},"SurveyFormClosedBefore":{"type":"string","format":"date-time","nullable":true},"SurveyFormLockedSince":{"type":"string","format":"date-time","nullable":true},"SurveyFormLockedBefore":{"type":"string","format":"date-time","nullable":true},"SurveyFormOpenedSince":{"type":"string","format":"date-time","nullable":true},"SurveyFormOpenedBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectGradebooks object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectGradebooks":{"type":"object","properties":{"AchievementId":{"type":"string","format":"uuid","nullable":true},"ClassId":{"type":"string","format":"uuid","nullable":true},"ClassInstructorId":{"type":"string","format":"uuid","nullable":true},"FrameworkId":{"type":"string","format":"uuid","nullable":true},"PeriodId":{"type":"string","format":"uuid","nullable":true},"IsLocked":{"type":"boolean","nullable":true},"ClassTitle":{"type":"string","nullable":true},"GradebookTitle":{"type":"string","nullable":true},"GradebookType":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"Reference":{"type":"string","nullable":true},"ClassStartedSince":{"type":"string","format":"date-time","nullable":true},"ClassStartedBefore":{"type":"string","format":"date-time","nullable":true},"GradebookCreatedSince":{"type":"string","format":"date-time","nullable":true},"GradebookCreatedBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectGroups object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectGroups":{"type":"object","properties":{"GroupCode":{"type":"string","nullable":true},"GroupCreatedSince":{"type":"string","format":"date-time","nullable":true},"GroupCreatedBefore":{"type":"string","format":"date-time","nullable":true},"GroupExpirySince":{"type":"string","format":"date-time","nullable":true},"GroupExpiryBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectMemberships object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectMemberships":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid","nullable":true},"AccountScope":{"type":"string","nullable":true},"MembershipEffectiveSince":{"type":"string","format":"date-time","nullable":true},"MembershipEffectiveBefore":{"type":"string","format":"date-time","nullable":true},"MembershipExpirySince":{"type":"string","format":"date-time","nullable":true},"MembershipExpiryBefore":{"type":"string","format":"date-time","nullable":true},"ModifiedSince":{"type":"string","format":"date-time","nullable":true},"ModifiedBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectPages object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectPages":{"type":"object","properties":{"ObjectId":{"type":"string","format":"uuid","nullable":true},"ParentPageId":{"type":"string","format":"uuid","nullable":true},"SiteId":{"type":"string","format":"uuid","nullable":true},"IsAccessDenied":{"type":"boolean","nullable":true},"IsHidden":{"type":"boolean","nullable":true},"IsNewTab":{"type":"boolean","nullable":true},"IsNullNavigateUrl":{"type":"boolean","nullable":true},"AuthorName":{"type":"string","nullable":true},"ContentControl":{"type":"string","nullable":true},"ContentLabels":{"type":"string","nullable":true},"Hook":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"NavigateUrl":{"type":"string","nullable":true},"ObjectType":{"type":"string","nullable":true},"PageIcon":{"type":"string","nullable":true},"PageSlug":{"type":"string","nullable":true},"PageType":{"type":"string","nullable":true},"ParentPageSlug":{"type":"string","nullable":true},"ParentPageType":{"type":"string","nullable":true},"SiteDomain":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Sequence":{"type":"integer","format":"int32","nullable":true},"AuthorDateSince":{"type":"string","format":"date-time","nullable":true},"AuthorDateBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectPendingPeople object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectPendingPeople":{"type":"object","properties":{"SubmittedBy":{"type":"string","format":"uuid","nullable":true},"PersonCode":{"type":"string","nullable":true},"UserEmail":{"type":"string","nullable":true},"UserFirstName":{"type":"string","nullable":true},"UserLastName":{"type":"string","nullable":true},"SubmittedBefore":{"type":"string","format":"date-time","nullable":true},"SubmittedSince":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectPeople object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectPeople":{"type":"object","properties":{"UserId":{"type":"string","format":"uuid","nullable":true},"EmailExact":{"type":"string","nullable":true},"EmailLike":{"type":"string","nullable":true},"EventRole":{"type":"string","nullable":true},"FullName":{"type":"string","nullable":true},"PersonCode":{"type":"string","nullable":true},"FirstNameExact":{"type":"string","nullable":true},"LastNameExact":{"type":"string","nullable":true},"LastAuthenticatedSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"IsApproved":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The CollectPeriods object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectPeriods":{"type":"object","properties":{"Name":{"type":"string","nullable":true},"EndSince":{"type":"string","format":"date-time","nullable":true},"EndBefore":{"type":"string","format":"date-time","nullable":true},"StartSince":{"type":"string","format":"date-time","nullable":true},"StartBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectRegistrations object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectRegistrations":{"type":"object","properties":{"AttendanceTakenSince":{"type":"string","format":"date-time","nullable":true},"AttendanceTakenBefore":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedSince":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedBefore":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdatedSince":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdatedBefore":{"type":"string","format":"date-time","nullable":true},"GradeAssignedSince":{"type":"string","format":"date-time","nullable":true},"GradeAssignedBefore":{"type":"string","format":"date-time","nullable":true},"GradePublishedSince":{"type":"string","format":"date-time","nullable":true},"GradePublishedBefore":{"type":"string","format":"date-time","nullable":true},"GradeReleasedSince":{"type":"string","format":"date-time","nullable":true},"GradeReleasedBefore":{"type":"string","format":"date-time","nullable":true},"GradeWithheldSince":{"type":"string","format":"date-time","nullable":true},"GradeWithheldBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOnSince":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOnBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectSites object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectSites":{"type":"object","properties":{"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectStandards object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectStandards":{"type":"object","properties":{"ParentStandardId":{"type":"string","format":"uuid","nullable":true},"ParentStandardIds":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"StandardIds":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"ContentTitle":{"type":"string","nullable":true},"StandardType":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CollectSubmissions object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectSubmissions":{"type":"object","properties":{"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"ResponseSessionCompletedSince":{"type":"string","format":"date-time","nullable":true},"ResponseSessionCompletedBefore":{"type":"string","format":"date-time","nullable":true},"ResponseSessionCreatedSince":{"type":"string","format":"date-time","nullable":true},"ResponseSessionCreatedBefore":{"type":"string","format":"date-time","nullable":true},"ResponseSessionStartedSince":{"type":"string","format":"date-time","nullable":true},"ResponseSessionStartedBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectUserConnections object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectUserConnections":{"type":"object","properties":{"ConnectedSince":{"type":"string","format":"date-time","nullable":true},"ConnectedBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CollectUsers object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CollectUsers":{"type":"object","properties":{"UserIds":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"UserEmailExact":{"type":"string","nullable":true},"UserFullNameContains":{"type":"string","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The ComplianceSummaryCriteria object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ComplianceSummaryCriteria":{"type":"object","properties":{"Departments":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"Learners":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"Measurements":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"ProfileCondition":{"type":"integer","format":"int32"},"LearnerMustHaveProfile":{"type":"boolean"},"DepartmentEmployment":{"type":"boolean","nullable":true},"OrganizationEmployment":{"type":"boolean","nullable":true},"DataAccess":{"type":"boolean","nullable":true},"ZeroRequirementsProgressDisplay":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The ComplianceSummaryMeasurement object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ComplianceSummaryMeasurement":{"type":"object","properties":{"Key":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Score":{"type":"number","format":"double","nullable":true},"Required":{"type":"integer","format":"int32"},"Satisfied":{"type":"integer","format":"int32"},"Expired":{"type":"integer","format":"int32","nullable":true},"NotCompleted":{"type":"integer","format":"int32","nullable":true},"NotApplicable":{"type":"integer","format":"int32","nullable":true},"NeedsTraining":{"type":"integer","format":"int32","nullable":true},"SelfAssessed":{"type":"integer","format":"int32","nullable":true},"Submitted":{"type":"integer","format":"int32","nullable":true},"Validated":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false}}}}
```

## The ComplianceSummaryModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ComplianceSummaryModel":{"type":"object","properties":{"Department":{"$ref":"#/components/schemas/Model"},"Learner":{"$ref":"#/components/schemas/Model"},"PrimaryProfile":{"$ref":"#/components/schemas/Model"},"Measurement":{"$ref":"#/components/schemas/ComplianceSummaryMeasurement"}},"additionalProperties":false},"Model":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"Slug":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true}},"additionalProperties":false},"ComplianceSummaryMeasurement":{"type":"object","properties":{"Key":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Score":{"type":"number","format":"double","nullable":true},"Required":{"type":"integer","format":"int32"},"Satisfied":{"type":"integer","format":"int32"},"Expired":{"type":"integer","format":"int32","nullable":true},"NotCompleted":{"type":"integer","format":"int32","nullable":true},"NotApplicable":{"type":"integer","format":"int32","nullable":true},"NeedsTraining":{"type":"integer","format":"int32","nullable":true},"SelfAssessed":{"type":"integer","format":"int32","nullable":true},"Submitted":{"type":"integer","format":"int32","nullable":true},"Validated":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false}}}}
```

## The ContentContainer object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ContentContainer":{"type":"object","properties":{"Count":{"type":"integer","format":"int32","readOnly":true},"IsEmpty":{"type":"boolean","readOnly":true},"HasItems":{"type":"boolean","readOnly":true},"IsLoaded":{"type":"boolean"},"Languages":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"Title":{"$ref":"#/components/schemas/ContentContainerItem"},"Summary":{"$ref":"#/components/schemas/ContentContainerItem"},"Description":{"$ref":"#/components/schemas/ContentContainerItem"},"Feedback":{"$ref":"#/components/schemas/ContentContainerItem"},"FeedbackWhenNotSelected":{"$ref":"#/components/schemas/ContentContainerItem"},"Hint":{"$ref":"#/components/schemas/ContentContainerItem"},"Body":{"$ref":"#/components/schemas/ContentContainerItem"}},"additionalProperties":false},"ContentContainerItem":{"type":"object","properties":{"Text":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"Html":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"Snip":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"IsEmpty":{"type":"boolean","readOnly":true},"HasItems":{"type":"boolean","readOnly":true},"Languages":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"Key":{"type":"string","nullable":true},"Value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The ContentContainerItem object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ContentContainerItem":{"type":"object","properties":{"Text":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"Html":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"Snip":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"IsEmpty":{"type":"boolean","readOnly":true},"HasItems":{"type":"boolean","readOnly":true},"Languages":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"Key":{"type":"string","nullable":true},"Value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CookieGenerateResponse object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CookieGenerateResponse":{"type":"object","properties":{"Token":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CookieToken object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CookieToken":{"type":"object","properties":{"AuthenticationSource":{"type":"string","nullable":true},"Created":{"type":"string","nullable":true},"CurrentBrowser":{"type":"string","nullable":true},"CurrentBrowserVersion":{"type":"string","nullable":true},"CurrentOrganization":{"type":"string","nullable":true},"ID":{"type":"string","format":"uuid"},"ImpersonatorOrganization":{"type":"string","nullable":true},"ImpersonatorUser":{"type":"string","nullable":true},"IsAdministrator":{"type":"boolean"},"IsAuthenticated":{"type":"boolean","readOnly":true},"IsDeveloper":{"type":"boolean"},"IsOperator":{"type":"boolean"},"IsLearner":{"type":"boolean"},"Language":{"type":"string","nullable":true},"Modified":{"type":"string","nullable":true},"OrganizationCode":{"type":"string","nullable":true},"OrganizationIdentifier":{"type":"string","format":"uuid","nullable":true},"Session":{"type":"string","nullable":true},"TimeZoneId":{"type":"string","nullable":true},"UserEmail":{"type":"string","nullable":true},"UserIdentifier":{"type":"string","format":"uuid","nullable":true},"UserRoles":{"type":"array","items":{"type":"string"},"nullable":true},"ValidationKey":{"type":"string","nullable":true},"Environment":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CookieValueResponse object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CookieValueResponse":{"type":"object","properties":{"Value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CountAchievements object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountAchievements":{"type":"object","properties":{"AchievementTitle":{"type":"string","nullable":true},"ExpirationFixedDateSince":{"type":"string","format":"date-time","nullable":true},"ExpirationFixedDateBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountAttempts object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountAttempts":{"type":"object","properties":{"AttemptStatus":{"type":"string","nullable":true},"AttemptGradedSince":{"type":"string","format":"date-time","nullable":true},"AttemptGradedBefore":{"type":"string","format":"date-time","nullable":true},"AttemptImportedSince":{"type":"string","format":"date-time","nullable":true},"AttemptImportedBefore":{"type":"string","format":"date-time","nullable":true},"AttemptPingedSince":{"type":"string","format":"date-time","nullable":true},"AttemptPingedBefore":{"type":"string","format":"date-time","nullable":true},"AttemptStartedSince":{"type":"string","format":"date-time","nullable":true},"AttemptStartedBefore":{"type":"string","format":"date-time","nullable":true},"AttemptSubmittedSince":{"type":"string","format":"date-time","nullable":true},"AttemptSubmittedBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountBanks object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountBanks":{"type":"object","properties":{"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"IsActive":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The CountCaseStatuses object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountCaseStatuses":{"type":"object","properties":{"CaseTypeContains":{"type":"string","nullable":true},"CaseTypeExact":{"type":"string","nullable":true},"StatusNameContains":{"type":"string","nullable":true},"StatusNameExact":{"type":"string","nullable":true},"StatusCategoryContains":{"type":"string","nullable":true},"StatusCategoryExact":{"type":"string","nullable":true},"ReportCategoryContains":{"type":"string","nullable":true},"ReportCategoryExact":{"type":"string","nullable":true},"StatusSequenceSince":{"type":"integer","format":"int32","nullable":true},"StatusSequenceBefore":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false}}}}
```

## The CountCases object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountCases":{"type":"object","properties":{"CaseClosedSince":{"type":"string","format":"date-time","nullable":true},"CaseClosedBefore":{"type":"string","format":"date-time","nullable":true},"CaseOpenedSince":{"type":"string","format":"date-time","nullable":true},"CaseOpenedBefore":{"type":"string","format":"date-time","nullable":true},"CaseReportedSince":{"type":"string","format":"date-time","nullable":true},"CaseReportedBefore":{"type":"string","format":"date-time","nullable":true},"CaseStatusEffectiveSince":{"type":"string","format":"date-time","nullable":true},"CaseStatusEffectiveBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountCourses object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountCourses":{"type":"object","properties":{"ClosedSince":{"type":"string","format":"date-time","nullable":true},"ClosedBefore":{"type":"string","format":"date-time","nullable":true},"CreatedSince":{"type":"string","format":"date-time","nullable":true},"CreatedBefore":{"type":"string","format":"date-time","nullable":true},"ModifiedSince":{"type":"string","format":"date-time","nullable":true},"ModifiedBefore":{"type":"string","format":"date-time","nullable":true},"IsPublished":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The CountCredentials object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountCredentials":{"type":"object","properties":{"AchievementId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid","nullable":true},"ModifiedFrom":{"type":"string","format":"date-time","nullable":true},"ModifiedBefore":{"type":"string","format":"date-time","nullable":true},"PersonCode":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CountEvents object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountEvents":{"type":"object","properties":{"DistributionExpectedSince":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedBefore":{"type":"string","format":"date-time","nullable":true},"DistributionOrderedSince":{"type":"string","format":"date-time","nullable":true},"DistributionOrderedBefore":{"type":"string","format":"date-time","nullable":true},"DistributionShippedSince":{"type":"string","format":"date-time","nullable":true},"DistributionShippedBefore":{"type":"string","format":"date-time","nullable":true},"DistributionTrackedSince":{"type":"string","format":"date-time","nullable":true},"DistributionTrackedBefore":{"type":"string","format":"date-time","nullable":true},"EventScheduledEndSince":{"type":"string","format":"date-time","nullable":true},"EventScheduledEndBefore":{"type":"string","format":"date-time","nullable":true},"EventScheduledStartSince":{"type":"string","format":"date-time","nullable":true},"EventScheduledStartBefore":{"type":"string","format":"date-time","nullable":true},"ExamMaterialReturnShipmentReceivedSince":{"type":"string","format":"date-time","nullable":true},"ExamMaterialReturnShipmentReceivedBefore":{"type":"string","format":"date-time","nullable":true},"ExamStartedSince":{"type":"string","format":"date-time","nullable":true},"ExamStartedBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationDeadlineSince":{"type":"string","format":"date-time","nullable":true},"RegistrationDeadlineBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationLockedSince":{"type":"string","format":"date-time","nullable":true},"RegistrationLockedBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationStartSince":{"type":"string","format":"date-time","nullable":true},"RegistrationStartBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountFiles object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountFiles":{"type":"object","properties":{"ObjectId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid","nullable":true},"FileIds":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"ObjectTypeExact":{"type":"string","nullable":true},"ObjectIdentifierContains":{"type":"string","nullable":true},"FileNameContains":{"type":"string","nullable":true},"DocumentNameContains":{"type":"string","nullable":true},"FileUploadedSince":{"type":"string","format":"date-time","nullable":true},"FileUploadedBefore":{"type":"string","format":"date-time","nullable":true},"HasClaims":{"type":"boolean","nullable":true},"FileTag":{"$ref":"#/components/schemas/FileTag"}},"additionalProperties":false},"FileTag":{"enum":["PersonImport"],"type":"string"}}}}
```

## The CountForms object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountForms":{"type":"object","properties":{"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"SurveyFormClosedSince":{"type":"string","format":"date-time","nullable":true},"SurveyFormClosedBefore":{"type":"string","format":"date-time","nullable":true},"SurveyFormLockedSince":{"type":"string","format":"date-time","nullable":true},"SurveyFormLockedBefore":{"type":"string","format":"date-time","nullable":true},"SurveyFormOpenedSince":{"type":"string","format":"date-time","nullable":true},"SurveyFormOpenedBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountGradebooks object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountGradebooks":{"type":"object","properties":{"AchievementId":{"type":"string","format":"uuid","nullable":true},"ClassId":{"type":"string","format":"uuid","nullable":true},"ClassInstructorId":{"type":"string","format":"uuid","nullable":true},"FrameworkId":{"type":"string","format":"uuid","nullable":true},"PeriodId":{"type":"string","format":"uuid","nullable":true},"IsLocked":{"type":"boolean","nullable":true},"ClassTitle":{"type":"string","nullable":true},"GradebookTitle":{"type":"string","nullable":true},"GradebookType":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"Reference":{"type":"string","nullable":true},"ClassStartedSince":{"type":"string","format":"date-time","nullable":true},"ClassStartedBefore":{"type":"string","format":"date-time","nullable":true},"GradebookCreatedSince":{"type":"string","format":"date-time","nullable":true},"GradebookCreatedBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountGroups object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountGroups":{"type":"object","properties":{"GroupCode":{"type":"string","nullable":true},"GroupCreatedSince":{"type":"string","format":"date-time","nullable":true},"GroupCreatedBefore":{"type":"string","format":"date-time","nullable":true},"GroupExpirySince":{"type":"string","format":"date-time","nullable":true},"GroupExpiryBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountMemberships object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountMemberships":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid","nullable":true},"AccountScope":{"type":"string","nullable":true},"MembershipEffectiveSince":{"type":"string","format":"date-time","nullable":true},"MembershipEffectiveBefore":{"type":"string","format":"date-time","nullable":true},"MembershipExpirySince":{"type":"string","format":"date-time","nullable":true},"MembershipExpiryBefore":{"type":"string","format":"date-time","nullable":true},"ModifiedSince":{"type":"string","format":"date-time","nullable":true},"ModifiedBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountPages object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountPages":{"type":"object","properties":{"ObjectId":{"type":"string","format":"uuid","nullable":true},"ParentPageId":{"type":"string","format":"uuid","nullable":true},"SiteId":{"type":"string","format":"uuid","nullable":true},"IsAccessDenied":{"type":"boolean","nullable":true},"IsHidden":{"type":"boolean","nullable":true},"IsNewTab":{"type":"boolean","nullable":true},"IsNullNavigateUrl":{"type":"boolean","nullable":true},"AuthorName":{"type":"string","nullable":true},"ContentControl":{"type":"string","nullable":true},"ContentLabels":{"type":"string","nullable":true},"Hook":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"NavigateUrl":{"type":"string","nullable":true},"ObjectType":{"type":"string","nullable":true},"PageIcon":{"type":"string","nullable":true},"PageSlug":{"type":"string","nullable":true},"PageType":{"type":"string","nullable":true},"ParentPageSlug":{"type":"string","nullable":true},"ParentPageType":{"type":"string","nullable":true},"SiteDomain":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Sequence":{"type":"integer","format":"int32","nullable":true},"AuthorDateSince":{"type":"string","format":"date-time","nullable":true},"AuthorDateBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountPendingPeople object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountPendingPeople":{"type":"object","properties":{"SubmittedBy":{"type":"string","format":"uuid","nullable":true},"PersonCode":{"type":"string","nullable":true},"UserEmail":{"type":"string","nullable":true},"UserFirstName":{"type":"string","nullable":true},"UserLastName":{"type":"string","nullable":true},"SubmittedBefore":{"type":"string","format":"date-time","nullable":true},"SubmittedSince":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountPeople object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountPeople":{"type":"object","properties":{"UserId":{"type":"string","format":"uuid","nullable":true},"EmailExact":{"type":"string","nullable":true},"EmailLike":{"type":"string","nullable":true},"EventRole":{"type":"string","nullable":true},"FullName":{"type":"string","nullable":true},"PersonCode":{"type":"string","nullable":true},"FirstNameExact":{"type":"string","nullable":true},"LastNameExact":{"type":"string","nullable":true},"LastAuthenticatedSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"IsApproved":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The CountPeriods object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountPeriods":{"type":"object","properties":{"Name":{"type":"string","nullable":true},"EndSince":{"type":"string","format":"date-time","nullable":true},"EndBefore":{"type":"string","format":"date-time","nullable":true},"StartSince":{"type":"string","format":"date-time","nullable":true},"StartBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountRegistrations object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountRegistrations":{"type":"object","properties":{"AttendanceTakenSince":{"type":"string","format":"date-time","nullable":true},"AttendanceTakenBefore":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedSince":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedBefore":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdatedSince":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdatedBefore":{"type":"string","format":"date-time","nullable":true},"GradeAssignedSince":{"type":"string","format":"date-time","nullable":true},"GradeAssignedBefore":{"type":"string","format":"date-time","nullable":true},"GradePublishedSince":{"type":"string","format":"date-time","nullable":true},"GradePublishedBefore":{"type":"string","format":"date-time","nullable":true},"GradeReleasedSince":{"type":"string","format":"date-time","nullable":true},"GradeReleasedBefore":{"type":"string","format":"date-time","nullable":true},"GradeWithheldSince":{"type":"string","format":"date-time","nullable":true},"GradeWithheldBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOnSince":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOnBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountResult object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountResult":{"type":"object","properties":{"Count":{"type":"integer","format":"int32"},"Summary":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CountSites object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountSites":{"type":"object","properties":{"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountStandards object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountStandards":{"type":"object","properties":{"ParentStandardId":{"type":"string","format":"uuid","nullable":true},"ParentStandardIds":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"StandardIds":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"ContentTitle":{"type":"string","nullable":true},"StandardType":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CountSubmissions object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountSubmissions":{"type":"object","properties":{"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"ResponseSessionCompletedSince":{"type":"string","format":"date-time","nullable":true},"ResponseSessionCompletedBefore":{"type":"string","format":"date-time","nullable":true},"ResponseSessionCreatedSince":{"type":"string","format":"date-time","nullable":true},"ResponseSessionCreatedBefore":{"type":"string","format":"date-time","nullable":true},"ResponseSessionStartedSince":{"type":"string","format":"date-time","nullable":true},"ResponseSessionStartedBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountUserConnections object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountUserConnections":{"type":"object","properties":{"ConnectedSince":{"type":"string","format":"date-time","nullable":true},"ConnectedBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CountUsers object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CountUsers":{"type":"object","properties":{"UserIds":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"UserEmailExact":{"type":"string","nullable":true},"UserFullNameContains":{"type":"string","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CourseMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CourseMatch":{"type":"object","properties":{"CourseId":{"type":"string","format":"uuid"},"CourseName":{"type":"string","nullable":true},"CourseCode":{"type":"string","nullable":true},"CourseLabel":{"type":"string","nullable":true},"CourseHook":{"type":"string","nullable":true},"CourseIsHidden":{"type":"boolean"},"CatalogId":{"type":"string","format":"uuid","nullable":true},"CatalogName":{"type":"string","nullable":true},"CatalogIsHidden":{"type":"boolean","nullable":true},"PublicationStatus":{"type":"string","nullable":true},"PublicationDate":{"type":"string","format":"date-time","nullable":true},"PublicationAuthor":{"type":"string","nullable":true},"PublicationPageId":{"type":"string","format":"uuid","nullable":true},"UnitCount":{"type":"integer","format":"int32","nullable":true},"ModuleCount":{"type":"integer","format":"int32","nullable":true},"ActivityCount":{"type":"integer","format":"int32","nullable":true},"EnrollmentCount":{"type":"integer","format":"int32"},"EnrollmentCountStarted":{"type":"integer","format":"int32"},"EnrollmentCountCompleted":{"type":"integer","format":"int32"},"GradebookId":{"type":"string","format":"uuid","nullable":true},"GradebookTitle":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CourseModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CourseModel":{"type":"object","properties":{"CatalogId":{"type":"string","format":"uuid","nullable":true},"CompletedToAdministratorMessageId":{"type":"string","format":"uuid","nullable":true},"CompletedToLearnerMessageId":{"type":"string","format":"uuid","nullable":true},"CompletionActivityId":{"type":"string","format":"uuid","nullable":true},"CourseId":{"type":"string","format":"uuid"},"CreatedBy":{"type":"string","format":"uuid"},"FrameworkStandardId":{"type":"string","format":"uuid","nullable":true},"GradebookId":{"type":"string","format":"uuid","nullable":true},"ModifiedBy":{"type":"string","format":"uuid"},"SourceId":{"type":"string","format":"uuid","nullable":true},"StalledToAdministratorMessageId":{"type":"string","format":"uuid","nullable":true},"StalledToLearnerMessageId":{"type":"string","format":"uuid","nullable":true},"AllowDiscussion":{"type":"boolean"},"CourseIsHidden":{"type":"boolean"},"IsDisplayOverviewOnly":{"type":"boolean"},"IsMultipleUnitsEnabled":{"type":"boolean"},"IsProgressReportEnabled":{"type":"boolean"},"CourseCode":{"type":"string","nullable":true},"CourseDescription":{"type":"string","nullable":true},"CourseFlagColor":{"type":"string","nullable":true},"CourseFlagText":{"type":"string","nullable":true},"CourseHook":{"type":"string","nullable":true},"CourseIcon":{"type":"string","nullable":true},"CourseImage":{"type":"string","nullable":true},"CourseLabel":{"type":"string","nullable":true},"CourseLevel":{"type":"string","nullable":true},"CourseName":{"type":"string","nullable":true},"CoursePlatform":{"type":"string","nullable":true},"CourseProgram":{"type":"string","nullable":true},"CourseSlug":{"type":"string","nullable":true},"CourseStyle":{"type":"string","nullable":true},"CourseUnit":{"type":"string","nullable":true},"CourseAsset":{"type":"integer","format":"int32"},"CourseSequence":{"type":"integer","format":"int32","nullable":true},"OutlineWidth":{"type":"integer","format":"int32","nullable":true},"SendMessageStalledAfterDays":{"type":"integer","format":"int32","nullable":true},"SendMessageStalledMaxCount":{"type":"integer","format":"int32","nullable":true},"Closed":{"type":"string","format":"date-time","nullable":true},"Created":{"type":"string","format":"date-time"},"Modified":{"type":"string","format":"date-time"}},"additionalProperties":false}}}}
```

## The CreateCaseStatus object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CreateCaseStatus":{"type":"object","properties":{"CaseType":{"type":"string","nullable":true},"StatusName":{"type":"string","nullable":true},"StatusSequence":{"type":"integer","format":"int32"},"StatusCategory":{"type":"string","nullable":true},"ReportCategory":{"type":"string","nullable":true},"StatusDescription":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CreateFile object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CreateFile":{"type":"object","properties":{"ApprovedUserId":{"type":"string","format":"uuid","nullable":true},"FileId":{"type":"string","format":"uuid"},"LastActivityUserId":{"type":"string","format":"uuid","nullable":true},"ObjectId":{"type":"string","format":"uuid"},"ReviewedUserId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid"},"DocumentName":{"type":"string","nullable":true},"FileCategory":{"type":"string","nullable":true},"FileContentType":{"type":"string","nullable":true},"FileDescription":{"type":"string","nullable":true},"FileLocation":{"type":"string","nullable":true},"FileName":{"type":"string","nullable":true},"FilePath":{"type":"string","nullable":true},"FileStatus":{"type":"string","nullable":true},"FileSubcategory":{"type":"string","nullable":true},"FileUrl":{"type":"string","nullable":true},"ObjectType":{"type":"string","nullable":true},"FileSize":{"type":"integer","format":"int32"},"ApprovedTime":{"type":"string","format":"date-time","nullable":true},"FileAlternated":{"type":"string","format":"date-time","nullable":true},"FileExpiry":{"type":"string","format":"date-time","nullable":true},"FileReceived":{"type":"string","format":"date-time","nullable":true},"FileUploaded":{"type":"string","format":"date-time"},"LastActivityTime":{"type":"string","format":"date-time","nullable":true},"ReviewedTime":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CreateInput object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CreateInput":{"type":"object","properties":{"ContainerId":{"type":"string","format":"uuid"},"ContentId":{"type":"string","format":"uuid"},"ContainerType":{"type":"string","nullable":true},"ContentHtml":{"type":"string","nullable":true},"ContentLabel":{"type":"string","nullable":true},"ContentLanguage":{"type":"string","nullable":true},"ContentSnip":{"type":"string","nullable":true},"ContentText":{"type":"string","nullable":true},"ReferenceFiles":{"type":"string","nullable":true},"ContentSequence":{"type":"integer","format":"int32","nullable":true},"ReferenceCount":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false}}}}
```

## The CreatePendingPerson object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CreatePendingPerson":{"required":["EmployeeStatus","PersonCode","UserEmail","UserFirstName","UserLastName"],"type":"object","properties":{"PersonCode":{"minLength":1,"type":"string"},"UserEmail":{"minLength":1,"type":"string"},"UserFirstName":{"minLength":1,"type":"string"},"UserLastName":{"minLength":1,"type":"string"},"EmployeeStatus":{"minLength":1,"type":"string"}},"additionalProperties":false}}}}
```

## The CreatePermission object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CreatePermission":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid"},"ObjectId":{"type":"string","format":"uuid"},"PermissionGrantedBy":{"type":"string","format":"uuid","nullable":true},"PermissionId":{"type":"string","format":"uuid"},"AllowAdministrate":{"type":"boolean"},"AllowConfigure":{"type":"boolean"},"AllowCreate":{"type":"boolean"},"AllowDelete":{"type":"boolean"},"AllowRead":{"type":"boolean"},"AllowTrialAccess":{"type":"boolean"},"AllowWrite":{"type":"boolean"},"ObjectType":{"type":"string","nullable":true},"PermissionGranted":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The CredentialMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CredentialMatch":{"type":"object","properties":{"AchievementId":{"type":"string","format":"uuid"},"CredentialId":{"type":"string","format":"uuid"},"UserId":{"type":"string","format":"uuid"},"CredentialIssued":{"type":"string","format":"date-time","nullable":true},"CredentialStatus":{"type":"string","nullable":true},"CredentialNecessity":{"type":"string","nullable":true},"CredentialIsRequired":{"type":"boolean"},"AchievementLabel":{"type":"string","nullable":true},"AchievementTitle":{"type":"string","nullable":true},"PersonCode":{"type":"string","nullable":true},"AchievementEffectiveDate":{"type":"string","format":"date-time","nullable":true},"AchievementExpiryDate":{"type":"string","format":"date-time","nullable":true},"AchievementValid":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The CredentialModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"CredentialModel":{"type":"object","properties":{"AchievementId":{"type":"string","format":"uuid"},"AuthorityId":{"type":"string","format":"uuid","nullable":true},"CredentialId":{"type":"string","format":"uuid"},"EmployerGroupId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid"},"AfterExpiryNotificationSent":{"type":"boolean"},"BeforeExpiryNotificationSent":{"type":"boolean"},"AuthorityLocation":{"type":"string","nullable":true},"AuthorityName":{"type":"string","nullable":true},"AuthorityReference":{"type":"string","nullable":true},"AuthorityType":{"type":"string","nullable":true},"CredentialDescription":{"type":"string","nullable":true},"CredentialGrantedDescription":{"type":"string","nullable":true},"CredentialNecessity":{"type":"string","nullable":true},"CredentialPriority":{"type":"string","nullable":true},"CredentialReminderType":{"type":"string","nullable":true},"CredentialRevokedReason":{"type":"string","nullable":true},"CredentialStatus":{"type":"string","nullable":true},"EmployerGroupStatus":{"type":"string","nullable":true},"ExpirationLifetimeUnit":{"type":"string","nullable":true},"ExpirationType":{"type":"string","nullable":true},"PublisherAddress":{"type":"string","nullable":true},"TransactionHash":{"type":"string","nullable":true},"ExpirationLifetimeQuantity":{"type":"integer","format":"int32","nullable":true},"PublicationStatus":{"type":"integer","format":"int32","nullable":true},"CredentialGrantedScore":{"type":"number","format":"double","nullable":true},"CredentialHours":{"type":"number","format":"double","nullable":true},"CredentialRevokedScore":{"type":"number","format":"double","nullable":true},"CredentialAssigned":{"type":"string","format":"date-time","nullable":true},"CredentialExpirationExpected":{"type":"string","format":"date-time","nullable":true},"CredentialExpirationReminderDelivered0":{"type":"string","format":"date-time","nullable":true},"CredentialExpirationReminderDelivered1":{"type":"string","format":"date-time","nullable":true},"CredentialExpirationReminderDelivered2":{"type":"string","format":"date-time","nullable":true},"CredentialExpirationReminderDelivered3":{"type":"string","format":"date-time","nullable":true},"CredentialExpirationReminderRequested0":{"type":"string","format":"date-time","nullable":true},"CredentialExpirationReminderRequested1":{"type":"string","format":"date-time","nullable":true},"CredentialExpirationReminderRequested2":{"type":"string","format":"date-time","nullable":true},"CredentialExpirationReminderRequested3":{"type":"string","format":"date-time","nullable":true},"CredentialExpired":{"type":"string","format":"date-time","nullable":true},"CredentialGranted":{"type":"string","format":"date-time","nullable":true},"CredentialRevoked":{"type":"string","format":"date-time","nullable":true},"ExpirationFixedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The DownloadColumnSettings object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"DownloadColumnSettings":{"type":"object","properties":{"PhysicalName":{"type":"string","nullable":true},"LogicalHeading":{"type":"string","nullable":true},"HideByDefault":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The DownloadSettings object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"DownloadSettings":{"type":"object","properties":{"Columns":{"type":"array","items":{"$ref":"#/components/schemas/DownloadColumnSettings"},"nullable":true}},"additionalProperties":false},"DownloadColumnSettings":{"type":"object","properties":{"PhysicalName":{"type":"string","nullable":true},"LogicalHeading":{"type":"string","nullable":true},"HideByDefault":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The EmployeeStatusEnum object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"EmployeeStatusEnum":{"enum":["Active","Deceased","LaidOff","Leave","Retired","Terminated"],"type":"string"}}}}
```

## The EnvironmentModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"EnvironmentModel":{"type":"object","properties":{"Name":{"type":"string","nullable":true},"Version":{"type":"string","nullable":true},"Color":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The EventMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"EventMatch":{"type":"object","properties":{"EventId":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The EventModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"EventModel":{"type":"object","properties":{"AchievementId":{"type":"string","format":"uuid","nullable":true},"EventId":{"type":"string","format":"uuid"},"LearnerRegistrationGroupId":{"type":"string","format":"uuid","nullable":true},"MandatorySurveyFormId":{"type":"string","format":"uuid","nullable":true},"VenueCoordinatorId":{"type":"string","format":"uuid","nullable":true},"VenueLocationId":{"type":"string","format":"uuid","nullable":true},"VenueOfficeId":{"type":"string","format":"uuid","nullable":true},"AllowMultipleRegistrations":{"type":"boolean"},"AllowRegistrationWithLink":{"type":"boolean","nullable":true},"BillingCodeEnabled":{"type":"boolean"},"IntegrationWithholdDistribution":{"type":"boolean"},"IntegrationWithholdGrades":{"type":"boolean"},"PersonCodeIsRequired":{"type":"boolean"},"WaitlistEnabled":{"type":"boolean"},"AppointmentType":{"type":"string","nullable":true},"Content":{"type":"string","nullable":true},"DistributionCode":{"type":"string","nullable":true},"DistributionErrors":{"type":"string","nullable":true},"DistributionProcess":{"type":"string","nullable":true},"DistributionStatus":{"type":"string","nullable":true},"DurationUnit":{"type":"string","nullable":true},"EventBillingType":{"type":"string","nullable":true},"EventCalendarColor":{"type":"string","nullable":true},"EventClassCode":{"type":"string","nullable":true},"EventDescription":{"type":"string","nullable":true},"EventFormat":{"type":"string","nullable":true},"EventPublicationStatus":{"type":"string","nullable":true},"EventRequisitionStatus":{"type":"string","nullable":true},"EventSchedulingStatus":{"type":"string","nullable":true},"EventSource":{"type":"string","nullable":true},"EventSummary":{"type":"string","nullable":true},"EventTitle":{"type":"string","nullable":true},"EventType":{"type":"string","nullable":true},"ExamMaterialReturnShipmentCode":{"type":"string","nullable":true},"ExamMaterialReturnShipmentCondition":{"type":"string","nullable":true},"ExamType":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"PublicationErrors":{"type":"string","nullable":true},"RegistrationFields":{"type":"string","nullable":true},"VenueRoom":{"type":"string","nullable":true},"CapacityMaximum":{"type":"integer","format":"int32","nullable":true},"CapacityMinimum":{"type":"integer","format":"int32","nullable":true},"DurationQuantity":{"type":"integer","format":"int32","nullable":true},"EventNumber":{"type":"integer","format":"int32"},"ExamDurationInMinutes":{"type":"integer","format":"int32","nullable":true},"InvigilatorMinimum":{"type":"integer","format":"int32","nullable":true},"CreditHours":{"type":"number","format":"double","nullable":true},"DistributionExpected":{"type":"string","format":"date-time","nullable":true},"DistributionOrdered":{"type":"string","format":"date-time","nullable":true},"DistributionShipped":{"type":"string","format":"date-time","nullable":true},"DistributionTracked":{"type":"string","format":"date-time","nullable":true},"EventScheduledEnd":{"type":"string","format":"date-time","nullable":true},"EventScheduledStart":{"type":"string","format":"date-time"},"ExamMaterialReturnShipmentReceived":{"type":"string","format":"date-time","nullable":true},"ExamStarted":{"type":"string","format":"date-time","nullable":true},"LastChangeTime":{"type":"string","format":"date-time","nullable":true},"RegistrationDeadline":{"type":"string","format":"date-time","nullable":true},"RegistrationLocked":{"type":"string","format":"date-time","nullable":true},"RegistrationStart":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The ExportStarted object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ExportStarted":{"type":"object","properties":{"DownloadUrl":{"type":"string","nullable":true},"ExportFormat":{"type":"string","nullable":true},"ExportKey":{"type":"string","nullable":true},"Expiry":{"type":"string","format":"date-time"}},"additionalProperties":false}}}}
```

## The FileMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"FileMatch":{"type":"object","properties":{"OrganizationCode":{"type":"string","nullable":true},"ObjectType":{"type":"string","nullable":true},"ObjectId":{"type":"string","format":"uuid"},"FileId":{"type":"string","format":"uuid"},"FileLocation":{"type":"string","nullable":true},"FileName":{"type":"string","nullable":true},"DocumentName":{"type":"string","nullable":true},"FileSize":{"type":"integer","format":"int32"},"FileUploaded":{"type":"string","format":"date-time"},"UserId":{"type":"string","format":"uuid"},"UserFullName":{"type":"string","nullable":true},"FileTag":{"type":"string","nullable":true},"HasClaims":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The FileModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"FileModel":{"type":"object","properties":{"ApprovedUserId":{"type":"string","format":"uuid","nullable":true},"FileId":{"type":"string","format":"uuid"},"LastActivityUserId":{"type":"string","format":"uuid","nullable":true},"ObjectId":{"type":"string","format":"uuid"},"ReviewedUserId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid"},"DocumentName":{"type":"string","nullable":true},"FileCategory":{"type":"string","nullable":true},"FileContentType":{"type":"string","nullable":true},"FileDescription":{"type":"string","nullable":true},"FileLocation":{"type":"string","nullable":true},"FileName":{"type":"string","nullable":true},"FilePath":{"type":"string","nullable":true},"FileStatus":{"type":"string","nullable":true},"FileSubcategory":{"type":"string","nullable":true},"FileUrl":{"type":"string","nullable":true},"ObjectType":{"type":"string","nullable":true},"FileSize":{"type":"integer","format":"int32"},"ApprovedTime":{"type":"string","format":"date-time","nullable":true},"FileAlternated":{"type":"string","format":"date-time","nullable":true},"FileExpiry":{"type":"string","format":"date-time","nullable":true},"FileReceived":{"type":"string","format":"date-time","nullable":true},"FileUploaded":{"type":"string","format":"date-time"},"LastActivityTime":{"type":"string","format":"date-time","nullable":true},"ReviewedTime":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The FileTag object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"FileTag":{"enum":["PersonImport"],"type":"string"}}}}
```

## The FormMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"FormMatch":{"type":"object","properties":{"SurveyFormId":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The FormModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"FormModel":{"type":"object","properties":{"LastChangeUser":{"type":"string","format":"uuid"},"SurveyFormId":{"type":"string","format":"uuid"},"SurveyMessageInvitation":{"type":"string","format":"uuid","nullable":true},"SurveyMessageResponseCompleted":{"type":"string","format":"uuid","nullable":true},"SurveyMessageResponseConfirmed":{"type":"string","format":"uuid","nullable":true},"SurveyMessageResponseStarted":{"type":"string","format":"uuid","nullable":true},"DisplaySummaryChart":{"type":"boolean"},"EnableUserConfidentiality":{"type":"boolean"},"HasWorkflowConfiguration":{"type":"boolean"},"RequireUserAuthentication":{"type":"boolean"},"RequireUserIdentification":{"type":"boolean"},"LastChangeType":{"type":"string","nullable":true},"SurveyFormHook":{"type":"string","nullable":true},"SurveyFormLanguage":{"type":"string","nullable":true},"SurveyFormLanguageTranslations":{"type":"string","nullable":true},"SurveyFormName":{"type":"string","nullable":true},"SurveyFormStatus":{"type":"string","nullable":true},"UserFeedback":{"type":"string","nullable":true},"AssetNumber":{"type":"integer","format":"int32"},"BranchCount":{"type":"integer","format":"int32"},"ConditionCount":{"type":"integer","format":"int32"},"PageCount":{"type":"integer","format":"int32"},"QuestionCount":{"type":"integer","format":"int32"},"ResponseLimitPerUser":{"type":"integer","format":"int32","nullable":true},"SurveyFormDurationMinutes":{"type":"integer","format":"int32","nullable":true},"LastChangeTime":{"type":"string","format":"date-time"},"SurveyFormClosed":{"type":"string","format":"date-time","nullable":true},"SurveyFormLocked":{"type":"string","format":"date-time","nullable":true},"SurveyFormOpened":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The GradebookMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"GradebookMatch":{"type":"object","properties":{"GradebookId":{"type":"string","format":"uuid"},"GradebookTitle":{"type":"string","nullable":true},"GradebookCreated":{"type":"string","format":"date-time"},"GradebookEnrollmentCount":{"type":"integer","format":"int32"},"ClassId":{"type":"string","format":"uuid","nullable":true},"ClassTitle":{"type":"string","nullable":true},"ClassStarted":{"type":"string","format":"date-time","nullable":true},"ClassEnded":{"type":"string","format":"date-time","nullable":true},"AchievementId":{"type":"string","format":"uuid","nullable":true},"AchievementTitle":{"type":"string","nullable":true},"AchievementCountGranted":{"type":"integer","format":"int32"},"IsLocked":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The GradebookModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"GradebookModel":{"type":"object","properties":{"AchievementId":{"type":"string","format":"uuid","nullable":true},"EventId":{"type":"string","format":"uuid","nullable":true},"FrameworkId":{"type":"string","format":"uuid","nullable":true},"GradebookId":{"type":"string","format":"uuid"},"PeriodId":{"type":"string","format":"uuid","nullable":true},"IsLocked":{"type":"boolean"},"GradebookTitle":{"type":"string","nullable":true},"GradebookType":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"Reference":{"type":"string","nullable":true},"GradebookCreated":{"type":"string","format":"date-time"},"LastChangeTime":{"type":"string","format":"date-time"},"AchievementTitle":{"type":"string","nullable":true},"ClassInstructors":{"type":"string","nullable":true},"ClassScheduledStartDate":{"type":"string","nullable":true},"ClassScheduledEndDate":{"type":"string","nullable":true},"ClassTitle":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The GroupMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"GroupMatch":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid"},"GroupName":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The GroupModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"GroupModel":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid"},"MembershipProductId":{"type":"string","format":"uuid","nullable":true},"MessageToAdminWhenEventVenueChanged":{"type":"string","format":"uuid","nullable":true},"MessageToAdminWhenMembershipEnded":{"type":"string","format":"uuid","nullable":true},"MessageToAdminWhenMembershipStarted":{"type":"string","format":"uuid","nullable":true},"MessageToUserWhenMembershipEnded":{"type":"string","format":"uuid","nullable":true},"MessageToUserWhenMembershipStarted":{"type":"string","format":"uuid","nullable":true},"ParentGroupId":{"type":"string","format":"uuid","nullable":true},"SurveyFormId":{"type":"string","format":"uuid","nullable":true},"GroupStatusItemId":{"type":"string","format":"uuid","nullable":true},"AddNewUsersAutomatically":{"type":"boolean"},"AllowJoinGroupUsingLink":{"type":"boolean"},"AllowSelfSubscription":{"type":"boolean"},"GroupCategory":{"type":"string","nullable":true},"GroupCode":{"type":"string","nullable":true},"GroupDescription":{"type":"string","nullable":true},"GroupEmail":{"type":"string","nullable":true},"GroupFax":{"type":"string","nullable":true},"GroupImage":{"type":"string","nullable":true},"GroupIndustry":{"type":"string","nullable":true},"GroupIndustryComment":{"type":"string","nullable":true},"GroupLabel":{"type":"string","nullable":true},"GroupName":{"type":"string","nullable":true},"GroupOffice":{"type":"string","nullable":true},"GroupPhone":{"type":"string","nullable":true},"GroupRegion":{"type":"string","nullable":true},"GroupSize":{"type":"string","nullable":true},"GroupType":{"type":"string","nullable":true},"GroupWebSiteUrl":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"LifetimeUnit":{"type":"string","nullable":true},"ShippingPreference":{"type":"string","nullable":true},"SocialMediaUrls":{"type":"string","nullable":true},"SurveyNecessity":{"type":"string","nullable":true},"GroupCapacity":{"type":"integer","format":"int32","nullable":true},"LifetimeQuantity":{"type":"integer","format":"int32","nullable":true},"GroupCreated":{"type":"string","format":"date-time"},"GroupExpiry":{"type":"string","format":"date-time","nullable":true},"LastChangeTime":{"type":"string","format":"date-time"}},"additionalProperties":false}}}}
```

## The HealthConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"HealthConfiguration":{"type":"object","properties":{"Providers":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}}}}
```

## The HealthResponse object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"HealthResponse":{"type":"object","properties":{"Status":{"type":"string","nullable":true},"Version":{"type":"string","nullable":true},"Environment":{"nullable":true},"Configuration":{"$ref":"#/components/schemas/HealthConfiguration"}},"additionalProperties":false},"HealthConfiguration":{"type":"object","properties":{"Providers":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}}}}
```

## The HomeSettings object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"HomeSettings":{"type":"object","properties":{"Text":{"type":"string","nullable":true},"Url":{"type":"string","nullable":true},"Icon":{"type":"string","nullable":true},"Image":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The ImportPerson object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ImportPerson":{"required":["EmployeeStatus","PersonCode","UserEmail","UserFirstName","UserLastName"],"type":"object","properties":{"PersonCode":{"maxLength":20,"minLength":1,"type":"string"},"UserEmail":{"maxLength":254,"minLength":1,"type":"string"},"UserFirstName":{"maxLength":40,"minLength":1,"type":"string"},"UserLastName":{"maxLength":40,"minLength":1,"type":"string"},"UserMiddleName":{"maxLength":38,"type":"string","nullable":true},"JobDivision":{"maxLength":100,"type":"string","nullable":true},"JobTitle":{"maxLength":256,"type":"string","nullable":true},"WorkAddressStreet1":{"maxLength":200,"type":"string","nullable":true},"WorkAddressStreet2":{"maxLength":200,"type":"string","nullable":true},"WorkAddressCity":{"maxLength":128,"type":"string","nullable":true},"WorkAddressProvince":{"maxLength":64,"type":"string","nullable":true},"WorkAddressPostalCode":{"maxLength":20,"type":"string","nullable":true},"GroupCode":{"type":"string","nullable":true},"EmployeeStatus":{"$ref":"#/components/schemas/EmployeeStatusEnum"}},"additionalProperties":false},"EmployeeStatusEnum":{"enum":["Active","Deceased","LaidOff","Leave","Retired","Terminated"],"type":"string"}}}}
```

## The ImportResult object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ImportResult":{"required":["ImportedPeople","ReportFileId","ReportFileName"],"type":"object","properties":{"ReportFileId":{"type":"string","format":"uuid","nullable":true},"ReportFileName":{"type":"string","nullable":true},"ImportedPeople":{"type":"array","items":{"$ref":"#/components/schemas/ImportResultItem"},"nullable":true}},"additionalProperties":false},"ImportResultItem":{"required":["PersonCode","Status"],"type":"object","properties":{"PersonCode":{"type":"string","nullable":true},"Status":{"$ref":"#/components/schemas/StatusEnum"},"PendingPersonId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid","nullable":true},"Failure":{"$ref":"#/components/schemas/ValidationFailure"}},"additionalProperties":false},"StatusEnum":{"enum":["Modified","NotChanged","Created","Pending","Error"],"type":"string"},"ValidationFailure":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/Problem"},"nullable":true}},"additionalProperties":false},"Problem":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## The ImportResultItem object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ImportResultItem":{"required":["PersonCode","Status"],"type":"object","properties":{"PersonCode":{"type":"string","nullable":true},"Status":{"$ref":"#/components/schemas/StatusEnum"},"PendingPersonId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid","nullable":true},"Failure":{"$ref":"#/components/schemas/ValidationFailure"}},"additionalProperties":false},"StatusEnum":{"enum":["Modified","NotChanged","Created","Pending","Error"],"type":"string"},"ValidationFailure":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/Problem"},"nullable":true}},"additionalProperties":false},"Problem":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## The Input object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"Input":{"required":["ActionUrl"],"type":"object","properties":{"ActionUrl":{"type":"string","nullable":true},"Visited":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The InputMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"InputMatch":{"type":"object","properties":{"ContentId":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The InputModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"InputModel":{"type":"object","properties":{"ContainerId":{"type":"string","format":"uuid"},"ContentId":{"type":"string","format":"uuid"},"ContainerType":{"type":"string","nullable":true},"ContentHtml":{"type":"string","nullable":true},"ContentLabel":{"type":"string","nullable":true},"ContentLanguage":{"type":"string","nullable":true},"ContentSnip":{"type":"string","nullable":true},"ContentText":{"type":"string","nullable":true},"ReferenceFiles":{"type":"string","nullable":true},"ContentSequence":{"type":"integer","format":"int32","nullable":true},"ReferenceCount":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false}}}}
```

## The JwtIntrospectResponse object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"JwtIntrospectResponse":{"type":"object","properties":{"Jwt":{"nullable":true},"Principal":{"nullable":true}},"additionalProperties":false}}}}
```

## The JwtRequest object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"JwtRequest":{"type":"object","properties":{"Debug":{"type":"boolean"},"Paging":{"type":"boolean"},"Secret":{"type":"string","nullable":true},"Lifetime":{"type":"integer","format":"int32","nullable":true},"Organization":{"type":"string","format":"uuid","nullable":true},"Agent":{"type":"string","format":"uuid","nullable":true},"Subject":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false}}}}
```

## The JwtResponse object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"JwtResponse":{"type":"object","properties":{"AccessToken":{"type":"string","nullable":true},"TokenType":{"type":"string","nullable":true},"ExpiresIn":{"type":"integer","format":"int32"},"Lifetime":{"type":"string","nullable":true},"Paging":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The JwtValidateResult object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"JwtValidateResult":{"type":"object","properties":{"Subject":{"type":"string","nullable":true},"SignatureVerification":{"type":"string","nullable":true},"ExpiryVerification":{"type":"string","nullable":true},"AudienceVerification":{"type":"string","nullable":true},"IssuerVerification":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The LinkModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"LinkModel":{"type":"object","properties":{"Url":{"type":"string","nullable":true},"Text":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The MembershipMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"MembershipMatch":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid"},"MembershipId":{"type":"string","format":"uuid"},"UserId":{"type":"string","format":"uuid"},"GroupName":{"type":"string","nullable":true},"GroupType":{"type":"string","nullable":true},"UserEmail":{"type":"string","nullable":true},"UserName":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The MembershipModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"MembershipModel":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid"},"MembershipId":{"type":"string","format":"uuid"},"ModifiedBy":{"type":"string","format":"uuid"},"UserId":{"type":"string","format":"uuid"},"MembershipFunction":{"type":"string","nullable":true},"MembershipEffective":{"type":"string","format":"date-time"},"MembershipExpiry":{"type":"string","format":"date-time","nullable":true},"Modified":{"type":"string","format":"date-time"},"LastChangeTime":{"type":"string","format":"date-time"},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The MenuLinkModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"MenuLinkModel":{"type":"object","properties":{"Url":{"type":"string","nullable":true},"Text":{"type":"string","nullable":true},"Icon":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The MenuModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"MenuModel":{"type":"object","properties":{"Title":{"type":"string","nullable":true},"MenuItems":{"type":"array","items":{"$ref":"#/components/schemas/MenuLinkModel"},"nullable":true}},"additionalProperties":false},"MenuLinkModel":{"type":"object","properties":{"Url":{"type":"string","nullable":true},"Text":{"type":"string","nullable":true},"Icon":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The Model object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"Model":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"Slug":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The ModifyCaseStatus object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ModifyCaseStatus":{"type":"object","properties":{"StatusName":{"type":"string","nullable":true},"StatusSequence":{"type":"integer","format":"int32"},"StatusCategory":{"type":"string","nullable":true},"ReportCategory":{"type":"string","nullable":true},"StatusDescription":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The ModifyFile object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ModifyFile":{"type":"object","properties":{"ApprovedUserId":{"type":"string","format":"uuid","nullable":true},"FileId":{"type":"string","format":"uuid"},"LastActivityUserId":{"type":"string","format":"uuid","nullable":true},"ObjectId":{"type":"string","format":"uuid"},"ReviewedUserId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid"},"DocumentName":{"type":"string","nullable":true},"FileCategory":{"type":"string","nullable":true},"FileContentType":{"type":"string","nullable":true},"FileDescription":{"type":"string","nullable":true},"FileLocation":{"type":"string","nullable":true},"FileName":{"type":"string","nullable":true},"FilePath":{"type":"string","nullable":true},"FileStatus":{"type":"string","nullable":true},"FileSubcategory":{"type":"string","nullable":true},"FileUrl":{"type":"string","nullable":true},"ObjectType":{"type":"string","nullable":true},"FileSize":{"type":"integer","format":"int32"},"ApprovedTime":{"type":"string","format":"date-time","nullable":true},"FileAlternated":{"type":"string","format":"date-time","nullable":true},"FileExpiry":{"type":"string","format":"date-time","nullable":true},"FileReceived":{"type":"string","format":"date-time","nullable":true},"FileUploaded":{"type":"string","format":"date-time"},"LastActivityTime":{"type":"string","format":"date-time","nullable":true},"ReviewedTime":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The ModifyInput object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ModifyInput":{"type":"object","properties":{"ContainerId":{"type":"string","format":"uuid"},"ContentId":{"type":"string","format":"uuid"},"ContainerType":{"type":"string","nullable":true},"ContentHtml":{"type":"string","nullable":true},"ContentLabel":{"type":"string","nullable":true},"ContentLanguage":{"type":"string","nullable":true},"ContentSnip":{"type":"string","nullable":true},"ContentText":{"type":"string","nullable":true},"ReferenceFiles":{"type":"string","nullable":true},"ContentSequence":{"type":"integer","format":"int32","nullable":true},"ReferenceCount":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false}}}}
```

## The ModifyPendingPerson object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ModifyPendingPerson":{"type":"object","properties":{"PendingPersonIdentifier":{"type":"string","format":"uuid"},"PersonCode":{"type":"string","nullable":true},"UserEmail":{"type":"string","nullable":true},"UserFirstName":{"type":"string","nullable":true},"UserLastName":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The ModifyPermission object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ModifyPermission":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid"},"ObjectId":{"type":"string","format":"uuid"},"PermissionGrantedBy":{"type":"string","format":"uuid","nullable":true},"PermissionId":{"type":"string","format":"uuid"},"AllowAdministrate":{"type":"boolean"},"AllowConfigure":{"type":"boolean"},"AllowCreate":{"type":"boolean"},"AllowDelete":{"type":"boolean"},"AllowRead":{"type":"boolean"},"AllowTrialAccess":{"type":"boolean"},"AllowWrite":{"type":"boolean"},"ObjectType":{"type":"string","nullable":true},"PermissionGranted":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The OrganizationMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"OrganizationMatch":{"type":"object","properties":{"CompanyName":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The OrganizationModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"OrganizationModel":{"type":"object","properties":{"AdministratorUserId":{"type":"string","format":"uuid","nullable":true},"GlossaryId":{"type":"string","format":"uuid","nullable":true},"AccountStatus":{"type":"string","nullable":true},"CompanyName":{"type":"string","nullable":true},"CompanySize":{"type":"string","nullable":true},"CompanySummary":{"type":"string","nullable":true},"CompanyTitle":{"type":"string","nullable":true},"CompanyWebSiteUrl":{"type":"string","nullable":true},"CompetencyAutoExpirationMode":{"type":"string","nullable":true},"OrganizationCode":{"type":"string","nullable":true},"OrganizationData":{"type":"string","nullable":true},"OrganizationLogoUrl":{"type":"string","nullable":true},"PersonFullNamePolicy":{"type":"string","nullable":true},"StandardContentLabels":{"type":"string","nullable":true},"TimeZone":{"type":"string","nullable":true},"CompetencyAutoExpirationDay":{"type":"integer","format":"int32","nullable":true},"CompetencyAutoExpirationMonth":{"type":"integer","format":"int32","nullable":true},"AccountClosed":{"type":"string","format":"date-time","nullable":true},"AccountOpened":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The Origin object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"Origin":{"type":"object","properties":{"When":{"type":"string","format":"date-time"},"Organization":{"type":"string","format":"uuid"},"User":{"type":"string","format":"uuid"},"Proxy":{"type":"string","format":"uuid","nullable":true},"Description":{"type":"string","nullable":true},"Reason":{"type":"string","nullable":true},"Source":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The PageContentModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PageContentModel":{"type":"object","properties":{"Title":{"type":"string","nullable":true},"ContentFields":{"type":"array","items":{"type":"string"},"nullable":true},"Content":{"$ref":"#/components/schemas/ContentContainer"},"Blocks":{"type":"array","items":{"$ref":"#/components/schemas/BlockContentModel"},"nullable":true}},"additionalProperties":false},"ContentContainer":{"type":"object","properties":{"Count":{"type":"integer","format":"int32","readOnly":true},"IsEmpty":{"type":"boolean","readOnly":true},"HasItems":{"type":"boolean","readOnly":true},"IsLoaded":{"type":"boolean"},"Languages":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"Title":{"$ref":"#/components/schemas/ContentContainerItem"},"Summary":{"$ref":"#/components/schemas/ContentContainerItem"},"Description":{"$ref":"#/components/schemas/ContentContainerItem"},"Feedback":{"$ref":"#/components/schemas/ContentContainerItem"},"FeedbackWhenNotSelected":{"$ref":"#/components/schemas/ContentContainerItem"},"Hint":{"$ref":"#/components/schemas/ContentContainerItem"},"Body":{"$ref":"#/components/schemas/ContentContainerItem"}},"additionalProperties":false},"ContentContainerItem":{"type":"object","properties":{"Text":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"Html":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"Snip":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"IsEmpty":{"type":"boolean","readOnly":true},"HasItems":{"type":"boolean","readOnly":true},"Languages":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"Key":{"type":"string","nullable":true},"Value":{"type":"string","nullable":true}},"additionalProperties":false},"BlockContentModel":{"type":"object","properties":{"BlockId":{"type":"string","format":"uuid"},"BlockIdNumber":{"type":"integer","format":"int32","nullable":true},"BlockType":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Hook":{"type":"string","nullable":true},"Content":{"$ref":"#/components/schemas/ContentContainer"}},"additionalProperties":false}}}}
```

## The PageContentModifyModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PageContentModifyModel":{"type":"object","properties":{"Content":{"$ref":"#/components/schemas/ContentContainer"},"Blocks":{"type":"array","items":{"$ref":"#/components/schemas/BlockContentModel"},"nullable":true},"DeletedBlockIds":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true}},"additionalProperties":false},"ContentContainer":{"type":"object","properties":{"Count":{"type":"integer","format":"int32","readOnly":true},"IsEmpty":{"type":"boolean","readOnly":true},"HasItems":{"type":"boolean","readOnly":true},"IsLoaded":{"type":"boolean"},"Languages":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"Title":{"$ref":"#/components/schemas/ContentContainerItem"},"Summary":{"$ref":"#/components/schemas/ContentContainerItem"},"Description":{"$ref":"#/components/schemas/ContentContainerItem"},"Feedback":{"$ref":"#/components/schemas/ContentContainerItem"},"FeedbackWhenNotSelected":{"$ref":"#/components/schemas/ContentContainerItem"},"Hint":{"$ref":"#/components/schemas/ContentContainerItem"},"Body":{"$ref":"#/components/schemas/ContentContainerItem"}},"additionalProperties":false},"ContentContainerItem":{"type":"object","properties":{"Text":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"Html":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"Snip":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true},"IsEmpty":{"type":"boolean","readOnly":true},"HasItems":{"type":"boolean","readOnly":true},"Languages":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"Key":{"type":"string","nullable":true},"Value":{"type":"string","nullable":true}},"additionalProperties":false},"BlockContentModel":{"type":"object","properties":{"BlockId":{"type":"string","format":"uuid"},"BlockIdNumber":{"type":"integer","format":"int32","nullable":true},"BlockType":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Hook":{"type":"string","nullable":true},"Content":{"$ref":"#/components/schemas/ContentContainer"}},"additionalProperties":false}}}}
```

## The PageMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PageMatch":{"type":"object","properties":{"PageId":{"type":"string","format":"uuid"},"PageIcon":{"type":"string","nullable":true},"PageTitle":{"type":"string","nullable":true},"PageUrl":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The PageModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PageModel":{"type":"object","properties":{"ObjectId":{"type":"string","format":"uuid","nullable":true},"PageId":{"type":"string","format":"uuid"},"ParentPageId":{"type":"string","format":"uuid","nullable":true},"SiteId":{"type":"string","format":"uuid","nullable":true},"IsAccessDenied":{"type":"boolean"},"IsHidden":{"type":"boolean"},"IsNewTab":{"type":"boolean"},"AuthorName":{"type":"string","nullable":true},"ContentControl":{"type":"string","nullable":true},"ContentLabels":{"type":"string","nullable":true},"Hook":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"NavigateUrl":{"type":"string","nullable":true},"ObjectType":{"type":"string","nullable":true},"PageIcon":{"type":"string","nullable":true},"PageSlug":{"type":"string","nullable":true},"PageType":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Sequence":{"type":"integer","format":"int32"},"AuthorDate":{"type":"string","format":"date-time","nullable":true},"LastChangeTime":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The PageSettings object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PageSettings":{"type":"object","properties":{"ActionId":{"type":"string","format":"uuid"},"PageId":{"type":"string","format":"uuid","nullable":true},"CoreAbout":{"$ref":"#/components/schemas/AboutModel"},"CustomAbout":{"$ref":"#/components/schemas/AboutModel"},"Breadcrumbs":{"type":"array","items":{"$ref":"#/components/schemas/BreadcrumbModel"},"nullable":true},"DisplayCalendar":{"type":"boolean"},"ActionTitle":{"type":"string","nullable":true},"FullWidth":{"type":"boolean"},"Problems":{"type":"array","items":{"$ref":"#/components/schemas/Problem"},"nullable":true},"Download":{"$ref":"#/components/schemas/DownloadSettings"}},"additionalProperties":false},"AboutModel":{"type":"object","properties":{"Heading":{"type":"string","nullable":true},"Body":{"type":"string","nullable":true}},"additionalProperties":false},"BreadcrumbModel":{"type":"object","properties":{"Text":{"type":"string","nullable":true},"Url":{"type":"string","nullable":true}},"additionalProperties":false},"Problem":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}},"DownloadSettings":{"type":"object","properties":{"Columns":{"type":"array","items":{"$ref":"#/components/schemas/DownloadColumnSettings"},"nullable":true}},"additionalProperties":false},"DownloadColumnSettings":{"type":"object","properties":{"PhysicalName":{"type":"string","nullable":true},"LogicalHeading":{"type":"string","nullable":true},"HideByDefault":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The PasswordHashResponse object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PasswordHashResponse":{"type":"object","properties":{"Hash":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The PendingPersonModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PendingPersonModel":{"type":"object","properties":{"PendingPersonIdentifier":{"type":"string","format":"uuid"},"OrganizationIdentifier":{"type":"string","format":"uuid"},"GroupIdentifier":{"type":"string","format":"uuid","nullable":true},"SubmittedBy":{"type":"string","format":"uuid"},"PersonCode":{"type":"string","nullable":true},"UserEmail":{"type":"string","nullable":true},"UserFirstName":{"type":"string","nullable":true},"UserLastName":{"type":"string","nullable":true},"UserMiddleName":{"type":"string","nullable":true},"JobDivision":{"type":"string","nullable":true},"JobTitle":{"type":"string","nullable":true},"WorkAddressStreet1":{"type":"string","nullable":true},"WorkAddressStreet2":{"type":"string","nullable":true},"WorkAddressCity":{"type":"string","nullable":true},"WorkAddressProvince":{"type":"string","nullable":true},"WorkAddressPostalCode":{"type":"string","nullable":true},"EmployeeStatus":{"type":"string","nullable":true},"SubmittedAt":{"type":"string","format":"date-time"}},"additionalProperties":false}}}}
```

## The PeriodMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PeriodMatch":{"type":"object","properties":{"Id":{"type":"string","format":"uuid"},"Name":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The PeriodModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PeriodModel":{"type":"object","properties":{"PeriodId":{"type":"string","format":"uuid"},"PeriodName":{"type":"string","nullable":true},"PeriodEnd":{"type":"string","format":"date-time"},"PeriodStart":{"type":"string","format":"date-time"}},"additionalProperties":false}}}}
```

## The PermissionMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PermissionMatch":{"type":"object","properties":{"PermissionId":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The PermissionModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PermissionModel":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid"},"ObjectId":{"type":"string","format":"uuid"},"PermissionGrantedBy":{"type":"string","format":"uuid","nullable":true},"PermissionId":{"type":"string","format":"uuid"},"AllowAdministrate":{"type":"boolean"},"AllowConfigure":{"type":"boolean"},"AllowCreate":{"type":"boolean"},"AllowDelete":{"type":"boolean"},"AllowRead":{"type":"boolean"},"AllowTrialAccess":{"type":"boolean"},"AllowWrite":{"type":"boolean"},"ObjectType":{"type":"string","nullable":true},"PermissionGranted":{"type":"string","format":"date-time","nullable":true},"GroupName":{"type":"string","nullable":true},"OrganizationCode":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The PermissionsModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PermissionsModel":{"type":"object","properties":{"Accounts":{"type":"boolean"},"Integrations":{"type":"boolean"},"Settings":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The PersonAddressModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PersonAddressModel":{"type":"object","properties":{"AddressId":{"type":"string","format":"uuid"},"City":{"type":"string","nullable":true},"Country":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"PostalCode":{"type":"string","nullable":true},"Province":{"type":"string","nullable":true},"Street1":{"type":"string","nullable":true},"Street2":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The PersonMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PersonMatch":{"type":"object","properties":{"PersonId":{"type":"string","format":"uuid"},"PersonCode":{"type":"string","nullable":true},"PersonFirstName":{"type":"string","nullable":true},"PersonMiddleName":{"type":"string","nullable":true},"PersonLastName":{"type":"string","nullable":true},"UserId":{"type":"string","format":"uuid"},"UserName":{"type":"string","nullable":true},"UserEmail":{"type":"string","nullable":true},"IsAdministrator":{"type":"boolean"},"IsDeveloper":{"type":"boolean"},"IsLearner":{"type":"boolean"},"IsOperator":{"type":"boolean"},"TimeZone":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The PersonModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PersonModel":{"type":"object","properties":{"FullName":{"type":"string","nullable":true},"PersonFirstName":{"type":"string","nullable":true},"PersonMiddleName":{"type":"string","nullable":true},"PersonLastName":{"type":"string","nullable":true},"PersonType":{"type":"string","nullable":true},"PersonCode":{"type":"string","nullable":true},"PersonId":{"type":"string","format":"uuid"},"UserId":{"type":"string","format":"uuid"},"UserName":{"type":"string","nullable":true},"UserEmail":{"type":"string","nullable":true},"UserEmailAlternate":{"type":"string","nullable":true},"IsAdministrator":{"type":"boolean"},"IsDeveloper":{"type":"boolean"},"IsLearner":{"type":"boolean"},"IsOperator":{"type":"boolean"},"AccessRevoked":{"type":"string","format":"date-time","nullable":true},"AccessRevokedBy":{"type":"string","nullable":true},"LastAuthenticated":{"type":"string","format":"date-time","nullable":true},"UserAccessGranted":{"type":"string","format":"date-time","nullable":true},"UserAccessGrantedBy":{"type":"string","nullable":true},"UserApproveReason":{"type":"string","nullable":true},"WelcomeEmailsSentToUser":{"type":"integer","format":"int32","nullable":true},"EmailAlternateEnabled":{"type":"boolean"},"EmailEnabled":{"type":"boolean"},"MarketingEmailEnabled":{"type":"boolean"},"Phone":{"type":"string","nullable":true},"PhoneFax":{"type":"string","nullable":true},"PhoneHome":{"type":"string","nullable":true},"PhoneOther":{"type":"string","nullable":true},"PhoneWork":{"type":"string","nullable":true},"BillingAddress":{"$ref":"#/components/schemas/PersonAddressModel"},"HomeAddress":{"$ref":"#/components/schemas/PersonAddressModel"},"ShippingAddress":{"$ref":"#/components/schemas/PersonAddressModel"},"ShippingPreference":{"type":"string","nullable":true},"WorkAddress":{"$ref":"#/components/schemas/PersonAddressModel"},"EmergencyContactName":{"type":"string","nullable":true},"EmergencyContactPhone":{"type":"string","nullable":true},"EmergencyContactRelationship":{"type":"string","nullable":true},"AgeGroup":{"type":"string","nullable":true},"Birthdate":{"type":"string","format":"date-time","nullable":true},"Citizenship":{"type":"string","nullable":true},"FirstLanguage":{"type":"string","nullable":true},"Gender":{"type":"string","nullable":true},"Language":{"type":"string","nullable":true},"Region":{"type":"string","nullable":true},"TimeZone":{"type":"string","nullable":true},"EmployerGroupId":{"type":"string","format":"uuid","nullable":true},"EmployeeType":{"type":"string","nullable":true},"EmployeeUnion":{"type":"string","nullable":true},"JobDivision":{"type":"string","nullable":true},"JobTitle":{"type":"string","nullable":true},"JobsApproved":{"type":"string","format":"date-time","nullable":true},"JobsApprovedBy":{"type":"string","nullable":true},"OccupationStandardId":{"type":"string","format":"uuid","nullable":true},"CandidateCompletionProfilePercent":{"type":"integer","format":"int32","nullable":true},"CandidateCompletionResumePercent":{"type":"integer","format":"int32","nullable":true},"CandidateIsActivelySeeking":{"type":"boolean","nullable":true},"CandidateIsWillingToRelocate":{"type":"boolean","nullable":true},"CandidateLinkedInUrl":{"type":"string","nullable":true},"CandidateOccupationList":{"type":"string","nullable":true},"ImmigrationApplicant":{"type":"string","nullable":true},"ImmigrationCategory":{"type":"string","nullable":true},"ImmigrationDestination":{"type":"string","nullable":true},"ImmigrationDisability":{"type":"string","nullable":true},"ImmigrationLandingDate":{"type":"string","format":"date-time","nullable":true},"ImmigrationNumber":{"type":"string","nullable":true},"MemberEndDate":{"type":"string","format":"date-time","nullable":true},"MembershipStatusItemId":{"type":"string","format":"uuid","nullable":true},"MemberStartDate":{"type":"string","format":"date-time","nullable":true},"CredentialingCountry":{"type":"string","nullable":true},"EducationLevel":{"type":"string","nullable":true},"IndustryItemId":{"type":"string","format":"uuid","nullable":true},"SocialInsuranceNumber":{"type":"string","nullable":true},"TradeworkerNumber":{"type":"string","nullable":true},"ConsentConsultation":{"type":"string","nullable":true},"ConsentToShare":{"type":"string","nullable":true},"Referrer":{"type":"string","nullable":true},"ReferrerOther":{"type":"string","nullable":true},"IsArchived":{"type":"boolean"},"WhenArchived":{"type":"string","format":"date-time","nullable":true},"WhenUnarchived":{"type":"string","format":"date-time","nullable":true},"AccountReviewCompleted":{"type":"string","format":"date-time","nullable":true},"AccountReviewQueued":{"type":"string","format":"date-time","nullable":true},"WebSiteUrl":{"type":"string","nullable":true},"Created":{"type":"string","format":"date-time"},"CreatedBy":{"type":"string","format":"uuid","nullable":true},"CustomKey":{"type":"integer","format":"int32","nullable":true},"Modified":{"type":"string","format":"date-time"},"ModifiedBy":{"type":"string","format":"uuid"},"SinModified":{"type":"string","format":"date-time","nullable":true},"LastChangeTime":{"type":"string","format":"date-time"},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","format":"uuid"}},"additionalProperties":false},"PersonAddressModel":{"type":"object","properties":{"AddressId":{"type":"string","format":"uuid"},"City":{"type":"string","nullable":true},"Country":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"PostalCode":{"type":"string","nullable":true},"Province":{"type":"string","nullable":true},"Street1":{"type":"string","nullable":true},"Street2":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The PersonSecretModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PersonSecretModel":{"type":"object","properties":{"PersonId":{"type":"string","format":"uuid"},"SecretId":{"type":"string","format":"uuid"},"SecretName":{"type":"string","nullable":true},"SecretType":{"type":"string","nullable":true},"SecretValue":{"type":"string","nullable":true},"SecretLifetimeLimit":{"type":"integer","format":"int32","nullable":true},"SecretExpiry":{"type":"string","format":"date-time"}},"additionalProperties":false}}}}
```

## The PolicyResult object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"PolicyResult":{"type":"object","properties":{"Controller":{"type":"string","nullable":true},"Action":{"type":"string","nullable":true},"Resource":{"type":"string","nullable":true},"Policy":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The Problem object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"Problem":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## The ProblemDetails object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ProblemDetails":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## The ProblemsResult object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ProblemsResult":{"type":"object","properties":{"ApiEndpointResourcesMissingFromPermissionMatrix":{"type":"array","items":{"type":"string"},"nullable":true},"PermissionMatrixResourcesNotUsedByAnyApiEndpoint":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}}}}
```

## The QueryFilter object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"QueryFilter":{"type":"object","properties":{"Page":{"type":"integer","format":"int32"},"PageSize":{"type":"integer","format":"int32"},"Sort":{"type":"string","nullable":true},"Excludes":{"type":"string","nullable":true},"Includes":{"type":"string","nullable":true},"Format":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The RegistrationMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"RegistrationMatch":{"type":"object","properties":{"RegistrationIdentifier":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The RegistrationModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"RegistrationModel":{"type":"object","properties":{"AttemptIdentifier":{"type":"string","format":"uuid","nullable":true},"CandidateIdentifier":{"type":"string","format":"uuid"},"CustomerIdentifier":{"type":"string","format":"uuid","nullable":true},"EmployerIdentifier":{"type":"string","format":"uuid","nullable":true},"EventIdentifier":{"type":"string","format":"uuid"},"ExamFormIdentifier":{"type":"string","format":"uuid","nullable":true},"OrganizationIdentifier":{"type":"string","format":"uuid"},"PaymentIdentifier":{"type":"string","format":"uuid","nullable":true},"RegistrationIdentifier":{"type":"string","format":"uuid"},"RegistrationRequestedBy":{"type":"string","format":"uuid","nullable":true},"SchoolIdentifier":{"type":"string","format":"uuid","nullable":true},"SeatIdentifier":{"type":"string","format":"uuid","nullable":true},"IncludeInT2202":{"type":"boolean"},"MaterialsIncludeDiagramBook":{"type":"boolean","nullable":true},"ApprovalProcess":{"type":"string","nullable":true},"ApprovalReason":{"type":"string","nullable":true},"ApprovalStatus":{"type":"string","nullable":true},"AttendanceStatus":{"type":"string","nullable":true},"BillingCode":{"type":"string","nullable":true},"BillingCustomer":{"type":"string","nullable":true},"CandidateType":{"type":"string","nullable":true},"EligibilityProcess":{"type":"string","nullable":true},"EligibilityStatus":{"type":"string","nullable":true},"EventPotentialConflicts":{"type":"string","nullable":true},"Grade":{"type":"string","nullable":true},"GradeWithheldReason":{"type":"string","nullable":true},"GradingProcess":{"type":"string","nullable":true},"GradingStatus":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"MaterialsPackagedForDistribution":{"type":"string","nullable":true},"MaterialsPermittedToCandidates":{"type":"string","nullable":true},"RegistrationComment":{"type":"string","nullable":true},"RegistrationPassword":{"type":"string","nullable":true},"RegistrationSource":{"type":"string","nullable":true},"SynchronizationProcess":{"type":"string","nullable":true},"SynchronizationStatus":{"type":"string","nullable":true},"ExamTimeLimit":{"type":"integer","format":"int32","nullable":true},"RegistrationSequence":{"type":"integer","format":"int32","nullable":true},"WorkBasedHoursToDate":{"type":"integer","format":"int32","nullable":true},"RegistrationFee":{"type":"number","format":"double","nullable":true},"Score":{"type":"number","format":"double","nullable":true},"AttendanceTaken":{"type":"string","format":"date-time","nullable":true},"DistributionExpected":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdated":{"type":"string","format":"date-time","nullable":true},"GradeAssigned":{"type":"string","format":"date-time","nullable":true},"GradePublished":{"type":"string","format":"date-time","nullable":true},"GradeReleased":{"type":"string","format":"date-time","nullable":true},"GradeWithheld":{"type":"string","format":"date-time","nullable":true},"LastChangeTime":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOn":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchAchievements object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchAchievements":{"type":"object","properties":{"AchievementTitle":{"type":"string","nullable":true},"ExpirationFixedDateSince":{"type":"string","format":"date-time","nullable":true},"ExpirationFixedDateBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchAttempts object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchAttempts":{"type":"object","properties":{"AttemptStatus":{"type":"string","nullable":true},"AttemptGradedSince":{"type":"string","format":"date-time","nullable":true},"AttemptGradedBefore":{"type":"string","format":"date-time","nullable":true},"AttemptImportedSince":{"type":"string","format":"date-time","nullable":true},"AttemptImportedBefore":{"type":"string","format":"date-time","nullable":true},"AttemptPingedSince":{"type":"string","format":"date-time","nullable":true},"AttemptPingedBefore":{"type":"string","format":"date-time","nullable":true},"AttemptStartedSince":{"type":"string","format":"date-time","nullable":true},"AttemptStartedBefore":{"type":"string","format":"date-time","nullable":true},"AttemptSubmittedSince":{"type":"string","format":"date-time","nullable":true},"AttemptSubmittedBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchBanks object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchBanks":{"type":"object","properties":{"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"IsActive":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The SearchCaseStatuses object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchCaseStatuses":{"type":"object","properties":{"CaseTypeContains":{"type":"string","nullable":true},"CaseTypeExact":{"type":"string","nullable":true},"StatusNameContains":{"type":"string","nullable":true},"StatusNameExact":{"type":"string","nullable":true},"StatusCategoryContains":{"type":"string","nullable":true},"StatusCategoryExact":{"type":"string","nullable":true},"ReportCategoryContains":{"type":"string","nullable":true},"ReportCategoryExact":{"type":"string","nullable":true},"StatusSequenceSince":{"type":"integer","format":"int32","nullable":true},"StatusSequenceBefore":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false}}}}
```

## The SearchCases object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchCases":{"type":"object","properties":{"CaseClosedSince":{"type":"string","format":"date-time","nullable":true},"CaseClosedBefore":{"type":"string","format":"date-time","nullable":true},"CaseOpenedSince":{"type":"string","format":"date-time","nullable":true},"CaseOpenedBefore":{"type":"string","format":"date-time","nullable":true},"CaseReportedSince":{"type":"string","format":"date-time","nullable":true},"CaseReportedBefore":{"type":"string","format":"date-time","nullable":true},"CaseStatusEffectiveSince":{"type":"string","format":"date-time","nullable":true},"CaseStatusEffectiveBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchCourses object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchCourses":{"type":"object","properties":{"ClosedSince":{"type":"string","format":"date-time","nullable":true},"ClosedBefore":{"type":"string","format":"date-time","nullable":true},"CreatedSince":{"type":"string","format":"date-time","nullable":true},"CreatedBefore":{"type":"string","format":"date-time","nullable":true},"ModifiedSince":{"type":"string","format":"date-time","nullable":true},"ModifiedBefore":{"type":"string","format":"date-time","nullable":true},"IsPublished":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The SearchCredentials object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchCredentials":{"type":"object","properties":{"AchievementId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid","nullable":true},"ModifiedFrom":{"type":"string","format":"date-time","nullable":true},"ModifiedBefore":{"type":"string","format":"date-time","nullable":true},"PersonCode":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The SearchEvents object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchEvents":{"type":"object","properties":{"DistributionExpectedSince":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedBefore":{"type":"string","format":"date-time","nullable":true},"DistributionOrderedSince":{"type":"string","format":"date-time","nullable":true},"DistributionOrderedBefore":{"type":"string","format":"date-time","nullable":true},"DistributionShippedSince":{"type":"string","format":"date-time","nullable":true},"DistributionShippedBefore":{"type":"string","format":"date-time","nullable":true},"DistributionTrackedSince":{"type":"string","format":"date-time","nullable":true},"DistributionTrackedBefore":{"type":"string","format":"date-time","nullable":true},"EventScheduledEndSince":{"type":"string","format":"date-time","nullable":true},"EventScheduledEndBefore":{"type":"string","format":"date-time","nullable":true},"EventScheduledStartSince":{"type":"string","format":"date-time","nullable":true},"EventScheduledStartBefore":{"type":"string","format":"date-time","nullable":true},"ExamMaterialReturnShipmentReceivedSince":{"type":"string","format":"date-time","nullable":true},"ExamMaterialReturnShipmentReceivedBefore":{"type":"string","format":"date-time","nullable":true},"ExamStartedSince":{"type":"string","format":"date-time","nullable":true},"ExamStartedBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationDeadlineSince":{"type":"string","format":"date-time","nullable":true},"RegistrationDeadlineBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationLockedSince":{"type":"string","format":"date-time","nullable":true},"RegistrationLockedBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationStartSince":{"type":"string","format":"date-time","nullable":true},"RegistrationStartBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchFiles object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchFiles":{"type":"object","properties":{"ObjectId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid","nullable":true},"FileIds":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"ObjectTypeExact":{"type":"string","nullable":true},"ObjectIdentifierContains":{"type":"string","nullable":true},"FileNameContains":{"type":"string","nullable":true},"DocumentNameContains":{"type":"string","nullable":true},"FileUploadedSince":{"type":"string","format":"date-time","nullable":true},"FileUploadedBefore":{"type":"string","format":"date-time","nullable":true},"HasClaims":{"type":"boolean","nullable":true},"FileTag":{"$ref":"#/components/schemas/FileTag"}},"additionalProperties":false},"FileTag":{"enum":["PersonImport"],"type":"string"}}}}
```

## The SearchForms object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchForms":{"type":"object","properties":{"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"SurveyFormClosedSince":{"type":"string","format":"date-time","nullable":true},"SurveyFormClosedBefore":{"type":"string","format":"date-time","nullable":true},"SurveyFormLockedSince":{"type":"string","format":"date-time","nullable":true},"SurveyFormLockedBefore":{"type":"string","format":"date-time","nullable":true},"SurveyFormOpenedSince":{"type":"string","format":"date-time","nullable":true},"SurveyFormOpenedBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchGradebooks object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchGradebooks":{"type":"object","properties":{"AchievementId":{"type":"string","format":"uuid","nullable":true},"ClassId":{"type":"string","format":"uuid","nullable":true},"ClassInstructorId":{"type":"string","format":"uuid","nullable":true},"FrameworkId":{"type":"string","format":"uuid","nullable":true},"PeriodId":{"type":"string","format":"uuid","nullable":true},"IsLocked":{"type":"boolean","nullable":true},"ClassTitle":{"type":"string","nullable":true},"GradebookTitle":{"type":"string","nullable":true},"GradebookType":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"Reference":{"type":"string","nullable":true},"ClassStartedSince":{"type":"string","format":"date-time","nullable":true},"ClassStartedBefore":{"type":"string","format":"date-time","nullable":true},"GradebookCreatedSince":{"type":"string","format":"date-time","nullable":true},"GradebookCreatedBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchGroups object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchGroups":{"type":"object","properties":{"GroupCode":{"type":"string","nullable":true},"GroupCreatedSince":{"type":"string","format":"date-time","nullable":true},"GroupCreatedBefore":{"type":"string","format":"date-time","nullable":true},"GroupExpirySince":{"type":"string","format":"date-time","nullable":true},"GroupExpiryBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchMemberships object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchMemberships":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid","nullable":true},"UserId":{"type":"string","format":"uuid","nullable":true},"AccountScope":{"type":"string","nullable":true},"MembershipEffectiveSince":{"type":"string","format":"date-time","nullable":true},"MembershipEffectiveBefore":{"type":"string","format":"date-time","nullable":true},"MembershipExpirySince":{"type":"string","format":"date-time","nullable":true},"MembershipExpiryBefore":{"type":"string","format":"date-time","nullable":true},"ModifiedSince":{"type":"string","format":"date-time","nullable":true},"ModifiedBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchOrganizations object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchOrganizations":{"type":"object","properties":{"CompanyNameContains":{"type":"string","nullable":true},"OrganizationCode":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The SearchPages object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchPages":{"type":"object","properties":{"ObjectId":{"type":"string","format":"uuid","nullable":true},"ParentPageId":{"type":"string","format":"uuid","nullable":true},"SiteId":{"type":"string","format":"uuid","nullable":true},"IsAccessDenied":{"type":"boolean","nullable":true},"IsHidden":{"type":"boolean","nullable":true},"IsNewTab":{"type":"boolean","nullable":true},"IsNullNavigateUrl":{"type":"boolean","nullable":true},"AuthorName":{"type":"string","nullable":true},"ContentControl":{"type":"string","nullable":true},"ContentLabels":{"type":"string","nullable":true},"Hook":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"NavigateUrl":{"type":"string","nullable":true},"ObjectType":{"type":"string","nullable":true},"PageIcon":{"type":"string","nullable":true},"PageSlug":{"type":"string","nullable":true},"PageType":{"type":"string","nullable":true},"ParentPageSlug":{"type":"string","nullable":true},"ParentPageType":{"type":"string","nullable":true},"SiteDomain":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Sequence":{"type":"integer","format":"int32","nullable":true},"AuthorDateSince":{"type":"string","format":"date-time","nullable":true},"AuthorDateBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchPeople object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchPeople":{"type":"object","properties":{"UserId":{"type":"string","format":"uuid","nullable":true},"EmailExact":{"type":"string","nullable":true},"EmailLike":{"type":"string","nullable":true},"EventRole":{"type":"string","nullable":true},"FullName":{"type":"string","nullable":true},"PersonCode":{"type":"string","nullable":true},"FirstNameExact":{"type":"string","nullable":true},"LastNameExact":{"type":"string","nullable":true},"LastAuthenticatedSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"IsApproved":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The SearchPeriods object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchPeriods":{"type":"object","properties":{"Name":{"type":"string","nullable":true},"EndSince":{"type":"string","format":"date-time","nullable":true},"EndBefore":{"type":"string","format":"date-time","nullable":true},"StartSince":{"type":"string","format":"date-time","nullable":true},"StartBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchRegistrations object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchRegistrations":{"type":"object","properties":{"AttendanceTakenSince":{"type":"string","format":"date-time","nullable":true},"AttendanceTakenBefore":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedSince":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedBefore":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdatedSince":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdatedBefore":{"type":"string","format":"date-time","nullable":true},"GradeAssignedSince":{"type":"string","format":"date-time","nullable":true},"GradeAssignedBefore":{"type":"string","format":"date-time","nullable":true},"GradePublishedSince":{"type":"string","format":"date-time","nullable":true},"GradePublishedBefore":{"type":"string","format":"date-time","nullable":true},"GradeReleasedSince":{"type":"string","format":"date-time","nullable":true},"GradeReleasedBefore":{"type":"string","format":"date-time","nullable":true},"GradeWithheldSince":{"type":"string","format":"date-time","nullable":true},"GradeWithheldBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOnSince":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOnBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchSites object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchSites":{"type":"object","properties":{"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchStandards object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchStandards":{"type":"object","properties":{"ParentStandardId":{"type":"string","format":"uuid","nullable":true},"ParentStandardIds":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"StandardIds":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"ContentTitle":{"type":"string","nullable":true},"StandardType":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The SearchSubmissions object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchSubmissions":{"type":"object","properties":{"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"ResponseSessionCompletedSince":{"type":"string","format":"date-time","nullable":true},"ResponseSessionCompletedBefore":{"type":"string","format":"date-time","nullable":true},"ResponseSessionCreatedSince":{"type":"string","format":"date-time","nullable":true},"ResponseSessionCreatedBefore":{"type":"string","format":"date-time","nullable":true},"ResponseSessionStartedSince":{"type":"string","format":"date-time","nullable":true},"ResponseSessionStartedBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchUserConnections object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchUserConnections":{"type":"object","properties":{"ConnectedSince":{"type":"string","format":"date-time","nullable":true},"ConnectedBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SearchUsers object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SearchUsers":{"type":"object","properties":{"UserIds":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"UserEmailExact":{"type":"string","nullable":true},"UserFullNameContains":{"type":"string","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SiteMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SiteMatch":{"type":"object","properties":{"SiteId":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The SiteModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SiteModel":{"type":"object","properties":{"SiteId":{"type":"string","format":"uuid"},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"SiteDomain":{"type":"string","nullable":true},"SiteTitle":{"type":"string","nullable":true},"LastChangeTime":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The SiteSettings object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SiteSettings":{"type":"object","properties":{"TimeZoneId":{"type":"string","nullable":true},"OrganizationCode":{"type":"string","nullable":true},"DomainName":{"type":"string","nullable":true},"CompanyName":{"type":"string","nullable":true},"IsCmds":{"type":"boolean"},"Home":{"$ref":"#/components/schemas/HomeSettings"},"UserName":{"type":"string","nullable":true},"IsAdministrator":{"type":"boolean"},"IsOperator":{"type":"boolean"},"IsMultiOrganization":{"type":"boolean"},"ImpersonatorName":{"type":"string","nullable":true},"MyDashboard":{"$ref":"#/components/schemas/LinkModel"},"Permissions":{"$ref":"#/components/schemas/PermissionsModel"},"Environment":{"$ref":"#/components/schemas/EnvironmentModel"},"StylePath":{"type":"string","nullable":true},"AdminNavigationLogo":{"type":"string","nullable":true},"UserHostAddress":{"type":"string","nullable":true},"SessionTimeoutMinutes":{"type":"integer","format":"int32"},"AllApps":{"type":"array","items":{"$ref":"#/components/schemas/MenuModel"},"nullable":true},"FrequentlyUsedApps":{"type":"array","items":{"$ref":"#/components/schemas/MenuLinkModel"},"nullable":true},"ShortcutGroups":{"type":"array","items":{"$ref":"#/components/schemas/MenuLinkModel"},"nullable":true},"AdminNavigationGroups":{"type":"array","items":{"$ref":"#/components/schemas/MenuModel"},"nullable":true},"PlatformSearchDownloadMaximumRows":{"type":"integer","format":"int32"},"PartitionEmail":{"type":"string","nullable":true},"CurrentLanguage":{"type":"string","nullable":true},"SupportedLanguages":{"type":"array","items":{"type":"string"},"nullable":true},"RecentLinksKey":{"type":"string","nullable":true}},"additionalProperties":false},"HomeSettings":{"type":"object","properties":{"Text":{"type":"string","nullable":true},"Url":{"type":"string","nullable":true},"Icon":{"type":"string","nullable":true},"Image":{"type":"string","nullable":true}},"additionalProperties":false},"LinkModel":{"type":"object","properties":{"Url":{"type":"string","nullable":true},"Text":{"type":"string","nullable":true}},"additionalProperties":false},"PermissionsModel":{"type":"object","properties":{"Accounts":{"type":"boolean"},"Integrations":{"type":"boolean"},"Settings":{"type":"boolean"}},"additionalProperties":false},"EnvironmentModel":{"type":"object","properties":{"Name":{"type":"string","nullable":true},"Version":{"type":"string","nullable":true},"Color":{"type":"string","nullable":true}},"additionalProperties":false},"MenuModel":{"type":"object","properties":{"Title":{"type":"string","nullable":true},"MenuItems":{"type":"array","items":{"$ref":"#/components/schemas/MenuLinkModel"},"nullable":true}},"additionalProperties":false},"MenuLinkModel":{"type":"object","properties":{"Url":{"type":"string","nullable":true},"Text":{"type":"string","nullable":true},"Icon":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The StandardMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"StandardMatch":{"type":"object","properties":{"Id":{"type":"string","format":"uuid"},"ParentId":{"type":"string","format":"uuid","nullable":true},"Code":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Type":{"type":"string","nullable":true},"Label":{"type":"string","nullable":true},"AssetNumber":{"type":"integer","format":"int32"},"Sequence":{"type":"integer","format":"int32"}},"additionalProperties":false}}}}
```

## The StandardModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"StandardModel":{"type":"object","properties":{"BankId":{"type":"string","format":"uuid","nullable":true},"BankSetId":{"type":"string","format":"uuid","nullable":true},"CategoryItemId":{"type":"string","format":"uuid","nullable":true},"CreatedBy":{"type":"string","format":"uuid"},"DepartmentGroupId":{"type":"string","format":"uuid","nullable":true},"IndustryItemId":{"type":"string","format":"uuid","nullable":true},"ModifiedBy":{"type":"string","format":"uuid"},"ParentStandardId":{"type":"string","format":"uuid","nullable":true},"StandardId":{"type":"string","format":"uuid"},"StandardStatusLastUpdateUser":{"type":"string","format":"uuid","nullable":true},"IsCertificateEnabled":{"type":"boolean"},"IsFeedbackEnabled":{"type":"boolean"},"IsHidden":{"type":"boolean"},"IsLocked":{"type":"boolean"},"IsPractical":{"type":"boolean"},"IsPublished":{"type":"boolean"},"IsTemplate":{"type":"boolean"},"IsTheory":{"type":"boolean"},"AuthorName":{"type":"string","nullable":true},"CanvasIdentifier":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true},"CompetencyScoreCalculationMethod":{"type":"string","nullable":true},"CompetencyScoreSummarizationMethod":{"type":"string","nullable":true},"ContentDescription":{"type":"string","nullable":true},"ContentName":{"type":"string","nullable":true},"ContentSettings":{"type":"string","nullable":true},"ContentSummary":{"type":"string","nullable":true},"ContentTitle":{"type":"string","nullable":true},"CreditIdentifier":{"type":"string","nullable":true},"DocumentType":{"type":"string","nullable":true},"Icon":{"type":"string","nullable":true},"Language":{"type":"string","nullable":true},"LevelCode":{"type":"string","nullable":true},"LevelType":{"type":"string","nullable":true},"MajorVersion":{"type":"string","nullable":true},"MinorVersion":{"type":"string","nullable":true},"SourceDescriptor":{"type":"string","nullable":true},"StandardAlias":{"type":"string","nullable":true},"StandardHook":{"type":"string","nullable":true},"StandardLabel":{"type":"string","nullable":true},"StandardPrivacyScope":{"type":"string","nullable":true},"StandardStatus":{"type":"string","nullable":true},"StandardTier":{"type":"string","nullable":true},"StandardType":{"type":"string","nullable":true},"Tags":{"type":"string","nullable":true},"AssetNumber":{"type":"integer","format":"int32"},"CalculationArgument":{"type":"integer","format":"int32","nullable":true},"Sequence":{"type":"integer","format":"int32"},"CertificationHoursPercentCore":{"type":"number","format":"double","nullable":true},"CertificationHoursPercentNonCore":{"type":"number","format":"double","nullable":true},"CreditHours":{"type":"number","format":"double","nullable":true},"MasteryPoints":{"type":"number","format":"double","nullable":true},"PassingScore":{"type":"number","format":"double","nullable":true},"PointsPossible":{"type":"number","format":"double","nullable":true},"AuthorDate":{"type":"string","format":"date-time","nullable":true},"Created":{"type":"string","format":"date-time"},"DatePosted":{"type":"string","format":"date-time","nullable":true},"Modified":{"type":"string","format":"date-time"},"StandardStatusLastUpdateTime":{"type":"string","format":"date-time","nullable":true},"UtcPublished":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The StatusEnum object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"StatusEnum":{"enum":["Modified","NotChanged","Created","Pending","Error"],"type":"string"}}}}
```

## The StringStringKeyValuePair object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"StringStringKeyValuePair":{"type":"object","properties":{"Key":{"type":"string","nullable":true},"Value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The SubmissionMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SubmissionMatch":{"type":"object","properties":{"ResponseSessionId":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The SubmissionModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"SubmissionModel":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid","nullable":true},"LastAnsweredQuestionId":{"type":"string","format":"uuid","nullable":true},"LastChangeUser":{"type":"string","format":"uuid"},"PeriodId":{"type":"string","format":"uuid","nullable":true},"RespondentUserId":{"type":"string","format":"uuid"},"ResponseSessionId":{"type":"string","format":"uuid"},"SurveyFormId":{"type":"string","format":"uuid"},"ResponseIsLocked":{"type":"boolean"},"LastChangeType":{"type":"string","nullable":true},"RespondentLanguage":{"type":"string","nullable":true},"ResponseSessionStatus":{"type":"string","nullable":true},"LastChangeTime":{"type":"string","format":"date-time"},"ResponseSessionCompleted":{"type":"string","format":"date-time","nullable":true},"ResponseSessionCreated":{"type":"string","format":"date-time","nullable":true},"ResponseSessionStarted":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The UserConnectionMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"UserConnectionMatch":{"type":"object","properties":{"FromUserId":{"type":"string","format":"uuid"},"ToUserId":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The UserConnectionModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"UserConnectionModel":{"type":"object","properties":{"FromUserId":{"type":"string","format":"uuid"},"ToUserId":{"type":"string","format":"uuid"},"IsLeader":{"type":"boolean"},"IsManager":{"type":"boolean"},"IsSupervisor":{"type":"boolean"},"IsValidator":{"type":"boolean"},"Connected":{"type":"string","format":"date-time"},"LastChangeTime":{"type":"string","format":"date-time"},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The UserMatch object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"UserMatch":{"type":"object","properties":{"UserId":{"type":"string","format":"uuid"},"FullName":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The UserModel object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"UserModel":{"type":"object","properties":{"UserId":{"type":"string","format":"uuid"},"AccessGrantedToCmds":{"type":"boolean"},"MultiFactorAuthentication":{"type":"boolean"},"DefaultPassword":{"type":"string","nullable":true},"Email":{"type":"string","nullable":true},"EmailAlternate":{"type":"string","nullable":true},"EmailVerified":{"type":"string","nullable":true},"FirstName":{"type":"string","nullable":true},"FullName":{"type":"string","nullable":true},"Honorific":{"type":"string","nullable":true},"ImageUrl":{"type":"string","nullable":true},"Initials":{"type":"string","nullable":true},"LastName":{"type":"string","nullable":true},"LoginOrganizationCode":{"type":"string","nullable":true},"MiddleName":{"type":"string","nullable":true},"MultiFactorAuthenticationCode":{"type":"string","nullable":true},"OAuthProviderUserId":{"type":"string","nullable":true},"OldUserPasswordHash":{"type":"string","nullable":true},"PhoneMobile":{"type":"string","nullable":true},"SoundexFirstName":{"type":"string","nullable":true},"SoundexLastName":{"type":"string","nullable":true},"TimeZone":{"type":"string","nullable":true},"UserPasswordHash":{"type":"string","nullable":true},"PrimaryLoginMethod":{"type":"integer","format":"int32","nullable":true},"SecondaryLoginMethod":{"type":"integer","format":"int32","nullable":true},"UserPasswordChangeRequested":{"type":"integer","format":"int32","nullable":true},"AccountCloaked":{"type":"string","format":"date-time","nullable":true},"DefaultPasswordExpired":{"type":"string","format":"date-time","nullable":true},"UserLicenseAccepted":{"type":"string","format":"date-time","nullable":true},"UserPasswordChanged":{"type":"string","format":"date-time","nullable":true},"UserPasswordExpired":{"type":"string","format":"date-time"},"UtcArchived":{"type":"string","format":"date-time","nullable":true},"UtcUnarchived":{"type":"string","format":"date-time","nullable":true},"LastChangeTime":{"type":"string","format":"date-time"},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The ValidateInput object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ValidateInput":{"type":"object","properties":{"Token":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The ValidationFailure object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"ValidationFailure":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/Problem"},"nullable":true}},"additionalProperties":false},"Problem":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## The VersionResponse object

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"components":{"schemas":{"VersionResponse":{"type":"object","properties":{"Version":{"type":"string","nullable":true},"Major":{"type":"integer","format":"int32"},"Minor":{"type":"integer","format":"int32"},"Build":{"type":"integer","format":"int32"},"Revision":{"type":"integer","format":"int32"}},"additionalProperties":false}}}}
```


---

# 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://docs.shiftiq.com/developers/api-v2/navigating-the-api/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.