Namespace: Resto.Front.Api.V3
Assembly: Resto.Front.Api.V3 (in Resto.Front.Api.V3.dll) Version: 4.1.1236.1 (4.1.1236.1)
Syntax
C#
public interface IOperationService
The IOperationService type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | AddErrorMessage |
Shows non-modal error message in the left top corner of the screen.
|
| AddNotificationMessage(String) |
Shows non-modal notification message in the left top corner of the screen.
|
| AddNotificationMessage(String, NullableTimeSpan) |
Shows non-modal notification message in the left top corner of the screen.
|
| AddWarningMessage(String) |
Shows non-modal warning message in the left top corner of the screen.
|
| AddWarningMessage(String, NullableTimeSpan) |
Shows non-modal warning message in the left top corner of the screen.
|
| AuthenticateByPin | |
| BillOrder |
Changes the order to Bill status and returns text of bill cheque.
|
| CancelNewDelivery |
Cancels new delivery.
|
| CancelReserve |
Cancels reservation due to some reason
|
| CheckCanEditOrder |
If current user has permissions to view order.
|
| CheckProductsSellingRestrictions |
If current user can add these products with such amounts.
|
| CreateEditSession |
Creates an edit session. All changes made with this session will be accumulated without affecting entities. Use SubmitChanges(ICredentials, IEditSession) method to apply all changes or do nothing to discard them.
|
| DeleteOrder |
Deletes order. Order must have no printed items. User must have rights to edit orders.
|
| GetActiveProducts | |
| GetActiveRemovalTypes |
Gets removal types which are allowed to use.
|
| GetActiveStreets |
Gets active streets.
|
| GetAllProducts |
Gets all products (both active and inactive).
|
| GetAllRemovalTypes |
Gets all removal types (both active and inactive).
|
| GetAllStreets |
Gets all streets (both active and inactive).
|
| GetAssignedModifierByOrderItemProduct |
Returns assignedModifier by id from the specified orderItemProduct.
|
| GetAssignedModifiersByOrderItemProduct |
Returns assignedModifiers of the specified orderItemProduct.
|
| GetChildGroupsByProductGroup |
Returns childGroups of the specified productGroup.
|
| GetChildProductsByProductGroup |
Returns childProducts of the specified productGroup.
|
| GetCityById |
Returns city by id.
|
| GetClientById |
Returns client by id.
|
| GetClients | |
| GetConceptionById |
Returns conception by id.
|
| GetConceptions | |
| GetDeletedOrderTypes | |
| GetDeliveries | |
| GetDeliveryById |
Returns delivery by id.
|
| GetDeliveryCancelCauseById |
Returns deliveryCancelCause by id.
|
| GetDeliveryCancelCauses | |
| GetDeliveryOrderById |
Returns deliveryOrder by id.
|
| GetDeliveryOrders | |
| GetDeliverySection |
Returns section of current group where delivery orders are created. Is determined by default table of group.
|
| GetDiscountCardById |
Returns discountCard by id.
|
| GetDiscountCards | |
| GetDiscountTypeById |
Returns discountType by id.
|
| GetDiscountTypes | |
| GetGroupModifiersByProduct |
Returns groupModifiers of the specified product.
|
| GetGuestByOrder |
Returns guest by id from the specified order.
|
| GetGuestsByOrder |
Returns guests of the specified order.
|
| GetHierarchicalMenu | |
| GetHostDeliverySettings |
Returns delivery settings of restaurant
|
| GetHostRestaurant | |
| GetHostTerminalCultureInfo | |
| GetHostTerminalPointsOfSale |
Returns list of points of sale attached to current terminal. Empty list means that current terminal is not cash terminal.
|
| GetHostTerminalsGroup | |
| GetInactiveProducts | Obsolete. |
| GetIncludedInMenuSectionsByProduct |
Returns includedInMenuSections of the specified product.
|
| GetKitchenOrderById |
Returns kitchenOrder by id.
|
| GetKitchenOrders | |
| GetMarketingSourceById |
Returns marketingSource by id.
|
| GetMarketingSources | |
| GetOrderById | |
| GetOrders | |
| GetOrderTypeById |
Returns orderType by id.
|
| GetOrderTypes | |
| GetParentByProduct |
Returns parent of the specified product.
|
| GetParentByProductGroup |
Returns parent of the specified productGroup.
|
| GetPaymentByOrder |
Returns payment by id from the specified order.
|
| GetPaymentsByOrder |
Returns payments of the specified order.
|
| GetPaymentTypeById |
Returns paymentType by id.
|
| GetPaymentTypes | |
| GetPaymentTypesToPayOutOnUser |
Returns payment types that can be proccessed “silently”, without user interface.
|
| GetProductById |
Returns product by id.
|
| GetProductByOrder |
Returns product by id from the specified order.
|
| GetProductCategories | |
| GetProductCategoryById |
Returns productCategory by id.
|
| GetProductGroupById |
Returns productGroup by id.
|
| GetProductGroups | |
| GetProducts | Obsolete. |
| GetProductsByOrder |
Returns products of the specified order.
|
| GetProductsRemainingAmounts |
Gets remaining amounts of products in stop list.
|
| GetQuickMenu |
Returns quick menu for specified restaurant section and day.
|
| GetRegionById |
Returns region by id.
|
| GetRegions | |
| GetRemovalTypeById |
Returns removalType by id.
|
| GetReserveById |
Returns reserve by id.
|
| GetReserves | |
| GetRestaurantSections | |
| GetSimpleModifiersByProduct |
Returns simpleModifiers of the specified product.
|
| GetSplitDeliveries |
Gets all deliveries that are related with argument through splitting between cash registers. Delivery itself is also returned. If delivery was not split, returns delivery passed as argument.
|
| GetStreetById |
Returns street by id.
|
| GetTableById |
Returns table by id.
|
| GetTables | |
| GetUpdatedDeliveries | |
| GetUpdatedDeliveriesByOrder | |
| GetUser |
Get user corresponding to specified credentials.
|
| GetUserById |
Returns user by id.
|
| GetUsers | |
| IsActiveForDeliveries | |
| IsDeliveryActive |
Returns whether delivery is active.
|
| IsDeliveryConfirmationActive |
Returns whether delivery confirmation is active.
|
| IsProductSellingRestricted |
Checks remaining amount of the product and determines whether selling of that product is restricted.
|
| PrintBanquet |
Prints preliminary document with estimated event date and time, planned menu, guests count, client contacts, prepay info, etc.
|
| PrintBillCheque | |
| PrintOrderItemProducts |
Prints service cheque for defined order item products.
|
| PrintTableReservedCheque |
Prints short “Table reserved” document with estimated event date and time, guests count and client contacts. Can be used to place onto reserved table as a hint not to occupy it.
|
| StartCourseCooking |
Starts cooking for all order item products of the specified course.
|
| StartProductsCooking |
Starts cooking for the specified order item products.
|
| SubmitChanges |
Applies all changes made with specified edit session.
|
| TryGetAssignedModifierByOrderItemProduct |
Returns assignedModifier by id from the specified orderItemProduct or null if orderItemProduct doesn't exist or doesn't contain assignedModifier with that id.
|
| TryGetAssignedModifiersByOrderItemProduct |
Returns assignedModifiers of the specified orderItemProduct or null if orderItemProduct doesn't exist.
|
| TryGetChildGroupsByProductGroup |
Returns childGroups of the specified productGroup or null if productGroup doesn't exist.
|
| TryGetChildProductsByProductGroup |
Returns childProducts of the specified productGroup or null if productGroup doesn't exist.
|
| TryGetCityById |
Returns city by id or null if city with specified id doesn't exist.
|
| TryGetClientById |
Returns client by id or null if client with specified id doesn't exist.
|
| TryGetConceptionById |
Returns conception by id or null if conception with specified id doesn't exist.
|
| TryGetDeliveryById |
Returns delivery by id or null if delivery with specified id doesn't exist.
|
| TryGetDeliveryByOrderId |
Returns delivery by delivery order id, null if order doesn't exist.
|
| TryGetDeliveryCancelCauseById |
Returns deliveryCancelCause by id or null if deliveryCancelCause with specified id doesn't exist.
|
| TryGetDeliveryOrderById |
Returns deliveryOrder by id or null if deliveryOrder with specified id doesn't exist.
|
| TryGetDiscountCardById |
Returns discountCard by id or null if discountCard with specified id doesn't exist.
|
| TryGetDiscountTypeById |
Returns discountType by id or null if discountType with specified id doesn't exist.
|
| TryGetGroupModifiersByProduct |
Returns groupModifiers of the specified product or null if product doesn't exist.
|
| TryGetGuestByOrder |
Returns guest by id from the specified order or null if order doesn't exist or doesn't contain guest with that id.
|
| TryGetGuestsByOrder |
Returns guests of the specified order or null if order doesn't exist.
|
| TryGetIncludedInMenuSectionsByProduct |
Returns includedInMenuSections of the specified product or null if product doesn't exist.
|
| TryGetKitchenOrderById |
Returns kitchenOrder by id or null if kitchenOrder with specified id doesn't exist.
|
| TryGetMarketingSourceById |
Returns marketingSource by id or null if marketingSource with specified id doesn't exist.
|
| TryGetOrderById | |
| TryGetOrderTypeById |
Returns orderType by id or null if orderType with specified id doesn't exist.
|
| TryGetParentByProduct |
Returns parent of the specified product or null if product doesn't exist.
|
| TryGetParentByProductGroup |
Returns parent of the specified productGroup or null if productGroup doesn't exist.
|
| TryGetPaymentByOrder |
Returns payment by id from the specified order or null if order doesn't exist or doesn't contain payment with that id.
|
| TryGetPaymentsByOrder |
Returns payments of the specified order or null if order doesn't exist.
|
| TryGetPaymentTypeById |
Returns paymentType by id or null if paymentType with specified id doesn't exist.
|
| TryGetPriceForCategory |
Returns price for the product according to the given client price category, or null if product doesn't exists.
|
| TryGetProductById |
Returns product by id or null if product with specified id doesn't exist.
|
| TryGetProductByOrder |
Returns product by id from the specified order or null if order doesn't exist or doesn't contain product with that id.
|
| TryGetProductCategoryById |
Returns productCategory by id or null if productCategory with specified id doesn't exist.
|
| TryGetProductGroupById |
Returns productGroup by id or null if productGroup with specified id doesn't exist.
|
| TryGetProductsByOrder |
Returns products of the specified order or null if order doesn't exist.
|
| TryGetRegionById |
Returns region by id or null if region with specified id doesn't exist.
|
| TryGetRemovalTypeById |
Returns removalType by id or null if removalType with specified id doesn't exist.
|
| TryGetReserveById |
Returns reserve by id or null if reserve with specified id doesn't exist.
|
| TryGetSimpleModifiersByProduct |
Returns simpleModifiers of the specified product or null if product doesn't exist.
|
| TryGetStreetById |
Returns street by id or null if street with specified id doesn't exist.
|
| TryGetTableById |
Returns table by id or null if table with specified id doesn't exist.
|
| TryGetUserById |
Returns user by id or null if user with specified id doesn't exist.
|
Extension Methods
| Name | Description | |
|---|---|---|
 | AddDiscount | Adds simple discount of known type to existing order. User must have rights to work with discounts. (Defined by OperationServiceExtensions.) |
| AddDiscountByCardNumber | Add discount by card number (Defined by OperationServiceExtensions.) |
| AddOrderGuest(String, IOrder, ICredentials) | Overloaded. Adds new guest to existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.) |
| AddOrderGuest(Guid, String, IOrder, ICredentials) | Overloaded. Adds new guest with the given ID to existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.) |
| AddOrderItemModifier(Int32, IProduct, IProductGroup, IOrder, IOrderItemProduct, ICredentials) | Overloaded. Adds order item modifier to the order item in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.) |
| AddOrderItemModifier(Guid, Int32, IProduct, IProductGroup, IOrder, IOrderItemProduct, ICredentials) | Overloaded. Adds order item modifier to the order item in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.) |
| AddOrderItemProduct(Decimal, IProduct, IOrder, IOrderItemGuest, ICredentials) | Overloaded. Adds assortment position to the guest in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.) |
| AddOrderItemProduct(Guid, Decimal, IProduct, IOrder, IOrderItemGuest, ICredentials) | Overloaded. Adds assortment position to the guest in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.) |
| AddOrderItemProduct(Decimal, OrderItemCourse, IProduct, IOrder, IOrderItemGuest, ICredentials) | Overloaded. Adds assortment position with specific OrderItemCourse to the guest in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.) |
| AddOrderItemProduct(Guid, Decimal, OrderItemCourse, IProduct, IOrder, IOrderItemGuest, ICredentials) | Overloaded. Adds assortment position to the guest in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.) |
| BindReserveToOrder | Converts exising reserve or banquet without order to banquet with order. (Defined by OperationServiceExtensions.) |
| ChangeClientAddresses | Changes client addresses. (Defined by OperationServiceExtensions.) |
| ChangeClientBlacklistInfo | Changes client blacklist info (Defined by OperationServiceExtensions.) |
| ChangeClientCardNumber | Changes client card number (Defined by OperationServiceExtensions.) |
| ChangeClientComment | Changes client comment (Defined by OperationServiceExtensions.) |
| ChangeClientEmails | Changes client emails list (Defined by OperationServiceExtensions.) |
| ChangeClientIikoNetId | Changes client's account in iikoNet (Defined by OperationServiceExtensions.) |
| ChangeClientMainAddressIndex | Changes client main address index (Defined by OperationServiceExtensions.) |
| ChangeClientName | Changes client name (Defined by OperationServiceExtensions.) |
| ChangeClientNick | Changes client nickname (Defined by OperationServiceExtensions.) |
| ChangeClientPhones | Changes client phones list (Defined by OperationServiceExtensions.) |
| ChangeClientSurname | Changes client surname (Defined by OperationServiceExtensions.) |
| ChangeDeliveryActualDeliverTime | Change time when delivery was actually delivered. (Defined by OperationServiceExtensions.) |
| ChangeDeliveryAddress | Changes address of delivery (Defined by OperationServiceExtensions.) |
| ChangeDeliveryComment | Change delivery comment (Defined by OperationServiceExtensions.) |
| ChangeDeliveryConfirmTime | Change delivery when delivery was confirmed. (Defined by OperationServiceExtensions.) |
| ChangeDeliveryCourier | Assign/Change delivery courier. Can use this action only before delivery is to be delivered. (Defined by OperationServiceExtensions.) |
| ChangeDeliveryDuration | Change duration of delivery processing (Defined by OperationServiceExtensions.) |
| ChangeDeliveryEmail | Change delivery e-mail (Defined by OperationServiceExtensions.) |
| ChangeDeliveryExpectedDeliverTime | Change time when client want delivery to be delivered (Defined by OperationServiceExtensions.) |
| ChangeDeliveryLocation | Change delivery address location. (Defined by OperationServiceExtensions.) |
| ChangeDeliveryMarketingSource | Assign/Change delivery marketing source. (Defined by OperationServiceExtensions.) |
| ChangeDeliveryOperator | Assign/Change delivery operator. (Defined by OperationServiceExtensions.) |
| ChangeDeliveryPersonsCount | Changes persons count for a delivery (Defined by OperationServiceExtensions.) |
| ChangeDeliveryPhone | Changes delivery phone (Defined by OperationServiceExtensions.) |
| ChangeDeliveryProblemComment | Change delivery problem comment (Defined by OperationServiceExtensions.) |
| ChangeDeliveryProblemStatus | Change delivery problem status (Defined by OperationServiceExtensions.) |
| ChangeDeliverySplitBetweenPersons | Changes delivery property if order should be split between persons (Defined by OperationServiceExtensions.) |
| ChangeEstimatedOrderGuestsCount | Changes estimated order guests count. Use this method to set estimated guests count when guests collection doesn't reflect actual state of affairs. (Defined by OperationServiceExtensions.) |
| ChangeOrderItemComment | Changes product order item's comment. (Defined by OperationServiceExtensions.) |
| ChangeOrderItemModifierAmount | Changes the amount of the order item modifier. User must have rights to edit orders. (Defined by OperationServiceExtensions.) |
| ChangeOrderItemProductAmount | Changes the amount of the assortment position in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.) |
| ChangeOrderItemProductCourse | Changes the course of the order item. (Defined by OperationServiceExtensions.) |
| ChangeOrderOriginName | Sets order origin — name of the source this order was received from. Specifying origin allows to analyse efficiency of external order sources such as different web-sites, mobile applications and so on. Origin name can be set only once. (Defined by OperationServiceExtensions.) |
| ChangeReserveComment | Changes reserve comment. Use empty string to clear comment. (Defined by OperationServiceExtensions.) |
| ChangeReserveDuration | Changes estimated reserve duration (amount of time betwen visit's start and end). Default reserve duration is 2 hours, banquet duration is 3 hours. (Defined by OperationServiceExtensions.) |
| ChangeReserveEstimatedStartTime | Changes estimated reserve start time. (Defined by OperationServiceExtensions.) |
| ChangeReserveGuestsCount | Changes estimated guests count for reserve. Default value is 2. (Defined by OperationServiceExtensions.) |
| ChangeReserveReminder | Changes reserve reminder flag. (Defined by OperationServiceExtensions.) |
| ChangeReserveTable | Changes reserving table. (Defined by OperationServiceExtensions.) |
| ChangeStreetName | Changes street's name (Defined by OperationServiceExtensions.) |
| CreateBanquet(DateTime, IClient, ITable, ICredentials) | Overloaded. Creates reservation for planned event in future. Table will be marked as reserved to prevent collision with other events at the same time. (Defined by OperationServiceExtensions.) |
| CreateBanquet(DateTime, IClient, IOrder, ICredentials) | Overloaded. Creates reservation for planned event in future. Order's table will be marked as reserved to prevent collision with other events at the same time. (Defined by OperationServiceExtensions.) |
| CreateReserve | Creates reservation for planned visit in future. Table will be marked as reserved to prevent collision with other guests at the same time. (Defined by OperationServiceExtensions.) |
| CreateStreet(String, ICredentials) | Overloaded. Creates new street. (Defined by OperationServiceExtensions.) |
| CreateStreet(Guid, String, ICity, ICredentials) | Overloaded. Creates new street. (Defined by OperationServiceExtensions.) |
| DeleteDiscount | Removes discount of known type to existing order. User must have rights to work with discounts. (Defined by OperationServiceExtensions.) |
| DeleteExternalPaymentItem | Delete existing external payment item from order. (Defined by OperationServiceExtensions.) |
| DeleteOrderGuest | Deletes guest without any products from order. (Defined by OperationServiceExtensions.) |
| DeleteOrderItemComment | Deletes product order item's comment. (Defined by OperationServiceExtensions.) |
| DeleteOrderItemModifier | Deletes order item modifier from order item that represents the assortment position. User must have rights to edit orders. (Defined by OperationServiceExtensions.) |
| DeleteOrderItemProduct | Deletes order item from order that represents the assortment position. User must have rights to edit orders. (Defined by OperationServiceExtensions.) |
| DeleteOrRestoreStreet | Deletes street (Defined by OperationServiceExtensions.) |
| DeletePaymentItem | Delete existing payment item from order. (Defined by OperationServiceExtensions.) |
| DeletePrintedOrderItemModifier | Deletes order item modifier that is already printed. User must have rights to edit orders. (Defined by OperationServiceExtensions.) |
| DeletePrintedOrderItemProduct | Deletes order item that is already printed. User must have rights to edit orders. (Defined by OperationServiceExtensions.) |
| MoveOrderItemProduct | Moves product item between guests of the same order. (Defined by OperationServiceExtensions.) |
| MoveOrderItemProductToAnotherOrder | Moves product item between orders. (Defined by OperationServiceExtensions.) |
| RenameOrderGuest | Renames order's guest. (Defined by OperationServiceExtensions.) |
| ReopenReserve | Reopens previously closed or canceled reserve. (Defined by OperationServiceExtensions.) |
| ServeOrderItemProduct | Mark order item product as served. (Defined by OperationServiceExtensions.) |
| SetDeliveryConfirmed | Change delivery status to confirmed. (Defined by OperationServiceExtensions.) |
| SetDeliveryDelivered | Change delivery status to delivered. (Defined by OperationServiceExtensions.) |
| SetDeliveryUnconfirmed | Change delivery status to unconfirmed. (Defined by OperationServiceExtensions.) |
| SetDeliveryUndelivered | Change delivery status to OnWay from status delivered. (Defined by OperationServiceExtensions.) |
| SetOrderType | Sets order type for existing order. (Defined by OperationServiceExtensions.) |
| StartBanquet | Transits banquet to the started status. (Defined by OperationServiceExtensions.) |
| UnserveOrderItemProduct | Mark order item product as unserved. (Defined by OperationServiceExtensions.) |
See Also