populi-api-client

Populi API Client with Retrofit2 and JAXB

Usage

In your build.gradle, add following:

repositories {
    jcenter()
}

dependencies {
    implementation 'com.github.joelhandwell:populi-api-client:1.1.0'
}

Then in your kotlin code,

fun clientWithUsernamePassword(){
    val populi = Populi.Builder().withBaseUrl("https://your_university.populiweb.com/")
                                 .withUsername("your_name")
                                 .withPassword("your_password").build()
    println(populi.getDegrees())
}

fun clientWithAccessKey(){
    val populi = Populi.Builder().withBaseUrl("https://your_university.populiweb.com/")
                                 .withAccessKey("7283dac8472d4e5d...").build()
    println(populi.getDegrees())
    println(populi.getUsers())
    println(populi.getCampuses())
}

API Coverage

subject	operation type	task	jaxb impl status
AcademicTerms	get	getAcademicTerms
AcademicYears	get	getAcademicYears
Address	add	addAddress
Address	delete	deleteAddress
Address	update	updateAddress
AdvisorFromStudent	remove	removeAdvisorFromStudent
AdvisorToStudent	add	addAdvisorToStudent
AidApplication	add	addAidApplication
AidApplication	edit	editAidApplication
AidApplication	get	getAidApplication
AidApplicationForStudentAidYear	get	getAidApplicationForStudentAidYear
AllCustomFields	get	getAllCustomFields
Application	add	addApplication
Application	get	getApplication
Application	submit	submitApplication
ApplicationComponents	get	getApplicationComponents
ApplicationField	set	setApplicationField
ApplicationFieldOptions	get	getApplicationFieldOptions
ApplicationNote	add	addApplicationNote
Applications	get	getApplications
ApplicationStatus	update	updateApplicationStatus
ApplicationTemplates	get	getApplicationTemplates
AvailableRoles	get	getAvailableRoles
Backup	download	downloadBackup
Backup	request	requestBackup
Campuses	get	getCampuses
CampusFromStudent	delete	deleteCampusFromStudent
CampusToStudent	add	addCampusToStudent
CommunicationPlanFromPerson	delete	deleteCommunicationPlanFromPerson
CommunicationPlans	get	getCommunicationPlans
CommunicationPlanToPerson	add	addCommunicationPlanToPerson
Countries	get	getCountries
CourseCatalog	get	getCourseCatalog
CourseGroupInfo	get	getCourseGroupInfo
CourseGroups	get	getCourseGroups
CourseInstance	finalize	finalizeCourseInstance
CourseInstance	get	getCourseInstance
CourseInstanceAssignment	add	addCourseInstanceAssignment
CourseInstanceAssignment	delete	deleteCourseInstanceAssignment
CourseInstanceAssignment	update	updateCourseInstanceAssignment
CourseInstanceAssignmentGroup	add	addCourseInstanceAssignmentGroup
CourseInstanceAssignmentGroup	delete	deleteCourseInstanceAssignmentGroup
CourseInstanceAssignmentGroup	update	updateCourseInstanceAssignmentGroup
CourseInstanceAssignmentGroups	get	getCourseInstanceAssignmentGroups
CourseInstanceAssignments	get	getCourseInstanceAssignments
CourseInstanceFiles	get	getCourseInstanceFiles
CourseInstanceLessons	get	getCourseInstanceLessons
CourseInstanceMeeting	create	createCourseInstanceMeeting
CourseInstanceMeetingAttendance	get	getCourseInstanceMeetingAttendance
CourseInstanceMeetings	get	getCourseInstanceMeetings
CourseInstanceStudent	get	getCourseInstanceStudentXml
CourseInstanceStudentAttendance	get	getCourseInstanceStudentAttendance
CourseInstanceStudents	get	getCourseInstanceStudents
CourseOfferingLink	add	addCourseOfferingLink
CourseOfferingLink	delete	deleteCourseOfferingLink
CourseOfferingLink	update	updateCourseOfferingLink
CourseOfferingLinks	get	getCourseOfferingLinks
CurrentAcademicTerm	get	getCurrentAcademicTerm
CustomField	delete	deleteCustomField
CustomField	set	setCustomField
CustomFieldOptions	get	getCustomFieldOptions
CustomFields	get	getCustomFields
DefaultTuitionScheduleFromStudent	remove	removeDefaultTuitionScheduleFromStudent
DefaultTuitionScheduleToStudent	add	addDefaultTuitionScheduleToStudent
DegreeAudit	get	getDegreeAudit
Degrees	get	getDegrees
EducationLevels	get	getEducationLevels
EmailAddress	unsbscribe	unsubscribeEmailAddress
EmailAddress	add	addEmailAddress
EmailAddress	delete	deleteEmailAddress
EmailAddress	resubscribe	resubscribeEmailAddress
EmailAddress	update	updateEmailAddress
Enrollment	add	addEnrollment
EntriesForAccount	get	getEntriesForAccount
Event	get	getEvent
Events	get	getEvents
Fees	get	getFees
File	download	downloadFile
File	upload	uploadFile
FileDownloadURL	get	getFileDownloadURL
FinancialAidAward	add	addFinancialAidAward
FinancialAidAward	delete	deleteFinancialAidAward
FinancialAidAward	edit	editFinancialAidAward
FinancialAidAwards	get	getFinancialAidAwards
FinancialAidAwardTypes	get	getFinancialAidAwardTypes
FinancialAidDisbursement	add	addFinancialAidDisbursement
FinancialAidDisbursement	delete	deleteFinancialAidDisbursement
FinancialAidDisbursement	edit	editFinancialAidDisbursement
FinancialAidDisbursement	post	postFinancialAidDisbursement
FinancialAidDisbursementBatch	create	createFinancialAidDisbursementBatch
FinancialAidDisbursements	get	getFinancialAidDisbursements
FinancialAidRefund	add	addFinancialAidRefund
FinancialAidRefund	delete	deleteFinancialAidRefund
FinancialAidRefund	edit	editFinancialAidRefund
FinancialAidYears	get	getFinancialAidYears
GradeReport	get	getGradeReport
Inquiry	add	addInquiry
Inquiry	get	getInquiry
Invoice	get	getInvoice
Invoices	get	getInvoices
LeadInfo	set	setLeadInfo
LeadSources	get	getLeadSources
LedgerAccounts	get	getLedgerAccounts
LessonContent	get	getLessonContent
LicensePlate	delete	deleteLicensePlate
LicensePlate	update	updateLicensePlate
MealPlans	get	getMealPlans
MyCourses	get	getMyCourses
News	get	getNews
Payment	add	addPayment
Payment	get	getPayment
PaymentPlans	get	getPaymentPlans
PendingCharge	add	addPendingCharge
PendingCharges	get	getPendingCharges
PendingCharges	invoice	invoicePendingCharges
People	search	searchPeople
Person	add	addPerson
Person	get	getPerson
PersonApplications	get	getPersonApplications
PersonBirthDate	delete	deletePersonBirthDate
PersonBirthDate	set	setPersonBirthDate
PersonCitizenship	delete	deletePersonCitizenship
PersonCitizenship	set	setPersonCitizenship
PersonCommunicationPlans	get	getPersonCommunicationPlans
PersonGender	set	setPersonGender
PersonHometown	delete	deletePersonHometown
PersonHometown	set	setPersonHometown
PersonLeads	get	getPersonLeads
PersonName	set	setPersonName
PersonRaceEthnicity	delete	deletePersonRaceEthnicity
PersonRaceEthnicity	set	setPersonRaceEthnicity
PersonSSN	delete	deletePersonSSN
PersonSSN	get	getPersonSSN
PersonSSN	set	setPersonSSN
PhoneNumber	add	addPhoneNumber
PhoneNumber	delete	deletePhoneNumber
PhoneNumber	update	updatePhoneNumber
PossibleDuplicatePeople	get	getPossibleDuplicatePeople
PrintLayouts	get	getPrintLayouts
ProfilePicture	add	addProfilePicture
Programs	get	getPrograms
Provinces	get	getProvinces
Races	get	getRaces
Refund	get	getRefund
Role	add	addRole
Role	remove	removeRole
RoleMembers	get	getRoleMembers
Roles	get	getRoles
RoomPlans	get	getRoomPlans
States	get	getStates
StudentAssignmentGrade	set	setStudentAssignmentGrade
StudentAssignmentSubmissions	get	getStudentAssignmentSubmissions
StudentAttendance	update	updateStudentAttendance
StudentBalances	get	getStudentBalances
StudentDefaultTuitionSchedules	get	getStudentDefaultTuitionSchedules
StudentDegree	add	addStudentDegree
StudentDegreeSpecialization	add	addStudentDegreeSpecialization
StudentDegreeSpecialization	delete	deleteStudentDegreeSpecialization
StudentDiscipline	get	getStudentDiscipline
StudentEntranceTerm	set	setStudentEntranceTerm
StudentFinalGrade	set	setStudentFinalGrade
StudentID	set	setStudentID
StudentInfo	get	getStudentInfo
StudentMealPlan	get	getStudentMealPlan
StudentProgram	add	addStudentProgram
StudentPrograms	get	getStudentPrograms
StudentRoomPlan	get	getStudentRoomPlan
StudentSchedule	download	downloadStudentSchedule
StudentTermTuitionScheduleBracket	update	updateStudentTermTuitionScheduleBracket
StudentTermTuitionSchedules	get	getStudentTermTuitionSchedules
Tag	add	addTag
Tag	remove	removeTag
TaggedPeople	get	getTaggedPeople
Tags	get	getTags
TermBillingInfo	get	getTermBillingInfo
TermCourseInstances	get	getTermCourseInstances
TermEnrollment	get	getTermEnrollment
TermStudents	get	getTermStudents
TermTuitionScheduleFromStudent	remove	removeTermTuitionScheduleFromStudent
TermTuitionScheduleToStudent	add	addTermTuitionScheduleToStudent
Todo	add	addTodo
Todo	delete	deleteTodo
TodoCompleted	set	setTodoCompleted
Todos	get	getTodos
Transactions	get	getTransactions
Transcript	get	getTranscript
TuitionSchedules	get	getTuitionSchedules
UpdatedEnrollment	get	getUpdatedEnrollment
UpdatedPeople	get	getUpdatedPeople
User	add	addUser
User	block	blockUser
User	remove	removeUser
User	unblock	unblockUser
Users	get	getUsers
VoidedTransactions	get	getVoidedTransactions