GetSubjectStatus
Used to retrieve the subject-level statuses for multiple subjects in one project. These statuses are used to determine whether all the subject info and settings are available.
Syntax
SubjectStatus GetSubjectStatus(string APIKeyHeader, string Message, string[] ProjectIDs, string[] subjectIDs, string[] AdditionalFields)
Inputs: <InputParameter>
This function takes two parameters ProjectID and SubjectIDs
| Parameter | Attribute Type | Description |
|---|---|---|
| DataSourceID: string | Message Header | |
| ProjectID : string | ||
| SubjectIDs : string [][] | The corresponding subjectsSince there might be subject/secondary subject, a two dimensional array is used. For example: Course1 Teacher1Course1 Teacher2 The corresponding subjectsSince there might be subject/secondary subject, a two dimensional array is used. For example: Course1 Teacher1Course1 Teacher2 |
Outputs: SubjectStatus
A collection of object of type SubjectStatus.
SubjectStatus Structure
| Parameter | Attribute Type | Description |
|---|---|---|
| TransactionID: long | Message Header | |
| Message: string | Message Header | |
| SubjectIDs: string[] | The subjectID which the statuses belong to. | |
| OptInOptOut: string | optout | |
| PaperOnline: string | A value indicates whether the evaluation is paper or online or both. Value: “paper” or “online” or “both”. This status only associated with Primary subjectIn the case of only secondary SubjectID inputted, empty string is returned.This status only associated with Primary subjectIn the case of only secondary SubjectID inputted, empty string is returned. | |
| StartDate: DateTime | Value: the evaluation start time for the inputted subject In the case of only secondary SubjectID inputted, min datetime value is returned. Value: the evaluation start time for the inputted subjectIn the case of only secondary SubjectID inputted, min datetime value is returned. | |
| EndDate: DateTime | Value: the evaluation end time for the inputted subject In the case of only secondary SubjectID inputted, min datetime value is returned. Value: the evaluation end time for the inputted subjectIn the case of only secondary SubjectID inputted, min datetime value is returned. | |
| StartedStopped: string | A value indicates the current status of the subject evaluation process whether it started or stopped Value: “started” or” stopped” A value indicates the current status of the subject evaluation process whether it started or stoppedValue: “started” or” stopped” | |
| AutoManual: string | A project setting to indicate whether subject can have control to start/stop their own evaluation process. Value: “manual” or “auto” This status only associated with Primary subject In the case of only secondary SubjectID inputted, empty string is returned. A project setting to indicate whether subject can have control to start/stop their own evaluation process.Value: “manual” or “auto”This status only associated with Primary subjectIn the case of only secondary SubjectID inputted, empty string is returned. |
Back to top