SJP Upgrade Help

Follow this guide to help you migrate from the Legacy SJP to the Content Api.

Not all messages could be migrated verbatim

The Content Api has been modeled from the original SJP Api. Most response messages are exactly the same as the original SJP messages however some messages weren't completely backward compatible. The ones that were not backward compatible are in the Legacy column in the Message Implementation Matrix below.

Visit this page for the Swagger documentation for the Content Api Messages, then choose the "Legacy" docs from the dropdown menu and click explore

Swagger API specification

Whats different between the SJP and the Content Api?

Most messages are the same however

  1. The URL starts with /api/ in Content Api rather than /be/ in the SJP, so with most messages if you were calling the SJP in the past, you would change

    https://sjp.bookeasy.com.au/be/ to https://webapi.bookeasy.com.au/api/ or
    https://sjp.impartmedia.com/be/ to https://webapi.bookeasy.com.au/api/ or
    https://sjp.impartmedia.com.au/be/ to https://webapi.bookeasy.com.au/api/
  2. The Content Api uses a Cloud Front cache, so the Cache-Control Header is useful for caching responses on your side
  3. The Content Api is faster as a result of better caching logic
  4. The Content Api has the Swagger documentation built in, so you can generate classes using your preferred swagger class generation tool
  5. The Content Api will be supported going forward and enhanced, the SJP is going to be deprecated over time.

Message Implementation Matrix

Group Message Legacy Content Api
Accommodation getAccomAttributes api/getAccomAttributes
getAccomRates be/getAccomRates api/getAccomRates
getAccomRatesGrid be/getAccomRatesGrid api/getAccomRatesGrid
getAccomRoomDetailsShort be/getAccomRoomDetailsShort api/getAccomRoomDetailsShort
getAccomRoomsDetails be/getAccomRoomsDetails api/getAccomRoomsDetails
Authentication GetAuthDetails api/GetAuthDetails
SetCredentialsAanzMembership api/SetCredentialsAanzMembership
SetCredentialsAgent api/SetCredentialsAgent
SetCredentialsGuest api/SetCredentialsGuest
SetPromoCode api/SetPromoCode
SetTokens api/SetTokens
Car Hire getCarHireRates be/getCarHireRates api/getCarHireRates
getCarHireRatesGrid be/getCarHireRatesGrid api/getCarHireRatesGrid
getCarHireVehicles be/getCarHireVehicles api/getCarHireVehicles
Events getEventConfig api/getEventConfig
getEventsAttributes api/getEventsAttributes
getEventsDetailsShort be/getEventsDetailsShort api/getEventsDetailsShort
getEventsOperatorEventDetails api/getEventsOperatorEventDetails
getEventsRates be/getEventsRates api/getEventsRates
getEventsRatesGrid be/getEventsRatesGrid api/getEventsRatesGrid
Modules getTmOperatorConfig api/getTmOperatorConfig
getTmOperatorLocations api/getTmOperatorLocations
Operators getOperatorBookingQuestions api/getOperatorBookingQuestions
getOperatorConfig api/getOperatorConfig
getOperatorImages api/getOperatorImages
getOperatorInventoryAvail api/getOperatorInventoryAvail
getOperatorModDates api/getOperatorModDates
getOperatorReviews api/getOperatorReviews
getOperatorsDetailsShort be/getOperatorsDetailsShort api/getOperatorsDetailsShort
getOperatorsInformation api/getOperatorsInformation
getOperatorsMetadata api/getOperatorsMetadata
Packages getPackageDetails be/getPackageDetails api/getPackageDetails
getPackages be/getPackages api/getPackages
Shared getCurrencies be/getCurrencies api/getCurrencies
Shopping Cart deleteBECart api/cart/deleteBECart
getBEBooking api/cart/getBEBooking
getBECart api/cart/getBECart
getBECartInfo api/cart/getBECartInfo
getNewSession api/cart/getNewSession
saveBEBooking api/cart/saveBEBooking
saveBECartPart api/cart/saveBECartPart
saveBEOperatorBookingQuestionAnswers api/cart/saveBEOperatorBookingQuestionAnswers
Tours getToursAttributes api/getToursAttributes
getToursDetailsShort be/getToursDetailsShort api/getToursDetailsShort
getToursOperatorTourDetails be/getToursOperatorTourDetails api/getToursOperatorTourDetails
getToursRates be/getToursRates api/getToursRates
getToursRatesGrid be/getToursRatesGrid api/getToursRatesGrid
Utilities getFacilityTypes api/getFacilityTypes
getItineraryPdf api/getItineraryPdf
getNonce api/getNonce
Visitor Centre getVcBusinessTypes api/getVcBusinessTypes
getVcCampaignProducts api/getVcCampaignProducts
getVcCampaigns api/getVcCampaigns
getVcConfig api/getVcConfig
getVcCountries api/getVcCountries
getVcEventTrackingData api/getVcEventTrackingData
getVcFacilities api/getVcFacilities
getVcInformation api/getVcInformation
getVcLocations api/getVcLocations
getVcLocationsHierarchy api/getVcLocationsHierarchy
getVcOnlineBookingFields api/getVcOnlineBookingFields
getVcOperatorCategories api/getVcOperatorCategories
getVcOperatorIds api/getVcOperatorIds
getVcSiteContent api/getVcSiteContent
getVcTripInfo api/getVcTripInfo
Whats On getWhatsOnEvents api/getWhatsOnEvents