Program Information

Description

Access PESB's program information data, including locations and endorsements.  


URL

https://script.google.com/macros/s/AKfycbwIwzDYs5zlpZ5HaCumJW2T9PK4oAAsuFVRKhoziLaEyasEnm8K/exec


Method

GET


Base Table

A call to this url will return the base table, which has the following elements.

 Elements  Type  Description

 InstitutionCode

 INTEGER

PESB's internal institution codes, also shared by the Federal Title II reporting.

 InstitutionName

 STRING

The name of the institution.


Example

Sending the url without additional parameters returns this table.  The example below sets the return type paramter as csv to make the information easier to read. 



Parameters

Note PESB has other default parameters for all its APIs, such as returnType and download. 

 Parameter   TYPE

 institutionCode

 INTEGER

recommendedAgencyCode

 INTEGER

 siteType

 STRING

 contactInformation

 BOOLEAN

 geo

 BOOLEAN

 programType

 STRING

 endorsementCode

 INTEGER

 alternativeRoute

 BOOLEAN

 pathway2

 BOOLEAN

 online

 BOOLEAN

 fromAddress 

 STRING

 fromGeo

 STRING

 limit

 INTEGER

 Special Parameter* TYPE

 getAllEndorsements

 BOOLEAN



institutionCode

OSPI uses a code for agencies recommending certificates.  This parameter can be useful for combining PESB and OSPI data.

Valid Values

 Value  Description

 INTEGER

Limits the return to this institution code. 


Example

Return only information related to 500001 (Central Washington University)

recommendedAgencyCode

OSPI uses a code for agencies recommending certificates.  This parameter can be useful for combining PESB and OSPI data.

Added Element

 Elements  Type  Description

 RecommendedAgencyCode

 INTEGER

OSPI's recommended agency code


Valid Values

 Value  Description

 true

Returns all information, but adds the Recommended Agency Value to the return table

 INTEGER

Adds the Recommended Agency value as and limits the return to only this recommended agency code. 


Examples

Return all
Return only information related to 500001 (Central Washington University)

siteType

Site Type differentiates between the main and satellite campuses.

Added Element

 Elements  Type  Description

SiteType

 STRING

Is this a main or satellite campus.  


SiteName 

 STRING

The name of the campus (often is the name of the city where the campus is located)

Valid Values

 Value  Description

 true

Returns all information, but adds the site type and site name elements

 primary

Returns only main campus information

 secondary

Returns only information for satellite campuses.  

Note, while there is only one main campus per institution, there are often several satellite campuses.  


Examples

Return all

contactInformation

Adds contact information.

Added Element

 Elements  Type  Description

SiteType 

 STRING

Is this a main or satellite campus.   

SiteName 

 STRING

The name of the campus (often is the name of the city where the campus is located) 

StreetAddress

 STRING

The campus physical street address 

City 

 STRING

The campus city information

State

 STRING

The campus state information

Zipcode 

 INTEGER

The campus zipcode 

PhoneNumber

 STRING

The contact phone number (given by program) 

Website 

 STRING

The website (given by program)


Valid Values

 Value  Description

 true

 Adds the contact information elements


Examples

Return all
Find the addresses of all the satellite campuses for Western Washington University.


geo

Adds the campus geographic elements.

Added Element

 Elements  Type  Description

Longitude

 FLOAT

The campus physical street address 


Latitude 

 FLOAT

The campus city information

Valid Values

 Value  Description

 true

 Adds the geographic information elements


Examples

Return all
Get the latitude and longitude points for Central Washington University's main campus.

programType

Programs can be teacher, administrator, or educational staff associate.  

Added Element

 Elements Type Description

SiteType

 STRING

Is this a main or satellite campus.  


SiteName 

 STRING

The name of the campus (often is the name of the city where the campus is located)

 ProgramType

 STRING

The name of the program type (Teacher, Administrator, or Educational Staff Associate).

Valid Values

 Value

 Description

 true

Returns all information, but adds the program type element.

 teacher

Returns only the teacher programs

 administrator

Returns only the administrator programs 

 esa

Returns only the educational staff associate


Examples

Return all
Find all teacher programs available from Washington State University.

endorsementCode

This is the OSPI code for Washington approved endorsements.

Added Element

 Elements Type Description

 EndorsementCode

 INTEGER

OSPI's endorsement code


 EndorsementNickName

 STRING

The name of the endorsement.  Rather than being the technical name, this value is more familiar to the average person.

Valid Values

 Value Description

 true

Returns all information, but adds the endorsement elements

 INTEGER

Adds the endorsement elements and limits the return to only this endorsement. 


Examples

Return all teacher programs and their endorsements (this is large file will take some time to return, best used in a situation where the information is cached)


alternativeRoute

Institution sites can have only alternative route programs, no alternative route programs, or both alternative route and traditional programs.  Note this parameter always removes sites without alternative route programs.  

Added Element

 Elements Type Description

 Route

 STRING

The routes offered.

Valid Values

 Value Description

 true

Adds the route elements and returns only information for programs that have been designated alternative routes

 INTEGER

Adds the route elements and returns only information for programs that have a particular route


Examples

Return only alternative route programs

pathway2

Pathway 2 only applies to programs that have elected a pathway 2 as well as only a subset of endorsements eligible for pathway 2.  It is usually helpful to add the endorsementCode parameter when using this information.    

Added Element

 Elements Type Description

 Pathway2

 BOOLEAN

This program offers a pathway 2.

Valid Values

 Value Description

 true

Adds the route pathway 2 element and returns information for programs that have elected to offer a pathway 2.


Examples

Return all
Return all endorsements and programs that are available through pathway 2

online

Institutions may elect to offer certain endorsements online.  It is probably helpful to add the endorsementCode parameter to see which endorsements are included. 

Added Element

 Elements Type Description

 Online

 STRING

Currently this is limited to yes or no.

Valid Values

 Value Description

 true

Adds the online element to the results.

 yes

Adds the online element to the results and limit to only those institutions with an online component.  

 noAdds the online element to the results and limit to only those institutions with no online component.  

Examples

Return all institutions and whether it is possible to get an endorsement online.
Is it possible to become a chemistry teacher online?


fromAddress

This takes a physical location (such as address, city, or zipcode) and adds a distance element as well as sorting the information by how far it is from the parameter.

Note - This parameter needs to generate geo points prior to returning the data.  If already have have the geo information, it is faster to use the fromGeo parameter.

Added Element

 Elements Type Description

 SiteType

 STRING

Is this a main or satellite campus.  


SiteName 

 STRING

The name of the campus (often is the name of the city where the campus is located)

Distance INTEGER Number of miles between the address entered and the physical site location this is returned in miles and is "as the crow flies"

Valid Values

 Value Description

 LOCATION

Returns all information, but adds distance element as well as sorts results from nearest to furthest

Note, it is best practice to url encode this parameter



Examples

From Yakima WA, find the programs offering an English Language Arts endorsement.e


fromGeo

This inserts latitude and longitude and adds a distance element as well as sorting the information by how far it is from the parameter.

Added Element

 Elements Type Description

 SiteType

 STRING

Is this a main or satellite campus.  


SiteName 

 STRING

The name of the campus (often is the name of the city where the campus is located)

Distance INTEGER Number of miles between the address entered and the physical site location this is returned in miles and is "as the crow flies"

Valid Values

 Value Description

 LATITUDE,LONGITUDE

Must include latitude and longitude numbers separated by a comma. 

Note, it is best practice to url encode this parameter

Example

From Yakima WA (46.602071,-120.505899), find alternative route programs that offer an English Language Arts endorsement 

limit

Sometimes it is helpful to limit the number of results.  

Valid Values

 Value Description

 INTEGER

Limits the number of results


Examples

From Yelm WA, find the closest program where someone can become a band teacher. 

getAllEndorsements

This is a special parameter.

Valid Values

 Value Description

 true

Ignores all other parameters on this page and returns a list of all possible endorsements.  This can be helpful if you need to know all the endorsement possibilities.


Examples

Return all possible endorsements