SIFWorks ADK 2.0
Edustructures.SifWorks.Reporting Namespace
NamespacesEdustructures.SifWorks.Reporting

[This is preliminary documentation and is subject to change.]

[Missing namespace summary documentation for N:Edustructures.SifWorks.Reporting]

Declaration Syntax
C#Visual BasicVisual C++
namespace Edustructures.SifWorks.Reporting
Namespace Edustructures.SifWorks.Reporting
namespace Edustructures.SifWorks.Reporting
Types
All TypesClasses
IconTypeDescription
AuthorityLevel
Defines the set of values that can be specified whenever an AuthorityLevel is used as a parameter to a method or constructor.

IdStatus
Defines the set of values that can be specified whenever an IdStatus is used as a parameter to a method or constructor.

ReceivingAuthority
The authority for whom the report is intended, usually the same authority that defines this manifest.

ReportAuthorityInfo
This object contains information on authorities that provide ReportManifest objects and/or collect SIF_ReportObject objects, such as state departments of education, regional service agencies, or other report collecting agencies. SIF_Events are reported.

ReportData
Container element for the report content. This element is conditional. This element is included or the ReportInfo element is included but never both at the same time. See examples of the usage of the object below.

ReportDefinitionSource
Indicates where the report definition can be found. If Type="Description", this element's value contains the report definition. If Type="URL", this element's value is the URL pointing to the external source for the definition. Type="SIF_Query" indicates that the SIF_QueryGroup element below contains the definition.

ReportDefinitionSourceType
Defines the set of values that can be specified whenever a ReportDefinitionSourceType is used as a parameter to a method or constructor.

ReportFormat
References a third-party format that describes the visual representation of the report data.

ReportFormatList
A ReportFormatList

ReportFormatType
Defines the set of values that can be specified whenever a ReportFormatType is used as a parameter to a method or constructor.

ReportInfo
Identifies the manifest for the report and characteristics of the submission. This element is a conditional element. This element is included or the ReportData element is included but never both at the same time within an instance of this object. See examples of the usage of the object below.

ReportingDTD
Metadata for the Schools Interoperability Framework (SIF)

ReportingPeriod
Information on the period of time over which the report spans.

ReportManifest
This object provides a way to define a report within a SIF zone. It contains metadata about the report. This object represents a mutual agreement between senders and receivers of the report. SIF_Events are reported.

ReportSubmitterInfo
Identifies the submitter of the report.This element is conditional depending on the context in which the SIF_ReportObject is used. It must be present in the ReportInfo element when a SIF_ReportObject is sent to a report authority in a SIF_Event message. However, its presence is optional in SIF_ReportObject packets delivered to report authorities in SIF_Response messages.

RequestingAgencyId
Identification of the agency and/or location requesting the state ID. Optional because the SIF Zone infrastructure may provide adequate information for the state to ascertain the origin of the request.NOTE: Although used in the context of a Request query, this field conveys information to the state and typically does not participate in the matching logic.

RequestingAgencyIdType
Defines the set of values that can be specified whenever a RequestingAgencyIdType is used as a parameter to a method or constructor.

SIF_QueryGroup
A SIF_QueryGroup

SIF_ReportObject
This object is an envelope used to send other data objects, typically reports, to authorities such as state departments of education, district offices, other schools, etc. It is also used to signal a data collector agent that a report is compiled and ready to be requested. SIF_ReportObject contains a data object, which is either complete or partial (a partial data object is one that contains a subset of the elements for the data object). One or a series of SIF_ReportObjects contained within one or a series of related SIF_Response messages makes up a complete report. SIF_Events are reported.

SLContact
Typically used to provide the state information about a student's parents and legal guardians.

StudentLocator
An example SIF object that serves as a template for matching objects. There is an implied EQ operator for every element/attribute value present and an implied And group of all resulting conditions. Currently this is an experimental feature and limited to use with StudentLocator; wider use may be considered in future major versions of this specification.

SubmissionReason
Defines the set of values that can be specified whenever a SubmissionReason is used as a parameter to a method or constructor.