srePermissionRequests
http://www.sifassociation.org/datamodel/na/3.5
Documentation
Before a requester can access the sre object for a student, he must have obtained permission. This permission is tracked through this child resource called a "Permission Request", which contains details of the request, the status of the approval, and a token that is used to obtain the sre object in the next step. Because permission approvals will often require human intervention, these is likely to be issued as a SIF delayed request (although not required).
Tree
Table
Name | Mandatory | Characteristics | Type | Description | XPath |
---|---|---|---|---|---|
@refId | * | gRefIdType | /srePermissionRequests/srePermissionRequest/@refId | ||
srePermissionRequest | any | /srePermissionRequests/srePermissionRequest | |||
jobId | O | gUUIDType | The Sif Infrastructure guid that the srePermissionRequest belongs to. | /srePermissionRequests/srePermissionRequest/jobId | |
isActive | O | boolean | Indicates whether this permission request is the currently active request. SRE Job API Providers should update this value automatically based on the current conditions of the SRE Job. | /srePermissionRequests/srePermissionRequest/isActive | |
isApproved | O | boolean | Indicates whether this permission request has been approved by the provider school district. SRE Job API Providers should update this value automatically based on the current conditions of the SRE Job. If this value is not provided, then the request has not yet been approved or denied, and consumers should requery the object later to check for approval. | /srePermissionRequests/srePermissionRequest/isApproved | |
requesterComment | O | string | Human readable content provided by the requestor that helps clarify the purpose or scope of the request. | /srePermissionRequests/srePermissionRequest/requesterComment | |
providerComment | O | string | Human readable content that explains the decision or status of accepting or rejecting this request. | /srePermissionRequests/srePermissionRequest/providerComment | |
xpath | O | string | An xPath for a part of the student record object. For example, "/enrollments". | /srePermissionRequests/srePermissionRequest/requestedData/xpath |
Download: .xlsx (with CEDS & Formats)
Structure