Version schools

ecs

index /api/1.0/ecs

List early childhood centers

Arguments
  • string includes GET (optional)
    Include other datasets, comma-separated (current options: ec_profile, most_recent_ec_state_rating, ECContact, esd_el_2014, esd_el_2015, all)
  • int flatten_fields GET (optional)
    Remove localization structure from fields if true
  • array filter GET (optional)
    An array of field or property names from early childhood center entities paired with values to use to filter the result set.
  • array filter_op GET (optional)
    An array of field or property names from early childhood center entities paired with the operator to use when filtering the result set. If operator is IN, the query builder will attempt to explode the value of filter by commas (e.g. `filter[field_school_type]=10,922&filter_op[field_school_type]=IN` will be transformed into a `WHERE ... IN (..., ...)` query.
  • array filter_special GET (optional)
    A comma-separated list of custom filters to apply. Options: ec_profile_is_free_or_reduced_cost, ec_profile_has_transportation, ec_profile_has_special_needs_experience, ec_profile_has_meals, has_esd_el_2014, has_esd_el_2015, esd_el_highscore
  • string sort_by GET (optional)
    A comma separated list of field or property names from early childhood center entities by which to sort the result set.
  • string sort_order GET (optional)
    A comma separated list of order specifiers (DESC or ASC) indicating the direction the sort_by values should be applied to the result set.
  • string sort_by_special GET (optional)
    A comma separated list of special sorts to apply. Options: ec_profile_changed, ec_total_pts
  • string sort_order_special GET (optional)
    A comma separated list of order specifiers (DESC or ASC) indicating the direction the sort_by_special values should be applied to the result set.
  • string near_latlon GET (optional)
    A comma separated pair of decimal latitude and longitude to use as a geo-spatial filter, along with near_miles.
  • string near_miles GET (optional)
    Radius in miles to include in a geo-spatial query originating at coordinates specified in near_latlon.
  • int limit GET (optional)
    Limit response count (default 100)
  • int offset GET (optional)
    Offset starting record

retrieve /api/1.0/ecs/[id]

Arguments
  • int id URL
    ec entity ID
  • string includes GET (optional)
    Include other datasets, comma-separated (current options: ec_profile, most_recent_ec_state_rating, ECContact, esd_el_2014, esd_el_2015, all)
  • int flatten_fields GET (optional)
    Remove localization structure from fields if true

ec_state_ratings

index /api/1.0/ec_state_ratings

Arguments
  • int batch_timestamp URL (optional)
    UNIX timestamp of a specific batch (if not provided, returns most recent ratings)
Response Example
{
    "ec_state_ratings": [
        {
            "PublishedRating": "Empty Star", 
            "esd_ec_id": "630295306", 
            "ptsAdmin": null, 
            "ptsCurr": null, 
            "ptsEnv": null, 
            "ptsFamily": null, 
            "ptsStaff": null, 
            "ptsTotal": null, 
            "rating_id": "4096", 
            "source": "google sheet", 
            "timestamp": "1429388310"
        },
        {
            "PublishedRating": "4", 
            "esd_ec_id": "820021087", 
            "ptsAdmin": "6", 
            "ptsCurr": "12", 
            "ptsEnv": "6", 
            "ptsFamily": "2", 
            "ptsStaff": "12", 
            "ptsTotal": "38", 
            "rating_id": "4158", 
            "source": "google sheet", 
            "timestamp": "1429388310"
        }, 
        {
            "PublishedRating": "Empty Star", 
            "esd_ec_id": "630347309", 
            "ptsAdmin": null, 
            "ptsCurr": null, 
            "ptsEnv": null, 
            "ptsFamily": null, 
            "ptsStaff": null, 
            "ptsTotal": null, 
            "rating_id": "4097", 
            "source": "google sheet", 
            "timestamp": "1429388310"
        }
        // etc
    ]
}

retrieve /api/1.0/ec_state_ratings/[id]

Arguments
  • int esd_ec_id URL
    ESD-universe early childhood center ID
  • int batch_timestamp GET (optional)
    UNIX timestamp of a specific batch (if not provided, returns most recent rating)
Response Example
{
    "PublishedRating": "4", 
    "esd_ec_id": "820021087", 
    "ptsAdmin": "6", 
    "ptsCurr": "12", 
    "ptsEnv": "6", 
    "ptsFamily": "2", 
    "ptsStaff": "12", 
    "ptsTotal": "38", 
    "rating_id": "4158", 
    "source": "google sheet", 
    "timestamp": "1429388310"
}

schools

index /api/1.0/schools

Arguments
  • string includes GET (optional)
    Include other datasets, comma-separated (current options: school_profile, act_2011, act_2012, act_2013, act_2014, count_2016, count_2017, esd_hs_2013, esd_hs_2014, esd_hs_2015, esd_hs_2016, esd_k8_2013, esd_k8_2013_r1, esd_k8_2014, esd_k8_2015, esd_k8_2016, esd_k8_2017, fiveessentials_2013, fiveessentials_2014, fiveessentials_2015, fiveessentials_2016, k12_supplemental_2015, k12_supplemental_2016, k12_supplemental_2017, meap_2009, meap_2010, meap_2011, meap_2012, meap_2013, meap_2014, all)
  • int flatten_fields GET (optional)
    Remove localization structure from fields if true
  • array filter GET (optional)
    An array of field or property names from school entities paired with values to use to filter the result set.
  • array filter_op GET (optional)
    An array of field or property names from school entities paired with the operator to use when filtering the result set. If operator is IN, the query builder will attempt to explode the value of filter by commas (e.g. `filter[field_school_type]=10,922&filter_op[field_school_type]=IN` will be transformed into a `WHERE ... IN (..., ...)` query.
  • array filter_special GET (optional)
    A comma-separated list of custom filters to apply. Options: school_profile_has_specialed, school_profile_has_arts, school_profile_has_sports, school_profile_has_transportation, school_profile_has_before_after_care, school_profile_application_required, school_profile_collegereadiness, esd_k8hs_2015_highscore
  • string sort_by GET (optional)
    A comma separated list of field or property names from school entities by which to sort the result set.
  • string sort_order GET (optional)
    A comma separated list of order specifiers (DESC or ASC) indicating the direction the sort_by values should be applied to the result set.
  • string sort_by_special GET (optional)
    A comma separated list of special sorts to apply. Options: school_profile_changed, school_combined_total_pts
  • string sort_order_special GET (optional)
    A comma separated list of order specifiers (DESC or ASC) indicating the direction the sort_by_special values should be applied to the result set.
  • string near_latlon GET (optional)
    A comma separated pair of decimal latitude and longitude to use as a geo-spatial filter, along with near_miles.
  • string near_miles GET (optional)
    Radius in miles to include in a geo-spatial query originating at coordinates specified in near_latlon.
  • array filter_values GET (optional)
    An array of special fields paired with comma-separated values to use to filter the result set. Allowed values for schools: field_special_ed_level (basic,intensive,moderate,none), field_special_ed_programs (autism,blindness,cognitive,deafness,developmental_delay,emotional,ld,multiple,orthopedic,other,speech), field_transportation_options (none,passes,busses,shared_bus,special_ed_only), field_academic_focus (special_education, vocational, technology, all_arts, foreign_lang, religious, business, visual_arts, performing_arts, medical, music, engineering, service_learning, mathematics, science, none). Filter values are added to the query using an IN clause (OR).
  • int limit GET (optional)
    Limit response count (default 100)
  • int offset GET (optional)
    Offset starting record

retrieve /api/1.0/schools/[id]

Arguments
  • int id URL
    school entity ID
  • string includes GET (optional)
    Include other datasets, comma-separated (current options: school_profile, act_2011, act_2012, act_2013, act_2014, count_2016, count_2017, esd_hs_2013, esd_hs_2014, esd_hs_2015, esd_hs_2016, esd_k8_2013, esd_k8_2013_r1, esd_k8_2014, esd_k8_2015, esd_k8_2016, esd_k8_2017, fiveessentials_2013, fiveessentials_2014, fiveessentials_2015, fiveessentials_2016, k12_supplemental_2015, k12_supplemental_2016, k12_supplemental_2017, meap_2009, meap_2010, meap_2011, meap_2012, meap_2013, meap_2014, all)
  • int flatten_fields GET (optional)
    Remove localization structure from fields if true

node

retrieve /api/1.0/node/[id]

retrieve a single node

Arguments
  • int nid URL
    The nid of the node to retrieve
  • int flatten_fields GET (optional)
    Remove localization structure from fields if true
  • int include_option_labels GET (optional)
    Include human-readable option labels as well as machine codes for multivalue text fields