HavenStar WebApi Documentation

Introduction

Apis do stuff, check them out to see what they do and what you need to do to make them do do.

Bookings

Bookings Controller

API	Description
POST api/bookings/bookings	bookings and NewBooking are identical end points, However when implementing please use newBooking end point
POST api/bookings/newBooking	bookings and NewBooking are identical end points, However when implementing please use newBooking end point
POST api/bookings/FastArrival	creates new Fast Arrival record
POST api/bookings/BerthsAvailable	Returns berth availability matching specified parameters
POST api/bookings/CancelBooking	Cancel a booking
POST api/bookings/AmendBooking	Amend the start date of a booking
POST api/bookings/BookingEnquiry	Returns berth availability matching specified parameters
POST api/bookings/PayBooking	Records payment for a booking and creates the invoice
POST api/bookings/BerthsAvailableByBerthType	Lists berths available for the given date period and marina. Only returns berths available for the exact period requested. Returns berths grouped by berth type.
POST api/bookings/CreatePendingBooking	Creates a pending booking

API

Generic API controller

API	Description
POST api/BoatRenewalDetails	Queries the database for the Boat Renewal Details based on the account code supplied and returns them
POST api/Renewals	Queries the database for the Boat Renewal Details and the Customer Details based on the account code supplied and returns them
POST api/Payment	Records a payment for a renewal contract. Verifies that the given contract ID is for a renewal tied to any of the customer's boats (the account code can be for any boat the customer owns, master or sub account), and then records the payment against the master account code.
POST api/NewContract	Creates a new future/renewal contract with the given information.
POST api/ConfirmRenewal	Marks the given renewal contract as confirmed but not paid.
POST api/NewBoat	Returns newly added boat number
POST api/NewCustomer	Returns newly added customer code
POST api/VacancyNotification	Returns id of newly added vacancy
POST api/Search	Performs a limited search on the database - searches boat names, customer names (surnames) and berth numbers
POST api/AddNote	Adds a note to the specified customer, boat or berth
POST api/AccountInfo	Retrieves login info for a specified loginName

Vouchers

Vouchers Controller

API	Description
POST api/Vouchers/CustomerVouchers	Returns a list of vouchers for specified customer
POST api/Vouchers/RedeemVoucher	Redeem amount of voucher
POST api/Vouchers/AccountTenure	Get tenure details for account
POST api/Vouchers/SetAccountTenure	Set tenure details for account
POST api/Vouchers/BoatYardCampaigns	Returns a list of vouchers for specified customer

Info

Info Controller

API	Description
POST api/info/CountryList	Gets all countries and their code
POST api/info/BoatManufacturersList	Gets all boat manufacturers
POST api/info/BoatModelList	Gets all boat models
POST api/info/BoatTypesList	Gets all boat types
POST api/info/CommsTypesList	Gets all CommsTypes
POST api/info/UserRelationshipList	Gets all user relationships
POST api/info/DocumentRecordTypes	Gets all Document Record Types
POST api/info/DocumentTypes	Gets all Document Record Types
POST api/info/Marinas	Gets all marinas - re - route to api/sync/MarinaList
POST api/info/UsageTypes	Gets all Usage types
POST api/info/WLMarinaSpaces	Gets all waiting list marina spaces
POST api/info/WLDockSpaceLengths	Gets all waiting list Dock Space lengths
POST api/info/WLApplicationTypes	Gets all waiting list Application types
POST api/info/CreditCardTypes	Gets all credit card types
POST api/info/ContactTypes	Gets all contact types
POST api/info/CustomerTypes	Gets available customer types
POST api/info/PaymentTypes	Gets available payment types
POST api/info/CustTypes	Gets available customer types
POST api/info/UseTypes	Gets available use types

Boatyard

Endpoints related to the Boatyard and works orders.

API	Description
POST api/boatyard/FuelFillingTime	Returns the fuel filling time for the given boat or fuel capacity.
POST api/boatyard/Services	Returns a list of boatyard services.
POST api/boatyard/ServiceAvailability	Returns a list of boatyard timeslots for a given service.
POST api/boatyard/NewBooking	Creates a new works order and associated resource bookings. Sends an email to the marina and customer, and an SMS to the customer, if they have an InternalUse value set for them.
POST api/boatyard/Bookings	Returns a list of boatyard works orders matching the supplied parameters
POST api/boatyard/StartWorksOrderItem	Marks a works order job as started
POST api/boatyard/CompleteWorksOrderItem	Marks a works order job as completed and sets the completed time
POST api/boatyard/PayForBooking	Invoices a works order and records payment
POST api/boatyard/AssignPoint	Assigns the boat to the specified point
POST api/boatyard/WorksOrderItemsSync	Returns data on jobs starting in the specified time period and modified since the date provided
POST api/boatyard/MoveWorksOrderItem	Moves a works order item to the specified date/time
POST api/boatyard/SpacesAvailable	Lists berths available for the given date period and marina. Only returns berths available for the exact period requested.
POST api/boatyard/CreatePendingWorksOrder	Creates a pending works order
POST api/boatyard/CancelBooking	Cancels an existing works order
POST api/boatyard/AmendBooking	Amends an existing works order

About

About Controller, has api calls for things relating specifically to the HavenStar WebApi

API	Description
GET api/about/versionInfo	Returns the current version of the HavenStar Web Api
GET api/about/getError	Returns and example error that the API could potentially return

WaitingList

Waiting List Controller

API	Description
POST api/WaitingList/CustomerWaitingListEntries	Returns waiting list application entries for specified application
POST api/WaitingList/WaitingListApplicationFee	Returns waiting list application fee
POST api/WaitingList/WaitingListCreateApplication	Creates boat/customer/contacts/invoices required for waiting list application

FileHandler

File Handler Controller

API	Description
POST api/fileHandler/Uploadpicture	Please note... file upload via website not currently implemented - please use postman for testing this call
POST api/fileHandler/UploadContractDocuments	Please note... file upload via website not currently implemented - please use postman for testing this call
POST api/fileHandler/RetrieveBoatPicture	Please note... file download via website not currently implemented - please use postman for testing this call
POST api/fileHandler/RetrieveCustomerDocument	Please note... file download via website not currently implemented - please use postman for testing this call
POST api/fileHandler/RetrieveCustomerDocuments	Please note... file download via website not currently implemented - please use postman for testing this call
POST api/fileHandler/UploadDocuments	Uploads a document and stores against the customer record Please note... file upload via website not currently implemented - please use postman for testing this call

Portal

Endpoints related to Web Portal-specific functionality, such as configuration information. The Web Portal also uses various endpoints in other controllers.

API	Description
POST api/portal/GetStaticConfiguration	Returns (relatively) static, cacheable configuration information.

Sync

Sync Controller

API	Description
POST api/sync/MarinaList	Gets all marinas list
POST api/sync/MarinaConfiguration	Gets general configuration settings for a given marina.
POST api/sync/BerthList	Gets berth list from all marinas
POST api/sync/BerthHolderList	Gets Berth holders vacancy list
POST api/sync/ContractList	Returns list of contracts from database
POST api/sync/CustomerList	Returns list of customer boats
POST api/sync/BookingsList	Returns list of bookings
POST api/sync/ActiveBoatsList	Returns Customer/boat details for active customers
POST api/sync/Notes	Returns notes that have been created/amended after a given date.
POST api/sync/BoatYardJobs	Returns boatyard works orders that have been created/amended after a given date.
POST api/sync/BoatYardPackages	Returns boatyard packages that have been created/amended after a given date.
POST api/sync/Visits	Returns visit records.
POST api/sync/CustomerPreferences	Returns customer preference records
POST api/sync/Vouchers	Returns voucher records
POST api/sync/Transactions	Returns transactions
POST api/sync/Allocations	Returns allocations
POST api/sync/DeferredIncomeJournals	Returns a list of deferred income journals created on or after the date supplied
POST api/sync/Items	Returns a list of service/stock items created/modified on or after the date supplied
POST api/sync/VacancyNotifications	Returns a list of vacancy notifications created/modified on or after the date supplied
POST api/sync/VisitingBoatsWithoutBooking	Returns list of visiting boats currently in without a booking
POST api/sync/HistoricDebtRestrictions	Returns a list of accounts and current showHistoricDebtWarning flag updated since syncDateTime

ServicePoints

Service Points Controller

API	Description
POST api/ServicePoints/ListServicePoints	Returns a list of service points
POST api/ServicePoints/UpdateServiceReadings	Updates latest readings for listed service points
POST api/ServicePoints/BerthServicePoints	Lists service points linked to supplied berth number

Sales

Sales Controller

API	Description
POST api/sales/ElectricTopUp	TopUp electricity balance for specified account
POST api/sales/NonContractPayment	Sends payment the payment information into the database
POST api/sales/FuelPrices	No documentation available.
POST api/sales/NonMooringPriceList	Returns pricing information for specified details (not charging rates)
POST api/sales/ProductsAvailableOnline	Returns pricing information for products available to be purchase online
POST api/sales/WebBasket	Sends payment the payment information into the database

Keys

Keys Controller

API	Description
POST api/keys/AuthorisationList	Gets list of authorised users
POST api/keys/AddAuthorisation	Adds Authorisation to key
POST api/keys/UpdateAuthorisation	Updates Authorisation
POST api/keys/RemoveAuthorisation	Removes Authorisation
POST api/keys/CurrentStatus	Gets current status of key

MusterCheck

Muster Check Controller

API	Description
POST api/MusterCheck/CurrentCheckLists	Returns a list of incomplete check lists for the current day
POST api/MusterCheck/CheckList	Returns details for specified muster check
POST api/MusterCheck/CheckListEntry	Returns details for specified muster check entry
POST api/MusterCheck/NewCheckList	Returns details for specified muster check
POST api/MusterCheck/ConfirmCheckListBerths	Updates a set of check list entries
POST api/MusterCheck/CompleteMusterCheck	Marks speficied muster check as completed

MeterMACSGen2

MeterMACSGen2 Controller

API	Description
POST api/MeterMACSGen2/TurnPointOn	Turns specified point on at given marina
POST api/MeterMACSGen2/TurnBoatPointsOn	Turns specified point on at given marina
POST api/MeterMACSGen2/TurnPointOff	Turns specified point off at given marina
POST api/MeterMACSGen2/GetAlertInfo	Returns information alerts for given customer
POST api/MeterMACSGen2/SetAlertInfo	Sets alert information for given customer
POST api/MeterMACSGen2/AccountInfo	Returns information alerts for given customer
POST api/MeterMACSGen2/TopUp	TopUp electricity balance for specified account
POST api/MeterMACSGen2/SocketInfo	Returns socket info for specified point

Customer

Customer Controller

API	Description
POST api/customer/CustomerDetails	Returns the details for a single customer from their account code (either master or subaccount).
POST api/customer/CustomerDetailsV2	Returns the details for a single customer from their account code (either master or subaccount).
POST api/customer/UpdateCustomer	Updates Customer
POST api/customer/UpdateBoat	Updates Boat
POST api/customer/SetBoatInsuranceDetails	Updates Boat Insurance Details
POST api/customer/UpdateComms	Updates comms details
POST api/customer/FindAccountByEmail	Returns account codes
POST api/customer/UnsubscribeEmail	Unsubcribes marketing preferences for specified email
POST api/customer/CustomerContractDocuments	Returns Customer Contract Documents
POST api/customer/CustomerCreditCards	Returns Customer Contract Documents
POST api/customer/NewTokenisedCard	Creates a new credit card record.
POST api/customer/UpdateTokenisedCard	Updates an existing credit card record.
POST api/customer/DeleteTokenisedCard	Deletes an existing credit card record.
POST api/customer/CommsList	Returns Comms List
POST api/customer/FindAccountByName	Returns account codes
POST api/customer/CustomerContracts	Returns Customer Contracts
POST api/customer/Contracts	Returns contract information
POST api/customer/CustomerTransactions	Returns Customer transactions
POST api/customer/CustomerTransactionDetails	Returns Customer Invoice Lines
POST api/customer/CustomerBookings	Returns current / future customer bookings across all marinas
POST api/customer/Notes	Returns notes linked to specified customer account code
POST api/customer/ArriveBoat	Arrives boat into marina
POST api/customer/DepartBoat	Departs boat from marina
POST api/customer/MoveBoat	Moves boat within marina
POST api/customer/FinanceSummary	Gets finance summary for boat
POST api/customer/GenerateMooringInvoice	Generates mooring invoice for boat
POST api/customer/TurnOnMeterMACSPoint	Adds a request to Meter-MACS queue for given marina to turn on the point attached to the specified boat
POST api/customer/CustomerTransactionAllocations	Returns Customer transaction allocations
POST api/customer/UpdateMarketingPreferences	Updates the marketing preferences for the given contact or account
POST api/customer/ContractRenewalOptions	Returns contract renewal options for the given boat
POST api/customer/CustomerRenewals	Returns contract renewal list for the given account
POST api/customer/ActiveVisitingBoatsList	Returns list of visitors currently in the marina or arriving yesterday, today or tomorrow
POST api/customer/VisitingBoatDetails	Returns details of the visiting boat
POST api/customer/ChargingRatePriceList	Returns pricing information for specified details
POST api/customer/ValidateBankDetails	Validates supplied bank account details with VSeries
POST api/customer/NewDirectDebit	Creates a new direct debit within Havenstar, if VSeries is enabled, validation checks are also run
POST api/customer/ContractInstalmentSchedule	Returns contract instalment information
POST api/customer/TurnOffMeterMACSPoint	Adds a request to Meter-MACS queue for given marina to turn off the point attached to the specified boat
POST api/customer/VacancyNotifications	Returns a list of dates where the customer has notified they will be away from the marina
POST api/customer/RemoveVacancyNotification	Removes a customer notified vacancy notification at the specified marina
POST api/customer/BoatLocations	Returns a list of boats, their home berth information, and their current visit information.
POST api/customer/UpdateResidentDueBackDate	No documentation available.

Benefits

Benefits Controller

API	Description
POST api/Benefits/AssignBenefit	Returns a list of benefits for specified customer
POST api/Benefits/BenefitPackages	Returns benefit packages
POST api/Benefits/AddBenefitPackage	Adds benefit package to specified account
GET api/Benefits/BenefitPackagesAssigned?BenefitId={BenefitId}&BenefitPackageId={BenefitPackageId}&BoatNo={BoatNo}&AccountCode={AccountCode}&FreeNightsAssigned={FreeNightsAssigned}&FreeNightsRemaining={FreeNightsRemaining}&Description={Description}&Ended={Ended}	Adds benefit package to specified account