Warmup
| API | Description |
|---|---|
| GET api/warmup/BaseInit |
Forces a controller warmup to trigger caches + any needed functions |
StudentLogin
StudentLoginController
| API | Description |
|---|---|
| POST api/student/login |
Returns an access token to be used for "auto-login" in other services, e.g. the Hub. The access token expires after some time so it's important to request a new access token for each login attempt. |
StudentFlights
StudentFlightsController
| API | Description |
|---|---|
| GET api/student/flights/{PoseidonBookingId} |
Returns a list of flights associated with the selected student. Each flight includes the arrival and departure times, the arrival and departure airports, the carrier name, the flight number, and whether the flight is inbound or outbound. |
DataWarehouse
Api Controller for serving paperwork status info to the data warehouse
| API | Description |
|---|---|
| POST api/datawarehouse/ppw-all |
Gets all paperwork status info for data-warehousing purposes |
| POST api/datawarehouse/ppw-modified-since |
Gets a subset of paperwork status info based on modified date for data-warehousing purposes |
StudentPleet
StudentPleetController
| API | Description |
|---|---|
| GET api/student/pleet/{PoseidonBookingId} |
Gets the specified request. |
Affiliate
Affiliate API controller.
| API | Description |
|---|---|
| GET api/affiliate/getBasicAffiliate/{Id} |
Returns basic information about an affiliate. If no details are found it will return an empty response. |
DiscoveryTours
Handles inbound requests from the HSEY.DiscoveryToures.Api service
| API | Description |
|---|---|
| GET api/discoverytours/getStudentProgram/{poseidonBookingId} |
Get Student Program |
InfoMeetings
OfficesController
| API | Description |
|---|---|
| GET api/infomeetings/getAllInfomeetings?mc={mc}&includeGlobal={includeGlobal}&eventTags={eventTags}&departureYears={departureYears}&targetGroups={targetGroups}&locationTypes={locationTypes} |
Get Infomeetings by Market |
| GET api/infomeetings/getById?id={id}&mc={mc} |
Get Infomeetings by Id |
Iec
IEC API controller.
| API | Description |
|---|---|
| GET api/iec/getActiveHomePages |
Get active IEC home page data for marketing pages |
| GET api/iec/getIecPhoto?iecId={iecId}&photoId={photoId} |
Get IEC Photo |
StudentDetails
StudentDetailsController
| API | Description |
|---|---|
| GET api/student/details/{PoseidonBookingId} |
Returns basic information about a student. This includes birthdate, country code, email, first- and lastname, home address, and phone numbers. If no student details are found it will return an empty response with a message. |
Atlas
Atlast API integration endpoint
| API | Description |
|---|---|
| POST api/atlas/import |
Imports the specified hsey PNR information. |
| POST api/atlas/delete |
Imports the specified hsey PNR information. |
UserRenderPermissions
Utz HTML Render Permissions based on staff or affiliate
| API | Description |
|---|---|
| GET api/UserRenderPermissions/{userId}?accountId={accountId} |
Returns Permissions for HTML render. |
HostFamily
HF API controller.
| API | Description |
|---|---|
| GET api/hf/getHostFamilyPages |
Get HF home page data for marketing pages |
| GET api/hf/getHfPhoto?hfId={hfId}&photoId={photoId} |
Get HF Photo |
ETicket
Redirects to the latest eticket.
| API | Description |
|---|---|
| GET api/eticket/student?flight={flight} |
Endpoint for getting the latest eticket for a flight |
StudentPdfInfo
StudentPdfInfoController
| API | Description |
|---|---|
| GET api/student/getBasicStudent/{studentProgramId} |
Returns basic information about a student. full name, poseidon booking id and student program id. If no student details are found it will return an empty response. |
| POST api/student/getStudentCatalogExtendedInfo |
Returns Extended information about a student. If no student details are found it will return an empty response. |
Offices
OfficesController
| API | Description |
|---|---|
| GET api/offices/getOffice?mc={mc} |
Get Office by Market |
Pleet
Redirects to the latest pleets of students, host families, and schools.
| API | Description |
|---|---|
| GET api/pleet/{poseidonBookingId} |
Test endpoint for pleets. |
| GET api/pleet/student/{poseidonBookingId} |
Redirects to the latest student pleet if found, otherwise returns a 404. |
| GET api/pleet/hostfamily/{poseidonBookingId} |
Redirects to the latest host family pleet if found, otherwise returns a 404. |
| GET api/pleet/school/{poseidonBookingId} |
Redirects to the latest school pleet if found, otherwise returns a 404. |
Sms
SMSController
| API | Description |
|---|---|
| POST api/sms/send |
Queues SMS Message. |
SMSController
| API | Description |
|---|---|
| POST api/email/refer |
Queues Email Message for referral email |
| POST api/email/wfs-error |
Queues Email Message for referral email |
| POST api/email/interview-assigned |
Queues Email Message for interview leader assignment email |
| POST api/email/InitialHomeboundNotification |
Queues email messages for all affected HFs notifying them that the homebound selection process has begun |
DiscoveryToursComms
DiscoveryToursCommsController
| API | Description |
|---|---|
| POST api/discoverytours/comms/passwordReset |
Queues Password Reset Email. |
| POST api/discoverytours/comms/accountCreated |
Queues Account Creation Email. |
| POST api/discoverytours/comms/parentApproval |
Queues NatPat confirmation Email. |
| POST api/discoverytours/comms/hostApproval |
Queues host family confirmation email. |
| POST api/discoverytours/comms/travelerBooked |
Queues student confirmation email. |
| POST api/discoverytours/comms/contactus |
Relays contact us forms to staff email |
| POST api/discoverytours/comms/paymentProcessed |
Queues payment receipt email. |
StudentSearch
Student search API controller.
| API | Description |
|---|---|
| POST api/student/search |
Search for a student by age, country, gender, and hobbies. |
| POST api/student/fyssearch |
Search for a student by age, country, gender, and hobbies. Tied in with future programs for FYS |
StudentCommute
StudentCommuteController
| API | Description |
|---|---|
| GET api/student/commute/{PoseidonBookingId} |
Returns the host family and school address (if any) for the selected student, if the student is currently placed. Needs the Poseidon booking number in order to determinte which student program, host family, and school should be used. If the student is not placed, or a matching booking cannot be found it returns an empty response with a message. |
PreFill
PreFillController
| API | Description |
|---|---|
| GET api/PreFill?slug={slug}&formInstanceId={formInstanceId} |
Gets the PDF form. |
| GET api/PreFill/GetPdfForm/{poseidonBookingId}?slug={slug}&formInstanceId={formInstanceId} |
Gets the PDF form. |
Voice
VoiceController
| API | Description |
|---|---|
| GET api/Voice?commQueueId={commQueueId} |
Gets the specified comm queue identifier. |
| GET api/Voice/Get/{poseidonBookingId}?commQueueId={commQueueId} |
Gets the specified comm queue identifier. |