getElectronicTranscriptRunHistory: Get a specific ElectronicTranscriptRunHistory

Description Usage Arguments Value References

Description

This function returns fields for an ElectronicTranscriptRunHistory.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
getElectronicTranscriptRunHistory(
  ElectronicTranscriptRunHistoryID,
  EntityID = 1,
  returnElectronicTranscriptRunHistoryID = F,
  returnAPIErrorCount = F,
  returnAPISuccessCount = F,
  returnCanAccessMedia = F,
  returnCreatedTime = F,
  returnDistrictID = F,
  returnEndDateTime = F,
  returnEntityIDExportedFor = F,
  returnHasAnEntityExport = F,
  returnHasValidMedia = F,
  returnIsExport = F,
  returnIsLocked = F,
  returnMediaID = F,
  returnModifiedTime = F,
  returnRunData = F,
  returnRunParameters = F,
  returnSchoolYearID = F,
  returnScopeAccessAllowed = F,
  returnStartDateTime = F,
  returnStatus = F,
  returnStatusCode = F,
  returnStudentFilterDisplay = F,
  returnType = F,
  returnTypeCode = F,
  returnUserIDCanceledBy = F,
  returnUserIDCreatedBy = F,
  returnUserIDModifiedBy = F
)

Arguments

ElectronicTranscriptRunHistoryID

The id of the ElectronicTranscriptRunHistory.
Run getAllElectronicTranscriptRunHistories for a list of ElectronicTranscriptRunHistories.

EntityID

The id of the entity. Run getAllEntities for a list of entities.

returnFieldName

A TRUE or FALSE value determining whether or not to return FieldName for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.

Value

Details for the ElectronicTranscriptRunHistory.

References

{yourApiUrl}/swagger

Skyward's Knowledge Hub


samterfa/SkywardSDK documentation built on Oct. 13, 2020, 6:53 a.m.