DocumentTypeInfo PropertiesProvincial Approach to Student Information API

The DocumentTypeInfo type exposes the following members.

Properties

  NameDescription
Public propertyCanHaveMultipleRelevant
(Required) True when a student can have multiple documents of this type that are flagged as being relevant
Public propertyCategories
(Required) Identifies the categories that describe this document type
Public propertyDescription
(Required) A description of this document type
Public propertyDisposalAction
(Required) The action taken on the document when the retention period ends
Public propertyDocumentType
(Required) The business key for document type
Public propertyEffectiveEndDate
The last date that documents can be uploaded or edited for this document type
Public propertyEffectiveStartDate
(Required) The date that documents can be uploaded for this document type
Public propertyIsDateRequired
(Required) True when documents of this type require a document date
Public propertyIsExpiryDateRequired
(Required) True when documents of this type require an expiry date
Public propertyIsOrganizationBound
(Required) True if documents of this type are bound to the organization that added it
Public propertyIsRestricted
(Required) True when documents of this type are only accessible to Ministry representatives
Public propertyIsSchoolYearBound
(Required) True when documents of this document type are tied to a specific school year
Public propertyMaximumImageFileSize
(Required) The maximum file size acceptable for this document type in KB
Public propertyName
(Required) The name of this document type
Public propertyQualityAssuranceRatio
(Required) The percentage of documents of this type that will be targeted for quality assurance
Public propertyRetentionPeriod
(Required) Indicates the length of time the document needs to be kept active
Public propertyRetentionSchedule
(Required) The retention policy for documents of this document type
Public propertySecurityClassification
(Required) Identifies the minimum level of for documents of this type
Public propertySourceDocumentQuality
(Required) Identifies Source Document Quality for document Type
Top
See Also

Reference