Bookings
Handles all of the booking calls.
| API | Description |
|---|---|
| GET api/Bookings/ReserveSpace/{VisitDate}/{Spaces}/{ReservationID}/{ResourceID} |
Allows a number of spaces to be reserved for a resource on a particular visit date under a unique reservation ID. This should be used to allow space to be reserved while completing the booking process. With the reservationID being passed to the final booking save. |
| GET api/Bookings/CancelReservedSpace/{VisitDate}/{Spaces}/{ReservationID}/{ResourceID} |
Allows a previously made reservation to be cancelled to open up the reserved space. This only works for reserved space that has not been assigned to a completed booking. |
| GET api/Bookings/GetCategories/{Category} |
Allows the client to request a list of all booking categories that can be assigned against a booking. |
| GET api/Bookings/GetSources/{Source} |
Allows the client to request a list of all booking soruces that can be assigned against a booking. |
| GET api/Bookings/GetStatuses/{Status} |
Allows the client to request a list of all booking statuses that can be assigned against a booking. |
| GET api/Bookings/GetBookingSaleDetails/{SaleID}/{BookingID} |
Allows a client to retrieve the sale details of a booking, either using the Sale ID or the Booking ID. |
| GET api/Bookings/GetCancelledBookings/{StartDate}/{EndDate} |
Allows a client to request a list of cancelled bookings between a start and end date range. |
| GET api/Bookings/GetRedeemedBookings/{StartDate}/{EndDate}/{ResourceView} |
Allows a client to request a list of redeemed bookings between a start and end date range and within a specific resource view. |
| GET api/Bookings/GetBookingAmendments/{StartDate}/{EndDate} |
Allows a client to request a list of amendments that have happened to bookings within a start and end date range. |
| GET api/Bookings/VerifyReference/{Reference}/{ConfirmAttendees} |
Allows a client to request a ticket/booking reference to be validated. |
| GET api/Bookings/ChargeOutstandingCosts/{BookingID}/{OutstandingAmount} |
Allows an outstanding amount against a booking to be charged, if a card token is valid and stored for the booking. |
| GET api/Bookings/GetCancellationReasons |
Allows a client to request a list of valid reasons within the system why a booking would be cancelled. |
| GET api/Bookings/CancelBooking/{BookingID}/{CancelledReason} |
Allows a client to request that a booking is cancelled for a specific reason. |
| GET api/Bookings/GetBookingHistory/{PersonID}/{StartDate}/{EndDate}/{AccountCode}/{Source}/{Status} |
Allows a client to request a hist of a customers bookings based on a person ID or account code. Allows filtering based on a date range, booking source and booking status. |
| PUT api/Bookings/SaveBooking/{LinkBookings}/{PaymentOption}/{PaymentMethod}/{IsDeposit} |
Allows a list of booking objects to be passed and the API will attempt to save each booking. |
| PUT api/Bookings/AmendBooking/{LinkBookings}/{PaymentOption}/{PaymentMethod}/{IsDeposit} |
Allows a list of booking amendments to be passed and the API will attempt to make the amendments to the booking |
| PUT api/Bookings/AddBookingCost/{ChargeToken}/{BookingID} |
Allows a client to add new costs to an existing booking and charge a stored card token if one exists. |
StockMovement
This handles all of the stock movement calls
| API | Description |
|---|---|
| GET api/StockMovement/TransferStock/{movementBatchID}/{transferDate}/{frombranch}/{tobranch}/{code}/{amount} |
This will transfer the stock using the passed parameters |
StockCountBatch
Handles all of the StockCountBatch calls
| API | Description |
|---|---|
| GET api/StockCount/GetStockCountBatch |
This will return a full list of StockCountBranchs, containing only the ID, description, Created on date, created by and notes connected. |
Vouchers
Handles all of the voucher resource calls
| API | Description |
|---|---|
| GET api/Vouchers/LoadVouchers/{voucherCode}/{startDate}/{endDate} |
Returns a list of valid vouchers based on a date range |
| PUT api/Vouchers/CheckVoucher/{voucherCode}/{visitDate} |
Allows a voucher to be checked against a list of products, to check if a discount can be applied to the price of the products. |
| PUT api/Vouchers/CreateVoucher |
Allows a voucher to be updated or created by passing an APIVoucher within the body, containing the valid details to create or update. |
TaskHelper
Confirm Configuration Tasks have been completed.
| API | Description |
|---|---|
| GET api/TaskHelper/TaskList |
Gets a list of Tasks (Admin Only) |
| GET api/TaskHelper/Task/{taskid} |
Runs Tasks by ID (Admin Only) |
Users
Handles all of the User calls
| API | Description |
|---|---|
| GET api/StockUsers/EPOSUsersList |
This will return a full list of active EPOS users within the system as a datatable. |
Resources
Handles all of the booking resource calls
| API | Description |
|---|---|
| GET api/Resources/ResourceList/{resourceID} |
Gets a resource based on the resourceID passed or a list of resources if the resourceID is 0. |
| GET api/Resources/ResourceListByDate/{resourceID}/{startDate}/{endDate}/{showProductMap} |
Gets a list of resources based on a date range and can also return a specific resource if the resource ID is passed. |
| GET api/Resources/ResourceListByViewName/{viewName} |
Gets a list of resource based on a resource view name passed as a parameter. |
| GET api/Resources/ResourceListByViewByDate/{viewName}/{startDate}/{endDate}/{showProductMap} |
Gets a list of resource based on a resource view name passed and also the start and end dates passed for availability. |
| GET api/Resources/ResourceListByViewByDateByPerson/{viewName}/{startDate}/{endDate}/{personID}/{showProductMap} |
Gets a list of resource based on a resource view name passed and also the start and end dates passed for availability and takes in person ID for custom product discounts. |
| GET api/Resources/ResourceListByViewByDateByVisitors/{viewName}/{startDate}/{endDate}/{showProductMap}/{visitors} |
Gets a list of resource based on a resource view name passed and also the start and end dates passed for availability and a number of visitors. |
| PUT api/Resources/SaveResource |
Allows a resource to be update or created by passing an APIResource within the body. |
Products
Handles all of the product calls
| API | Description |
|---|---|
| GET api/Products/ProductListByMapID/{productMapID}/{visitDate}/{personID}/{accountCode} |
Gets a list of products associated with the given Product Map ID |
| GET api/Products/ProductListByMapName/{productMapName}/{visitDate}/{personID}/{accountCode} |
Gets a list of products associated with the given Product Map name. |
| GET api/Products/ProductListByProductCode/{productCode}/{visitDate}/{personID}/{accountCode} |
Returns any product with the given product PLU. |
| GET api/Products/ProductListByGroup/{productGroup}/{visitDate}/{personID}/{accountCode} |
Returns any products associated with the given Product Group name. |
| GET api/Products/ProductListByCategory/{productCategory}/{visitDate}/{personID}/{accountCode} |
Gets a product list associated with the given Product Category name. |
| GET api/Products/ProductListByDescription/{productDescription}/{visitDate}/{personID}/{accountCode} |
Returns a list of products that have the given Product Description. |
| GET api/Products/ProductListAll/{visitDate}/{personID}/{accountCode} |
Returns a list of all available Products. |
| GET api/Products/ProductMaps/{productMapID} |
Returns all Product Maps or the Product Map with the given ID. |
| GET api/Products/TillProductList/{tillNo} |
This will return a full list of product currently in use at a specific till's location. |
| PUT api/Products/SaveProduct |
Update an existing Product based on the PLU or creates a new Product if not found. |
| PUT api/Products/SaveProductMap |
Update an existing Product Map if the ID passed exists or create a new product map. |
Change
| API | Description |
|---|---|
| GET api/Changes/resourceName/{queueID} |
Gets the resource name from the passed in resource ID |
| GET api/Changes/GetChanges/{queueID}?top={top} |
Gets the messages from the passed in queueID |
| POST api/Changes/ReceiveChanges/{queueID}/{messageID} |
Handles a received message for a specific queue and message ID |
| GET api/Changes/GetQueues/{inbound} |
Gets the list of queues for a certain direction, specified by the inbound parameter. |
| GET api/Changes/HandleAck/{queueID}/{messageID} |
Allows the API to handle acknowledgement of a confirmation of a datahub message. |
| POST api/Changes/HandleRejection/{queueID}/{messageID} |
Allows the API to handle the rejection of a datahub message. |
Customer
Customer
| API | Description |
|---|---|
| GET api/Customer/LoadCustomer/{Email}/{PostCode}/{LastName}/{ID}/{Password}/{MemberNumber}/{UserName}/{CheckExists}/{SerialNumber} |
Loads a customer based on a number of parameters. If a parameter is not none it can be left blank or as 0 for numbers |
| PUT api/Customer/LoadCustomerFromBody |
Loads a customer based on an object with parameters passed in the body of the request. If a parameter is not none it can be left blank or as 0 for numbers |
| GET api/Customer/LoadInterests/{id} |
Loads a list of interests. An optional parameter can be passed in which will bring only the interest relateing to the ID |
| GET api/Customer/GetContactInterests/{customerID} |
Loads a list of interests associated to the customer id passed in |
| GET api/Customer/ChangePassword/{id}/{oldPassword}/{newPassword}/{tempPassword} |
Allows a customer's password to be changed, by providing the Customer ID, Old Password, New Password and an Optional Boolean which when set to true will set new password as temporary |
| PUT api/Customer/SaveCustomer |
Allows a customer to be updated or created by passing an APICustomer within the body. Pass in an ID of 0 to create a new customer |
| PUT api/Customer/SetContactInterests/{customerID} |
Allows a list of customer interests to be created or updated against the customer's record. |
| PUT api/Customer/RemoveContactInterests/{customerID} |
Allows a list of customer interests to be removed from a customer's record. |
Membership
Handles all of the Membership calls
| API | Description |
|---|---|
| GET api/Membership/LoadCustomerMemberships/{membershipNumber}/{Email}/{customerID} |
Loads a list of memberships currently active for a customer. |
| GET api/Membership/LoadMembershipTypes |
Loads a full list of membership types that can be purchased. |
| GET api/Membership/ModifiedMembers/{startDate}/{endDate} |
Loads a list of all member modifications within a date range. |
| PUT api/Membership/CancelMembership/{membershipNumber}/{membershipType}/{personRef} |
Allows a membership to be cancelled for a customer. |
| PUT api/Membership/MembershipPurchase/{memberNumber}/{giftAid}/{handleRenewals}/{paymentMethod}/{membershipStartDate} |
Allows a membership to be purchased or renewed for a customer. |
ResourceView
Handles all of the resource view calls
| API | Description |
|---|---|
| GET api/ResourceViews/ViewList/{resourceID} |
Gets a resource view based on the resourceID passed or a list of resource views if the resourceID is 0. |
| PUT api/ResourceViews/SaveView |
Allows a resource view object to be passed in the body, along with a second resource list object, if the view is valid it will be created/updated depending on if the ID passed within it exists in the database |
Questionnaire
Handles all of the questionnaire calls
| API | Description |
|---|---|
| GET api/Questionnaire/LoadQuestionnaireByID/{questionnaireID} |
Gets the full questionnaire details based on the ID, this will return the name, description and list of questions for the Questionnaire. |
| PUT api/Questionnaire/SaveQuestionnaireForBooking/{bookingID} |
Save a set of questionnaire results against a booking. |
Events
Handles all of the events calls.
| API | Description |
|---|---|
| GET api/Events/EventsList/{viewID}/{startDate}/{endDate}/{showDates} |
Gets a list of event details within a date range which are assigned to a resource view, it can also show a list of available dates for the event. |
| GET api/Events/EventDatesByID/{eventID}/{startDate}/{endDate}/{showProducts} |
Gets a list of events within a date range, can select a single event by ID, it can also show the event products if specified. |
| GET api/Events/EventDatesByViewName/{viewName}/{startDate}/{endDate}/{showProducts} |
Gets a list of events within a date range, can be filtered by a view name for a group of events, it can also show the event products if specified. |
| GET api/Events/WebEvents/{startDate}/{endDate}/{getEmailTemplate}/{getDependencies}/{loadImages}/{personID} |
Gets a list of what's on items to display what up coming events are set-up for the site. |
| PUT api/Events/SaveEvent |
Allows an event to be update or created by passing an APIEvent within the body. |
Branch
Handles all of the branch calls
| API | Description |
|---|---|
| GET api/Branch/GetBranchList |
This will return a full list of branches, containing only the ID, Code and Name of the branch |
MailOrder
Handles all of the mail order calls.
| API | Description |
|---|---|
| PUT api/MailOrders/CreateMailOrder/{PaymentMethod} |
This allows a list of mail orders to be created in the system by passing the details in the objects within the body of the request. |