{"openapi":"3.0.0","servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://api.toshostivar.cz/api"},{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/3ID_API/3ID_CENTRALA/1.0.0"}],"info":{"description":"This is 3ID API","version":"1.0.0","title":"3ID  API","contact":{"email":"bugayevskiy@3id.cz"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"tags":[{"name":"timeline log","description":"Actions to manage timeline log"},{"name":"driver","description":"Actions to manage drivers"}],"paths":{"/service/box/timeline/drmax":{"get":{"tags":["timeline log"],"summary":"get log list","operationId":"searchTimelineLog","description":"By passing in the appropriate options, you can search for\navailable timeline logs in the system\n","parameters":[{"in":"query","name":"datetime_from","description":"datetime log event created from","required":false,"schema":{"type":"string"}},{"in":"query","name":"datetime_to","description":"datetime log event created to","required":false,"schema":{"type":"string"}},{"in":"query","name":"mac","description":"mac address of a box","required":false,"schema":{"type":"string"}},{"in":"query","name":"order_number","description":"number of order","required":false,"schema":{"type":"string"}},{"in":"query","name":"event_type","required":false,"schema":{"type":"string","enum":["pin_entered","put_order_view","put_order_section_selected","put_order_confirmed","open_lock","order_has_been_paid","payment_accepted","payment_canceled","requests_queue_command"]},"description":"event code occured during box workflow Sort order:\n * `pin_entered` - PIN entered by client/courier\n * `put_order_view` - put order select sections screen shown\n * `put_order_section_selected` - sections have been selected to put package in\n * `put_order_confirmed` - package put confirmed\n * `open_lock` - lock opened for selected sections\n * `order_has_been_paid` - in case order is not paid, payment screen is shown and this event occurs after success payment\n * `payment_accepted` - after success payment, system accept this action\n * `payment_canceled` - payment canceled by client\n * `requests_queue_command` - this event occures only to send events occured in box offline mode\n"},{"in":"query","name":"event_result","required":false,"schema":{"type":"string","enum":["pin_expired","order_already_taken_by_customer","redirect_to_put_order_view","manager_put_order_view","put_order_confirm_view","put_order_complete_view","put_order_section_select_view","service_view","reservation_canceled_by_user_view","take_order_select_view","order_payment_view","box_not_found","order_number_cannot_be_used","order_number_already_in_use","all_lockers_occuped","order_not_found","box_is_occuped","pin_lifespan_expired","section_already_used","payment_accepted_view","internal_error"]},"description":"event code occured during box workflow:\n  * `pin_expired` - pin expired\n  * `order_already_taken_by_customer` - order has been taken by user \n  * `redirect_to_put_order_view` - put order screen is shown\n  * `manager_put_order_view` -  put order screen is shown in manager mode\n  * `put_order_confirm_view` - put order confirm screen is shown\n  * `put_order_complete_view` - put order completed screen is shown\n  * `put_order_section_select_view` - section selection screen is shown\n  * `service_view` - screen is shown in service mode\n  * `reservation_canceled_by_user_view` - reservation caneled screen is shown\n  * `take_order_select_view` - shows screen when client can take the package\n  * `order_payment_view` - screen with amount of order is shown\n  * `box_not_found` - box not found\n  * `order_number_cannot_be_used` - pin typed by client/courier is not availab \n  * `order_number_already_in_use` - pin typed by client/courier linked to other order\n  * `all_lockers_occuped` - lockers are occuped\n  * `order_not_found` - order not found\n  * `box_is_occuped` - box is not available for putting packages\n  * `pin_lifespan_expired` - pin is action for package take, in case lock is not opened client has 5 minutes to use pin and try open lock again, after 5 minutes pin is expired\n  * `section_already_used` - section used by other package of order\n  * `payment_accepted_view` - payment accepted screen is shown\n  * `internal_error` - for unexpected erorrs\n"},{"in":"query","name":"exclude_event_type","description":"exclude event type from list (separate by comma without spaces)","example":"pin_entered,open_lock","required":false,"schema":{"type":"string"}},{"in":"query","name":"exclude_event_result","description":"exclude event results from list (separate by comma without spaces)","example":"section_already_used,payment_accepted_view","required":false,"schema":{"type":"string"}},{"in":"query","name":"page","description":"page number","schema":{"type":"integer","format":"int32","minimum":1}},{"in":"query","name":"page_size","description":"maximum number of records to return","schema":{"type":"integer","format":"int32","minimum":1}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"object","properties":{"current_page":{"type":"integer","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/TimelineLogItem"}},"first_page_url":{"type":"string","example":"http://server.localhost:8080/api/service/box/timeline/drmax?page=1"},"from":{"type":"integer","example":1},"last_page":{"type":"integer","example":1},"last_page_url":{"type":"string","example":"http://server.localhost:8080/api/service/box/timeline/drmax?page=1"},"links":{"type":"array","items":{"$ref":"#/components/schemas/PageLink"}},"next_page_url":{"type":"string","example":"http://server.localhost:8080/api/service/box/timeline/drmax?page=2"},"path":{"type":"string","example":"http://server.localhost:8080/api/service/box/timeline/drmax"},"per_page":{"type":"integer","example":100},"prev_page_url":{"type":"string"},"to":{"type":"integer","example":1},"total":{"type":"integer","example":1}}}}}},"500":{"description":"internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}}}},"/service/box/driver/drmax":{"get":{"tags":["driver"],"summary":"get drivers list","operationId":"searchDrivers","description":"By passing in the appropriate options, you can search for\navailable drivers in the system\n","parameters":[{"in":"query","name":"datetime_from","description":"datetime log event created from","required":false,"schema":{"type":"string"}},{"in":"query","name":"datetime_to","description":"datetime log event created to","required":false,"schema":{"type":"string"}},{"in":"query","name":"uuid","description":"drivers uuid","required":false,"schema":{"type":"string"}},{"in":"query","name":"first_name","description":"Drivers first name","required":false,"schema":{"type":"string"}},{"in":"query","name":"last_name","required":false,"schema":{"type":"string"},"description":"Drivers last name"},{"in":"query","name":"page","description":"page number","schema":{"type":"integer","format":"int32","minimum":1}},{"in":"query","name":"page_size","description":"maximum number of records to return","schema":{"type":"integer","format":"int32","minimum":1}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"object","properties":{"current_page":{"type":"integer","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/DriverItem"}},"first_page_url":{"type":"string","example":"http://server.localhost:8080/api/service/box/driver/drmax?page=1"},"from":{"type":"integer","example":1},"last_page":{"type":"integer","example":1},"last_page_url":{"type":"string","example":"http://server.localhost:8080/api/service/box/driver/drmax?page=1"},"links":{"type":"array","items":{"$ref":"#/components/schemas/PageLink"}},"next_page_url":{"type":"string","example":"http://server.localhost:8080/api/service/box/driver/drmax?page=2"},"path":{"type":"string","example":"http://server.localhost:8080/api/service/box/driver/drmax"},"per_page":{"type":"integer","example":100},"prev_page_url":{"type":"string"},"to":{"type":"integer","example":1},"total":{"type":"integer","example":1}}}}}},"400":{"description":"bad input parameter"},"500":{"description":"internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}}},"post":{"tags":["driver"],"summary":"create new driver","operationId":"addDriver","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"description":"Drivers first name","type":"string"},"last_name":{"description":"Drivers last name","type":"string"}},"example":{"first_name":"Jan","last_name":"Prochazka"}}}}},"responses":{"200":{"description":"create new driver response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"OK"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DriverItem"}}}}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"500":{"description":"internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}}}},"/service/box/driver/drmax/{uuid}":{"get":{"tags":["driver"],"summary":"get driver","operationId":"getDriver","parameters":[{"in":"path","name":"uuid","description":"drivers UUID","example":"6c61d58e-33f3-4032-b9b8-f591aed5a343","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"OK"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DriverItem"}}}}}}},"422":{"description":"update driver validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"500":{"description":"internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}}},"put":{"tags":["driver"],"summary":"update driver","operationId":"updateDriver","parameters":[{"in":"path","name":"uuid","description":"drivers UUID","example":"6c61d58e-33f3-4032-b9b8-f591aed5a343","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"description":"Drivers first name","type":"string"},"last_name":{"description":"Drivers last name","type":"string"}},"example":{"first_name":"Jan","last_name":"Prochazka"}}}}},"responses":{"200":{"description":"update driver response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"OK"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DriverItem"}}}}}}},"422":{"description":"update driver validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"500":{"description":"internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}}},"delete":{"tags":["driver"],"summary":"delete driver","operationId":"deleteDriver","parameters":[{"in":"path","name":"uuid","description":"drivers UUID","example":"6c61d58e-33f3-4032-b9b8-f591aed5a343","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"deleted driver success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"OK"}}}}}},"500":{"description":"internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}}}}},"components":{"schemas":{"TimelineLogItem":{"type":"object","properties":{"type":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851"},"price":{"type":"number","example":199.99},"result":{"type":"string","example":"take_order_select_view"},"context":{"$ref":"#/components/schemas/Context"},"message":{"type":"string"},"payment":{"type":"string"},"pinType":{"type":"string","enum":["manager","service","pin","order"],"example":"pin"},"timestamp":{"type":"string","example":"2022-11-18 22:21:48"},"enteredPin":{"type":"string","example":923044}}},"Context":{"properties":{"lock":{"type":"integer","example":12},"boxType":{"type":"string","enum":["manager","service","pin","order"],"example":"pin"},"boxModel":{"$ref":"#/components/schemas/BoxModel"},"commands":{"type":"array","items":{"$ref":"#/components/schemas/Command"}},"metaData":{"$ref":"#/components/schemas/Metadata"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/Section"}},"macAddress":{"type":"string","example":"00:00:00:00:00:00"},"isConnected":{"type":"array","items":{"$ref":"#/components/schemas/isConnected"}},"lockSections":{"type":"array","items":{"$ref":"#/components/schemas/Section"}},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}},"serviceParams":{"$ref":"#/components/schemas/ServiceParams"},"reservationUuid":{"type":"string","format":"uuid","example":"ffd9f755-0ac1-47a3-ac13-dc9c10cfe3bb"},"serverResponses":{"type":"array","items":{"$ref":"#/components/schemas/ServerResponses"}},"occupiedSections":{"type":"array","items":{"$ref":"#/components/schemas/Section"}},"reservationNumber":{"type":"string","example":5320000070}},"type":"object"},"BoxModel":{"properties":{"mac":{"type":"string","example":"00:00:00:00:00:00"},"uuid":{"type":"string","example":"ffd9f755-0ac1-47a3-ac13-dc9c10cfe3bb"},"boxOpen":{"type":"boolean","example":false},"lastUpdate":{"type":"string","example":"2022-11-18 22:21:48"}},"type":"object"},"Command":{"type":"object","properties":{"type":{"type":"string","enum":["open","get","set"],"example":"open"},"command":{"type":"string","example":"python3 ./ -a open_lock -v 01 -d /dev/ttyUSB0 2>&1"},"payload":{"type":"string","example":"01|01"},"response":{"type":"string","enum":["0","1"],"example":"0"}}},"DriverItem":{"type":"object","properties":{"id":{"type":"integer","example":1},"uuid":{"type":"string","example":1},"first_name":{"type":"string","example":"Jan"},"last_name":{"type":"string","example":"Prochazka"},"pin":{"type":"string","example":"E53AE96CE"},"partner_code":{"type":"string","example":"drmax"},"qr_code":{"type":"string","format":"base64"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2023-01-22T16:19:01.000000Z"},"deleted_at":{"type":"string","example":null}}},"Metadata":{"type":"object","properties":{"order_uuid":{"type":"string","example":"ffd9f755-0ac1-47a3-ac13-dc9c10cfe3bb"}}},"isConnected":{"type":"object","properties":{"action":{"type":"string","example":"/box/check-pin"},"isConnected":{"type":"boolean","example":true}}},"Section":{"type":"string","example":"01"},"Transaction":{"type":"object","properties":{"status":{"type":"string","example":"success"},"msg":{"type":"number","example":199.99},"dateTime":{"type":"string","example":"2023-01-17 10:29:52"}}},"ServiceParams":{"type":"object","properties":{"title":{"type":"string","example":"Service mode"},"footer":{"type":"string","example":"00:00:00:00:00:00 | 192.168.208.1"}}},"ServerResponses":{"type":"object","properties":{"action":{"type":"string","example":"/box/login"},"content":{"type":"object"}}},"PageLink":{"type":"object","properties":{"url":{"type":"string","example":"http://server.localhost:8080/api/service/box/timeline/drmax?page=1"},"label":{"type":"string","example":1},"active":{"type":"boolean","example":false}}},"ValidationError":{"type":"object","properties":{"message":{"type":"string","example":"The given data was invalid."},"errors":{"type":"array","items":{"type":"object","properties":{"first_name":{"type":"array","items":{"type":"string","example":"The first name field is required."}}}}}}},"InternalError":{"type":"object","properties":{"status":{"type":"string","example":"ERROR"},"error_code":{"type":"string","example":"internal-error"},"message":{"type":"string","example":"Internal Error"}}}}}}