Documentation
¶
Index ¶
- Constants
- func HandleAddDeliveryOrder(c *fiber.Ctx) error
- func HandleAddRoutine(c *fiber.Ctx) error
- func HandleCancelDeliveryOrder(c *fiber.Ctx) error
- func HandleGetDeliveryOrder(c *fiber.Ctx) error
- func HandleGetDutyRooms(c *fiber.Ctx) error
- func HandleGetFloorPlan(c *fiber.Ctx) error
- func HandleGetRoutineDeliveryOrder(c *fiber.Ctx) error
- func HandleHealthCheck(c *fiber.Ctx) error
- func HandleLoginAdmin(c *fiber.Ctx) error
- func HandleLoginStaff(c *fiber.Ctx) error
- func HandleLogout(c *fiber.Ctx) error
- func HandleRenewToken(c *fiber.Ctx) error
- func HandleReportJobStatus(c *fiber.Ctx) error
- func HandleReportSystemStatus(c *fiber.Ctx) error
- func HandleTestAW2(c *fiber.Ctx) error
- func HandleTestMW1(c *fiber.Ctx) error
- func HandleTestOW1(c *fiber.Ctx) error
- func HandleTestSW1(c *fiber.Ctx) error
- func HandleTriggerHandlingOrder(c *fiber.Ctx) error
- func HandleUpdateDeliveryOrder(c *fiber.Ctx) error
- func HandleUpdateRoutineDeliveryOrder(c *fiber.Ctx) error
Constants ¶
const AW2_RESPONSE string = `{
"messageCode": "LOCATION_UPDATE",
"userId": 1,
"dutyLocationId" : 1,
"dutyLocationName" : "5/F DSC"
}`
const CancelDeliveryOrder string = `` /* 367-byte string literal not displayed */
const GET_FLOOR_PLAN_RESPONSE string = `` /* 156-byte string literal not displayed */
const MW1_RESPONSE string = `` /* 411-byte string literal not displayed */
const OW1_RESPONSE string = `` /* 209-byte string literal not displayed */
const SW1_RESPONSE string = `{
"messageCode": "SYSTEM_STATUS",
"systemState": "STOPPED",
"systemStatus": ["LIFT_ALARM"]
}`
Variables ¶
This section is empty.
Functions ¶
func HandleAddDeliveryOrder ¶
func HandleAddDeliveryOrder(c *fiber.Ctx) error
@Summary Add Delivery Order. @Description Create adhoc delivery order. @Tags Order Management @Accept json
@Param parameters body dto.AddDeliveryOrderDTO true "Add Delivery Order Parameters"
@Produce json @Success 200 {object} orderManagement.AddDeliveryOrderResponse @Failure 400 {object} models.FailResponse
@Router /addDeliveryOrder [post] @Security Bearer
func HandleAddRoutine ¶
func HandleAddRoutine(c *fiber.Ctx) error
@Summary Add Routine. @Description Create Routine delivery order. @Tags Order Management @Accept json
@Param parameters body dto.AddRoutineDTO true "Add Routine Parameters"
@Produce json @Success 200 {object} orderManagement.AddRoutineResponse @Failure 400 {object} models.FailResponse
@Router /addRoutine [post] @Security Bearer
func HandleCancelDeliveryOrder ¶
func HandleCancelDeliveryOrder(c *fiber.Ctx) error
@Summary Cancel Delivery Order. @Description Update Non Started Delivery Order . @Tags Order Management
@Accept json
@Param todo body dto.CancelDeliveryOrderDTO true "Cancel Delivery Parameters"
@Produce json @Success 200 {object} orderManagement.CancelDeliveryOrderResponse @Failure 400 {object} models.FailResponse
@Router /cancelDeliveryOrder [post] @Security Bearer
func HandleGetDeliveryOrder ¶
func HandleGetDeliveryOrder(c *fiber.Ctx) error
@Summary Get Delivery Order. @Description Get the list of delivery order by order status which start/end at the staff's duty location. @Tags Order Management @Accept */* @Param orderStatus query []string true "Order Status"
@Produce json @Success 200 {object} orderManagement.OrderListBody @Failure 400 {object} models.FailResponse
@Router /getDeliveryOrder [get] @Security Bearer
func HandleGetDutyRooms ¶
func HandleGetDutyRooms(c *fiber.Ctx) error
@Summary Get Duty Rooms. @Description Get the list of location. @Tags Map Handling @Accept */* @Produce json @Success 200 {object} mapHandling.GetDutyRoomsResponse @Failure 400 {object} models.FailResponse
@Router /getDutyRooms [get]
func HandleGetFloorPlan ¶
func HandleGetFloorPlan(c *fiber.Ctx) error
@Summary Get Floor Plan. @Description Get UI Floor Plan. @Tags Map Handling @Accept */* @Produce json @Success 200 {object} mapHandling.GetFloorPlanResponse @Failure 400 {object} models.FailResponse
@Router /getFloorPlan [get]
func HandleGetRoutineDeliveryOrder ¶
func HandleGetRoutineDeliveryOrder(c *fiber.Ctx) error
@Summary Get Routine Delivery Order. @Description Get the list of routine delivery orders. @Tags Order Management @Accept */*
@Produce json @Success 200 {object} orderManagement.OrderListBody @Failure 400 {object} models.FailResponse
@Router /getRoutineDeliveryOrder [get] @Security Bearer
func HandleHealthCheck ¶
func HandleHealthCheck(c *fiber.Ctx) error
@Summary Show the status of server. @Description get the status of server. @Tags Health @Accept */* @Produce plain @Success 200 "OK" @Router /health [get]
func HandleLoginAdmin ¶
func HandleLoginAdmin(c *fiber.Ctx) error
@Summary Login to OMS. @Description Login to OMS. @Tags Login Auth @Accept json
@Param todo body dto.LoginAdminDTO true "Login Parameters"
@Produce json @Success 200 {object} loginAuth.LoginResponse @Failure 400 {object} models.FailResponse @Router /loginAdmin [post]
func HandleLoginStaff ¶
func HandleLoginStaff(c *fiber.Ctx) error
@Summary Login to OMS. @Description Login to OMS. @Tags Login Auth @Accept json
@Param todo body dto.LoginStaffDTO true "Login Parameters"
@Produce json @Success 200 {object} loginAuth.LoginResponse @Failure 400 {object} models.FailResponse @Router /loginStaff [post]
func HandleLogout ¶
func HandleLogout(c *fiber.Ctx) error
@Summary Logout from OMS. @Description Logout from OMS. @Tags Login Auth @Accept json @Produce json @Success 200 {object} loginAuth.LogoutResponse @Failure 400 {object} models.FailResponse
@Router /logout [get] @Security Bearer
func HandleRenewToken ¶
func HandleRenewToken(c *fiber.Ctx) error
@Summary Renew JWT Token. @Description Using Valid Token to renew token before expired @Tags Login Auth @Accept */*
@Produce json @Success 200 {object} loginAuth.LoginResponse @Success 200 {object} loginAuth.LoginResponse @Failure 400 {object} models.FailResponse
@Router /renewToken [get] @Security Bearer
func HandleReportJobStatus ¶
func HandleReportJobStatus(c *fiber.Ctx) error
@Summary Report Job Status. @Description Receive the delivery job updated status. @Tags Order Management
@Accept json
@Param todo body dto.ReportJobStatusDTO true "Return Job Status Parameters"
@Produce json @Success 200 {object} models.ResponseHeader @Failure 400 {object} models.FailResponse
@Router /reportJobStatus [post]
func HandleReportSystemStatus ¶
func HandleReportSystemStatus(c *fiber.Ctx) error
@Summary Report System Status. @Description Get current system status. @Tags Order Management
@Accept */*
@Produce json @Success 200 {object} orderManagement.ReportSystemStatusResponse @Failure 400 {object} models.FailResponse
@Router /reportSystemStatus [post]
func HandleTestAW2 ¶
func HandleTestAW2(c *fiber.Ctx) error
@Summary Test AW2 websocket response. @Description Get the response of AW2 (Server notify the user which location selected). @Tags Test @Param parameters body string false "AW2 response" @Produce plain @Success 200 "OK" @Router /testAW2 [post]
func HandleTestMW1 ¶
func HandleTestMW1(c *fiber.Ctx) error
@Summary Test MW1 websocket response. @Description Get the response of MW1 (Server report robot status and location (every 1s) ). @Tags Test @Param parameters body string false "MW1 response" @Produce plain @Success 200 "OK" @Router /testHW1 [post]
func HandleTestOW1 ¶
func HandleTestOW1(c *fiber.Ctx) error
@Summary Test OW1 websocket response. @Description Get the response of OW1 (Server notify any of created order status changed). @Tags Test @Param parameters body string false "OW1 response" @Produce plain @Success 200 "OK" @Router /testOW1 [post]
func HandleTestSW1 ¶
func HandleTestSW1(c *fiber.Ctx) error
@Summary Test SW1 websocket response. @Description Get the response of SW1 (Server report robot status and location (every 1s) ). @Tags Test @Param parameters body string false "SW1 response" @Produce plain @Success 200 "OK" @Router /testSW1 [post]
func HandleTriggerHandlingOrder ¶
func HandleTriggerHandlingOrder(c *fiber.Ctx) error
@Summary Trigger Delivery Order. @Description Notify system users are ready to handle the current order. @Tags Order Management @Accept */*
@Param orderIds query int false "Order IDs" @Param scheduleId query int false "Schedule IDs"
@Produce json @Success 200 {object} orderManagement.TriggerHandlingOrderResponse @Failure 400 {object} models.FailResponse
@Router /triggerHandlingOrder [get] @Security Bearer
func HandleUpdateDeliveryOrder ¶
func HandleUpdateDeliveryOrder(c *fiber.Ctx) error
@Summary Update Delivery Order. @Description Update Non Started Delivery Order . @Tags Order Management
@Accept json
@Param todo body dto.UpdateDeliveryOrderDTO true "Update Delivery Order Parameters" @Param processingStatus query string false "Processing Status"
@Produce json @Success 200 {object} orderManagement.UpdateDeliveryOrderResponse @Failure 400 {object} models.FailResponse
@Router /updateDeliveryOrder [post] @Security Bearer
func HandleUpdateRoutineDeliveryOrder ¶
func HandleUpdateRoutineDeliveryOrder(c *fiber.Ctx) error
@Summary Update Routine Delivery Order. @Description Update Routine Delivery Order . @Tags Order Management
@Accept json
@Param todo body dto.UpdateRoutineDeliveryOrderDTO true "Update Delivery Order Parameters"
@Produce json @Success 200 {object} orderManagement.UpdateRoutineDeliveryOrderResponse @Failure 400 {object} models.FailResponse
@Router /updateRoutineDeliveryOrder [post] @Security Bearer
Types ¶
This section is empty.
Source Files