Bombshell Agency Platform Service

<back to all web services

EducationalInstitutionRequest

The following routes are available for this service:
GET,POST,OPTIONS/EducationalInstitution
GET,POST,OPTIONS/EducationalInstitution/{PageNumber}/{PageSize}

To override the Content-type in your clients HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/EducationalInstitutionRequest HTTP/1.1 
Host: testapi.responsible-advisor.com 
Content-Type: text/jsv
Content-Length: length

{
	EducationalInstitutions: 
	[
		{
			ID: 0,
			DATASET_YR: String,
			INUN_ID: String,
			NAME: String,
			YEAR_LAST_SURVEYED: String,
			LINE1: String,
			LINE2: String,
			LINE3: String,
			FRN_POSTAL_LOC: String,
			DOM_LOC_CITY: String,
			CITY: String,
			STATE_CODE: String,
			COUNTY: String,
			COUNTRY_CODE: String,
			ZIPCODE: String,
			OFFICIAL_AREA_CODE: String,
			OFFICIAL_PHONE: String,
			OFFICIAL_EXT: String,
			INSTATE_AREA_CODE: String,
			INSTATE_PHONE: String,
			INSTATE_EXT: String,
			OUTSTATE_AREA_CODE: String,
			OUTSTATE_PHONE: String,
			OUTSTATE_EXT: String,
			FAX_AREA_CODE: String,
			FAX: String,
			FAX_EXT: String,
			COORDINATE_SCHOOL: String,
			DB_KEY: String,
			AFFIL_CODE: String,
			DENOM_CODE: String,
			FIPS_CODE: String,
			URL_ADDRESS: String,
			SAT_KEY: String,
			MAIN_CARNEGIE_CLASS: String,
			MAIN_CNTRL_REG_ID: String,
			MAIN_FICE_CODE: String,
			MAIN_IPEDS_CODE: String,
			MAIN_SPECIAL_CODE: String,
			MAIN_SPECIAL_T: String,
			MAIN_FUNCTION_TYPE: String,
			MAIN_STUDENT_BODY: String,
			MAIN_FOUNDING_YR: String,
			MAIN_CONGRESS_DIST: String,
			MAIN_INST_CONTROL: String,
			MAIN_CALENDAR: String,
			MAIN_OTHER_CALENDAR: String,
			UpdateDate: 0001-01-01,
			UpdatedBy: String,
			CreatedBy: String,
			DateCreated: 0001-01-01,
			EducationalInstitutionPricing: 
			{
				ID: 0,
				DATASET_YR: 0,
				REPRJ_ID: 0,
				INUN_ID: 0,
				ACAD_YR: 0,
				EXP_I: String,
				TUIT_OVERALL_FT_D: String,
				TUIT_AREA_FT_D: String,
				TUIT_STATE_FT_D: String,
				TUIT_NRES_FT_D: String,
				FEES_FT_D: String,
				TUIT_OVERALL_PT_D: String,
				TUIT_OVERALL_PT_UNIT: String,
				TUIT_AREA_PT_D: String,
				TUIT_AREA_PT_UNIT: String,
				TUIT_STATE_PT_D: String,
				TUIT_STATE_PT_UNIT: String,
				TUIT_NRES_PT_D: String,
				TUIT_NRES_PT_UNIT: String,
				RM_BD_D: String,
				RM_ONLY_D: String,
				COMP_FEE_D: String,
				EXPENSE_T: String,
				TAKEN_N: String,
				TAKEN_UNIT: String,
				CURRENCY_CODE: String,
				TUIT_INTL_FT_D: String,
				BOOKS_RES_D: String,
				BOOKS_COMMUTE_HOME_D: String,
				BOOKS_COMMUTE_NOT_HOME_D: String,
				RM_RES_D: String,
				RM_COMMUTE_HOME_D: String,
				RM_COMMUTE_NOT_HOME_D: String,
				BD_RES_D: String,
				BD_COMMUTE_HOME_D: String,
				BD_COMMUTE_NOT_HOME_D: String,
				TRANSPORT_RES_D: String,
				TRANSPORT_COMMUTE_HOME_D: String,
				TRANSPORT_COMMUTE_NOT_HOME_D: String,
				OTH_RES_D: String,
				OTH_COMMUTE_HOME_D: String,
				OTH_COMMUTE_NOT_HOME_D: String,
				TOT_RES_D: String,
				TOT_COMMUTE_HOME_D: String,
				TOT_COMMUTE_NOT_HOME_D: String,
				FEES_ONE_TIME_D: String,
				FEES_PT_CRDT_D: String,
				FEES_PT_CRDT_UNIT: String,
				FEES_PT_TERM_D: String,
				FEES_PT_TERM_UNIT: String,
				TUIT_VARY_PROG: String,
				TUIT_VARY_LOC: String,
				TUIT_VARY_TIME: String,
				TUIT_VARY_LOAD: String,
				TUIT_VARY_COURSE_LVL: String,
				TUIT_VARY_DEG: String,
				TUIT_VARY_RECIPROCITY: String,
				TUIT_VARY_STUD: String,
				RM_BD_VARY_BD: String,
				RM_BD_VARY_LOC: String,
				RM_BD_VARY_GENDER: String,
				RM_BD_VARY_HOUS: String,
				RM_BD_VARY_STUD: String,
				TUIT_PLAN_GUAR: String,
				TUIT_PLAN_PREPAY: String,
				TUIT_PLAN_INSTALL: String,
				TUIT_PLAN_DEFER: String,
				TUIT_WAIV_MINORITY: String,
				TUIT_WAIV_ALUMNI: String,
				TUIT_WAIV_EMPLOYEE: String,
				TUIT_WAIV_ADULT: String,
				TUIT_WAIV_SENIOR: String,
				FEES_PT_CRDT_2_D: String,
				FEES_PT_CRDT_2_UNIT: String,
				FEES_PT_TERM_2_D: String,
				FEES_PT_TERM_2_UNIT: String,
				FEES_FT_TERM_D: String,
				FEES_FT_TERM_UNIT: String,
				FEES_PT_ONE_TIME_D: String,
				RM_BD_GR_MARRY_D: String,
				RM_BD_GR_SINGLE_D: String,
				RM_ONLY_GR_MARRY_D: String,
				RM_ONLY_GR_SINGLE_D: String,
				TUIT_VARY_RELIGION: String,
				FEES_ALT_FT_D: String,
				TUIT_ALT_FT_D: String,
				EXPENSE_T_ALT: String,
				URL_ADDRESS_PRICE_CALC: String,
				GiftingPercentage: 0,
				ProfileEFCCalculation: False,
				UpdateDate: 0001-01-01,
				UpdatedBy: String,
				CreatedBy: String,
				DateCreated: 0001-01-01
			}
		}
	],
	InputObject: 
	{
		ID: 0,
		DATASET_YR: String,
		INUN_ID: String,
		NAME: String,
		YEAR_LAST_SURVEYED: String,
		LINE1: String,
		LINE2: String,
		LINE3: String,
		FRN_POSTAL_LOC: String,
		DOM_LOC_CITY: String,
		CITY: String,
		STATE_CODE: String,
		COUNTY: String,
		COUNTRY_CODE: String,
		ZIPCODE: String,
		OFFICIAL_AREA_CODE: String,
		OFFICIAL_PHONE: String,
		OFFICIAL_EXT: String,
		INSTATE_AREA_CODE: String,
		INSTATE_PHONE: String,
		INSTATE_EXT: String,
		OUTSTATE_AREA_CODE: String,
		OUTSTATE_PHONE: String,
		OUTSTATE_EXT: String,
		FAX_AREA_CODE: String,
		FAX: String,
		FAX_EXT: String,
		COORDINATE_SCHOOL: String,
		DB_KEY: String,
		AFFIL_CODE: String,
		DENOM_CODE: String,
		FIPS_CODE: String,
		URL_ADDRESS: String,
		SAT_KEY: String,
		MAIN_CARNEGIE_CLASS: String,
		MAIN_CNTRL_REG_ID: String,
		MAIN_FICE_CODE: String,
		MAIN_IPEDS_CODE: String,
		MAIN_SPECIAL_CODE: String,
		MAIN_SPECIAL_T: String,
		MAIN_FUNCTION_TYPE: String,
		MAIN_STUDENT_BODY: String,
		MAIN_FOUNDING_YR: String,
		MAIN_CONGRESS_DIST: String,
		MAIN_INST_CONTROL: String,
		MAIN_CALENDAR: String,
		MAIN_OTHER_CALENDAR: String,
		UpdateDate: 0001-01-01,
		UpdatedBy: String,
		CreatedBy: String,
		DateCreated: 0001-01-01,
		EducationalInstitutionPricing: 
		{
			ID: 0,
			DATASET_YR: 0,
			REPRJ_ID: 0,
			INUN_ID: 0,
			ACAD_YR: 0,
			EXP_I: String,
			TUIT_OVERALL_FT_D: String,
			TUIT_AREA_FT_D: String,
			TUIT_STATE_FT_D: String,
			TUIT_NRES_FT_D: String,
			FEES_FT_D: String,
			TUIT_OVERALL_PT_D: String,
			TUIT_OVERALL_PT_UNIT: String,
			TUIT_AREA_PT_D: String,
			TUIT_AREA_PT_UNIT: String,
			TUIT_STATE_PT_D: String,
			TUIT_STATE_PT_UNIT: String,
			TUIT_NRES_PT_D: String,
			TUIT_NRES_PT_UNIT: String,
			RM_BD_D: String,
			RM_ONLY_D: String,
			COMP_FEE_D: String,
			EXPENSE_T: String,
			TAKEN_N: String,
			TAKEN_UNIT: String,
			CURRENCY_CODE: String,
			TUIT_INTL_FT_D: String,
			BOOKS_RES_D: String,
			BOOKS_COMMUTE_HOME_D: String,
			BOOKS_COMMUTE_NOT_HOME_D: String,
			RM_RES_D: String,
			RM_COMMUTE_HOME_D: String,
			RM_COMMUTE_NOT_HOME_D: String,
			BD_RES_D: String,
			BD_COMMUTE_HOME_D: String,
			BD_COMMUTE_NOT_HOME_D: String,
			TRANSPORT_RES_D: String,
			TRANSPORT_COMMUTE_HOME_D: String,
			TRANSPORT_COMMUTE_NOT_HOME_D: String,
			OTH_RES_D: String,
			OTH_COMMUTE_HOME_D: String,
			OTH_COMMUTE_NOT_HOME_D: String,
			TOT_RES_D: String,
			TOT_COMMUTE_HOME_D: String,
			TOT_COMMUTE_NOT_HOME_D: String,
			FEES_ONE_TIME_D: String,
			FEES_PT_CRDT_D: String,
			FEES_PT_CRDT_UNIT: String,
			FEES_PT_TERM_D: String,
			FEES_PT_TERM_UNIT: String,
			TUIT_VARY_PROG: String,
			TUIT_VARY_LOC: String,
			TUIT_VARY_TIME: String,
			TUIT_VARY_LOAD: String,
			TUIT_VARY_COURSE_LVL: String,
			TUIT_VARY_DEG: String,
			TUIT_VARY_RECIPROCITY: String,
			TUIT_VARY_STUD: String,
			RM_BD_VARY_BD: String,
			RM_BD_VARY_LOC: String,
			RM_BD_VARY_GENDER: String,
			RM_BD_VARY_HOUS: String,
			RM_BD_VARY_STUD: String,
			TUIT_PLAN_GUAR: String,
			TUIT_PLAN_PREPAY: String,
			TUIT_PLAN_INSTALL: String,
			TUIT_PLAN_DEFER: String,
			TUIT_WAIV_MINORITY: String,
			TUIT_WAIV_ALUMNI: String,
			TUIT_WAIV_EMPLOYEE: String,
			TUIT_WAIV_ADULT: String,
			TUIT_WAIV_SENIOR: String,
			FEES_PT_CRDT_2_D: String,
			FEES_PT_CRDT_2_UNIT: String,
			FEES_PT_TERM_2_D: String,
			FEES_PT_TERM_2_UNIT: String,
			FEES_FT_TERM_D: String,
			FEES_FT_TERM_UNIT: String,
			FEES_PT_ONE_TIME_D: String,
			RM_BD_GR_MARRY_D: String,
			RM_BD_GR_SINGLE_D: String,
			RM_ONLY_GR_MARRY_D: String,
			RM_ONLY_GR_SINGLE_D: String,
			TUIT_VARY_RELIGION: String,
			FEES_ALT_FT_D: String,
			TUIT_ALT_FT_D: String,
			EXPENSE_T_ALT: String,
			URL_ADDRESS_PRICE_CALC: String,
			GiftingPercentage: 0,
			ProfileEFCCalculation: False,
			UpdateDate: 0001-01-01,
			UpdatedBy: String,
			CreatedBy: String,
			DateCreated: 0001-01-01
		}
	},
	Insert: False,
	Delete: False,
	Update: False,
	PageSize: 0,
	PageNumber: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	},
	ErrorLog: 
	[
		{
			ErrorLogId: 0,
			Message: String,
			Page: String,
			LineNumber: 0,
			ColNumber: 0,
			UserAgent: String,
			LogDate: 0001-01-01
		}
	]
}