HsWebApi

Documented ApiError Codes

Code: Name: Description:
IncorrectSqlExecution An error has occured during the execution of a sql statement against a database
RetrievalError There was an error retrieving the data
NoDataRetrived The sql statement which was meant to get back some data did not get back data. This does not mean the sql was incorrect, passed parameters might have no data associated with it
IncorrectSqlSyntax The sql that was executed against the server was incorrect. If you are not a Star Marina Solutions developer and you see this please contact Star Marina Solutions.
ConnectionToDatabaseFailed The database connection failed, check to see if the database server is running
NotImplemented Not built yet in the api, intended for Star Marina Solutions developers. If you see this error and you are not a Star Marina Solutions developer please contact Star Marina Solutions
NoRenewalContractForSuppliedAccountCode There is no renwal contract for the supplied account code. If a customer gets this and believes this is incorrect they must contact a member or staff to check if their account code is correct on their login account
NoDataSentInBody There was no data found in the body of the request. Please ensure there is data
ContractAlreadyHasPaymentRegistered The contract the customer wishes to pay for already has a payment registered. They should contract support of they believe this to be incorrect
CastException Something has gone wrong in the SQL retrival stage of the API. Please contact Star
InvalidBoatDetails Provided boat dimension are not valid i.e set to 0 or lessr
IncorrectDates Provided dates are not valid i.e. dates overlapping
VacancyOverlaps Provided vacancy details overlaps with existing vacancies
BookingOverlaps Provided booking details overlaps with existing bookings
IncorrectDatesFormat Provided dates format is not valid
IncorrectMarina Marina code provided does not exist.
CannotPayBookingWithoutBoat Cannot mark booking as paid if no boat number is provided
InvalidBerth Provided berth does not exist in specified marina
IncorrectAccountCode Provided Account code does not exist
BoatDoesNotExists Boat provided does not exists
CommsTypeNotExists Comms type procided does not exists
InvalidContact Contact details provided does not exist in the system
InvalidKeyAuthorisation Key provides does not exists in system
IncorrectDetails Details provided either do not exists or are incorrect
NoTransactionCreated No transaction was created by the calling procedure
BoatInMarina The boat is currently in at this marina, which this operation doesn't allow
ExampleApiError Example Api Error which is always thrown by the Api called api/about/getError
ExceptionError Catched general exception