ITMS

International Travel Management System

Base URL: /domains/legacy/travel/itms/v1

Version: v1

Default response content-types: application/json

Schemes: https

Summary

Path	Operation	Description
/adminnote	POST	Saves a Travel Plan Admin Note
/adminnote	PUT	Updates the existing Travel Plan Admin Note
/adminnote/{noteId}	DELETE	Removes a Travel Plan Admin note
/adminnote/{noteId}	GET	Gets a Travel Plan Admin note
/airlineIATAcode	PUT	Update IATA airline
/airlineIATAcode/all	GET	Gets IATA airline codes
/airlineIATAcode/current	GET	Gets IATA airline codes for existing byu sabre flight reservations
/airlineIATAcode/{code}	GET	Gets IATA airline code
/airportIATAcode	PUT	Update Airport IATA Code
/airportIATAcode/all	GET	Gets airport IATA Codes
/airportIATAcode/current	GET	Gets airport IATA Codes for existing byu sabre flight reservations
/airportIATACode/{code}	GET	Gets Airport IATA code
/authorization	GET	Get authorizations for the logged in user
/authorization/{personId}	GET	Get authorizations for a person
/calendar/{beginDate}/{endDate}	GET	Gets a Calendar Summary by date range
/country	POST	Saves a new country
/country	PUT	Updates an existing country
/country/all	GET	Gets a list of all countries
/country/all/valid	GET	Gets a list of all valid countries which means they have country name
/country/all/valid/cc	GET	Gets a list of all country codes with country name
/country/countinents	GET	Gets a list of all continents
/country/restriction	POST	Updates the Country Restriction Message
/country/restriction/add-update-all	POST	Save granted group rights for a limited Planner
/country/restriction/alert/{countryAlertId}	DELETE	Deletes a Country Custom Alert
/country/restriction/alert_note	POST	Updates a country alert note
/country/restriction/alerts	POST	Updates which Country Restriction Alerts are selected
/country/restriction/alerts/custom	POST	Saves or Updates a country custom alert
/country/restriction/country/{countryCode}	GET	Gets a list of all country restriction messages and alerts for a country
/country/restriction/defaults	GET	Gets a list of default country restriction messages
/country/restriction/defaults	PUT	Updates a default Country Restriction Message
/country/restriction/types	GET	Gets a list Country Restriction Types
/country/{countryCode}	GET	Gets a country by country code
/email	POST	Saves a new email
/email	PUT	Updates an existing email
/email/active/count/{travelPlanId}	GET	Returns the number of active emails for a travel plan
/email/active/{travelPlanId}	GET	Returns the active emails for a travel plan
/email/DTO/{emailId}	GET	Gets an email by id
/email/history/count/{travelPlanId}	GET	Returns the number of emails sent for a travel plan
/email/history/{travelPlanId}	GET	Returns a list of emails sent for a travel plan
/email/recipient	POST	Saves an email recipient
/email/recipient/{emailRecipientId}	DELETE	Removes an email recipient
/email/send_email/{emailId}	POST	sends an email immediately
/email/{emailId}	DELETE	Remove an email (sets to inactive)
/emergency_contact	POST	Saves Emergency Contact information for a person on a travel plan
/emergency_contact	PUT	Updates existing Emergency Contact information for a person on a travel plan
/emergency_contact/isp/pnr/{ytripPersonId}/{pnrLocator}	GET	Gets Emergency Contact information for a person on a sabre reservation
/emergency_contact/isp/{ytripPersonId}/{travelPlanId}	GET	Gets Emergency Contact information from the International Study Programs (ISP) System
/emergency_contact/{emergencyContactId}	DELETE	Removes an Emergency Contact record
/emergency_contact/{emergencyContactId}	GET	Gets Emergency Contact information by record id
/emergency_contact/{ytripPersonId}/{travelPlanId}	GET	Gets Emergency Contact information for a person on a travel plan
/granted_group_right/all	GET	Gets all the granted group rights for users
/granted_group_right/all/{ytripPersonId}	GET	Gets all granted group rights for a person by y-trip person ID
/granted_group_right/limited_rights	POST	Save granted group rights for a limited Planner
/granted_group_right/{rightId}	DELETE	Revokes a granted group right by right id
/granted_group_right/{typeId}/{grantedToId}	POST	Grants group right to the person with grantToId for groupType
/group_type/assignable	GET	Gets a list of all assignable group types
/group_type/assignable/{ytripPersonId}	GET	Gets all assignable group types for person
/group_type/{groupTypeId}	GET	Gets a group type by id
/groups/academic/students/{academicProgramId}/{memberDateMilliseconds}	GET	Returns students in the Acacemic Program from AIM
/groups/academic/{travelPlanId}/{+groupName}/{academicProgramId}/{memberDateMilliseconds}/{programEffectiveDateMilliseconds}	POST	Saves the definition of an Academic Group
/groups/athletics/all_teams	GET	Returns the name of all sports teams at byu as defined in the AIM system
/groups/athletics/team_members/{teamName}/{teamDate}	GET	Returns the team members of an athletic teams at byu as defined in the AIM system
/groups/athletics/{travelPlanId}/{+groupName}/{teamId}/{memberDateMilliseconds}	POST	Saves the definition of an Athletic Team
/groups/isp	POST	Saves the definition of an International Study Program group
/groups/isp/program/{ispProgramId}	GET	Returns a list of participants in the the International Study Program
/groups/isp/programs/{yearTerm}	GET	Returns a list of all the International Study Programs for the year term
/groups/isp/yearTerms/{startingYearTerm}	GET	Returns a list of all year terms where an International Study Program is offered
/groups/performingarts	POST	Saves the definition of a Performing Arts group
/groups/pnr/{pnrLocator}	GET	Returns a sabre group for the pnr locator which is the reservation identifier
/groups/travelplan/emails/{travelPlanId}	GET	Gets a List of Group Members and emails addresses for a Travel Plan
/groups/travelplan/{travelPlanId}	GET	Gets a list of groups for a Travel Plan
/groups/{groupId}	DELETE	Removes a group by group id
/groups/{groupId}	GET	Gets a group by group id
/itinerary/pnr/{pnr}	GET	Get the Itinerary for Sabre Reservation (PNR)
/itinerary/{travelPlanId}	GET	Get the Itinerary for a Travel Plan
/location/{locationId}	GET	Get Location by id
/pdf/itinerary/{travelPlanId}/{detailedView}*	GET	Get an Itinerary PDF
/pdf/pdfOptions	POST	Saves a new PDFOptions object
/pdf/pdfOptions/{pdfOptionsId}	DELETE	Delete a pdfOptions object
/pdf/pdfOptions/{pdfOptionsId}	GET	Get an Itinerary PDFOptions
/pdf/tracking/{pnr}/{personName}/{detailedView}*	GET	Get a Tracking Section PDF.
/person_travel_info	POST	Saves Person Contact Information for a person on a travel plan
/person_travel_info	PUT	Updates existing Person Contact Information for a person on a travel plan
/person_travel_info/{personTravelInfoId}	DELETE	Removes Person Contact Information
/person_travel_info/{personTravelInfoId}	GET	Gets Person Contact Information by id
/person_travel_info/{ytripPersonId}/{travelPlanId}	GET	Gets Person Contact Information
/person_travel_infonote	POST	Saves Person Contact Info note for a person on a travel plan
/person_travel_infonote	PUT	Updates existing Person Contact Info note for a person on a travel plan
/person_travel_infonote/{personTravelInfoNoteId}	DELETE	Removes Person Contact Info note
/person_travel_infonote/{personTravelInfoNoteId}	GET	Gets Person Contact Information note by note id
/person_travel_infonote/{ytripPersonId}/{travelPlanId}	GET	Gets Personal Contact Information note
/sabre/car/{segmentId}	GET	Get a Sabre Car Segment by id
/sabre/contactinfo/list/{pnr}	GET	Returns a list of sabre contact information for all people on the sabre reservation by reservation id (pnr)
/sabre/contactinfo/{id}	GET	Get sabre reservation contact information for a person by record id
/sabre/flight/arrival_iata/{iataCode}	GET	Get a list of Sabre Flight Segments by arrival IATA code
/sabre/flight/departure_iata/{iataCode}	GET	Get Sabre Flight Segments by departure IATA code
/sabre/flight/dto/{segmentId}	GET	Get a Sabre Flight Segment by id
/sabre/flight/{segmentId}	PUT	Update a Sabre Flight Segment with latest airport name from internal iata data
/sabre/hotel/{segmentId}	GET	Get a Sabre Hotel Segment by id
/sabre/participants/{segmentId}	GET	Gets a list of Sabre Segment Participants for a sabre segment by segment id
/sabre/person_travel_info/{pnrLocator}	GET	Gets a list of Sabre Travel Information for those booked on a reservation
/sabre/person_travel_info/{pnrLocator}/{ytripPersonId}	GET	Gets Sabre Travel Information for a person booked on a reservation
/sabre/person_travel_infonote	POST	Creates a Sabre Person Travel Info Note
/sabre/person_travel_infonote	PUT	Updates a Sabre Person Travel Info Note
/sabre/person_travel_infonote/{sabrePersonTravelInfoNoteId}	DELETE	Delete Note for a Sabre Traveler on a sabre reservation by note record id
/sabre/person_travel_infonote/{sabrePersonTravelInfoNoteId}	GET	Returns Note for a Sabre Traveler booked on a reservation by the note record id
/sabre/person_travel_infonote/{ytripPersonId}/{pnrLocator}	GET	Returns Note for a Sabre Traveler on a reservation by ytrip person id and reservation id (pnr)
/sabre/pnr/{pnrLocator}	GET	Returns the dates, institution, and group information for the sabre reservation by reservation id (pnr)
/sabre/rental_car_agency	PUT	Updates a Sabre Rental Car Agency Name
/sabre/rental_car_agency/all	GET	Gets a list of all Sabre Rental Car Agencies
/sabre/rental_car_agency/{vendorCode}	GET	Gets a Sabre Rental Car Agency by vendor code
/sabre/segments/{ids}	GET	Get Sabre Segments for the Calendar from an list of ids
/segment/activities/{+segmentIds}	GET	Gets a list of Activity Segments based on the list of segment ids passed in
/segment/activity	POST	Saves a new Activity Segment
/segment/activity	PUT	Updates an Activity Segment
/segment/activity/dates/{segmentId}	GET	Gets Activity Segment begin and end dates
/segment/activity/{segmentId}	DELETE	Removes an Activity Segment
/segment/activity/{segmentId}	GET	Gets an Activity Segment
/segment/convert_activity/{segmentId}	GET	Gets an Activity Segment that can be used to Update an Activity Segment
/segment/convert_side_trip/{segmentId}	GET	Gets a Side Trip that can be used to Update a Side Trip
/segment/convert_travel/{segmentId}	GET	Gets a Travel Segment that can be used to Update a Travel Segment
/segment/min_max/{sideTripId}	GET	Returns the date range of the side trip child segments
/segment/potential_participants/{travelPlanId}	GET	Gets a list of potential participants for a travel plan
/segment/side_trip	POST	Saves a new Side Trip
/segment/side_trip	PUT	Updates a Side Trip
/segment/side_trip/dates/{segmentId}	GET	Gets Side Trip begin and end dates
/segment/side_trip/has_children/{sideTripId}	GET	Returns 'true' if a side trip has child segments
/segment/side_trip/{segmentId}	DELETE	Removes a Side Trip
/segment/side_trip/{segmentId}	GET	Gets a Side Trip Segment
/segment/side_trip_only/{segmentId}	DELETE	Removes a Side Trip but does not remove associated segments
/segment/side_trips/{segmentIds}	GET	Gets a list of Side Trip Segments based on the list of segment ids passed in
/segment/stay	POST	Saves a new Stay Segment
/segment/stay	PUT	Updates a Stay Segment
/segment/stay/conflicts	PUT	Gets Stay Segment Participant Conflicts
/segment/stay/convert_stay/{segmentId}	GET	Gets a Stay Segment object that can be used to Update a Stay Segment
/segment/stay/dates/{segmentId}	GET	Gets Stay Segment beginning and end dates
/segment/stay/segment/types	GET	Returns a list of stay segment types.
/segment/stay/stays/{segmentIds}	GET	Gets a list of Stay Segments based on the list of segment ids passed in
/segment/stay/{segmentId}	DELETE	Removes a Stay Segment
/segment/stay/{segmentId}	GET	Gets a Stay Segment
/segment/travel	POST	Saves a new Travel Segment
/segment/travel	PUT	Updates a Travel Segment
/segment/travel/dates/{segmentId}	GET	Gets Travel Segment begin and end dates
/segment/travel/segment/types	GET	Gets a List of Travel Segment Types
/segment/travel/{segmentId}	DELETE	Removes a Travel Segment
/segment/travel/{segmentId}	GET	Gets a Travel Segment
/segment/travel_plan/side_trips/{travelPlanId}	GET	Gets a List of Simple Side Trips for a Travel Plan
/segment/travels/{+segmentIds}	GET	Gets a list of Travel Segments based on the list of segment ids passed in
/tracking/country_display/{countryCode}/{beginDateTime}/{endDateTime}/{+institutions}	GET	Gets Country Tracking Information
/tracking/search/groups/{dateRange1}/{dateRange2}/{+institutions}/{+groupTypes}	GET	Gets Groups for a Travel Plan or Pnr Sabre Reservation for a date range, institution, or group type
/tracking/search/location/{countryCode}/{+city}/{beginDateTime}/{endDateTime}/{+institutions}	GET	Searches for and returns Tracking information for a date range, country, and city
/tracking/search/person/{lastName}/{firstName}/{beginDateTime}/{endDateTime}/{+institutions}	GET	Searches for and returns Tracking information for a date range by person name
/tracking/world_display/{date1}/{date2}/{+institutions}	GET	Gets World Tracking Summary Information
/tracking/world_map/{date1}/{date2}	GET	Gets World Map Tracking Information
/travel_plan	POST	Saves a Travel Plan
/travel_plan	PUT	Updates the existing Travel Plan
/travel_plan/all/{travelPlanIds}	GET	Gets Travel Plans for a list of travel plan ids
/travel_plan/by_creator/{ytripPersonId}	GET	Gets a list of travel plans created by a person
/travel_plan/by_pnr/{pnr}	GET	Gets a list of travel palns for the sabre reservation (pnr)
/travel_plan/by_traveler/{ytripPersonId}	GET	Returns a list of travel plans for a ytrip person
/travel_plan/external_travel_summary/{ytripPersonId}	GET	Gets a list of travel information from external sources
/travel_plan/segments/dates/min_max/{travelPlanId}	GET	Returns the minimum and maximum dates for a travel plan based on it's child segments
/travel_plan/segments/group_participant/{travelPlanId}/{ytripPersonId}	DELETE	Removes a ytrip person from all segments in the travel plan
/travel_plan/selection/{ytripPersonId}	GET	Gets a list of travel plans for a person
/travel_plan/{travelPlanId}	DELETE	Removes a Travel Plan and associated items
/travel_plan/{travelPlanId}	GET	Gets a Travel Plan by id
/travel_planner	POST	Saves a Travel Planner
/travel_planner	PUT	Updates the existing Travel Planner
/travel_planner/travel_plan/{travelPlanId}	GET	Returns a list of travel planners for the travel plan
/travel_planner/{travelPlannerId}	DELETE	Removes a Travel Planner
/travel_planner/{travelPlannerId}	GET	Gets a Travel Planner by id
/traveler	POST	Saves a Traveler for a Travel Plan
/traveler/is_traveler/{ytripPersonId}/{travelPlanId}	GET	Returns whether this ytrip person is a traveler on the travel plan
/traveler/travel_plan/emails/{travelPlanId}	GET	Gets all Traveler Email Addresses for Travel Plan
/traveler/travel_plan/{travelPlanId}	GET	Gets the Travelers for a Travel Plan
/traveler/{travelerId}	DELETE	Removes Traveler
/traveler/{travelerId}	GET	Gets a Traveler by traveler id
/trip_participant/group/{groupId}	GET	Returns the contact information for travel plan group members.
/trip_participant/restore/groupSegments	POST	Restore a group traveler to the plan. Put them on the GroupMembersSegments.
/trip_participant/segment/nogroup/{travelPlanId}/{segmentId}	GET	Returns the contact information for segment participants.
/trip_participant/segment/{travelPlanId}/{segmentId}/{groupId}	GET	Returns the contact information for segment participants.
/trip_participant/travelers/{travelPlanId}	GET	Returns the contact information for travel plan travelers.
/version	GET	Get the version of the deployed application as a string.
/ytrip_person	POST	Save a Ytrip Person.
/ytrip_person	PUT	Update a Ytrip Person.
/ytrip_person/net_id/{netId}	GET	Get a Ytrip Person by net id.
/ytrip_person/person_id/{personId}	GET	Get a Ytrip Person by person id.
/ytrip_person/security_role/{securityRole}	GET	Get all the YtripPersons that have the given security role.
/ytrip_person/{ytripPersonId}	DELETE	Delete a Ytrip Person.
/ytrip_person/{ytripPersonId}	GET	Get Ytrip Person by Id.

Paths

Saves a Travel Plan Admin Note

POST /adminnote

Tags: Travel Plan

Saves a Travel Plan Admin Note

Authorization:

Administrative users are authorized

travel plan admin note values to save

travelPlanAdminNote

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

integerWrapper
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Updates the existing Travel Plan Admin Note

PUT /adminnote

Tags: Travel Plan

Updates the existing Travel Plan Admin Note

Authorization:

Administrative users are authorized

travel plan admin note values to update

travelPlanAdminNote

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Removes a Travel Plan Admin note

DELETE /adminnote/{noteId}

Tags: Travel Plan

Removes a Travel Plan Admin note

Authorization:

administrative users are authorized


noteId	id of the note	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a Travel Plan Admin note

GET /adminnote/{noteId}

Tags: Travel Plan

Gets a Travel Plan Admin note

Authorization:

Administrative and Executive users are authorized


noteId	the id the note	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

travelPlanAdminNote
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Update IATA airline

PUT /airlineIATAcode

Tags: Admin, Airline

Update IATA airline name for the airline with the given airline code.

Max airline name length is 40 characters.

Authorization: Admin

Update an IATA Airline

updateAirline

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: Empty response body
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
404 Not Found: The airline with that airline code does not exist.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Called with the wrong or missing a content-type HTTP header
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets IATA airline codes

GET /airlineIATAcode/all

Tags: Admin, Airline

Gets IATA airline codes

Uses default content-types: application/json

200 OK: List of all IATA Airline Codes

airlineCodes
204 No Content: Empty response body
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Called with the wrong or missing a content-type HTTP header
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets IATA airline codes for existing byu sabre flight reservations

GET /airlineIATAcode/current

Tags: Admin, Airline

Gets IATA airline codes for byu sabre flight reservations

Uses default content-types: application/json

200 OK: List of all IATA Airline Codes

airlineCodes
204 No Content: Empty response body
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Called with the wrong or missing a content-type HTTP header
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets IATA airline code

GET /airlineIATAcode/{code}

Tags: Admin, Airline

Gets IATA airline code


code	2 character iata airport code	path	string

Uses default content-types: application/json

200 OK: List of all IATA Airline Codes

airline
204 No Content: Empty response body
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Called with the wrong or missing a content-type HTTP header
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Update Airport IATA Code

PUT /airportIATAcode

Tags: Admin, Airport

Update Airport IATA Code

Update an Airport IATA Code

updateAirport

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: Empty response body
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Called with the wrong or missing a content-type HTTP header
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets airport IATA Codes

GET /airportIATAcode/all

Tags: Admin, Airport

Gets airport IATA Codes

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

airportCodes
204 No Content: Empty response body
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Called with the wrong or missing a content-type HTTP header
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets airport IATA Codes for existing byu sabre flight reservations

GET /airportIATAcode/current

Tags: Admin, Airport

Gets airport IATA Codes for byu sabre flight reservations

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

airportCodes
204 No Content: Empty response body
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Called with the wrong or missing a content-type HTTP header
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets Airport IATA code

GET /airportIATACode/{code}

Tags: Admin, Airport

Gets Airport IATA code


code	3 character iata airport code	path	string

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

airport
204 No Content: Empty response body
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Called with the wrong or missing a content-type HTTP header
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get authorizations for the logged in user

GET /authorization

Tags: Authorization

Get authorizations for a person. Returns information on what type of information they are allowed to view.

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

authorizationDTO
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
404 Not Found: the group type or ytrip person id parameters were not valid.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get authorizations for a person

GET /authorization/{personId}

Tags: Authorization

Get authorizations for a person. If the user is not authorized to get authorization for another person, no authorization data is returned.

Authorization:

Anyone can get back their own authorization information.
Admin and Executives can get back authorization information for another person.
Users with Full Group Rights can get back authorization information for another person.


personId	the person id of the person (the byu person id)	path	string

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

authorizationDTO
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
404 Not Found: the group type or ytrip person id parameters were not valid.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a Calendar Summary by date range

GET /calendar/{beginDate}/{endDate}

Tags: Admin, Country

Gets a Calendar Summary by date range

Authorization: Anyone is authorized to get their own calendar


beginDate	begin date of calendar date range	path	integer (int64)
endDate	end date of calendar date range	path	integer (int64)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

calendarSummary
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Saves a new country

POST /country

Tags: Admin, Country

Saves a Country

Authorization: admins are authorized

country values to save

country

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Updates an existing country

PUT /country

Tags: Admin, Country

Updates an existing country

Authorization: admins are authorized

country values to update

country

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a list of all countries

GET /country/all

Tags: Admin, Country

Gets a list of all countries

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

countries
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a list of all valid countries which means they have country name

GET /country/all/valid

Tags: Admin, Country

Gets a list of all valid countries that have a country name

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

countries
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a list of all country codes with country name

GET /country/all/valid/cc

Tags: Admin, Country

Gets a list of all country codes with country name

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

countryCodeWrapper
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a list of all continents

GET /country/countinents

Tags: Admin, Country

Gets a list of all continents

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

continents
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Updates the Country Restriction Message

POST /country/restriction

Tags: Admin, Country

Updates the Country Restriction Message

Authorization: admins are authorized

country restriction message values to save

updateCountryRestriction

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Save granted group rights for a limited Planner

POST /country/restriction/add-update-all

Tags: Admin, Country

Updates all Country Restrictions with country restriction information from Travel Smart.

Authorization:

Administrative users are authorized

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Deletes a Country Custom Alert

DELETE /country/restriction/alert/{countryAlertId}

Tags: Admin, Country

Deletes a Country Custom Alert

Authorization: only admins are authorized


countryAlertId	id of the country custom alert	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Updates a country alert note

POST /country/restriction/alert_note

Tags: Admin, Country

Updates a country alert note

Authorization: admins are authorized

country alerts to mark as selected or not

countryNote

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Updates which Country Restriction Alerts are selected

POST /country/restriction/alerts

Tags: Admin, Country

Updates which Country Restriction Alerts are selected

Authorization: admins are authorized

country alerts to mark as selected or not

countryAlertWrapper

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Saves or Updates a country custom alert

POST /country/restriction/alerts/custom

Tags: Admin, Country

Saves or Updates a country custom alert

Authorization: admins are authorized

custom country alerts to save or update

countryCustomAlertWrapper

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a list of all country restriction messages and alerts for a country

GET /country/restriction/country/{countryCode}

Tags: Admin, Country

Gets a list of all country restrciton messages and alerts for a country

Authorization: admins are authorized


countryCode	country code	path	string

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

countryRestrictions
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a list of default country restriction messages

GET /country/restriction/defaults

Tags: Admin, Country

Gets a list of all default country restriction messages

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

defaultRestrictions
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Updates a default Country Restriction Message

PUT /country/restriction/defaults

Tags: Admin, Country

Updates a default Country Restriction Message

Authorization: admins are authorized

country restriction message values to save

defaultRestriction

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a list Country Restriction Types

GET /country/restriction/types

Tags: Admin, Country

Gets a list of all Country Restrcition Types

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

ytripProperties
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a country by country code

GET /country/{countryCode}

Tags: Admin, Country

Gets a country by country code


countryCode	2 character country code	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

country
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Saves a new email

POST /email

Tags: Admin, Email

Saves a new email

Authorization:

admins are authorized
Travel Planners for the email Travel Plan are authorized

email values to save

emailSaveOrUpdate

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Updates an existing email

PUT /email

Tags: Admin, Email

Updates an existing email

Authorization:

admins are authorized
Travels Planners for the email travel plan are authorized

email values to update

emailSaveOrUpdate

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Returns the number of active emails for a travel plan

GET /email/active/count/{travelPlanId}

Tags: Admin, Email

Returns the number of active emails for a travel plan

Authorization:

Administrative and Executive users are authorized
Travel Planners for the email Travel plan id are authorized.
Trave Plan Travelers are authorized
Participants in a Travel Plan segment are authorized


travelPlanId	id of the travel plan	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

integerWrapper
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Returns the active emails for a travel plan

GET /email/active/{travelPlanId}

Tags: Admin, Email

Returns the active emails for a travel plan

Authorization:

Administrative and Executive users are authorized
Travel Planners for the email Travel plan id are authorized.
Travel Plan travelers are authorized
Participants in a traval plan segment are authorized


travelPlanId	id of the travel plan	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

emails
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets an email by id

GET /email/DTO/{emailId}

Tags: Admin, Email

Gets a saved email by id

Authorization:

Administrative and Executive users are authorized
Travel Planners for the email Travel plan id are authorized.


emailId	id of the saved email	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

email
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Returns the number of emails sent for a travel plan

GET /email/history/count/{travelPlanId}

Tags: Admin, Email

Returns the number of emails sent for a travel plan

Authorization:

Administrative and Executive users are authorized
Travel Planners for the email Travel plan id are authorized.


travelPlanId	id of the travel plan	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

integerWrapper
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Returns a list of emails sent for a travel plan

GET /email/history/{travelPlanId}

Tags: Admin, Email

Returns a list of emails sent for a travel plan

Authorization:

Administrative and Executive users are authorized
Travel Planners for the email Travel plan id are authorized.


travelPlanId	id of the travel plan	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

emailsSent
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Saves an email recipient

POST /email/recipient

Tags: Admin, Email

Saves an email recipient

Authorization: admins are authorized travel planners for the email travel plan are authorized

email recipient values to save

emailRecipient

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

postReturn
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Removes an email recipient

DELETE /email/recipient/{emailRecipientId}

Tags: Admin, Email

Removes an email recipient

Authorization: administrative users are authorized travel planners for the email travel plan are authorized


emailRecipientId	id of the email recipient	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

sends an email immediately

POST /email/send_email/{emailId}

Tags: Admin, Email

sends an email immediately

Authorization Administrative users are authorized Travel planners for the email travel plan are authorized


emailId		path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

postReturn
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
404 Not Found: the group type or ytrip person id parameters were not valid.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Remove an email (sets to inactive)

DELETE /email/{emailId}

Tags: Admin, Email

Removes an email (sets to inactive)

Authorization: administrative users are authorized travel planners for the email travel plan are authorized


emailId	id of the email	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Saves Emergency Contact information for a person on a travel plan

POST /emergency_contact

Tags: Segment

Saves Emergency Contact information for a person on a travel plan

Authorization:

Administrative users are authorized
Travel Planners for the Travel Plan are authorized to save emergency contact information for the travel plan
Travelers on the Travel Plan are authorized to save their own emergency contact information

emergency contact values to save

emergencyContact

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

integerWrapper
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Updates existing Emergency Contact information for a person on a travel plan

PUT /emergency_contact

Tags: Travel Plan

Updates an Emergency Contact

Updates existing Emergency Contact information for a person on a travel plan

Authorization:

Administrative users are authorized
Travel Planners for the Travel Plan are authorized to update emergency contacts for the travel plan
Travelers on the Travel Plan are authorized to update their own emergency contact information

emergency contact values to update

emergencyContact

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets Emergency Contact information for a person on a sabre reservation

GET /emergency_contact/isp/pnr/{ytripPersonId}/{pnrLocator}

Tags: Travel Plan

Gets Emergency Contact information from the International Study Programs (ISP) System for a person on a sabre reservation

Authorization:

Administrative and Executive users are authorized
A Travel Planner for ISP Groups is authorized
Sabre Travelers can get back their own ISP Emergency Contact Information


ytripPersonId	the id the ytrip person	path	integer (int32)
pnrLocator	the id the sabre reservation (PNR)	path	string

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

ispEmergencyContact
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets Emergency Contact information from the International Study Programs (ISP) System

GET /emergency_contact/isp/{ytripPersonId}/{travelPlanId}

Tags: Travel Plan

Gets Emergency Contact information from the International Study Programs (ISP) System for a person on a travel plan

Authorization:

Administrative and Executive users are authorized
A Travel Planner for the travel plan is authorized
Travelers can get back their own ISP Emergency Contact Information


ytripPersonId	the id the ytrip person	path	integer (int32)
travelPlanId	the id the travel plan	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

ispEmergencyContact
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Removes an Emergency Contact record

DELETE /emergency_contact/{emergencyContactId}

Tags: Travel Plan

Removes an Emergency Contact record

Authorization:

administrative users are authorized
travel planners for the travel plan are authorized
travelers are authorized to remove their own contact information


emergencyContactId	id of the emergency contact record	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets Emergency Contact information by record id

GET /emergency_contact/{emergencyContactId}

Tags: Travel Plan

Gets Emergency Contact information by record id

Authorization:

Administrative and Executive users are authorized
A Travel Planner for the travel plan is authorized
Travelers can get back their own Emergency Contact Information


emergencyContactId	the id the emergency contact record	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

emergencyContact
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets Emergency Contact information for a person on a travel plan

GET /emergency_contact/{ytripPersonId}/{travelPlanId}

Tags: Travel Plan

Gets Emergency Contact information for a person on a travel plan

Authorization:

Administrative and Executive users are authorized
A Travel Planner for the travel plan is authorized
Travelers can get back their own Emergency Contact Information


ytripPersonId	the id the ytrip person	path	integer (int32)
travelPlanId	the id the travel plan	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

emergencyContact
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets all the granted group rights for users

GET /granted_group_right/all

Tags: Admin, GroupRights

Gets all granted group rights for all users who have been granted group rights Authorization:

Administrative users are authorized to get a list of Granted Group Rights for all who have group rights.
Everyone else is authorized to get a list of their own Granted Group Rights.

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

grantedGroupRights
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets all granted group rights for a person by y-trip person ID

GET /granted_group_right/all/{ytripPersonId}

Tags: Admin, GroupRights

Gets all granted group rights for a person by y-trip person ID.

Authorization:

Administrative and Executive users are authorized to view the Granted Group Rights for a person
Those with Rull-Group Rights are authorized to view the Granted Group rights for a person
Everyone else is only allowed to get their own granted group rights.


ytripPersonId	ytrip person id to get list of granted group rights for	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

grantedGroupRights
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Save granted group rights for a limited Planner

POST /granted_group_right/limited_rights

Tags: Admin, GroupRights

A limited planner has group rights for a single travel plan. This method Replaces existing limited rights for the person with the new list of limited group rights. Any full group rights will be unchanged

Authorization:

Administrative users are authorized to save a limited group right.
Full planners can save rights for a limited planner for that travel plan.

List of limited group rights to save

saveLimitedRights

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Revokes a granted group right by right id

DELETE /granted_group_right/{rightId}

Tags: Admin, GroupRights

Revokes a granted group right by right id.

Authorization: only administrative users can revoked granted group rights


rightId	number id of the granted group right for the person	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Grants group right to the person with grantToId for groupType

POST /granted_group_right/{typeId}/{grantedToId}

Tags: Admin, GroupRights

Saves (Grants) a group right

Authorization - Administrative users are authorized to save a granted group right.


typeId	Valid Group Types are: 1 = Athletics 2 = Performaing Arts 3 = International Study Programs 4 = Academic Programs	path	integer (int32)
grantedToId	ytrip person id of person to be granted group rights	path	number

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

postReturn
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
404 Not Found: the group type or ytrip person id parameters were not valid.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a list of all assignable group types

GET /group_type/assignable

Tags: Admin, GroupType

Gets a list of all assignable group types

Authorization: Administrative and Executive users are authorized to get assignable group types

Valid Group Types are: 1 = Athletics 2 = Performaing Arts 3 = International Study Programs 4 = Academic Programs

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

groupTypes
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets all assignable group types for person

GET /group_type/assignable/{ytripPersonId}

Tags: Admin, GroupType

Gets a list of assignable group types for a person which means the list of group types they have not yet been granted.

Authorization: Administrative and Executive users are authorized to get assignable group types for a person.

Valid Group Types are: 1 = Athletics 2 = Performaing Arts 3 = International Study Programs 4 = Academic Programs


ytripPersonId	id of the person	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

groupTypes
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a group type by id

GET /group_type/{groupTypeId}

Tags: Admin, GroupType

Gets a group type by id.

Authorization: Administrative and Executive users are authorized to get a group type

Valid Group Types are: 1 = Athletics 2 = Performaing Arts 3 = International Study Programs 4 = Academic Programs


groupTypeId	id of the group type	path	integer (int32)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

groupType
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Returns students in the Acacemic Program from AIM

GET /groups/academic/students/{academicProgramId}/{memberDateMilliseconds}

Tags: Groups

Returns students in the Acacemic Program from AIM based on an academic program id and a date parameter which is a long integer in milliseconds from the epoch of 1970-01-01T00:00:00Z. The date is used to locate students who were members of an academic group on a certain date.

Authorization:

Administrative and Executive users are authorized
Those granted the group role of 'Academic Groups' by an ITMS administrator are authorized


academicProgramId	id of the aim academic program	path	integer (int32)
memberDateMilliseconds	date respresented by a long number of milliseconds since 1970	path	integer (int64)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

programMembers
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Saves the definition of an Academic Group

POST /groups/academic/{travelPlanId}/{+groupName}/{academicProgramId}/{memberDateMilliseconds}/{programEffectiveDateMilliseconds}

Tags: Groups

Saves the definition of an Academic Group so group members can be retrieved later.

Authorization

Administrative users are authorized
Those granted the group role of 'Academic Groups' by an ITMS administrator are authorized


travelPlanId	the id of the travel plan the group was added to	path	integer (int32)
+groupName	the name the group will be referred to in the ITMS system	path	string
academicProgramId	the academic program id in the aim system	path	string
memberDateMilliseconds	the date used to determine who group members are on a specific date	path	integer (int64)
programEffectiveDateMilliseconds	the effective date of the program in aim	path	integer (int64)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

integerWrapper
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
404 Not Found: the group type or ytrip person id parameters were not valid.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Returns the name of all sports teams at byu as defined in the AIM system

GET /groups/athletics/all_teams

Tags: Groups

Returns the name of all sports teams at byu as defined in the AIM system

Authorization:

Administrative and Executive users are authorized
Those granted the group role of 'Athletic Groups' by an ITMS administrator are authorized

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

simpleTeams
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Returns the team members of an athletic teams at byu as defined in the AIM system

GET /groups/athletics/team_members/{teamName}/{teamDate}

Tags: Groups

Returns the team members of an athletic teams at byu as defined in the AIM system

Authorization:

Administrative and Executive users are authorized
Those granted the group role of 'Athletic Groups' by an ITMS administrator are authorized


teamName	the name the athletic team as defined in the AIM system	path	string
teamDate	the date to use in determining who were team members on that date. The date is a long number in milliseconds since 1970.	path	integer (int64)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

team
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Saves the definition of an Athletic Team

POST /groups/athletics/{travelPlanId}/{+groupName}/{teamId}/{memberDateMilliseconds}

Tags: Groups

Saves the definition of an Athletic Team so group members can be retrieved later.

Authorization

Administrative users are authorized
Those granted the group role of 'Athletic Groups' by an ITMS administrator are authorized


travelPlanId	the id of the travel plan the group was added to	path	integer (int32)
+groupName	the name the group will be referred to in the ITMS system	path	string
teamId	the athletic team id in the aim system	path	string
memberDateMilliseconds	the date used to determine who group members are on a specific date	path	integer (int64)

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

integerWrapper
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
404 Not Found: the group type or ytrip person id parameters were not valid.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Saves the definition of an International Study Program group

POST /groups/isp

Tags: Groups

Saves the definition of an International Study Program group so group members can be retrieved later

Authorization:

Administrative users are authorized
Those granted the group role of 'International Study Programs' by an ITMS administrator are authorized

group definition values to save

groupIspSave

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

integerWrapper
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Returns a list of participants in the the International Study Program

GET /groups/isp/program/{ispProgramId}

Tags: Groups

Returns a list of participants in the the International Study Program

Authorization:

Administrative and Executive users are authorized
Those granted the group role of 'International Study Programs' by an ITMS administrator are authorized


ispProgramId	the is of the International Study Program from the ISP system	path	string

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

ispProgram
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Returns a list of all the International Study Programs for the year term

GET /groups/isp/programs/{yearTerm}

Tags: Groups

Returns a list of all the International Study Programs for the year term

Authorization:

Administrative and Executive users are authorized
Those granted the group role of 'International Study Programs' by an ITMS administrator are authorized


yearTerm	the 5 character byu year term for example 20171 for winter 2017, 20173 for spring 2017, 20174 for summer 2017, 20175 for fall 2017	path	string

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

simpleIspPrograms
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Returns a list of all year terms where an International Study Program is offered

GET /groups/isp/yearTerms/{startingYearTerm}

Tags: Groups

Returns a list of all year terms where an International Study Program is offered

Authorization:

Administrative and Executive users are authorized
Those granted the group role of 'International Study Programs' by an ITMS administrator are authorized


startingYearTerm	the year term to start with	path	string

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

yearTermDTOList
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Saves the definition of a Performing Arts group

POST /groups/performingarts

Tags: Groups

Saves the definition of a Performing Arts group so group members can be retrieved later

Authorization:

Administrative users are authorized
Those granted the group role of 'Performing Arts' by an ITMS administrator are authorized

group definition values to save

groupClassSave

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

integerWrapper
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Returns a sabre group for the pnr locator which is the reservation identifier

GET /groups/pnr/{pnrLocator}

Tags: Groups

Returns a sabre group for the pnr locator which is the reservation identifier

Authorization:

Administrative and Executive users are authorized


pnrLocator	the reservation identifier from the sabre reservation system	path	string

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

groupPnr
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a List of Group Members and emails addresses for a Travel Plan

GET /groups/travelplan/emails/{travelPlanId}

Tags: Groups

Gets a List of Group Members and emails addresses for a Travel Plan

This method gets a list of Groups for a Travel Plan returned as a YtripGroupListDTO object, which contains information about the group, the type of group, and the travelers in the group with emails.

Authorization:

Administrative and Executive users are authorized
Those granted the group role for the type of groups being associated with the travel plan are authorized
A Travel Planner for the group travel plan is authorized
Travelers on the travel plan for the group are authorized but will not get back any information about the other group travelers.
Group members of the travel plan groups are authorized but will not get back other group members.


travelPlanId	the id the travel plan	path	string

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

ytripGroupEmails
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a list of groups for a Travel Plan

GET /groups/travelplan/{travelPlanId}

Tags: Groups

Gets a list of groups for a Travel Plan.

This method gets a list of Groups for a Travel Plan returned as a YtripGroupListDTO object, which contains information about the group, the type of group, and the travelers in the group.

Authorization:

Administrative and Executive users are authorized
Those granted the group role for the type of groups being associated with the travel plan are authorized
A Travel Planner for the group travel plan is authorized
Travelers on the travel plan for the group are authorized but will not get back any information about the other group travelers.
Group members of the travel plan groups are authorized but will not get back other group members.


travelPlanId	the id the travel plan	path	string

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

groups
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Removes a group by group id

DELETE /groups/{groupId}

Tags: Groups

Removes a group by group id

This method removes a Group based on a group id. Removes all types of groups, athletic, academic, performing arts, or international study program groups.

Authorization:

Administrative and Executive users are authorized
Those granted the group role for the type of groups being associated with the travel plan are authorized
A Travel Planner for the group travel plan is authorized


groupId	the id the group	path	string

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.
204 No Content: No content. The service call has completed successfully. Empty response body.
400 Bad Request: There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
403 Forbidden: The user does not have access to the resource.
405 Method Not Allowed: The service method is not supported by the service.
415 Unsupported Media Type: Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.
500 Internal Server Error: An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Gets a group by group id

GET /groups/{groupId}

Tags: Groups

Gets a group by group id

This method gets a Group based on a group id and returns a YtripGroupDTO object, which contains information about the group, the type of group, and the travelers in the group.

Authorization:

Administrative and Executive users are authorized
Those granted the group role for the type of groups being associated with the travel plan are authorized
A Travel Planner for the group travel plan is authorized
Travelers on the travel plan for the group are authorized but will not get back any information about the other group travelers.
Group members of the travel plan groups are authorized but will not get back other group members.


groupId	the id the group	path	string

Uses default content-types: application/json

200 OK: Service request is OK and a response has been generated.

group
204 No Content: No content. The service call has completed successfully. Empty response body.