HTTP + JSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /jsv/reply/CollegePriceRequest HTTP/1.1
Host: api.responsible-advisor.com
Content-Type: text/jsv
Content-Length: length
{
InputObject:
{
Id: 0,
CaseDesignId: 0,
StudentId: 0,
SectionName: String,
Student:
{
StudentId: 0,
FactFinderId: 0,
Name: String,
DOB: 0001-01-01,
GraduationYear: 0,
YearsInCollege: 0,
GPA: 0,
ACT: 0,
SAT: 0,
Tuition: 0,
ActivitiesAnnualCosts: 0,
Gender: String,
Notes: String,
HighSchoolStudent:
{
StudentId: 0,
FactFinderId: 0,
PSATYearTaken: String,
PSATScore: 0,
APClassesTaken: 0,
APClassesWillTake: 0,
APClassesTotalOffered: 0,
HighSchool: String,
ExtracurricularActivities: String,
AreaOfStudyMajor: String,
CollegesOfInterest: String,
OkayWithCommunityCollege: False,
Geographical: String,
PublicPrivate: String,
SizeOfSchool: String,
StudentAnnualIncome: 0,
StudentAnnualIncomeNotAvailable: False,
CurrentFAFSALimit: 0,
NeedHelpEssayCoach: False,
NeedHelpCareerCoach: False,
NeedHelpAdmissionsCounselor: False,
NeedHelpToastmasters: False,
NeedHelpACTSATPreparation: False,
Notes: String
},
CollegePrices:
[
{
Id: 0,
CaseDesignId: 0,
StudentId: 0,
SectionName: String,
Student:
{
StudentId: 0,
FactFinderId: 0,
Name: String,
DOB: 0001-01-01,
GraduationYear: 0,
YearsInCollege: 0,
GPA: 0,
ACT: 0,
SAT: 0,
Tuition: 0,
ActivitiesAnnualCosts: 0,
Gender: String,
Notes: String,
HighSchoolStudent:
{
StudentId: 0,
FactFinderId: 0,
PSATYearTaken: String,
PSATScore: 0,
APClassesTaken: 0,
APClassesWillTake: 0,
APClassesTotalOffered: 0,
HighSchool: String,
ExtracurricularActivities: String,
AreaOfStudyMajor: String,
CollegesOfInterest: String,
OkayWithCommunityCollege: False,
Geographical: String,
PublicPrivate: String,
SizeOfSchool: String,
StudentAnnualIncome: 0,
StudentAnnualIncomeNotAvailable: False,
CurrentFAFSALimit: 0,
NeedHelpEssayCoach: False,
NeedHelpCareerCoach: False,
NeedHelpAdmissionsCounselor: False,
NeedHelpToastmasters: False,
NeedHelpACTSATPreparation: False,
Notes: String
},
CollegePrices:
[
{
Id: 0,
CaseDesignId: 0,
StudentId: 0,
SectionName: String,
Student:
{
StudentId: 0,
FactFinderId: 0,
Name: String,
DOB: 0001-01-01,
GraduationYear: 0,
YearsInCollege: 0,
GPA: 0,
ACT: 0,
SAT: 0,
Tuition: 0,
ActivitiesAnnualCosts: 0,
Gender: String,
Notes: String,
HighSchoolStudent:
{
StudentId: 0,
FactFinderId: 0,
PSATYearTaken: String,
PSATScore: 0,
APClassesTaken: 0,
APClassesWillTake: 0,
APClassesTotalOffered: 0,
HighSchool: String,
ExtracurricularActivities: String,
AreaOfStudyMajor: String,
CollegesOfInterest: String,
OkayWithCommunityCollege: False,
Geographical: String,
PublicPrivate: String,
SizeOfSchool: String,
StudentAnnualIncome: 0,
StudentAnnualIncomeNotAvailable: False,
CurrentFAFSALimit: 0,
NeedHelpEssayCoach: False,
NeedHelpCareerCoach: False,
NeedHelpAdmissionsCounselor: False,
NeedHelpToastmasters: False,
NeedHelpACTSATPreparation: False,
Notes: String
},
CollegePrices:
[
{
}
],
FactFinderStudentColleges:
[
{
Id: 0,
StudentId: 0,
EducationalInstitutionId: 0,
Priority: 0,
EducationalInstitution:
{
Id: 0,
DapipId: String,
OpeId: String,
IpedsUnitIds: String,
LocationName: String,
ParentName: String,
ParentDapipId: String,
LocationType: String,
Address: String,
GeneralPhone: String,
AdminName: String,
AdminPhone: String,
AdminEmail: String,
Fax: String,
UpdateDate: 0001-01-01,
Updatedby: String,
DateCreated: 0001-01-01,
GiftingPercentage: 0,
CostOfAttendancePerSemester: 0,
ProfileEFCCalculation: False,
CreatedBy: String
}
}
],
FactFinderCollegeSavingsPlans:
[
{
CollegeFundingId: 0,
FactFinderId: 0,
StudentId: 0,
TypeOfPlan: String,
Value: 0,
MonthlyContribution: 0,
Notes: String,
NotAvailable: False
}
],
TargetSchool:
{
Id: 0,
DapipId: String,
OpeId: String,
IpedsUnitIds: String,
LocationName: String,
ParentName: String,
ParentDapipId: String,
LocationType: String,
Address: String,
GeneralPhone: String,
AdminName: String,
AdminPhone: String,
AdminEmail: String,
Fax: String,
UpdateDate: 0001-01-01,
Updatedby: String,
DateCreated: 0001-01-01,
GiftingPercentage: 0,
CostOfAttendancePerSemester: 0,
ProfileEFCCalculation: False,
CreatedBy: String
}
},
Price: 0,
CommunityCollege: False,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
}
],
FactFinderStudentColleges:
[
{
Id: 0,
StudentId: 0,
EducationalInstitutionId: 0,
Priority: 0,
EducationalInstitution:
{
Id: 0,
DapipId: String,
OpeId: String,
IpedsUnitIds: String,
LocationName: String,
ParentName: String,
ParentDapipId: String,
LocationType: String,
Address: String,
GeneralPhone: String,
AdminName: String,
AdminPhone: String,
AdminEmail: String,
Fax: String,
UpdateDate: 0001-01-01,
Updatedby: String,
DateCreated: 0001-01-01,
GiftingPercentage: 0,
CostOfAttendancePerSemester: 0,
ProfileEFCCalculation: False,
CreatedBy: String
}
}
],
FactFinderCollegeSavingsPlans:
[
{
CollegeFundingId: 0,
FactFinderId: 0,
StudentId: 0,
TypeOfPlan: String,
Value: 0,
MonthlyContribution: 0,
Notes: String,
NotAvailable: False
}
],
TargetSchool:
{
Id: 0,
DapipId: String,
OpeId: String,
IpedsUnitIds: String,
LocationName: String,
ParentName: String,
ParentDapipId: String,
LocationType: String,
Address: String,
GeneralPhone: String,
AdminName: String,
AdminPhone: String,
AdminEmail: String,
Fax: String,
UpdateDate: 0001-01-01,
Updatedby: String,
DateCreated: 0001-01-01,
GiftingPercentage: 0,
CostOfAttendancePerSemester: 0,
ProfileEFCCalculation: False,
CreatedBy: String
}
},
Price: 0,
CommunityCollege: False,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
}
],
FactFinderStudentColleges:
[
{
Id: 0,
StudentId: 0,
EducationalInstitutionId: 0,
Priority: 0,
EducationalInstitution:
{
Id: 0,
DapipId: String,
OpeId: String,
IpedsUnitIds: String,
LocationName: String,
ParentName: String,
ParentDapipId: String,
LocationType: String,
Address: String,
GeneralPhone: String,
AdminName: String,
AdminPhone: String,
AdminEmail: String,
Fax: String,
UpdateDate: 0001-01-01,
Updatedby: String,
DateCreated: 0001-01-01,
GiftingPercentage: 0,
CostOfAttendancePerSemester: 0,
ProfileEFCCalculation: False,
CreatedBy: String
}
}
],
FactFinderCollegeSavingsPlans:
[
{
CollegeFundingId: 0,
FactFinderId: 0,
StudentId: 0,
TypeOfPlan: String,
Value: 0,
MonthlyContribution: 0,
Notes: String,
NotAvailable: False
}
],
TargetSchool:
{
Id: 0,
DapipId: String,
OpeId: String,
IpedsUnitIds: String,
LocationName: String,
ParentName: String,
ParentDapipId: String,
LocationType: String,
Address: String,
GeneralPhone: String,
AdminName: String,
AdminPhone: String,
AdminEmail: String,
Fax: String,
UpdateDate: 0001-01-01,
Updatedby: String,
DateCreated: 0001-01-01,
GiftingPercentage: 0,
CostOfAttendancePerSemester: 0,
ProfileEFCCalculation: False,
CreatedBy: String
}
},
Price: 0,
CommunityCollege: False,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
},
Insert: False,
Delete: False,
Update: False
}
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
}
]
},
OutputObject:
{
Id: 0,
CaseDesignId: 0,
StudentId: 0,
SectionName: String,
Student:
{
StudentId: 0,
FactFinderId: 0,
Name: String,
DOB: 0001-01-01,
GraduationYear: 0,
YearsInCollege: 0,
GPA: 0,
ACT: 0,
SAT: 0,
Tuition: 0,
ActivitiesAnnualCosts: 0,
Gender: String,
Notes: String,
HighSchoolStudent:
{
StudentId: 0,
FactFinderId: 0,
PSATYearTaken: String,
PSATScore: 0,
APClassesTaken: 0,
APClassesWillTake: 0,
APClassesTotalOffered: 0,
HighSchool: String,
ExtracurricularActivities: String,
AreaOfStudyMajor: String,
CollegesOfInterest: String,
OkayWithCommunityCollege: False,
Geographical: String,
PublicPrivate: String,
SizeOfSchool: String,
StudentAnnualIncome: 0,
StudentAnnualIncomeNotAvailable: False,
CurrentFAFSALimit: 0,
NeedHelpEssayCoach: False,
NeedHelpCareerCoach: False,
NeedHelpAdmissionsCounselor: False,
NeedHelpToastmasters: False,
NeedHelpACTSATPreparation: False,
Notes: String
},
CollegePrices:
[
{
Id: 0,
CaseDesignId: 0,
StudentId: 0,
SectionName: String,
Student:
{
StudentId: 0,
FactFinderId: 0,
Name: String,
DOB: 0001-01-01,
GraduationYear: 0,
YearsInCollege: 0,
GPA: 0,
ACT: 0,
SAT: 0,
Tuition: 0,
ActivitiesAnnualCosts: 0,
Gender: String,
Notes: String,
HighSchoolStudent:
{
StudentId: 0,
FactFinderId: 0,
PSATYearTaken: String,
PSATScore: 0,
APClassesTaken: 0,
APClassesWillTake: 0,
APClassesTotalOffered: 0,
HighSchool: String,
ExtracurricularActivities: String,
AreaOfStudyMajor: String,
CollegesOfInterest: String,
OkayWithCommunityCollege: False,
Geographical: String,
PublicPrivate: String,
SizeOfSchool: String,
StudentAnnualIncome: 0,
StudentAnnualIncomeNotAvailable: False,
CurrentFAFSALimit: 0,
NeedHelpEssayCoach: False,
NeedHelpCareerCoach: False,
NeedHelpAdmissionsCounselor: False,
NeedHelpToastmasters: False,
NeedHelpACTSATPreparation: False,
Notes: String
},
CollegePrices:
[
{
Id: 0,
CaseDesignId: 0,
StudentId: 0,
SectionName: String,
Student:
{
StudentId: 0,
FactFinderId: 0,
Name: String,
DOB: 0001-01-01,
GraduationYear: 0,
YearsInCollege: 0,
GPA: 0,
ACT: 0,
SAT: 0,
Tuition: 0,
ActivitiesAnnualCosts: 0,
Gender: String,
Notes: String,
HighSchoolStudent:
{
StudentId: 0,
FactFinderId: 0,
PSATYearTaken: String,
PSATScore: 0,
APClassesTaken: 0,
APClassesWillTake: 0,
APClassesTotalOffered: 0,
HighSchool: String,
ExtracurricularActivities: String,
AreaOfStudyMajor: String,
CollegesOfInterest: String,
OkayWithCommunityCollege: False,
Geographical: String,
PublicPrivate: String,
SizeOfSchool: String,
StudentAnnualIncome: 0,
StudentAnnualIncomeNotAvailable: False,
CurrentFAFSALimit: 0,
NeedHelpEssayCoach: False,
NeedHelpCareerCoach: False,
NeedHelpAdmissionsCounselor: False,
NeedHelpToastmasters: False,
NeedHelpACTSATPreparation: False,
Notes: String
},
CollegePrices:
[
{
}
],
FactFinderStudentColleges:
[
{
Id: 0,
StudentId: 0,
EducationalInstitutionId: 0,
Priority: 0,
EducationalInstitution:
{
Id: 0,
DapipId: String,
OpeId: String,
IpedsUnitIds: String,
LocationName: String,
ParentName: String,
ParentDapipId: String,
LocationType: String,
Address: String,
GeneralPhone: String,
AdminName: String,
AdminPhone: String,
AdminEmail: String,
Fax: String,
UpdateDate: 0001-01-01,
Updatedby: String,
DateCreated: 0001-01-01,
GiftingPercentage: 0,
CostOfAttendancePerSemester: 0,
ProfileEFCCalculation: False,
CreatedBy: String
}
}
],
FactFinderCollegeSavingsPlans:
[
{
CollegeFundingId: 0,
FactFinderId: 0,
StudentId: 0,
TypeOfPlan: String,
Value: 0,
MonthlyContribution: 0,
Notes: String,
NotAvailable: False
}
],
TargetSchool:
{
Id: 0,
DapipId: String,
OpeId: String,
IpedsUnitIds: String,
LocationName: String,
ParentName: String,
ParentDapipId: String,
LocationType: String,
Address: String,
GeneralPhone: String,
AdminName: String,
AdminPhone: String,
AdminEmail: String,
Fax: String,
UpdateDate: 0001-01-01,
Updatedby: String,
DateCreated: 0001-01-01,
GiftingPercentage: 0,
CostOfAttendancePerSemester: 0,
ProfileEFCCalculation: False,
CreatedBy: String
}
},
Price: 0,
CommunityCollege: False,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
}
],
FactFinderStudentColleges:
[
{
Id: 0,
StudentId: 0,
EducationalInstitutionId: 0,
Priority: 0,
EducationalInstitution:
{
Id: 0,
DapipId: String,
OpeId: String,
IpedsUnitIds: String,
LocationName: String,
ParentName: String,
ParentDapipId: String,
LocationType: String,
Address: String,
GeneralPhone: String,
AdminName: String,
AdminPhone: String,
AdminEmail: String,
Fax: String,
UpdateDate: 0001-01-01,
Updatedby: String,
DateCreated: 0001-01-01,
GiftingPercentage: 0,
CostOfAttendancePerSemester: 0,
ProfileEFCCalculation: False,
CreatedBy: String
}
}
],
FactFinderCollegeSavingsPlans:
[
{
CollegeFundingId: 0,
FactFinderId: 0,
StudentId: 0,
TypeOfPlan: String,
Value: 0,
MonthlyContribution: 0,
Notes: String,
NotAvailable: False
}
],
TargetSchool:
{
Id: 0,
DapipId: String,
OpeId: String,
IpedsUnitIds: String,
LocationName: String,
ParentName: String,
ParentDapipId: String,
LocationType: String,
Address: String,
GeneralPhone: String,
AdminName: String,
AdminPhone: String,
AdminEmail: String,
Fax: String,
UpdateDate: 0001-01-01,
Updatedby: String,
DateCreated: 0001-01-01,
GiftingPercentage: 0,
CostOfAttendancePerSemester: 0,
ProfileEFCCalculation: False,
CreatedBy: String
}
},
Price: 0,
CommunityCollege: False,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
}
],
FactFinderStudentColleges:
[
{
Id: 0,
StudentId: 0,
EducationalInstitutionId: 0,
Priority: 0,
EducationalInstitution:
{
Id: 0,
DapipId: String,
OpeId: String,
IpedsUnitIds: String,
LocationName: String,
ParentName: String,
ParentDapipId: String,
LocationType: String,
Address: String,
GeneralPhone: String,
AdminName: String,
AdminPhone: String,
AdminEmail: String,
Fax: String,
UpdateDate: 0001-01-01,
Updatedby: String,
DateCreated: 0001-01-01,
GiftingPercentage: 0,
CostOfAttendancePerSemester: 0,
ProfileEFCCalculation: False,
CreatedBy: String
}
}
],
FactFinderCollegeSavingsPlans:
[
{
CollegeFundingId: 0,
FactFinderId: 0,
StudentId: 0,
TypeOfPlan: String,
Value: 0,
MonthlyContribution: 0,
Notes: String,
NotAvailable: False
}
],
TargetSchool:
{
Id: 0,
DapipId: String,
OpeId: String,
IpedsUnitIds: String,
LocationName: String,
ParentName: String,
ParentDapipId: String,
LocationType: String,
Address: String,
GeneralPhone: String,
AdminName: String,
AdminPhone: String,
AdminEmail: String,
Fax: String,
UpdateDate: 0001-01-01,
Updatedby: String,
DateCreated: 0001-01-01,
GiftingPercentage: 0,
CostOfAttendancePerSemester: 0,
ProfileEFCCalculation: False,
CreatedBy: String
}
},
Price: 0,
CommunityCollege: False,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
}
}