Education Cloud Developer Guide
jEducInstSearchableProfile
Represents information about an educational institution aggregated from other
objects for Criteria-Based Search and Filter. This object is available in API version
64.0 and later.
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields
AccountId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The institution's account related to the educational institution
searchable profile.
This field is a relationship field.
- Relationship Name: Account
- Refers To: Account
Address
- Type: address
- Properties: Filter, Nillable
- Description: The address of the educational institution.
BusinessProfileId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The business profile related to the educational institution
searchable profile.
This field is a relationship field.
- Relationship Name: BusinessProfile
- Refers To: BusinessProfile
City
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The city where the educational institution is located.
Country
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The country where the educational institution is located.
CountryCode
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description: The country code of the country where the educational institution is located.
-
Possible values:
- AD—Andorra
- AE—United Arab Emirates
- AF—Afghanistan
- AG—Antigua and Barbuda
- AI—Anguilla
- AL—Albania
- AM—Armenia
- AO—Angola
- AQ—Antarctica
- AR—Argentina
- AT—Austria
- AU—Australia
- AW—Aruba
- AX—Aland Islands
- AZ—Azerbaijan
- BA—Bosnia and Herzegovina
- BB—Barbados
- BD—Bangladesh
- BE—Belgium
- BF—Burkina Faso
- BG—Bulgaria
- BH—Bahrain
- BI—Burundi
- BJ—Benin
- BL—Saint Barthélemy
- BM—Bermuda
- BN—Brunei Darussalam
- BO—Bolivia, Plurinational State of
- BQ—Bonaire, Sint Eustatius and Saba
- BR—Brazil
- BS—Bahamas
- BT—Bhutan
- BV—Bouvet Island
- BW—Botswana
- BY—Belarus
- BZ—Belize
- CA—Canada
- CC—Cocos (Keeling) Islands
- CD—Congo, the Democratic Republic of the
- CF—Central African Republic
- CG—Congo
- CH—Switzerland
- CI—Cote d'Ivoire
- CK—Cook Islands
- CL—Chile
- CM—Cameroon
- CN—China
- CO—Colombia
- CR—Costa Rica
- CV—Cape Verde
- CW—Curaçao
- CX—Christmas Island
- CY—Cyprus
- CZ—Czechia
- DE—Germany
- DJ—Djibouti
- DK—Denmark
- DM—Dominica
- DO—Dominican Republic
- DZ—Algeria
- EC—Ecuador
- EE—Estonia
- EG—Egypt
- EH—Western Sahara
- ER—Eritrea
- ES—Spain
- ET—Ethiopia
- FI—Finland
- FJ—Fiji
- FK—Falkland Islands (Malvinas)
- FO—Faroe Islands
- FR—France
- GA—Gabon
- GB—United Kingdom
- GD—Grenada
- GE—Georgia
- GF—French Guiana
- GG—Guernsey
- GH—Ghana
- GI—Gibraltar
- GL—Greenland
- GM—Gambia
- GN—Guinea
- GP—Guadeloupe
- GQ—Equatorial Guinea
- GR—Greece
- GS—South Georgia and the South Sandwich Islands
- GT—Guatemala
- GW—Guinea-Bissau
- GY—Guyana
- HM—Heard Island and McDonald Islands
- HN—Honduras
- HR—Croatia
- HT—Haiti
- HU—Hungary
- ID—Indonesia
- IE—Ireland
- IL—Israel
- IM—Isle of Man
- IN—India
- IO—British Indian Ocean Territory
- IQ—Iraq
- IS—Iceland
- IT—Italy
- JE—Jersey
- JM—Jamaica
- JO—Jordan
- JP—Japan
- KE—Kenya
- KG—Kyrgyzstan
- KH—Cambodia
- KI—Kiribati
- KM—Comoros
- KN—Saint Kitts and Nevis
- KR—Korea, Republic of
- KW—Kuwait
- KY—Cayman Islands
- KZ—Kazakhstan
- LA—Lao People's Democratic Republic
- LB—Lebanon
- LC—Saint Lucia
- LI—Liechtenstein
- LK—Sri Lanka
- LR—Liberia
- LS—Lesotho
- LT—Lithuania
- LU—Luxembourg
- LV—Latvia
- LY—Libya
- MA—Morocco
- MC—Monaco
- MD—Moldova, Republic of
- ME—Montenegro
- MF—Saint Martin (French part)
- MG—Madagascar
- MK—North Macedonia
- ML—Mali
- MM—Myanmar
- MN—Mongolia
- MO—Macao
- MQ—Martinique
- MR—Mauritania
- MS—Montserrat
- MT—Malta
- MU—Mauritius
- MV—Maldives
- MW—Malawi
- MX—Mexico
- MY—Malaysia
- MZ—Mozambique
- NA—Namibia
- NC—New Caledonia
- NE—Niger
- NF—Norfolk Island
- NG—Nigeria
- NI—Nicaragua
- NL—Netherlands
- NO—Norway
- NP—Nepal
- NR—Nauru
- NU—Niue
- NZ—New Zealand
- OM—Oman
- PA—Panama
- PE—Peru
- PF—French Polynesia
- PG—Papua New Guinea
- PH—Philippines
- PK—Pakistan
- PL—Poland
- PM—Saint Pierre and Miquelon
- PN—Pitcairn
- PS—Palestine
- PT—Portugal
- PY—Paraguay
- QA—Qatar
- RE—Reunion
- RO—Romania
- RS—Serbia
- RU—Russian Federation
- RW—Rwanda
- SA—Saudi Arabia
- SB—Solomon Islands
- SC—Seychelles
- SE—Sweden
- SG—Singapore
- SH—Saint Helena, Ascension and Tristan da Cunha
- SI—Slovenia
- SJ—Svalbard and Jan Mayen
- SK—Slovakia
- SL—Sierra Leone
- SM—San Marino
- SN—Senegal
- SO—Somalia
- SR—Suriname
- SS—South Sudan
- ST—Sao Tome and Principe
- SV—El Salvador
- SX—Sint Maarten (Dutch part)
- SZ—Eswatini
- TC—Turks and Caicos Islands
- TD—Chad
- TF—French Southern Territories
- TG—Togo
- TH—Thailand
- TJ—Tajikistan
- TK—Tokelau
- TL—Timor-Leste
- TM—Turkmenistan
- TN—Tunisia
- TO—Tonga
- TR—Türkiye
- TT—Trinidad and Tobago
- TV—Tuvalu
- TW—Taiwan
- TZ—Tanzania, United Republic of
- UA—Ukraine
- UG—Uganda
- US—United States
- UY—Uruguay
- UZ—Uzbekistan
- VA—Holy See (Vatican City State)
- VC—Saint Vincent and the Grenadines
- VE—Venezuela, Bolivarian Republic of
- VG—Virgin Islands, British
- VN—Vietnam
- VU—Vanuatu
- WF—Wallis and Futuna
- WS—Samoa
- XK—Kosovo
- YE—Yemen
- YT—Mayotte
- ZA—South Africa
- ZM—Zambia
- ZW—Zimbabwe
CurrencyIsoCode
- Type: picklist
- Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description: The ISO code for the currency related to theeducational institution searchable profile.
- Default value: USD
-
Possible values:
- GBP—British Pound
- USD—U.S. Dollar
EducInstitutionOfferingId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The institution offering related to the educational institution
searchable profile.
This field is a relationship field.
- Relationship Name: EducInstitutionOffering
- Refers To: EducInstitutionOffering
EducationalInstitutionFormat
- Type: textarea
- Properties: Create, Nillable, Update
- Description: The education format at the educational institution.
EducationalInstitutionImageUrl
- Type: url
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The URL of the image for the educational institution.
EducationalInstitutionName
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The name of the educational institution.
EducationalInstitutionType
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description: Specifies the type of the educational institution.
-
Possible values:
- Charter
- Private
- Public
GeocodeAccuracy
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description: The accuracy rating for the geocode of the educational institution. The accuracy rating contains information about the location of a latitude and longitude.
-
Possible values:
- Address
- Block
- City
- County
- ExtendedZip—Extended Zip
- NearAddress—Near Address
- Neighborhood
- State
- Street
- Unknown
- Zip
GradesOffered
- Type: textarea
- Properties: Create, Nillable, Update
- Description: The grades offered by the educational institution.
GradesOfferedSummary
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The category of grades the educational institution offers.
LastReferencedDate
- Type: dateTime
- Properties: Filter, Nillable, Sort
- Description: The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate
- Type: dateTime
- Properties: Filter, Nillable, Sort
- Description: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.
Latitude
- Type: double
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The latitude where the educational institution is located.
LearningAcademicLevel
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description: Specifies the academic level offered by the educational institution.
-
Possible values:
- Adult Education
- Doctoral
- Elementary
- Graduate
- High School
- Middle School
- Post-Baccalaureate Certificate
- Pre-K/Preschool
- Professional Education
- Undergraduate
LearningCategory
- Type: textarea
- Properties: Create, Nillable, Update
- Description: The learning category of the educational institution.
LearningFormat
- Type: textarea
- Properties: Create, Nillable, Update
- Description: The learning format of the educational institution.
LearningGrade
- Type: textarea
- Properties: Create, Nillable, Update
- Description: The learning grade of the educational institution.
LearningId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The learning record related to the educational institution
searchable profile.
This field is a relationship field.
- Relationship Name: Learning
- Refers To: Learning
LearningImageUrl
- Type: url
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The URL of the image for the learning record related to the educational institution.
LearningProgramId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The learning program related to the educational institution
searchable profile.
This field is a relationship field.
- Relationship Name: LearningProgram
- Refers To: LearningProgram
LearningProgramName
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The name of the learning program offered by the educational institution.
Longitude
- Type: double
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The longitude where the educational institution is located.
Name
- Type: string
- Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description: The autonumbered name of the educational institution searchable profile.
OwnerId
- Type: reference
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
-
Description: The user who is the owner of this record.
This field is a polymorphic relationship field.
- Relationship Name: Owner
- Refers To: Group, User
PostalCode
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The postal code of the educational institution.
ProviderId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The provider related to the educational institution searchable
profile.
This field is a relationship field.
- Relationship Name: Provider
- Refers To: Account
ProviderName
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The name of the provider for the educational institution.
State
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The state where the educational institution is located.
StateCode
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description: The state code of the state where the educational institution is located.
-
Possible values:
- 01—Hokkaido
- 02—Akita
- 03—Iwate
- 04—Miyagi
- 05—Aichi
- 06—Yamagata
- 07—Fukushima
- 08—Ibaraki
- 09—Tochigi
- 10—Gunma
- 11—Saitama
- 12—Tianjin
- 13—Tokyo
- 14—Shanxi
- 15—Niigata
- 16—Toyama
- 17—Ishikawa
- 18—Fukui
- 19—Yamanashi
- 20—Nagano
- 21—Liaoning
- 22—Shizuoka
- 23—Heilongjiang
- 24—Mie
- 25—Shiga
- 26—Kyoto
- 27—Osaka
- 28—Hyogo
- 29—Nara
- 30—Wakayama
- 31—Tottori
- 32—Shimane
- 33—Zhejiang
- 34—Hiroshima
- 35—Yamaguchi
- 36—Tokushima
- 37—Shandong
- 38—Ehime
- 39—Kochi
- 40—Fukuoka
- 41—Saga
- 42—Nagasaki
- 43—Kumamoto
- 44—Oita
- 45—Miyazaki
- 46—Kagoshima
- 47—Okinawa
- 50—Chongqing
- 51—Sichuan
- 52—Guizhou
- 53—Yunnan
- 54—Xizang
- 61—Shaanxi
- 62—Gansu
- 63—Qinghai
- 64—Ningxia
- 65—Xinjiang
- 71—Taiwan
- 91—Hong Kong
- 92—Macao
- AB—Alberta
- AC—Acre
- ACT—Australian Capital Territory
- AG—Aguascalientes
- AK—Alaska
- AL—Alessandria
- AM—Amazonas
- AN—Andaman and Nicobar Islands
- AO—Aosta
- AP—Ascoli Piceno
- AQ—L'Aquila
- AR—Arunachal Pradesh
- AS—Assam
- AT—Asti
- AV—Avellino
- AZ—Arizona
- BA—Bari
- BC—British Columbia
- BG—Bergamo
- BI—Biella
- BL—Belluno
- BN—Benevento
- BO—Bologna
- BR—Brindisi
- BS—Brescia
- BT—Barletta-Andria-Trani
- BZ—Bolzano
- CA—California
- CB—Campobasso
- CE—Clare
- CH—Chihuahua
- CI—Carbonia-Iglesias
- CL—Colima
- CM—Campeche
- CN—Cuneo
- CO—Cork
- CR—Cremona
- CS—Cosenza
- CT—Connecticut
- CW—Carlow
- CZ—Catanzaro
- D—Dublin
- DC—District of Columbia
- DD—Daman and Diu
- DE—Delaware
- DF—Federal District
- DG—Durango
- DL—Donegal
- DN—Dadra and Nagar Haveli
- EN—Enna
- ES—Espírito Santo
- FC—Forlì-Cesena
- FE—Ferrara
- FG—Foggia
- FI—Florence
- FL—Florida
- FM—Fermo
- FR—Frosinone
- G—Galway
- GA—Goa
- GE—Genoa
- GJ—Gujarat
- GO—Gorizia
- GR—Guerrero
- GT—Guanajuato
- HG—Hidalgo
- HI—Hawaii
- HP—Himachal Pradesh
- HR—Haryana
- IA—Iowa
- ID—Idaho
- IL—Illinois
- IM—Imperia
- IN—Indiana
- IS—Isernia
- JA—Jalisco
- JH—Jharkhand
- JK—Jammu and Kashmir
- KA—Karnataka
- KE—Kildare
- KK—Kilkenny
- KL—Kerala
- KR—Crotone
- KS—Kansas
- KY—Kerry
- LA—Louisiana
- LC—Lecco
- LD—Longford
- LE—Lecce
- LH—Louth
- LI—Livorno
- LK—Limerick
- LM—Leitrim
- LO—Lodi
- LS—Laois
- LT—Latina
- LU—Lucca
- MA—Massachusetts
- MB—Monza and Brianza
- MC—Macerata
- MD—Maryland
- ME—Mexico State
- MG—Minas Gerais
- MH—Meath
- MI—Milan
- ML—Meghalaya
- MN—Monaghan
- MO—Morelos
- MP—Madhya Pradesh
- MS—Mississippi
- MT—Montana
- MZ—Mizoram
- NA—Nayarit
- NB—New Brunswick
- NC—North Carolina
- ND—North Dakota
- NE—Nebraska
- NH—New Hampshire
- NJ—New Jersey
- NL—Nuevo León
- NM—New Mexico
- NO—Novara
- NS—Nova Scotia
- NSW—New South Wales
- NT—Northwest Territories
- NU—Nuoro
- NV—Nevada
- NY—New York
- OA—Oaxaca
- OG—Ogliastra
- OH—Ohio
- OK—Oklahoma
- ON—Ontario
- OR—Oristano
- OT—Olbia-Tempio
- OY—Offaly
- PA—Pennsylvania
- PB—Punjab
- PC—Piacenza
- PD—Padua
- PE—Prince Edward Island
- PG—Perugia
- PI—Pisa
- PN—Pordenone
- PO—Prato
- PR—Parma
- PT—Pistoia
- PU—Pesaro and Urbino
- PV—Pavia
- PY—Puducherry
- PZ—Potenza
- QC—Quebec
- QE—Querétaro
- QLD—Queensland
- QR—Quintana Roo
- RA—Ravenna
- RC—Reggio Calabria
- RE—Reggio Emilia
- RG—Ragusa
- RI—Rieti
- RJ—Rio de Janeiro
- RM—Rome
- RN—Roscommon
- RO—Rovigo
- RR—Roraima
- RS—Rio Grande do Sul
- SA—South Australia
- SC—South Carolina
- SD—South Dakota
- SE—Sergipe
- SI—Sinaloa
- SK—Sikkim
- SL—San Luis Potosí
- SO—Sonora
- SP—São Paulo
- SR—Syracuse
- SS—Sassari
- SV—Savona
- TA—Tipperary
- TAS—Tasmania
- TB—Tabasco
- TE—Teramo
- TG—Telangana
- TL—Tlaxcala
- TM—Tamaulipas
- TN—Trento
- TO—Turin
- TP—Trapani
- TR—Tripura
- TS—Trieste
- TV—Treviso
- TX—Texas
- UD—Udine
- UP—Uttar Pradesh
- UT—Uttarakhand
- VA—Virginia
- VB—Verbano-Cusio-Ossola
- VC—Vercelli
- VE—Veracruz
- VI—Vicenza
- VIC—Victoria
- VR—Verona
- VS—Medio Campidano
- VT—Viterbo
- VV—Vibo Valentia
- WA—Western Australia
- WB—West Bengal
- WD—Waterford
- WH—Westmeath
- WI—Wisconsin
- WV—West Virginia
- WW—Wicklow
- WX—Wexford
- WY—Wyoming
- YT—Yukon Territories
- YU—Yucatán
- ZA—Zacatecas
Street
- Type: textarea
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The street where the educational institution is located.
SupportProgramFormat
- Type: textarea
- Properties: Create, Nillable, Update
- Description: The format of the support program at the educational institution.
SupportProgramId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The support program related to the educational institution
searchable profile.
This field is a relationship field.
- Relationship Name: SupportProgram
- Refers To: Program
SupportProgramImageUrl
- Type: url
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The URL of the image for the educational institution's support program.
SupportProgramName
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The name of the support program at the educational institution.
Associated Objects
This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.
- EducInstSearchableProfileHistory
- History is available for tracked fields of the object.
- EducInstSearchableProfileOwnerSharingRule
- Sharing rules are available for the object.
- EducInstSearchableProfileShare
- Sharing is available for the object.