Created
October 14, 2020 21:17
-
-
Save angusbreno/cab98d1cbb5892087e010f6dd03b016c to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "version": "v1", | |
| "title": "HBLOG Kernel API" | |
| }, | |
| "paths": { | |
| "/api/ElevationOrder/GetByLineUpId": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "operationId": "GetByLineUpId", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "LineUpId", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrder" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/UpSertElevationOrder": { | |
| "put": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "operationId": "UpSertElevationOrder", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "command", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderUpsertCommand" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrder" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/GetNextOrderNumber": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "operationId": "GetNextOrderNumber", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "format": "float", | |
| "type": "number" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/GetVolumeByElevation": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "operationId": "GetVolumeByElevation", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "ElevationId", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrder" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/UploadMATEFile": { | |
| "post": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Upload MATE file from elevation order", | |
| "operationId": "UploadMATEFile", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "command", | |
| "in": "body", | |
| "description": "", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderDocumentationCommand" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderDocumentation" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/RemoveMATEFile": { | |
| "post": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Remove MATE file from elevation order.", | |
| "operationId": "RemoveMATEFile", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "ElevationId", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderDocumentation" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/RequestBilling": { | |
| "post": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Send request billing to SAP", | |
| "operationId": "RequestBilling", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "elevationOrder", | |
| "in": "body", | |
| "description": "", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderCommand" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrder" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/GetRequestBilling": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "operationId": "GetRequestBilling", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[ElevationOrderBilling]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/GetElevationDashboard": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Dashboard information for given elevation order.", | |
| "operationId": "GetElevationDashboard", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "elevationOrderId", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationDashboard" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/UpsertDocumentation": { | |
| "post": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Upsert of elevation order documentation", | |
| "operationId": "UpsertDocumentation", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "elevationOrder", | |
| "in": "body", | |
| "description": "", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderDocumentationCommand" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderDocumentation" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/RemoveDocumentation": { | |
| "post": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Remove elevation order documentation", | |
| "operationId": "RemoveDocumentation", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "elevationOrder", | |
| "in": "body", | |
| "description": "", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderDocumentationCommand" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderDocumentation" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/GetAllDocumentation": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Return all documentation data, with OData filter and pagging.", | |
| "operationId": "GetAllDocumentation", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[ElevationOrderDocumentation]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/GetElevationOrderBoardingPlan": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Return data for user input and inserted boarding plans by elevation order.", | |
| "operationId": "GetElevationOrderBoardingPlans", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "elevationOrderId", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BoardingPlans" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/UpsertBoardingPlan": { | |
| "post": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Insert or update a boardgin plan for the elevation order.", | |
| "operationId": "UpsertBoardginPlan", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "command", | |
| "in": "body", | |
| "description": "", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderBoardingPlanCommand" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderBoardingPlan" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/GetBoardingPlanById": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Boarding plan data for update form.", | |
| "operationId": "GetBoardingPlanById", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "boardingPlanId", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderBoardingPlan" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/DeleteBoardingPlan": { | |
| "delete": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Remove elevation order boarding plan.", | |
| "operationId": "DeleteBoardingPlanById", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "boardingPlanId", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderBoardingPlan" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/GetElevationOrderPartials": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Return elevation order partials.", | |
| "operationId": "GetElevationOrderPartials", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "elevationOrderId", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "top", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[ElevationOrderPartial]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/ManualInputElevationPartial": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Return information for manualy input elevation order partials.", | |
| "operationId": "ManualInputElevationPartial", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "elevationOrderId", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderPartialInput" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Insert or update elevation partials.", | |
| "operationId": "ManualInputElevationPartial", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "elevationPartials", | |
| "in": "body", | |
| "description": "", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": false, | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ElevationOrderPartial" | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "uniqueItems": false, | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ElevationOrderPartial" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/RemoveElevationPartial": { | |
| "delete": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Remove elevation order partial by id.", | |
| "operationId": "RemoveElevationPartial", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "partialId", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderPartial" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/GetElevationOrderConsult": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Return elevation order list sended to SAP.", | |
| "operationId": "GetElevationOrderConsult", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[ElevationOrderBase]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/GetElevationOrderInvoice": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "summary": "Return NFSe and associated NFE by client.", | |
| "operationId": "GetElevationOrderInvoice", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderInvoices" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/FinalizeElevationData": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "operationId": "FinalizeElevationData", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "elevationOrderId", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrder" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/getall": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "operationId": "GetAll", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[ElevationOrder]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/getbyid": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "operationId": "GetById", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrder" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/upsert": { | |
| "post": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "operationId": "Upsert", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "model", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrder" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrder" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrder/delete": { | |
| "delete": { | |
| "tags": [ | |
| "ElevationOrder" | |
| ], | |
| "operationId": "Delete", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrder" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrderEvent/GetElevationOrderEventsByElevationOrderId": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrderEvent" | |
| ], | |
| "operationId": "GetElevationOrderEventsByElevationOrderId", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "elevationOrderId", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "top", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[ElevationOrderEvent]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrderEvent/UpsertElevationOrderEvent": { | |
| "put": { | |
| "tags": [ | |
| "ElevationOrderEvent" | |
| ], | |
| "operationId": "UpsertElevationOrderEvent", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "lineUpDates", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderEvent" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderEvent" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrderEvent/getall": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrderEvent" | |
| ], | |
| "operationId": "GetAll", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[ElevationOrderEvent]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrderEvent/getbyid": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrderEvent" | |
| ], | |
| "operationId": "GetById", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderEvent" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrderEvent/upsert": { | |
| "post": { | |
| "tags": [ | |
| "ElevationOrderEvent" | |
| ], | |
| "operationId": "Upsert", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "model", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderEvent" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderEvent" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrderEvent/delete": { | |
| "delete": { | |
| "tags": [ | |
| "ElevationOrderEvent" | |
| ], | |
| "operationId": "Delete", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderEvent" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrderEventType/getall": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrderEventType" | |
| ], | |
| "operationId": "GetAll", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[ElevationOrderEventType]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrderEventType/getbyid": { | |
| "get": { | |
| "tags": [ | |
| "ElevationOrderEventType" | |
| ], | |
| "operationId": "GetById", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderEventType" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrderEventType/upsert": { | |
| "post": { | |
| "tags": [ | |
| "ElevationOrderEventType" | |
| ], | |
| "operationId": "Upsert", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "model", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderEventType" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderEventType" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/ElevationOrderEventType/delete": { | |
| "delete": { | |
| "tags": [ | |
| "ElevationOrderEventType" | |
| ], | |
| "operationId": "Delete", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ElevationOrderEventType" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "version": "v1", | |
| "title": "HBLOG Kernel API" | |
| }, | |
| "paths": { | |
| "/api/LineUp/GetById": { | |
| "get": { | |
| "tags": [ | |
| "LineUp" | |
| ], | |
| "operationId": "GetById", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/LineUp" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/LineUp/GetLineUpPanel": { | |
| "get": { | |
| "tags": [ | |
| "LineUp" | |
| ], | |
| "operationId": "GetLineUpPanel", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "client", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "vesselName", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "lineUpStatus", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "enum": [ | |
| "Planned", | |
| "InProgress", | |
| "Finished", | |
| "Canceled" | |
| ] | |
| }, | |
| { | |
| "name": "initialDate", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| { | |
| "name": "finalDate", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "top", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[LineUpPanel]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/LineUp/GetLineUpDashboard": { | |
| "get": { | |
| "tags": [ | |
| "LineUp" | |
| ], | |
| "operationId": "GetLineUpDashboard", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "client", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "vesselName", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "lineUpStatus", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "enum": [ | |
| "Planned", | |
| "InProgress", | |
| "Finished", | |
| "Canceled" | |
| ] | |
| }, | |
| { | |
| "name": "initialDate", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| { | |
| "name": "finalDate", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/LineUpDashboard" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/LineUp/LineUpDates": { | |
| "put": { | |
| "tags": [ | |
| "LineUp" | |
| ], | |
| "operationId": "LineUpDates", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "lineUpDates", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/LineUpDates" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/LineUp/GetLineUpOperation": { | |
| "get": { | |
| "tags": [ | |
| "LineUp" | |
| ], | |
| "operationId": "GetLineUpOperation", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "uniqueItems": false, | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/KeyValue" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/LineUp/UpSertLineUp": { | |
| "put": { | |
| "tags": [ | |
| "LineUp" | |
| ], | |
| "operationId": "UpSertLineUp", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "command", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/LineUpCommand" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/LineUp" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/LineUp/GetLineUpElevationOrder": { | |
| "get": { | |
| "tags": [ | |
| "LineUp" | |
| ], | |
| "operationId": "GetLineUpElevationOrder", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "lineUpId", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/LineUpElevationOrder" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/LineUp/CancelLineUpElevationOrder": { | |
| "put": { | |
| "tags": [ | |
| "LineUp" | |
| ], | |
| "operationId": "CancelLineUpElevationOrder", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "command", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/LineUpCancelCommander" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/LineUp" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/LineUp/GetLineUpStatusValues": { | |
| "get": { | |
| "tags": [ | |
| "LineUp" | |
| ], | |
| "operationId": "GetLineUpStatusValues", | |
| "consumes": [], | |
| "produces": [], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/LineUp/getall": { | |
| "get": { | |
| "tags": [ | |
| "LineUp" | |
| ], | |
| "operationId": "GetAll", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[LineUp]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/LineUp/upsert": { | |
| "post": { | |
| "tags": [ | |
| "LineUp" | |
| ], | |
| "operationId": "Upsert", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "model", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/LineUp" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/LineUp" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/LineUp/delete": { | |
| "delete": { | |
| "tags": [ | |
| "LineUp" | |
| ], | |
| "operationId": "Delete", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/LineUp" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "version": "v1", | |
| "title": "HBLOG Kernel API" | |
| }, | |
| "paths": { | |
| "/api/Unloading/Upsert": { | |
| "post": { | |
| "tags": [ | |
| "Unloading" | |
| ], | |
| "operationId": "Upsert", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "unloading", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/Unloading" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/Unloading" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading": { | |
| "get": { | |
| "tags": [ | |
| "Unloading" | |
| ], | |
| "operationId": "GetAll", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "top", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "period", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "assetId", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "startDate", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| { | |
| "name": "endDate", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| { | |
| "name": "tripNumber", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "enum": [ | |
| "InTransit", | |
| "InProgress", | |
| "Executed" | |
| ] | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "uniqueItems": false, | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/UnloadingEventListing" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading/GetById": { | |
| "get": { | |
| "tags": [ | |
| "Unloading" | |
| ], | |
| "operationId": "GetById", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "unloadingId", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/UnloadingEventListing" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading/FinishUnloading": { | |
| "post": { | |
| "tags": [ | |
| "Unloading" | |
| ], | |
| "operationId": "FinishUnloading", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "unloadingId", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/Unloading" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading/GetAll": { | |
| "get": { | |
| "tags": [ | |
| "Unloading" | |
| ], | |
| "summary": "Return all data, with OData filter and pagging.", | |
| "operationId": "GetAllAsync", | |
| "consumes": [], | |
| "produces": [], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[Unloading]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading/Delete": { | |
| "delete": { | |
| "tags": [ | |
| "Unloading" | |
| ], | |
| "summary": "Delete an item, with SoftDelete option.", | |
| "operationId": "DeleteAsync", | |
| "consumes": [], | |
| "produces": [], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Item Id.", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "softDelete", | |
| "in": "query", | |
| "description": "Logical removal (TRUE: marks the record as removed | FALSE: delete the base record)", | |
| "required": false, | |
| "type": "boolean", | |
| "default": true | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading/FiscalControl/GetFiscalControlTable": { | |
| "get": { | |
| "tags": [ | |
| "UnloadingFiscalControl" | |
| ], | |
| "operationId": "GetFiscalControlTable", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "origin", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "client", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "startDate", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| { | |
| "name": "endDate", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| { | |
| "name": "operation", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "enum": [ | |
| "Cabotage", | |
| "Export" | |
| ] | |
| }, | |
| { | |
| "name": "product", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "top", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[FiscalControl]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading/Partials/GetAll": { | |
| "get": { | |
| "tags": [ | |
| "UnloadingPartial" | |
| ], | |
| "summary": "Return all data, with OData filter and pagging.", | |
| "operationId": "GetAllAsync", | |
| "consumes": [], | |
| "produces": [], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[UnloadingPartial]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading/Partials/Upsert": { | |
| "post": { | |
| "tags": [ | |
| "UnloadingPartial" | |
| ], | |
| "summary": "Update or insert items.", | |
| "operationId": "UpsertAsync", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [], | |
| "parameters": [ | |
| { | |
| "name": "model", | |
| "in": "body", | |
| "description": "Item to update or insert.", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/UnloadingPartial" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/UnloadingPartial" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading/Partials/Delete": { | |
| "delete": { | |
| "tags": [ | |
| "UnloadingPartial" | |
| ], | |
| "summary": "Delete an item, with SoftDelete option.", | |
| "operationId": "DeleteAsync", | |
| "consumes": [], | |
| "produces": [], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Item Id.", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "softDelete", | |
| "in": "query", | |
| "description": "Logical removal (TRUE: marks the record as removed | FALSE: delete the base record)", | |
| "required": false, | |
| "type": "boolean", | |
| "default": true | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading/Plan/Upsert": { | |
| "post": { | |
| "tags": [ | |
| "UnloadingPlan" | |
| ], | |
| "operationId": "Upsert", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "unloading", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/UnloadingPlan" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/UnloadingPlan" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading/Plan/GetById": { | |
| "get": { | |
| "tags": [ | |
| "UnloadingPlan" | |
| ], | |
| "operationId": "GetById", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "unloadingPlanId", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/UnloadingPlan" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading/Plan/GetAllByUnloadingId": { | |
| "get": { | |
| "tags": [ | |
| "UnloadingPlan" | |
| ], | |
| "operationId": "GetAllByUnloadingId", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "top", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "unloadingId", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[UnloadingPlan]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading/Plan/GetAll": { | |
| "get": { | |
| "tags": [ | |
| "UnloadingPlan" | |
| ], | |
| "summary": "Return all data, with OData filter and pagging.", | |
| "operationId": "GetAllAsync", | |
| "consumes": [], | |
| "produces": [], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[UnloadingPlan]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading/Plan/Delete": { | |
| "delete": { | |
| "tags": [ | |
| "UnloadingPlan" | |
| ], | |
| "summary": "Delete an item, with SoftDelete option.", | |
| "operationId": "DeleteAsync", | |
| "consumes": [], | |
| "produces": [], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Item Id.", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "softDelete", | |
| "in": "query", | |
| "description": "Logical removal (TRUE: marks the record as removed | FALSE: delete the base record)", | |
| "required": false, | |
| "type": "boolean", | |
| "default": true | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Unloading/PlanListing/GetAll": { | |
| "get": { | |
| "tags": [ | |
| "UnloadingPlanListing" | |
| ], | |
| "operationId": "GetAll", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "assetId", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "startDate", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| { | |
| "name": "endDate", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| { | |
| "name": "tripNumber", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "enum": [ | |
| "InTransit", | |
| "InProgress", | |
| "Executed" | |
| ] | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "top", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "uniqueItems": false, | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/UnloadingPlanListing" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "version": "v1", | |
| "title": "HBLOG Kernel API" | |
| }, | |
| "paths": { | |
| "/api/Warehouse/GetWarehouses": { | |
| "get": { | |
| "tags": [ | |
| "Warehouse" | |
| ], | |
| "summary": "Return all active warehouses.", | |
| "operationId": "GetWarehouses", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "uniqueItems": false, | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/KeyValue" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Warehouse/Active": { | |
| "put": { | |
| "tags": [ | |
| "Warehouse" | |
| ], | |
| "summary": "Active/Desactive a warehouse.", | |
| "operationId": "Active", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "command", | |
| "in": "body", | |
| "description": "", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/ActiveDeactiveCommand" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Warehouse/GetWarehousesStorageDashboard": { | |
| "get": { | |
| "tags": [ | |
| "Warehouse" | |
| ], | |
| "summary": "Return all active warehouses with storage info.", | |
| "operationId": "GetWarehousesStorageDashboard", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "uniqueItems": false, | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/WarehouseDashboard" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Warehouse/BalanceBySalina": { | |
| "get": { | |
| "tags": [ | |
| "Warehouse" | |
| ], | |
| "operationId": "BalanceBySalina", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "uniqueItems": false, | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/WarehouseBalance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Warehouse/GetIncomigVolumes": { | |
| "get": { | |
| "tags": [ | |
| "Warehouse" | |
| ], | |
| "summary": "Return incoming volumes by trip", | |
| "operationId": "GetIncoming", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "assetId", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "startDate", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| { | |
| "name": "endDate", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| { | |
| "name": "tripNumber", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "enum": [ | |
| "InTransit", | |
| "InProgress", | |
| "Executed" | |
| ] | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "top", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/Incoming" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Warehouse/GetControlStorageNFe": { | |
| "get": { | |
| "tags": [ | |
| "Warehouse" | |
| ], | |
| "operationId": "GetControlStorageNFe", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "assetId", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "startDate", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| { | |
| "name": "endDate", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| { | |
| "name": "tripNumber", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "enum": [ | |
| "InTransit", | |
| "InProgress", | |
| "Executed" | |
| ] | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "top", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[ControlStorageNFe]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Warehouse/GetControlStorage": { | |
| "get": { | |
| "tags": [ | |
| "Warehouse" | |
| ], | |
| "operationId": "GetControlStorage", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "operation", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "enum": [ | |
| "Cabotage", | |
| "Export" | |
| ] | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "top", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[ControlStorage]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Warehouse/TransferVolume": { | |
| "get": { | |
| "tags": [ | |
| "Warehouse" | |
| ], | |
| "summary": "Get input data for volume transfer", | |
| "operationId": "TransferVolume", | |
| "consumes": [], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "warehouseId", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/WarehouseTransferInputData" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Warehouse" | |
| ], | |
| "summary": "Transfer volumes between warehouses", | |
| "operationId": "Transfer", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "text/plain", | |
| "application/json", | |
| "text/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "transfer", | |
| "in": "body", | |
| "description": "", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": false, | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/WarehouseTransfer" | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Warehouse/GetAll": { | |
| "get": { | |
| "tags": [ | |
| "Warehouse" | |
| ], | |
| "summary": "Return all data, with OData filter and pagging.", | |
| "operationId": "GetAllAsync", | |
| "consumes": [], | |
| "produces": [], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResult[Warehouse]" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Warehouse/Upsert": { | |
| "post": { | |
| "tags": [ | |
| "Warehouse" | |
| ], | |
| "summary": "Update or insert items.", | |
| "operationId": "UpsertAsync", | |
| "consumes": [ | |
| "application/json-patch+json", | |
| "application/json", | |
| "text/json", | |
| "application/*+json" | |
| ], | |
| "produces": [], | |
| "parameters": [ | |
| { | |
| "name": "model", | |
| "in": "body", | |
| "description": "Item to update or insert.", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/Warehouse" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/Warehouse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Warehouse/Delete": { | |
| "delete": { | |
| "tags": [ | |
| "Warehouse" | |
| ], | |
| "summary": "Delete an item, with SoftDelete option.", | |
| "operationId": "DeleteAsync", | |
| "consumes": [], | |
| "produces": [], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Item Id.", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "softDelete", | |
| "in": "query", | |
| "description": "Logical removal (TRUE: marks the record as removed | FALSE: delete the base record)", | |
| "required": false, | |
| "type": "boolean", | |
| "default": true | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment