Home‎ > ‎Archive‎ > ‎Developer‎ > ‎Application Programming Interface‎ > ‎

Program Site Visit Data


Description

Access PESB's data related to education program site visit reports.  

URL

https://script.google.com/macros/s/AKfycbwiHvEekfpwr-EozdDXCCOahYowueCS84ULBg6lfWg32mhrudI/exec

Method

GET


Parameters

 Parameters TYPE

 report

 STRING

 institutionCode

 INTEGER

 programType

 STRING

 schoolYear

 STRING

 Special Parameters

 Type

 getAllInstitutions

 BOOLEAN

 getAllPrograms

 BOOLEAN



Reports

report

Adding the count parameter defaults to counting students.

Valid Values

 Value Description

 written

Returns the complete written report

 aggregate

Returns the number and type of recommended ratings by standard.

 all_status

Returns all approval status decisions



written

Return Table Schema

Using the parameter reportType=json will return an array of stringified objects using the schema below.  Other report types will return a flattened file.   

 Key TYPE Description

 institutionCode

 INTEGER

 The unique institution code generated for the Federal Title II reports.

 institutionName

 STRING

 The instituion name

 program

 REPEATING RECORD

 Institutions can have multiple programs

 program.lastFullVisitYear

 INTEGER

 The most recent full visit

 program.currentApprovalStatus

 STRING

 The current approval status

 program.programType

 STRING

 The type of program (teacher, principal, etc)

 program.programName

 STRING

 The name of the program

 program.report

 REPEATING RECORD

 Reports have multiple records.

 program.report.standard

 STRING

 The standard

 program.report.substandard

 REPEATING RECORD

 Standards can have multiple substandards.

 program.report.substandard.reportType

 STRING

 The type of visit that generated this record

 program.report.substandard.name

 STRING

 The substandard

 program.report.substandard.year

 INTEGER

 The year this record was generated

 program.report.substandard.standardCode

 STRING

 PESB internal code for the standard

 program.report.substandard.rating

 STRING

 The recommended rating for this substandard

 program.report.substandard.summary

 STRING

 The written summary for this substandard. 


Example

Return written reports for Antioch University's latest site visit, including followup focused visits (institutionCode=201).


aggregate

Return Table Schema

 Element TYPE Description

 InstitutionCode

 INTEGER

 The unique institution code generated for the Federal Title II reports.

 InstitutionName

 STRING

 The institution name

 ReportType

 STRING

 Full or Focused

 VisitYear

 INTEGER

 The most recent full visit

 ApprovalStatus

 STRING

 The current approval status

 ProgramType

 STRING

 The type of program (teacher, principal, etc)

 ProgramName

 STRING

 The name of the program

 StandardNumber

 STRING

 The number of the standard (1-5)

 Standard

 STRING

 The standard

 ReportYear

 INTEGER

 The year this record was generated

 Rating

 STRING

 The recommended rating for this substandard

 Count

 INTEGER

 The number of ratings (each substandard has one rating)



Return aggregate results for Central Washington University's latest site visit (institutionCode=203)
Return aggregate results for Central Washington University's latest site visit and pivot results (institutionCode=203)

all_status

Return Table Schema

 Element TYPE Description

 InstitutionCode

 INTEGER

 The unique institution code generated for the Federal Title II reports.

 InstitutionName

 STRING

 The institution name

 ProgramType

 STRING

 The type of program (teacher, principal, etc)

 ProgramName

 STRING

 The name of the program

 ReportYear

 INTEGER

 The year this record was generated

 ApprovalStatus

 STRING

 The current approval status



Return all approval status results from 2001 - current year 
Return all status results for Western Washington University and pivot by year (institutionCode=248)



Drill-down, limit, and pivot parameters

The parameters below are used to drill down (add elements) to the query, limiting the values returned, and pivoting the count category.

pivot

Pivots the the count by rating (removes the rating and adds Unmet, Met, and Exemplary columns)

year

Limits by school year. If not included the results will include all available data. 

Added Elements

Year Code is returned by default.

Valid Values

 Value Description

 latest

The latest school year

 2013

 Returns the results from the 2013 calendar year.

 ....

....

 2002

 Returns the results from the 2002 calendar year..

Note - Multiple years can be selected by separating the values by a comma 

Example



institutionCode

Adds district elements to the base table.  Use a district code to limit to a specific district, or use 'true' to return all districts.e

Valid Values

 Value Description

 true

Returns all information, but adds the district elements

 INTEGER

Adds the district elements and limits the return to only this district code. 

Note - Multiple institutions can be selected by separating the values by a comma

Example



programType


Adds district and school elements to the base table.  Use a school code to limit to a specific school, or use 'true' to return all schools.  Can be combined with districtCode parameter to return school level data from a specific district.

Valid Values

 Value Description

 true

Returns all information, but adds the school and district elements

 INTEGER

Adds the school and district elements and limits the return to only this school code. 


Note - Multiple schools can be selected by separating the values by a comma

Example




Special Parameters

Special parameters work independently to extract helpful information.  If there is a special parameter included in your fetch it will ignore other parameters.  If you have multiple special parameters it will default to the first special parameter listed below.

getAllInstitutions

This special parameter returns all districts contained in the assignment data. 

Valid Values

 Value Description

 true

Returns all information.


Example

Get all districts associated with this data


getAllPrograms

This special parameter returns schools for a specific district.

Valid Values

 Value Description

 INTEGER

District Code


Example

Get all schools associated with 27403 (Bethel School District)






Return Type and Download

Select how data returns as well as an option to download using PESB's shared API parameters.