Search Programs and Learning Units
search_programs_and_learning_unitsWhich programs or courses match, and where? Words, a subject (CIP family, or unknown), a course subject prefix, a credential class, an award as published, and a school's state, city, type or UNITID answer with product cards (name, award, length and college when held, school and city, subject, checklist size, and what the program leads to through the CIP-SOC crosswalk) and the counts to refine by. Courses across every school need words of 3 or more characters; words held by very many courses need a state, city or school. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "search_programs_and_learning_units"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cip | No | Optional: programs or learning units with this six-digit CIP code (e.g. 48.0508), a comma-separated list, or an array of codes | |
| city | No | Optional city, one of a state answer's cities | |
| code | No | Optional, courses only: a course code as printed, e.g. ZOO 2015; lists that code at every school, or within the state, city or school given | |
| type | No | program (the default) or learning_unit | |
| view | No | For type=learning_unit: count returns filtered entity counts without fetching cards; details returns bounded pageable cards for all schools or selected state/school, combined with subject_code, CIP, title query and printed code. Omit for automatic shop behavior. Explicit view is not supported for type=program. | |
| award | No | Optional award exactly as published, one of the answer's awards | |
| limit | No | Optional page size (default 10, at most 50) | |
| place | No | Optional: a place the question names, read as a state (name or code), a city, or a school, e.g. Wyoming or Casper | |
| query | No | Words: a program's name or award, or a course's title | |
| state | No | Optional two-letter state | |
| locale | No | Optional, where the publish holds the College Scorecard's characteristics: only schools in this setting (NCES locale) | |
| offset | No | Optional: the next_offset from a previous answer | |
| sector | No | Optional school type as IPEDS labels it, e.g. public 2-year | |
| unitid | No | Optional: one school's IPEDS UNITID | |
| subject | No | Optional CIP family (two digits, e.g. 51) or unknown | |
| credential | No | Optional, programs only: a credential class, one of the answer's credential values (e.g. ceterms:AssociateDegree), or none | |
| exam_credit | No | Optional: only schools with a published rule granting credit for this exam program | |
| online_only | No | Optional, where the publish holds the College Scorecard's characteristics: only schools whose programs are all offered online | |
| residential | No | Optional, where the publish holds the College Scorecard's characteristics: only primarily or highly residential four-year schools (Carnegie size and setting) | |
| subject_code | No | Optional: a course subject prefix, e.g. NURS, one of the answer's subject codes. A course's own prefix as printed, or a prefix a program's checklist requires | |
| school_offset | No | Optional: the next_school_offset from a previous answer, for the school facet's next page of schools | |
| with_pathways | No | Optional: only schools taking part in at least one pathway held | |
| tuition_in_max | No | Optional: only schools whose in-state tuition and fees (College Scorecard) is at or under this many dollars a year | |
| with_agreements | No | Optional: only schools with at least one transfer agreement held | |
| on_campus_housing | No | Optional: only schools that publish an on-campus room and board cost (College Scorecard) | |
| with_prior_learning | No | Optional: only schools with a published prior learning policy or a published rule for credit for prior learning they receive | |
| with_transfer_policy | No | Optional: only schools with a published transfer credit policy | |
| with_veteran_services | No | Optional: only schools with veterans and military services held |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| facets | No | The refinements: each facet's values with their counts of held rows. The school facet is one page of schools_matching, each school with its title (name), sector and checklists held | |
| publish | No | The data road's publish number | |
| results | No | The product cards | |
| contract | Yes | ||
| statement | Yes | ||
| portal_url | No | The same view on the portal | |
| understood | No | What was read: words, place (with candidates when several schools fit), the filters in force, question (frame, department, not_held words), lead (the product a page shows first), and match (step, words_used, stems, statement) | |
| next_offset | No | ||
| next_actions | No | ||
| build_version | Yes | Deprecated: the same value as publish | |
| census_cleared | Yes | ||
| total_matching | No | ||
| union_statement | No | Said once when any card carries forms or sources: the full source list is in the structured data | |
| schools_matching | No | How many schools hold the matching set | |
| next_school_offset | No | While schools of schools_matching remain past this page of the school facet: the school_offset of the next page |