{ "openapi": "3.0.0", "info": { "title": "ubf", "version": "1.0.0", "description": "UBF", "contact": {} }, "paths": { "/activitylogs": { "post": { "x-controller-name": "ActivitylogController", "x-operation-name": "save", "tags": [ "ActivitylogController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "description": "Common request body", "require": true }, "operationId": "ActivitylogController.save" }, "get": { "x-controller-name": "ActivitylogController", "x-operation-name": "find", "tags": [ "ActivitylogController" ], "responses": { "200": { "description": "ActivitylogsResponse", "content": { "application/json": { "schema": { "type": "array", "title": "ActivitylogsResponse", "items": { "type": "object", "properties": {} } } } } } }, "parameters": [ { "name": "start", "in": "query", "schema": { "type": "number" } }, { "name": "length", "in": "query", "schema": { "type": "number" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ActivitylogController.find" } }, "/addresses/{id}": { "patch": { "x-controller-name": "AddressController", "x-operation-name": "updateById", "tags": [ "AddressController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Address PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "email", "phoneNumber", "contactType" ], "properties": { "lineOne": { "type": "string", "description": "" }, "lineTwo": { "type": "string", "description": "" }, "city": { "type": "string", "description": "" }, "cityUnCode": { "type": "string", "description": "" }, "pincode": { "type": "number", "description": "" } } } } }, "description": "Request body for address save", "required": true, "x-parameter-index": 1 }, "operationId": "AddressController.updateById" }, "delete": { "x-controller-name": "AddressController", "x-operation-name": "deleteById", "tags": [ "AddressController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Address DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AddressController.deleteById" } }, "/airlines/{id}": { "patch": { "x-controller-name": "AirlineController", "x-operation-name": "updateById", "tags": [ "AirlineController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Airline PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Airline name" }, "code": { "type": "string", "description": "" }, "location": { "type": "string", "description": "" } } } } }, "description": "Request body for Airline save", "required": true, "x-parameter-index": 1 }, "operationId": "AirlineController.updateById" }, "get": { "x-controller-name": "AirlineController", "x-operation-name": "findById", "tags": [ "AirlineController" ], "responses": { "200": { "description": "AirlineResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AirlineResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AirlineController.findById" }, "delete": { "x-controller-name": "AirlineController", "x-operation-name": "deleteById", "tags": [ "AirlineController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Airline DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AirlineController.deleteById" } }, "/airlines": { "post": { "x-controller-name": "AirlineController", "x-operation-name": "create", "tags": [ "AirlineController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Airline name" }, "code": { "type": "string", "description": "" }, "location": { "type": "string", "description": "" } } } } }, "description": "Request body for Airline save", "required": true }, "operationId": "AirlineController.create" }, "get": { "x-controller-name": "AirlineController", "x-operation-name": "find", "tags": [ "AirlineController" ], "responses": { "200": { "description": "AirlinesResponse", "content": { "application/json": { "schema": { "type": "array", "title": "AirlinesResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "location": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "operationId": "AirlineController.find" } }, "/airports/{id}": { "patch": { "x-controller-name": "AirportController", "x-operation-name": "updateById", "tags": [ "AirportController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Airport PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Airport name" }, "code": { "type": "string", "description": "" }, "location": { "type": "string", "description": "" } } } } }, "description": "Request body for Airport save", "required": true, "x-parameter-index": 1 }, "operationId": "AirportController.updateById" }, "get": { "x-controller-name": "AirportController", "x-operation-name": "findById", "tags": [ "AirportController" ], "responses": { "200": { "description": "AirportResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AirportResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AirportController.findById" }, "delete": { "x-controller-name": "AirportController", "x-operation-name": "deleteById", "tags": [ "AirportController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Airport DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AirportController.deleteById" } }, "/airports": { "post": { "x-controller-name": "AirportController", "x-operation-name": "create", "tags": [ "AirportController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Airport name" }, "code": { "type": "string", "description": "" }, "location": { "type": "string", "description": "" } } } } }, "description": "Request body for Airport save", "required": true }, "operationId": "AirportController.create" }, "get": { "x-controller-name": "AirportController", "x-operation-name": "find", "tags": [ "AirportController" ], "responses": { "200": { "description": "AirportsResponse", "content": { "application/json": { "schema": { "type": "array", "title": "AirportsResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "location": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "parameters": [ { "name": "searchStr", "in": "query", "schema": { "type": "string" } } ], "operationId": "AirportController.find" } }, "/booking/{id}/update-handleby": { "patch": { "x-controller-name": "BookingController", "x-operation-name": "updateHandleBy", "tags": [ "BookingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Update booking PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "description": "Common request body", "require": true, "x-parameter-index": 1 }, "operationId": "BookingController.updateHandleBy" } }, "/booking/{id}/update-status": { "patch": { "x-controller-name": "BookingController", "x-operation-name": "updateStatusText", "tags": [ "BookingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Update booking PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "statusText" ], "properties": { "statusText": { "type": "string", "description": "Status text" } } } } }, "description": "Request body for status text", "required": true, "x-parameter-index": 1 }, "operationId": "BookingController.updateStatusText" } }, "/bookings/active": { "get": { "x-controller-name": "BookingController", "x-operation-name": "findActive", "tags": [ "BookingController" ], "responses": { "200": { "description": "Array of Booking model instances", "content": { "application/json": { "schema": { "type": "array" } } } } }, "parameters": [ { "name": "searchStr", "in": "query", "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "number" } }, { "name": "length", "in": "query", "schema": { "type": "number" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "BookingController.findActive" } }, "/bookings/cargofiles/{id}": { "delete": { "x-controller-name": "BookingController", "x-operation-name": "deleteCargoFile", "tags": [ "BookingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Booking DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BookingController.deleteCargoFile" } }, "/bookings/cargoloads/{id}": { "delete": { "x-controller-name": "BookingController", "x-operation-name": "deleteCargoLoad", "tags": [ "BookingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Booking DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BookingController.deleteCargoLoad" } }, "/bookings/customer/export": { "get": { "x-controller-name": "BookingController", "x-operation-name": "exportBookingByCustomer", "tags": [ "BookingController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Export booking" } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "BookingController.exportBookingByCustomer" } }, "/bookings/export": { "get": { "x-controller-name": "BookingController", "x-operation-name": "exportBooking", "tags": [ "BookingController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Export booking" } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "BookingController.exportBooking" } }, "/bookings/generate-id": { "get": { "x-controller-name": "BookingController", "x-operation-name": "generateId", "tags": [ "BookingController" ], "responses": { "200": { "description": "GenerateBookingIdResponse", "content": { "application/json": { "schema": { "type": "string", "title": "GenerateBookingIdResponse" } } } } }, "operationId": "BookingController.generateId" } }, "/bookings/routingDetails/${id}": { "delete": { "x-controller-name": "BookingController", "x-operation-name": "deleteRoutingdetail", "tags": [ "BookingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Booking routing detail DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BookingController.deleteRoutingdetail" } }, "/bookings/smr/{customerId}": { "get": { "x-controller-name": "BookingController", "x-operation-name": "smr", "tags": [ "BookingController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Export booking" } } } } }, "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BookingController.smr" } }, "/bookings/smr": { "post": { "x-controller-name": "BookingController", "x-operation-name": "bulkSMR", "tags": [ "BookingController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "send bulk smr" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "customers" ], "properties": { "customers": { "type": "array", "description": "customers" } } } } }, "description": "Request body for bulk smr", "required": true }, "operationId": "BookingController.bulkSMR" } }, "/bookings/{id}/document/download": { "post": { "x-controller-name": "BookingController", "x-operation-name": "downloadDocument", "tags": [ "BookingController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "download" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "emailRecipients": { "type": "string", "description": "emailRecipients" }, "cc": { "type": "string", "description": "" }, "emailSubject": { "type": "string", "description": "" }, "emailBody": { "type": "string", "description": "" }, "documentTypes": { "type": "array", "items": { "type": "number" }, "description": "" }, "attachments": { "type": "array", "items": { "type": "string" }, "description": "" } } } } }, "description": "Request body for mail", "required": true, "x-parameter-index": 1 }, "operationId": "BookingController.downloadDocument" } }, "/bookings/{id}/document/send": { "post": { "x-controller-name": "BookingController", "x-operation-name": "sendDocumentMail", "tags": [ "BookingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Send mail" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "emailRecipients": { "type": "string", "description": "emailRecipients" }, "cc": { "type": "string", "description": "" }, "emailSubject": { "type": "string", "description": "" }, "emailBody": { "type": "string", "description": "" }, "documentTypes": { "type": "array", "items": { "type": "number" }, "description": "" }, "attachments": { "type": "array", "items": { "type": "string" }, "description": "" } } } } }, "description": "Request body for mail", "required": true, "x-parameter-index": 1 }, "operationId": "BookingController.sendDocumentMail" } }, "/bookings/{id}/export/pdf": { "get": { "x-controller-name": "BookingController", "x-operation-name": "exportPdfById", "tags": [ "BookingController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "description": "Export booking" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BookingController.exportPdfById" } }, "/bookings/{id}": { "patch": { "x-controller-name": "BookingController", "x-operation-name": "updateById", "tags": [ "BookingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Booking PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "branchId": { "type": "number", "description": "Branch of the user. Possible values are 1 = New Zealand,2 = Australia,3 = Fiji" }, "uniqueId": { "type": "string", "description": "Unique Id" }, "customerId": { "type": "number", "description": "Customer Id" }, "shipperId": { "type": "number", "description": "Shipper Id" }, "consigneeId": { "type": "number", "description": "Consignee Id" }, "salesexecutiveId": { "type": "number", "description": "Sales executive Id" }, "incotermId": { "type": "number", "description": "Incoterm Id" }, "shipmentmodeId": { "type": "number", "description": "Shipmentmode Id" }, "agentId": { "type": "number", "description": "Agent Id" }, "customerPo": { "type": "string", "description": "Customer Po" }, "consigneePo": { "type": "string", "description": "Consinee Po" }, "carrier": { "type": "string", "description": "Carrier" }, "statusText": { "type": "string", "description": "Status text" }, "billNo": { "type": "string", "description": "Bill no" }, "cargoloads": { "type": "array", "description": "", "items": { "type": "object", "required": [], "properties": { "id": { "type": "number", "description": "" }, "cargoDescription": { "type": "string", "description": "Cargo description" }, "containertypeId": { "type": "number", "description": "Container type id" }, "packagetypeId": { "type": "number", "description": "Package type id" }, "containerCount": { "type": "number", "description": "Container count" }, "weightUnit": { "type": "number", "description": "Weight unit" }, "weight": { "type": "number", "description": "Weight" }, "overWeight": { "type": "number", "description": "Is overweight? possible values are 1=yes,0=no" }, "quantity": { "type": "number", "description": "Quanitity" }, "perPackageWeight": { "type": "number", "description": "Per package weight" }, "totalWeight": { "type": "number", "description": "Total weight" }, "lengthUnit": { "type": "number", "description": "Unit of length" }, "length": { "type": "number", "description": "Length" }, "height": { "type": "number", "description": "Height" }, "width": { "type": "number", "description": "Width" }, "cbm": { "type": "number", "description": "Cbm" }, "totalCbm": { "type": "number", "description": "Total cbm" }, "chargeableWeight": { "type": "number", "description": "Chargebale weight" }, "cargoType": { "type": "number", "description": "Cargo type" }, "additionalInformation": { "type": "string", "description": "Additional information" }, "containerNumber": { "type": "string", "description": "Container number" }, "commodity": { "type": "string", "description": "" }, "goodsDescription": { "type": "string", "description": "" }, "unNumber": { "type": "string", "description": "" }, "unClass": { "type": "string", "description": "" }, "specialInstructions": { "type": "string", "description": "" }, "isDangerousGoods": { "type": "number", "description": "" } } } }, "routing": { "type": "object", "properties": { "id": { "type": "number", "description": "" }, "pickupAddress": { "type": "string", "description": "" }, "cargoReadyBy": { "type": "string", "description": "" }, "deliveryAddress": { "type": "string", "description": "" }, "estimatedDelivery": { "type": "string", "description": "" }, "receivingDepot": { "type": "string", "description": "" }, "cutoff": { "type": "string", "description": "" }, "deliveryDepot": { "type": "string", "description": "" } } }, "routingdetails": { "type": "array", "description": "", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "" }, "vessel": { "type": "string", "description": "" }, "carrier": { "type": "string", "description": "" }, "flightNumber": { "type": "string", "description": "" }, "eta": { "type": "string", "description": "" }, "etd": { "type": "string", "description": "" }, "airportId": { "type": "number", "description": "Airport id" }, "seaportId": { "type": "number", "description": "Seaport id" } } } }, "cargoExtrainfo": { "type": "object", "properties": { "id": { "type": "number", "description": "" }, "eta": { "type": "string", "description": "" }, "etd": { "type": "string", "description": "" }, "vessel": { "type": "string", "description": "" }, "voyage": { "type": "string", "description": "" }, "containerNumber": { "type": "string", "description": "" }, "mblNumber": { "type": "string", "description": "" }, "awbNumber": { "type": "string", "description": "" }, "insurance": { "type": "number", "description": "" }, "quoteNumber": { "type": "string", "description": "" }, "freightJobNumber": { "type": "string", "description": "" }, "internalNote": { "type": "string", "description": "" }, "externalNote": { "type": "string", "description": "" }, "freehand": { "type": "number", "description": "" }, "hblNumber": { "type": "string", "description": "" }, "coLoader": { "type": "string", "description": "" }, "flightNumber": { "type": "string", "description": "" }, "carrierReference": { "type": "string", "description": "" } } }, "cargofiles": { "type": "array", "description": "" }, "sendEmail": { "type": "number", "description": "Send email" }, "emailRecipients": { "type": "string", "description": "email reciepents" }, "emailSubject": { "type": "string", "description": "email subject" }, "emailBody": { "type": "string", "description": "email body" } } } } }, "description": "Request body for booking save", "required": true, "x-parameter-index": 1 }, "operationId": "BookingController.updateById" }, "get": { "x-controller-name": "BookingController", "x-operation-name": "findById", "tags": [ "BookingController" ], "responses": { "200": { "description": "Booking model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BookingController.findById" }, "delete": { "x-controller-name": "BookingController", "x-operation-name": "deleteById", "tags": [ "BookingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Booking DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BookingController.deleteById" } }, "/bookings": { "post": { "x-controller-name": "BookingController", "x-operation-name": "create", "tags": [ "BookingController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "branchId": { "type": "number", "description": "Branch of the user. Possible values are 1 = New Zealand,2 = Australia,3 = Fiji" }, "uniqueId": { "type": "string", "description": "Unique Id" }, "customerId": { "type": "number", "description": "Customer Id" }, "shipperId": { "type": "number", "description": "Shipper Id" }, "consigneeId": { "type": "number", "description": "Consignee Id" }, "salesexecutiveId": { "type": "number", "description": "Sales executive Id" }, "incotermId": { "type": "number", "description": "Incoterm Id" }, "shipmentmodeId": { "type": "number", "description": "Shipmentmode Id" }, "agentId": { "type": "number", "description": "Agent Id" }, "customerPo": { "type": "string", "description": "Customer Po" }, "consigneePo": { "type": "string", "description": "Consinee Po" }, "carrier": { "type": "string", "description": "Carrier" }, "statusText": { "type": "string", "description": "Status text" }, "billNo": { "type": "string", "description": "Bill no" }, "cargoloads": { "type": "array", "description": "", "items": { "type": "object", "required": [], "properties": { "id": { "type": "number", "description": "" }, "cargoDescription": { "type": "string", "description": "Cargo description" }, "containertypeId": { "type": "number", "description": "Container type id" }, "packagetypeId": { "type": "number", "description": "Package type id" }, "containerCount": { "type": "number", "description": "Container count" }, "weightUnit": { "type": "number", "description": "Weight unit" }, "weight": { "type": "number", "description": "Weight" }, "overWeight": { "type": "number", "description": "Is overweight? possible values are 1=yes,0=no" }, "quantity": { "type": "number", "description": "Quanitity" }, "perPackageWeight": { "type": "number", "description": "Per package weight" }, "totalWeight": { "type": "number", "description": "Total weight" }, "lengthUnit": { "type": "number", "description": "Unit of length" }, "length": { "type": "number", "description": "Length" }, "height": { "type": "number", "description": "Height" }, "width": { "type": "number", "description": "Width" }, "cbm": { "type": "number", "description": "Cbm" }, "totalCbm": { "type": "number", "description": "Total cbm" }, "chargeableWeight": { "type": "number", "description": "Chargebale weight" }, "cargoType": { "type": "number", "description": "Cargo type" }, "additionalInformation": { "type": "string", "description": "Additional information" }, "containerNumber": { "type": "string", "description": "Container number" }, "commodity": { "type": "string", "description": "" }, "goodsDescription": { "type": "string", "description": "" }, "unNumber": { "type": "string", "description": "" }, "unClass": { "type": "string", "description": "" }, "specialInstructions": { "type": "string", "description": "" }, "isDangerousGoods": { "type": "number", "description": "" } } } }, "routing": { "type": "object", "properties": { "id": { "type": "number", "description": "" }, "pickupAddress": { "type": "string", "description": "" }, "cargoReadyBy": { "type": "string", "description": "" }, "deliveryAddress": { "type": "string", "description": "" }, "estimatedDelivery": { "type": "string", "description": "" }, "receivingDepot": { "type": "string", "description": "" }, "cutoff": { "type": "string", "description": "" }, "deliveryDepot": { "type": "string", "description": "" } } }, "routingdetails": { "type": "array", "description": "", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "" }, "vessel": { "type": "string", "description": "" }, "carrier": { "type": "string", "description": "" }, "flightNumber": { "type": "string", "description": "" }, "eta": { "type": "string", "description": "" }, "etd": { "type": "string", "description": "" }, "airportId": { "type": "number", "description": "Airport id" }, "seaportId": { "type": "number", "description": "Seaport id" } } } }, "cargoExtrainfo": { "type": "object", "properties": { "id": { "type": "number", "description": "" }, "eta": { "type": "string", "description": "" }, "etd": { "type": "string", "description": "" }, "vessel": { "type": "string", "description": "" }, "voyage": { "type": "string", "description": "" }, "containerNumber": { "type": "string", "description": "" }, "mblNumber": { "type": "string", "description": "" }, "awbNumber": { "type": "string", "description": "" }, "insurance": { "type": "number", "description": "" }, "quoteNumber": { "type": "string", "description": "" }, "freightJobNumber": { "type": "string", "description": "" }, "internalNote": { "type": "string", "description": "" }, "externalNote": { "type": "string", "description": "" }, "freehand": { "type": "number", "description": "" }, "hblNumber": { "type": "string", "description": "" }, "coLoader": { "type": "string", "description": "" }, "flightNumber": { "type": "string", "description": "" }, "carrierReference": { "type": "string", "description": "" } } }, "cargofiles": { "type": "array", "description": "" }, "sendEmail": { "type": "number", "description": "Send email" }, "emailRecipients": { "type": "string", "description": "email reciepents" }, "emailSubject": { "type": "string", "description": "email subject" }, "emailBody": { "type": "string", "description": "email body" } } } } }, "description": "Request body for booking save", "required": true }, "operationId": "BookingController.create" }, "get": { "x-controller-name": "BookingController", "x-operation-name": "find", "tags": [ "BookingController" ], "responses": { "200": { "description": "Array of Booking model instances", "content": { "application/json": { "schema": { "type": "array" } } } } }, "parameters": [ { "name": "searchStr", "in": "query", "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "number" } }, { "name": "length", "in": "query", "schema": { "type": "number" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "BookingController.find" } }, "/branches/{id}": { "patch": { "x-controller-name": "BranchController", "x-operation-name": "updateById", "tags": [ "BranchController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Branch PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Branch name" } } } } }, "description": "Request body for Branch save", "required": true, "x-parameter-index": 1 }, "operationId": "BranchController.updateById" }, "get": { "x-controller-name": "BranchController", "x-operation-name": "findById", "tags": [ "BranchController" ], "responses": { "200": { "description": "BranchResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BranchController.findById" }, "delete": { "x-controller-name": "BranchController", "x-operation-name": "deleteById", "tags": [ "BranchController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Branch DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BranchController.deleteById" } }, "/branches": { "post": { "x-controller-name": "BranchController", "x-operation-name": "create", "tags": [ "BranchController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Branch name" } } } } }, "description": "Request body for Branch save", "required": true }, "operationId": "BranchController.create" }, "get": { "x-controller-name": "BranchController", "x-operation-name": "find", "tags": [ "BranchController" ], "responses": { "200": { "description": "BranchsResponse", "content": { "application/json": { "schema": { "type": "array", "title": "BranchsResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "operationId": "BranchController.find" } }, "/carriers": { "get": { "x-controller-name": "CarrierController", "x-operation-name": "find", "tags": [ "CarrierController" ], "responses": { "200": { "description": "CarriersResponse", "content": { "application/json": { "schema": { "type": "array", "title": "CarriersResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "location": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "operationId": "CarrierController.find" } }, "/commercialinvoices/booking/{id}/export": { "get": { "x-controller-name": "CommercialinvoiceController", "x-operation-name": "exportBooking", "tags": [ "CommercialinvoiceController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Export booking" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CommercialinvoiceController.exportBooking" } }, "/commercialinvoices/booking/{id}": { "post": { "x-controller-name": "CommercialinvoiceController", "x-operation-name": "save", "tags": [ "CommercialinvoiceController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "invoice": { "type": "array", "description": "", "items": { "type": "object", "required": [], "properties": { "id": { "type": "number", "description": "" }, "partNo": { "type": "string", "description": "" }, "description": { "type": "string", "description": "" }, "lookUp": { "type": "string", "description": "" }, "tariff": { "type": "string", "description": "" }, "quantity": { "type": "number", "description": "" }, "value": { "type": "number", "description": "" }, "countryOfOrigin": { "type": "string", "description": "" } } } } } } } }, "description": "Request body for commercial invoice", "required": true, "x-parameter-index": 1 }, "operationId": "CommercialinvoiceController.save" }, "get": { "x-controller-name": "CommercialinvoiceController", "x-operation-name": "find", "tags": [ "CommercialinvoiceController" ], "responses": { "200": { "description": "Array of Commercial invoice model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommercialinvoiceWithRelations" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CommercialinvoiceController.find" } }, "/commercialinvoices/{id}": { "delete": { "x-controller-name": "CommercialinvoiceController", "x-operation-name": "deleteById", "tags": [ "CommercialinvoiceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Contact DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CommercialinvoiceController.deleteById" } }, "/commodities": { "get": { "x-controller-name": "CommodityController", "x-operation-name": "find", "tags": [ "CommodityController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": {} } } } }, "operationId": "CommodityController.find" } }, "/contacts/{id}/address": { "post": { "x-controller-name": "ContactController", "x-operation-name": "createAddress", "tags": [ "ContactController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "email", "phoneNumber", "contactType" ], "properties": { "lineOne": { "type": "string", "description": "" }, "lineTwo": { "type": "string", "description": "" }, "city": { "type": "string", "description": "" }, "cityUnCode": { "type": "string", "description": "" }, "pincode": { "type": "number", "description": "" } } } } }, "description": "Request body for address save", "required": true, "x-parameter-index": 1 }, "operationId": "ContactController.createAddress" } }, "/contacts/{id}": { "patch": { "x-controller-name": "ContactController", "x-operation-name": "updateById", "tags": [ "ContactController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Contact PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "email", "phoneNumber", "contactType" ], "properties": { "name": { "type": "string", "description": "" }, "email": { "type": "string", "description": "" }, "phoneNumber": { "type": "string", "description": "" }, "contactType": { "type": "number", "description": "" }, "notes": { "type": "string", "description": "" }, "designation": { "type": "string", "description": "" } } } } }, "description": "Request body for contact save", "required": true, "x-parameter-index": 1 }, "operationId": "ContactController.updateById" }, "delete": { "x-controller-name": "ContactController", "x-operation-name": "deleteById", "tags": [ "ContactController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Contact DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ContactController.deleteById" } }, "/containertypes/{id}": { "patch": { "x-controller-name": "ContainertypeController", "x-operation-name": "updateById", "tags": [ "ContainertypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Containertype PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Containertype name" } } } } }, "description": "Request body for Containertype save", "required": true, "x-parameter-index": 1 }, "operationId": "ContainertypeController.updateById" }, "get": { "x-controller-name": "ContainertypeController", "x-operation-name": "findById", "tags": [ "ContainertypeController" ], "responses": { "200": { "description": "ContainertypeResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContainertypeResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ContainertypeController.findById" }, "delete": { "x-controller-name": "ContainertypeController", "x-operation-name": "deleteById", "tags": [ "ContainertypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Containertype DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ContainertypeController.deleteById" } }, "/containertypes": { "post": { "x-controller-name": "ContainertypeController", "x-operation-name": "create", "tags": [ "ContainertypeController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Containertype name" } } } } }, "description": "Request body for Containertype save", "required": true }, "operationId": "ContainertypeController.create" }, "get": { "x-controller-name": "ContainertypeController", "x-operation-name": "find", "tags": [ "ContainertypeController" ], "responses": { "200": { "description": "ContainertypesResponse", "content": { "application/json": { "schema": { "type": "array", "title": "ContainertypesResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "operationId": "ContainertypeController.find" } }, "/customers/export/excel": { "get": { "x-controller-name": "CustomerController", "x-operation-name": "exportExcel", "tags": [ "CustomerController" ], "responses": { "200": { "description": "CustomersResponse", "content": { "application/json": { "schema": { "type": "array", "title": "CustomersResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "companyName": { "type": "string" }, "phoneNumber": { "type": "string" }, "code": { "type": "string" }, "contactSegment": { "type": "number" }, "notes": { "type": "string" }, "document": { "type": "string" }, "documentSrc": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "parameters": [ { "name": "searchStr", "in": "query", "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "number" } }, { "name": "length", "in": "query", "schema": { "type": "number" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "CustomerController.exportExcel" } }, "/customers/top": { "get": { "x-controller-name": "CustomerController", "x-operation-name": "findTopCustomers", "tags": [ "CustomerController" ], "responses": { "200": { "description": "top customers", "content": { "application/json": { "schema": { "type": "array", "title": "top customers" } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "CustomerController.findTopCustomers" } }, "/customers/{id}/address": { "post": { "x-controller-name": "CustomerController", "x-operation-name": "createAddress", "tags": [ "CustomerController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "email", "phoneNumber", "contactType" ], "properties": { "lineOne": { "type": "string", "description": "" }, "lineTwo": { "type": "string", "description": "" }, "city": { "type": "string", "description": "" }, "cityUnCode": { "type": "string", "description": "" }, "pincode": { "type": "number", "description": "" } } } } }, "description": "Request body for address save", "required": true, "x-parameter-index": 1 }, "operationId": "CustomerController.createAddress" } }, "/customers/{id}/contacts": { "post": { "x-controller-name": "CustomerController", "x-operation-name": "createContact", "tags": [ "CustomerController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "email", "phoneNumber", "contactType" ], "properties": { "name": { "type": "string", "description": "" }, "email": { "type": "string", "description": "" }, "phoneNumber": { "type": "string", "description": "" }, "contactType": { "type": "number", "description": "" }, "notes": { "type": "string", "description": "" }, "designation": { "type": "string", "description": "" } } } } }, "description": "Request body for contact save", "required": true, "x-parameter-index": 1 }, "operationId": "CustomerController.createContact" }, "get": { "x-controller-name": "CustomerController", "x-operation-name": "findContacts", "tags": [ "CustomerController" ], "responses": { "200": { "description": "ContactsResponse", "content": { "application/json": { "schema": { "type": "array", "title": "ContactsResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "contactType": { "type": "number" }, "notes": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CustomerController.findContacts" } }, "/customers/{id}": { "patch": { "x-controller-name": "CustomerController", "x-operation-name": "updateById", "tags": [ "CustomerController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Customer PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyName", "phoneNumber", "code", "contactSegment" ], "properties": { "branchId": { "type": "number", "description": "" }, "companyName": { "type": "string", "description": "" }, "phoneNumber": { "type": "string", "description": "" }, "code": { "type": "string", "description": "" }, "contactSegment": { "type": "number", "description": "" }, "notes": { "type": "string", "description": "" }, "document": { "type": "string", "description": "" } } } } }, "description": "Request body for basic details update", "required": true, "x-parameter-index": 1 }, "operationId": "CustomerController.updateById" }, "get": { "x-controller-name": "CustomerController", "x-operation-name": "findById", "tags": [ "CustomerController" ], "responses": { "200": { "description": "CustomerResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CustomerController.findById" }, "delete": { "x-controller-name": "CustomerController", "x-operation-name": "deleteById", "tags": [ "CustomerController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Customer DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CustomerController.deleteById" } }, "/customers": { "post": { "x-controller-name": "CustomerController", "x-operation-name": "create", "tags": [ "CustomerController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" }, "id": { "type": "number" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "companyName", "phoneNumber", "code", "contactSegment" ], "properties": { "branchId": { "type": "number", "description": "" }, "companyName": { "type": "string", "description": "" }, "phoneNumber": { "type": "string", "description": "" }, "code": { "type": "string", "description": "" }, "contactSegment": { "type": "number", "description": "" }, "notes": { "type": "string", "description": "" }, "document": { "type": "string", "description": "" } } } } }, "description": "Request body for basic details update", "required": true }, "operationId": "CustomerController.create" }, "get": { "x-controller-name": "CustomerController", "x-operation-name": "find", "tags": [ "CustomerController" ], "responses": { "200": { "description": "CustomersResponse", "content": { "application/json": { "schema": { "type": "array", "title": "CustomersResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "companyName": { "type": "string" }, "phoneNumber": { "type": "string" }, "code": { "type": "string" }, "contactSegment": { "type": "number" }, "notes": { "type": "string" }, "document": { "type": "string" }, "documentSrc": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "parameters": [ { "name": "searchStr", "in": "query", "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "number" } }, { "name": "length", "in": "query", "schema": { "type": "number" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "CustomerController.find" } }, "/documenttypes": { "get": { "x-controller-name": "DocumenttypeController", "x-operation-name": "find", "tags": [ "DocumenttypeController" ], "responses": { "200": { "description": "DocumenttypesResponse", "content": { "application/json": { "schema": { "type": "array", "title": "DocumenttypesResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "DocumenttypeController.find" } }, "/files/{purpose}": { "post": { "x-controller-name": "FileUploadController", "x-operation-name": "fileUpload", "tags": [ "FileUploadController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Files and fields" } }, "parameters": [ { "name": "purpose", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "FileUploadController.fileUpload" } }, "/geocoding/{search}": { "get": { "x-controller-name": "MapboxController", "x-operation-name": "findGeoCoding", "tags": [ "MapboxController" ], "responses": { "200": { "description": "Geocoding", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "search", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MapboxController.findGeoCoding" } }, "/geocoding": { "post": { "x-controller-name": "MapboxController", "x-operation-name": "geocoding", "tags": [ "MapboxController" ], "responses": { "200": { "description": "Geocoding", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "search" ], "properties": { "search": { "type": "string", "description": "search" } } } } }, "description": "Request body for geocoding", "required": true }, "operationId": "MapboxController.geocoding" } }, "/incoterms/{id}": { "patch": { "x-controller-name": "IncotermController", "x-operation-name": "updateById", "tags": [ "IncotermController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Incoterm PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Incoterm name" }, "code": { "type": "string", "description": "" } } } } }, "description": "Request body for Incoterm save", "required": true, "x-parameter-index": 1 }, "operationId": "IncotermController.updateById" }, "get": { "x-controller-name": "IncotermController", "x-operation-name": "findById", "tags": [ "IncotermController" ], "responses": { "200": { "description": "IncotermResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncotermResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "IncotermController.findById" }, "delete": { "x-controller-name": "IncotermController", "x-operation-name": "deleteById", "tags": [ "IncotermController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Incoterm DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "IncotermController.deleteById" } }, "/incoterms": { "post": { "x-controller-name": "IncotermController", "x-operation-name": "create", "tags": [ "IncotermController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Incoterm name" }, "code": { "type": "string", "description": "" } } } } }, "description": "Request body for Incoterm save", "required": true }, "operationId": "IncotermController.create" }, "get": { "x-controller-name": "IncotermController", "x-operation-name": "find", "tags": [ "IncotermController" ], "responses": { "200": { "description": "IncotermsResponse", "content": { "application/json": { "schema": { "type": "array", "title": "IncotermsResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "operationId": "IncotermController.find" } }, "/locationtypes/{id}": { "patch": { "x-controller-name": "LocationtypeController", "x-operation-name": "updateById", "tags": [ "LocationtypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Locationtype PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Locationtype name" } } } } }, "description": "Request body for Locationtype save", "required": true, "x-parameter-index": 1 }, "operationId": "LocationtypeController.updateById" }, "get": { "x-controller-name": "LocationtypeController", "x-operation-name": "findById", "tags": [ "LocationtypeController" ], "responses": { "200": { "description": "LocationtypeResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationtypeResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LocationtypeController.findById" }, "delete": { "x-controller-name": "LocationtypeController", "x-operation-name": "deleteById", "tags": [ "LocationtypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Locationtype DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LocationtypeController.deleteById" } }, "/locationtypes": { "post": { "x-controller-name": "LocationtypeController", "x-operation-name": "create", "tags": [ "LocationtypeController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Locationtype name" } } } } }, "description": "Request body for Locationtype save", "required": true }, "operationId": "LocationtypeController.create" }, "get": { "x-controller-name": "LocationtypeController", "x-operation-name": "find", "tags": [ "LocationtypeController" ], "responses": { "200": { "description": "LocationtypesResponse", "content": { "application/json": { "schema": { "type": "array", "title": "LocationtypesResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "operationId": "LocationtypeController.find" } }, "/mail/send": { "post": { "x-controller-name": "UtilController", "x-operation-name": "sendMail", "tags": [ "UtilController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Send mail" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "emailRecipients": { "type": "string", "description": "emailRecipients" }, "cc": { "type": "string", "description": "" }, "emailSubject": { "type": "string", "description": "" }, "emailBody": { "type": "string", "description": "" }, "attachment": { "type": "string", "description": "" }, "documenttypes": { "type": "array", "items": { "type": "number" }, "description": "" } } } } }, "description": "Request body for mail", "required": true }, "operationId": "UtilController.sendMail" } }, "/packagetypes/{id}": { "patch": { "x-controller-name": "PackagetypeController", "x-operation-name": "updateById", "tags": [ "PackagetypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Packagetype PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Packagetype name" } } } } }, "description": "Request body for Packagetype save", "required": true, "x-parameter-index": 1 }, "operationId": "PackagetypeController.updateById" }, "get": { "x-controller-name": "PackagetypeController", "x-operation-name": "findById", "tags": [ "PackagetypeController" ], "responses": { "200": { "description": "PackagetypeResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackagetypeResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PackagetypeController.findById" }, "delete": { "x-controller-name": "PackagetypeController", "x-operation-name": "deleteById", "tags": [ "PackagetypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Packagetype DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PackagetypeController.deleteById" } }, "/packagetypes": { "post": { "x-controller-name": "PackagetypeController", "x-operation-name": "create", "tags": [ "PackagetypeController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Packagetype name" } } } } }, "description": "Request body for Packagetype save", "required": true }, "operationId": "PackagetypeController.create" }, "get": { "x-controller-name": "PackagetypeController", "x-operation-name": "find", "tags": [ "PackagetypeController" ], "responses": { "200": { "description": "PackagetypesResponse", "content": { "application/json": { "schema": { "type": "array", "title": "PackagetypesResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "operationId": "PackagetypeController.find" } }, "/ping": { "get": { "x-controller-name": "PingController", "x-operation-name": "ping", "tags": [ "PingController" ], "responses": { "200": { "description": "Ping Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PingResponse" } } } } }, "operationId": "PingController.ping" } }, "/roles/{id}": { "patch": { "x-controller-name": "RoleController", "x-operation-name": "updateById", "tags": [ "RoleController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Role PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Role name" } } } } }, "description": "Request body for Role save", "required": true, "x-parameter-index": 1 }, "operationId": "RoleController.updateById" }, "get": { "x-controller-name": "RoleController", "x-operation-name": "findById", "tags": [ "RoleController" ], "responses": { "200": { "description": "RoleResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RoleController.findById" }, "delete": { "x-controller-name": "RoleController", "x-operation-name": "deleteById", "tags": [ "RoleController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Role DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RoleController.deleteById" } }, "/roles": { "post": { "x-controller-name": "RoleController", "x-operation-name": "create", "tags": [ "RoleController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Role name" } } } } }, "description": "Request body for Role save", "required": true }, "operationId": "RoleController.create" }, "get": { "x-controller-name": "RoleController", "x-operation-name": "find", "tags": [ "RoleController" ], "responses": { "200": { "description": "RolesResponse", "content": { "application/json": { "schema": { "type": "array", "title": "RolesResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "operationId": "RoleController.find" } }, "/seaports/{id}": { "patch": { "x-controller-name": "SeaportController", "x-operation-name": "updateById", "tags": [ "SeaportController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Seaport PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Seaport name" }, "code": { "type": "string", "description": "" }, "location": { "type": "string", "description": "" } } } } }, "description": "Request body for Seaport save", "required": true, "x-parameter-index": 1 }, "operationId": "SeaportController.updateById" }, "get": { "x-controller-name": "SeaportController", "x-operation-name": "findById", "tags": [ "SeaportController" ], "responses": { "200": { "description": "SeaportResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeaportResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SeaportController.findById" }, "delete": { "x-controller-name": "SeaportController", "x-operation-name": "deleteById", "tags": [ "SeaportController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Seaport DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SeaportController.deleteById" } }, "/seaports": { "post": { "x-controller-name": "SeaportController", "x-operation-name": "create", "tags": [ "SeaportController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Seaport name" }, "code": { "type": "string", "description": "" }, "location": { "type": "string", "description": "" } } } } }, "description": "Request body for Seaport save", "required": true }, "operationId": "SeaportController.create" }, "get": { "x-controller-name": "SeaportController", "x-operation-name": "find", "tags": [ "SeaportController" ], "responses": { "200": { "description": "SeaportsResponse", "content": { "application/json": { "schema": { "type": "array", "title": "SeaportsResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "location": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "parameters": [ { "name": "searchStr", "in": "query", "schema": { "type": "string" } } ], "operationId": "SeaportController.find" } }, "/shipmentmodes/{id}": { "patch": { "x-controller-name": "ShipmentmodeController", "x-operation-name": "updateById", "tags": [ "ShipmentmodeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipmentmode PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Shipmentmode name" } } } } }, "description": "Request body for Shipmentmode save", "required": true, "x-parameter-index": 1 }, "operationId": "ShipmentmodeController.updateById" }, "get": { "x-controller-name": "ShipmentmodeController", "x-operation-name": "findById", "tags": [ "ShipmentmodeController" ], "responses": { "200": { "description": "ShipmentmodeResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentmodeResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentmodeController.findById" }, "delete": { "x-controller-name": "ShipmentmodeController", "x-operation-name": "deleteById", "tags": [ "ShipmentmodeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipmentmode DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentmodeController.deleteById" } }, "/shipmentmodes": { "post": { "x-controller-name": "ShipmentmodeController", "x-operation-name": "create", "tags": [ "ShipmentmodeController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Shipmentmode name" } } } } }, "description": "Request body for Shipmentmode save", "required": true }, "operationId": "ShipmentmodeController.create" }, "get": { "x-controller-name": "ShipmentmodeController", "x-operation-name": "find", "tags": [ "ShipmentmodeController" ], "responses": { "200": { "description": "ShipmentmodesResponse", "content": { "application/json": { "schema": { "type": "array", "title": "ShipmentmodesResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "operationId": "ShipmentmodeController.find" } }, "/shippinglines/{id}": { "patch": { "x-controller-name": "ShippinglineController", "x-operation-name": "updateById", "tags": [ "ShippinglineController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipping line PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Shippingline name" }, "code": { "type": "string", "description": "" }, "location": { "type": "string", "description": "" } } } } }, "description": "Request body for Shippingline save", "required": true, "x-parameter-index": 1 }, "operationId": "ShippinglineController.updateById" }, "get": { "x-controller-name": "ShippinglineController", "x-operation-name": "findById", "tags": [ "ShippinglineController" ], "responses": { "200": { "description": "ShippinglineResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippinglineResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShippinglineController.findById" }, "delete": { "x-controller-name": "ShippinglineController", "x-operation-name": "deleteById", "tags": [ "ShippinglineController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipping line DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShippinglineController.deleteById" } }, "/shippinglines": { "post": { "x-controller-name": "ShippinglineController", "x-operation-name": "create", "tags": [ "ShippinglineController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Shippingline name" }, "code": { "type": "string", "description": "" }, "location": { "type": "string", "description": "" } } } } }, "description": "Request body for Shippingline save", "required": true }, "operationId": "ShippinglineController.create" }, "get": { "x-controller-name": "ShippinglineController", "x-operation-name": "find", "tags": [ "ShippinglineController" ], "responses": { "200": { "description": "ShippinglinesResponse", "content": { "application/json": { "schema": { "type": "array", "title": "ShippinglinesResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "location": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "operationId": "ShippinglineController.find" } }, "/stats/bookings/total": { "get": { "x-controller-name": "StatsController", "x-operation-name": "totalBookings", "tags": [ "StatsController" ], "responses": { "200": { "description": "Array of Booking model instances", "content": { "application/json": { "schema": { "type": "array" } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "StatsController.totalBookings" } }, "/stats/bookings": { "get": { "x-controller-name": "StatsController", "x-operation-name": "bookings", "tags": [ "StatsController" ], "responses": { "200": { "description": "Array of Booking model instances", "content": { "application/json": { "schema": { "type": "array" } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "StatsController.bookings" } }, "/stats/port-performance": { "get": { "x-controller-name": "StatsController", "x-operation-name": "portPerformance", "tags": [ "StatsController" ], "responses": { "200": { "description": "Array of Booking model instances", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "StatsController.portPerformance" } }, "/stats/salesmanager-bookings": { "get": { "x-controller-name": "StatsController", "x-operation-name": "salesManagerBookings", "tags": [ "StatsController" ], "responses": { "200": { "description": "Array of Booking model instances", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "StatsController.salesManagerBookings" } }, "/tracking/cmacgm/equipments/{eqpId}": { "get": { "x-controller-name": "TrackingController", "x-operation-name": "trackByEqpId", "tags": [ "TrackingController" ], "responses": { "200": { "description": "Booking tracking", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "eqpId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TrackingController.trackByEqpId" } }, "/tracking/cmacgm/shipments/{shipmentRef}/equipments/{eqpId}": { "get": { "x-controller-name": "TrackingController", "x-operation-name": "trackByShipmentRefAndEqpId", "tags": [ "TrackingController" ], "responses": { "200": { "description": "Booking tracking", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "shipmentRef", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "eqpId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TrackingController.trackByShipmentRefAndEqpId" } }, "/tracking/cmacgm/shipments/{shipmentRef}": { "get": { "x-controller-name": "TrackingController", "x-operation-name": "trackByShipmentRef", "tags": [ "TrackingController" ], "responses": { "200": { "description": "Booking tracking", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "shipmentRef", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TrackingController.trackByShipmentRef" } }, "/tracking/cmacgm/track-and-trace": { "post": { "x-controller-name": "TrackingController", "x-operation-name": "cmacgmTrackAndTrace", "tags": [ "TrackingController" ], "responses": { "200": { "description": "Booking tracking", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "shipmentRef": { "type": "string", "description": "shipmentRef" }, "eqpId": { "type": "string", "description": "" } } } } }, "description": "Request body for Cmacgm tracking", "required": true }, "operationId": "TrackingController.cmacgmTrackAndTrace" } }, "/tracking/msc/track-and-trace": { "post": { "x-controller-name": "TrackingController", "x-operation-name": "mscTrackAndTrace", "tags": [ "TrackingController" ], "responses": { "200": { "description": "Booking tracking", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "billOfLadingNumber": { "type": "string", "description": "billOfLadingNumber" }, "bookingReference": { "type": "string", "description": "" }, "equipmentReference": { "type": "string", "description": "" }, "mscAccessToken": { "type": "string", "description": "" } } } } }, "description": "Request body for Msc tracking", "required": true }, "operationId": "TrackingController.mscTrackAndTrace" } }, "/tracking/protconnect/container-visits": { "get": { "x-controller-name": "TrackingController", "x-operation-name": "portConnectContainerVisitSearch", "tags": [ "TrackingController" ], "responses": { "200": { "description": "Booking tracking", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "containerNumber", "in": "query", "schema": { "type": "string" } }, { "name": "needUpdate", "in": "query", "schema": { "type": "number" } } ], "operationId": "TrackingController.portConnectContainerVisitSearch" } }, "/tracking/searates/track-and-trace": { "post": { "x-controller-name": "TrackingController", "x-operation-name": "searatesTrackAndTrace", "tags": [ "TrackingController" ], "responses": { "200": { "description": "Booking tracking", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "type": { "type": "string", "description": "type" }, "number": { "type": "string", "description": "" }, "sealine": { "type": "string", "description": "" } } } } }, "description": "Request body for Searates tracking", "required": true }, "operationId": "TrackingController.searatesTrackAndTrace" } }, "/tracking/track-and-trace": { "post": { "x-controller-name": "TrackingController", "x-operation-name": "trackAndTrace", "tags": [ "TrackingController" ], "responses": { "200": { "description": "Booking tracking", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "transportDocumentReference": { "type": "string", "description": "" }, "eventType": { "type": "string", "description": "" }, "equipmentReference": { "type": "string", "description": "" } } } } }, "description": "Request body for mearsk tracking", "required": true }, "operationId": "TrackingController.trackAndTrace" } }, "/tracking": { "post": { "x-controller-name": "TrackingController", "x-operation-name": "tracking", "tags": [ "TrackingController" ], "responses": { "200": { "description": "Booking tracking", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "bookingNumber": { "type": "string", "description": "bookingNumber" }, "billOfLadingNumber": { "type": "string", "description": "billOfLadingNumber" }, "cntrNumber": { "type": "string", "description": "cntrNumber" } } } } }, "description": "Request body for cosco tracking", "required": true }, "operationId": "TrackingController.tracking" } }, "/users/change-password": { "patch": { "x-controller-name": "UserController", "x-operation-name": "changePassword", "tags": [ "UserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Change status success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "password", "confirmPassword" ], "properties": { "password": { "type": "string", "description": "Password for authentication. Must be atleast 8 character and maximum 16 character.", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Password must be atleast 8 character and maximum 16 character." } }, "confirmPassword": { "type": "string", "description": "Re enter password", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Please re enter password." } } } } } }, "description": "Change password request body", "required": true }, "operationId": "UserController.changePassword" } }, "/users/change-role": { "patch": { "x-controller-name": "UserController", "x-operation-name": "changeRole", "tags": [ "UserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Change role success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "roleId" ], "properties": { "id": { "type": "number" }, "roleId": { "type": "number", "description": "Role of the user. Possible values are 2 = Sales Manager,3 = Sales Support Executive,4 = Ops Staff" } } } } }, "description": "Change role request body", "required": true }, "operationId": "UserController.changeRole" } }, "/users/change-status": { "patch": { "x-controller-name": "UserController", "x-operation-name": "changeStatus", "tags": [ "UserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Change status success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "status" ], "properties": { "id": { "type": "number" }, "status": { "type": "number", "description": " Possible values are 0 = Deactive, 1 = Active,2 = Delete" } } } } }, "description": "Change status request body", "required": true }, "operationId": "UserController.changeStatus" } }, "/users/forms/{formNo}": { "get": { "x-controller-name": "UserController", "x-operation-name": "getUsersByForm", "tags": [ "UserController" ], "responses": { "200": { "description": "UsersResponse", "content": { "application/json": { "schema": { "type": "array", "title": "UsersResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "roleId": { "type": "number" }, "branchId": { "type": "number" }, "status": { "type": "number" }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "branch": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } } } } } }, "parameters": [ { "name": "formNo", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "UserController.getUsersByForm" } }, "/users/identity/{id}": { "get": { "x-controller-name": "UserController", "x-operation-name": "getUser", "tags": [ "UserController" ], "responses": { "200": { "description": "UsersResponse", "content": { "application/json": { "schema": { "type": "array", "title": "UsersResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "roleId": { "type": "number" }, "branchId": { "type": "number" }, "status": { "type": "number" }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "branch": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "UserController.getUser" } }, "/users/initiate-ms-auth": { "get": { "x-controller-name": "UserController", "x-operation-name": "initiateMsAuth", "tags": [ "UserController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "authLink": { "type": "string" } } } } } } }, "operationId": "UserController.initiateMsAuth" } }, "/users/login": { "post": { "x-controller-name": "UserController", "x-operation-name": "login", "tags": [ "UserController" ], "responses": { "200": { "description": "LoginResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 8 } } } } }, "description": "The input of login function", "required": true }, "operationId": "UserController.login" } }, "/users/me": { "get": { "x-controller-name": "UserController", "x-operation-name": "me", "tags": [ "UserController" ], "responses": { "200": { "description": "UserResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } } } }, "operationId": "UserController.me" } }, "/users/ms/login": { "post": { "x-controller-name": "UserController", "x-operation-name": "MSLogin", "tags": [ "UserController" ], "responses": { "200": { "description": "MSLoginResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MSLoginResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string" } } } } }, "description": "The input of login function", "required": true }, "operationId": "UserController.MSLogin" } }, "/users/registration": { "post": { "x-controller-name": "UserController", "x-operation-name": "registration", "tags": [ "UserController" ], "responses": { "200": { "description": "RegistrationResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "firstName", "lastName", "email", "password", "confirmPassword", "roleId", "branchIds" ], "properties": { "firstName": { "type": "string", "description": "User first name." }, "lastName": { "type": "string", "description": "User last name." }, "email": { "type": "string", "description": "Email address for a user.", "jsonSchema": { "format": "email", "transform": [ "toLowerCase" ], "errorMessage": "Email should be valid." } }, "password": { "type": "string", "description": "Password for authentication. Must be atleast 8 character and maximum 16 character.", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Password must be atleast 8 character and maximum 16 character." } }, "confirmPassword": { "type": "string", "description": "Re enter password", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Please re enter password." } }, "roleId": { "type": "number", "description": "Role of the user. Possible values are 2 = Sales Manager,3 = Sales Support Executive,4 = Ops Staff" }, "branchIds": { "type": "array", "items": { "type": "number" }, "description": "Branch of the user. Possible values are 1 = New Zealand,2 = Australia,3 = Fiji" }, "assignedForms": { "type": "array", "items": { "type": "number" }, "description": "Branch of the user. Possible values are 1 = Personal Effects,2 = Sea Freight,3 = Airfreight" } } } } }, "description": "User registration request body", "required": true }, "operationId": "UserController.registration" } }, "/users/roles/{roleId}": { "get": { "x-controller-name": "UserController", "x-operation-name": "findRoleWiseUsers", "tags": [ "UserController" ], "responses": { "200": { "description": "UsersResponse", "content": { "application/json": { "schema": { "type": "array", "title": "UsersResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "roleId": { "type": "number" }, "branchId": { "type": "number" }, "status": { "type": "number" }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "branch": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } } } } } }, "parameters": [ { "name": "roleId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "UserController.findRoleWiseUsers" } }, "/users/roles": { "get": { "x-controller-name": "UserController", "x-operation-name": "findRolesUsers", "tags": [ "UserController" ], "responses": { "200": { "description": "UsersResponse", "content": { "application/json": { "schema": { "type": "array", "title": "UsersResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "roleId": { "type": "number" }, "branchId": { "type": "number" }, "status": { "type": "number" }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "branch": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } } } } } }, "parameters": [ { "name": "roleId", "in": "query", "schema": { "type": "string" } } ], "operationId": "UserController.findRolesUsers" } }, "/users/{id}/change-password": { "patch": { "x-controller-name": "UserController", "x-operation-name": "changeUserPassword", "tags": [ "UserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Change status success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "password", "confirmPassword" ], "properties": { "password": { "type": "string", "description": "Password for authentication. Must be atleast 8 character and maximum 16 character.", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Password must be atleast 8 character and maximum 16 character." } }, "confirmPassword": { "type": "string", "description": "Re enter password", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Please re enter password." } } } } } }, "description": "Change password request body", "required": true, "x-parameter-index": 1 }, "operationId": "UserController.changeUserPassword" } }, "/users/{id}": { "patch": { "x-controller-name": "UserController", "x-operation-name": "updateById", "tags": [ "UserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Users PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "firstName", "lastName", "roleId", "branchIds" ], "properties": { "firstName": { "type": "string", "description": "User first name." }, "lastName": { "type": "string", "description": "User last name." }, "roleId": { "type": "number", "description": "Role of the user. Possible values are 2 = Sales Manager,3 = Sales Support Executive,4 = Ops Staff" }, "branchIds": { "type": "array", "items": { "type": "number" }, "description": "Branch of the user. Possible values are 1 = New Zealand,2 = Australia,3 = Fiji" } } } } }, "description": "Request body for basic details update", "required": true, "x-parameter-index": 1 }, "operationId": "UserController.updateById" }, "get": { "x-controller-name": "UserController", "x-operation-name": "findById", "tags": [ "UserController" ], "responses": { "200": { "description": "UserResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "UserController.findById" } }, "/users": { "get": { "x-controller-name": "UserController", "x-operation-name": "find", "tags": [ "UserController" ], "responses": { "200": { "description": "UsersResponse", "content": { "application/json": { "schema": { "type": "array", "title": "UsersResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "roleId": { "type": "number" }, "branchId": { "type": "number" }, "status": { "type": "number" }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "branch": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } } } } } }, "operationId": "UserController.find" } } }, "servers": [ { "url": "https://ubbookings.techkopra.com" } ], "components": { "schemas": { "CargotypeWithRelations": { "title": "CargotypeWithRelations", "type": "object", "description": "(tsType: CargotypeWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "cargoloads": { "type": "array", "items": { "$ref": "#/components/schemas/CargoloadWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "CargotypeWithRelations" }, "RoleWithRelations": { "title": "RoleWithRelations", "type": "object", "description": "(tsType: RoleWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "RoleWithRelations" }, "UserbranchWithRelations": { "title": "UserbranchWithRelations", "type": "object", "description": "(tsType: UserbranchWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "userId": { "type": "number" }, "branchId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "branch": { "$ref": "#/components/schemas/BranchWithRelations" } }, "additionalProperties": false, "x-typescript-type": "UserbranchWithRelations" }, "UserformWithRelations": { "title": "UserformWithRelations", "type": "object", "description": "(tsType: UserformWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "formNo": { "type": "number" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "userId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserWithRelations" } }, "additionalProperties": false, "x-typescript-type": "UserformWithRelations" }, "UserWithRelations": { "title": "UserWithRelations", "type": "object", "description": "(tsType: UserWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "email": { "type": "string" }, "password": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "signupType": { "type": "number" }, "verificationToken": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "roleId": { "type": "number" }, "branchId": { "type": "number" }, "role": { "$ref": "#/components/schemas/RoleWithRelations" }, "branch": { "$ref": "#/components/schemas/BranchWithRelations" }, "salesexecutivebookings": { "type": "array", "items": { "$ref": "#/components/schemas/BookingWithRelations" } }, "creatorbookings": { "type": "array", "items": { "$ref": "#/components/schemas/BookingWithRelations" } }, "userbranches": { "type": "array", "items": { "$ref": "#/components/schemas/UserbranchWithRelations" } }, "userforms": { "type": "array", "items": { "$ref": "#/components/schemas/UserformWithRelations" } } }, "required": [ "password" ], "additionalProperties": false, "x-typescript-type": "UserWithRelations" }, "AddressWithRelations": { "title": "AddressWithRelations", "type": "object", "description": "(tsType: AddressWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "lineOne": { "type": "string" }, "lineTwo": { "type": "string" }, "city": { "type": "string" }, "cityUnCode": { "type": "string" }, "pincode": { "type": "number" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "customer": { "$ref": "#/components/schemas/CustomerWithRelations" }, "contact": { "$ref": "#/components/schemas/ContactWithRelations" } }, "additionalProperties": false, "x-typescript-type": "AddressWithRelations" }, "ContactWithRelations": { "title": "ContactWithRelations", "type": "object", "description": "(tsType: ContactWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "notes": { "type": "string" }, "contactType": { "type": "number" }, "designation": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "customerId": { "type": "number" }, "addressId": { "type": "number" }, "customer": { "$ref": "#/components/schemas/CustomerWithRelations" }, "address": { "$ref": "#/components/schemas/AddressWithRelations" } }, "additionalProperties": false, "x-typescript-type": "ContactWithRelations" }, "BranchWithRelations": { "title": "BranchWithRelations", "type": "object", "description": "(tsType: BranchWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserWithRelations" } }, "userbranches": { "type": "array", "items": { "$ref": "#/components/schemas/UserbranchWithRelations" } }, "bookings": { "type": "array", "items": { "$ref": "#/components/schemas/BookingWithRelations" } }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "BranchWithRelations" }, "CustomerWithRelations": { "title": "CustomerWithRelations", "type": "object", "description": "(tsType: CustomerWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "companyName": { "type": "string" }, "phoneNumber": { "type": "string" }, "code": { "type": "string" }, "contactSegment": { "type": "number" }, "notes": { "type": "string" }, "document": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "addressId": { "type": "number" }, "branchId": { "type": "number" }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactWithRelations" } }, "address": { "$ref": "#/components/schemas/AddressWithRelations" }, "customerbookings": { "type": "array", "items": { "$ref": "#/components/schemas/BookingWithRelations" } }, "shipperbookings": { "type": "array", "items": { "$ref": "#/components/schemas/BookingWithRelations" } }, "consigneebookings": { "type": "array", "items": { "$ref": "#/components/schemas/BookingWithRelations" } }, "agentbookings": { "type": "array", "items": { "$ref": "#/components/schemas/BookingWithRelations" } }, "branch": { "$ref": "#/components/schemas/BranchWithRelations" } }, "additionalProperties": false, "x-typescript-type": "CustomerWithRelations" }, "IncotermWithRelations": { "title": "IncotermWithRelations", "type": "object", "description": "(tsType: IncotermWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "bookings": { "type": "array", "items": { "$ref": "#/components/schemas/BookingWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "IncotermWithRelations" }, "ShipmentmodeWithRelations": { "title": "ShipmentmodeWithRelations", "type": "object", "description": "(tsType: ShipmentmodeWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "bookings": { "type": "array", "items": { "$ref": "#/components/schemas/BookingWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "ShipmentmodeWithRelations" }, "ContainertypeWithRelations": { "title": "ContainertypeWithRelations", "type": "object", "description": "(tsType: ContainertypeWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "cargoloads": { "type": "array", "items": { "$ref": "#/components/schemas/CargoloadWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "ContainertypeWithRelations" }, "PackagetypeWithRelations": { "title": "PackagetypeWithRelations", "type": "object", "description": "(tsType: PackagetypeWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "cargoloads": { "type": "array", "items": { "$ref": "#/components/schemas/CargoloadWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "PackagetypeWithRelations" }, "CargoloadWithRelations": { "title": "CargoloadWithRelations", "type": "object", "description": "(tsType: CargoloadWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "cargoDescription": { "type": "string" }, "containerCount": { "type": "number" }, "weightUnit": { "type": "number" }, "weight": { "type": "number" }, "overWeight": { "type": "number" }, "quantity": { "type": "number" }, "perPackageWeight": { "type": "number" }, "totalWeight": { "type": "number" }, "lengthUnit": { "type": "number" }, "length": { "type": "number" }, "height": { "type": "number" }, "width": { "type": "number" }, "cbm": { "type": "number" }, "totalCbm": { "type": "number" }, "chargeableWeight": { "type": "number" }, "containerNumber": { "type": "string" }, "cargoType": { "type": "number" }, "cargotypeId": { "type": "number" }, "additionalInformation": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "commodity": { "type": "string" }, "goodsDescription": { "type": "string" }, "isDangerousGoods": { "type": "number" }, "unNumber": { "type": "string" }, "unClass": { "type": "string" }, "specialInstructions": { "type": "string" }, "bookingId": { "type": "number" }, "containertypeId": { "type": "number" }, "packagetypeId": { "type": "number" }, "cargotype": { "$ref": "#/components/schemas/CargotypeWithRelations" }, "booking": { "$ref": "#/components/schemas/BookingWithRelations" }, "containertype": { "$ref": "#/components/schemas/ContainertypeWithRelations" }, "packagetype": { "$ref": "#/components/schemas/PackagetypeWithRelations" } }, "additionalProperties": false, "x-typescript-type": "CargoloadWithRelations" }, "SeaportWithRelations": { "title": "SeaportWithRelations", "type": "object", "description": "(tsType: SeaportWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "location": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "bookingorigins": { "type": "array", "items": { "$ref": "#/components/schemas/BookingoriginWithRelations" } }, "bookingdestinations": { "type": "array", "items": { "$ref": "#/components/schemas/BookingdestinationWithRelations" } }, "bookingroutedetails": { "type": "array", "items": { "$ref": "#/components/schemas/BookingroutedetailWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "SeaportWithRelations" }, "BookingroutedetailWithRelations": { "title": "BookingroutedetailWithRelations", "type": "object", "description": "(tsType: BookingroutedetailWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "eta": { "type": "string" }, "etd": { "type": "string" }, "vessel": { "type": "string" }, "voyage": { "type": "string" }, "carrier": { "type": "string" }, "flightNumber": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "bookingId": { "type": "number" }, "airportId": { "type": "number" }, "seaportId": { "type": "number" }, "booking": { "$ref": "#/components/schemas/BookingWithRelations" }, "airport": { "$ref": "#/components/schemas/AirportWithRelations" }, "seaport": { "$ref": "#/components/schemas/SeaportWithRelations" } }, "additionalProperties": false, "x-typescript-type": "BookingroutedetailWithRelations" }, "AirportWithRelations": { "title": "AirportWithRelations", "type": "object", "description": "(tsType: AirportWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "location": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "bookingorigins": { "type": "array", "items": { "$ref": "#/components/schemas/BookingoriginWithRelations" } }, "bookingdestinations": { "type": "array", "items": { "$ref": "#/components/schemas/BookingdestinationWithRelations" } }, "bookingroutedetails": { "type": "array", "items": { "$ref": "#/components/schemas/BookingroutedetailWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "AirportWithRelations" }, "BookingdestinationWithRelations": { "title": "BookingdestinationWithRelations", "type": "object", "description": "(tsType: BookingdestinationWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "location": { "type": "string" }, "pincode": { "type": "number" }, "address": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "bookingId": { "type": "number" }, "locationtypeId": { "type": "number" }, "airportId": { "type": "number" }, "seaportId": { "type": "number" }, "booking": { "$ref": "#/components/schemas/BookingWithRelations" }, "locationtype": { "$ref": "#/components/schemas/LocationtypeWithRelations" }, "airport": { "$ref": "#/components/schemas/AirportWithRelations" }, "seaport": { "$ref": "#/components/schemas/SeaportWithRelations" } }, "additionalProperties": false, "x-typescript-type": "BookingdestinationWithRelations" }, "LocationtypeWithRelations": { "title": "LocationtypeWithRelations", "type": "object", "description": "(tsType: LocationtypeWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "bookingorigins": { "type": "array", "items": { "$ref": "#/components/schemas/BookingoriginWithRelations" } }, "bookingdestinations": { "type": "array", "items": { "$ref": "#/components/schemas/BookingdestinationWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "LocationtypeWithRelations" }, "BookingoriginWithRelations": { "title": "BookingoriginWithRelations", "type": "object", "description": "(tsType: BookingoriginWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "pickupDate": { "type": "string" }, "readyDate": { "type": "string" }, "location": { "type": "string" }, "pincode": { "type": "number" }, "address": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "bookingId": { "type": "number" }, "locationtypeId": { "type": "number" }, "airportId": { "type": "number" }, "seaportId": { "type": "number" }, "booking": { "$ref": "#/components/schemas/BookingWithRelations" }, "locationtype": { "$ref": "#/components/schemas/LocationtypeWithRelations" }, "airport": { "$ref": "#/components/schemas/AirportWithRelations" }, "seaport": { "$ref": "#/components/schemas/SeaportWithRelations" } }, "additionalProperties": false, "x-typescript-type": "BookingoriginWithRelations" }, "CargoextrainfoWithRelations": { "title": "CargoextrainfoWithRelations", "type": "object", "description": "(tsType: CargoextrainfoWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "eta": { "type": "string" }, "etd": { "type": "string" }, "vessel": { "type": "string" }, "voyage": { "type": "string" }, "containerNumber": { "type": "string" }, "mblNumber": { "type": "string" }, "awbNumber": { "type": "string" }, "insurance": { "type": "number" }, "quoteNumber": { "type": "string" }, "freightJobNumber": { "type": "string" }, "internalNote": { "type": "string" }, "externalNote": { "type": "string" }, "freehand": { "type": "number" }, "hblNumber": { "type": "string" }, "coLoader": { "type": "string" }, "flightNumber": { "type": "string" }, "created": { "type": "number" }, "updated": { "type": "number" }, "carrierReference": { "type": "string" }, "bookingId": { "type": "number" }, "booking": { "$ref": "#/components/schemas/BookingWithRelations" } }, "additionalProperties": false, "x-typescript-type": "CargoextrainfoWithRelations" }, "CargofileWithRelations": { "title": "CargofileWithRelations", "type": "object", "description": "(tsType: CargofileWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "fileName": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "bookingId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "CargofileWithRelations" }, "CommercialinvoiceWithRelations": { "title": "CommercialinvoiceWithRelations", "type": "object", "description": "(tsType: CommercialinvoiceWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "partNo": { "type": "string" }, "description": { "type": "string" }, "lookUp": { "type": "string" }, "tariff": { "type": "string" }, "quantity": { "type": "number" }, "value": { "type": "number" }, "countryOfOrigin": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "bookingId": { "type": "number" }, "booking": { "$ref": "#/components/schemas/BookingWithRelations" } }, "additionalProperties": false, "x-typescript-type": "CommercialinvoiceWithRelations" }, "BookingrouteWithRelations": { "title": "BookingrouteWithRelations", "type": "object", "description": "(tsType: BookingrouteWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "pickupAddress": { "type": "string" }, "deliveryAddress": { "type": "string" }, "receivingDepot": { "type": "string" }, "deliveryDepot": { "type": "string" }, "cargoReadyBy": { "type": "string" }, "estimatedDelivery": { "type": "string" }, "cutoff": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" }, "bookingId": { "type": "number" }, "booking": { "$ref": "#/components/schemas/BookingWithRelations" } }, "additionalProperties": false, "x-typescript-type": "BookingrouteWithRelations" }, "BookingWithRelations": { "title": "BookingWithRelations", "type": "object", "description": "(tsType: BookingWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "uniqueId": { "type": "string" }, "customerPo": { "type": "string" }, "consigneePo": { "type": "string" }, "carrier": { "type": "string" }, "status": { "type": "number" }, "statusText": { "type": "string" }, "billNo": { "type": "string" }, "created": { "type": "number" }, "updated": { "type": "number" }, "customerIsShipper": { "type": "number" }, "customerIsConsignee": { "type": "number" }, "customerId": { "type": "number" }, "shipperId": { "type": "number" }, "consigneeId": { "type": "number" }, "salesexecutiveId": { "type": "number" }, "incotermId": { "type": "number" }, "shipmentmodeId": { "type": "number" }, "agentId": { "type": "number" }, "createdBy": { "type": "number" }, "branchId": { "type": "number" }, "customer": { "$ref": "#/components/schemas/CustomerWithRelations" }, "shipper": { "$ref": "#/components/schemas/CustomerWithRelations" }, "consignee": { "$ref": "#/components/schemas/CustomerWithRelations" }, "salesexecutive": { "$ref": "#/components/schemas/UserWithRelations" }, "incoterm": { "$ref": "#/components/schemas/IncotermWithRelations" }, "shipmentmode": { "$ref": "#/components/schemas/ShipmentmodeWithRelations" }, "agent": { "$ref": "#/components/schemas/CustomerWithRelations" }, "cargoloads": { "type": "array", "items": { "$ref": "#/components/schemas/CargoloadWithRelations" } }, "bookingorigin": { "$ref": "#/components/schemas/BookingoriginWithRelations" }, "bookingdestination": { "$ref": "#/components/schemas/BookingdestinationWithRelations" }, "cargoextrainfo": { "$ref": "#/components/schemas/CargoextrainfoWithRelations" }, "cargofiles": { "type": "array", "items": { "$ref": "#/components/schemas/CargofileWithRelations" } }, "creator": { "$ref": "#/components/schemas/UserWithRelations" }, "branch": { "$ref": "#/components/schemas/BranchWithRelations" }, "commercialinvoices": { "type": "array", "items": { "$ref": "#/components/schemas/CommercialinvoiceWithRelations" } }, "bookingroute": { "$ref": "#/components/schemas/BookingrouteWithRelations" }, "bookingroutedetails": { "type": "array", "items": { "$ref": "#/components/schemas/BookingroutedetailWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "BookingWithRelations" }, "AirlineResponse": { "type": "object", "title": "AirlineResponse", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "location": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "AirportResponse": { "type": "object", "title": "AirportResponse", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "location": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "BranchResponse": { "type": "object", "title": "BranchResponse", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "ContainertypeResponse": { "type": "object", "title": "ContainertypeResponse", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "CustomerResponse": { "type": "object", "title": "CustomerResponse", "properties": { "id": { "type": "number" }, "companyName": { "type": "string" }, "phoneNumber": { "type": "string" }, "code": { "type": "string" }, "contactSegment": { "type": "number" }, "notes": { "type": "string" }, "document": { "type": "string" }, "documentSrc": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "IncotermResponse": { "type": "object", "title": "IncotermResponse", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "LocationtypeResponse": { "type": "object", "title": "LocationtypeResponse", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "PackagetypeResponse": { "type": "object", "title": "PackagetypeResponse", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "PingResponse": { "type": "object", "title": "PingResponse", "properties": { "greeting": { "type": "string" }, "date": { "type": "string" }, "url": { "type": "string" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } }, "additionalProperties": true } } }, "RoleResponse": { "type": "object", "title": "RoleResponse", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "SeaportResponse": { "type": "object", "title": "SeaportResponse", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "location": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "ShipmentmodeResponse": { "type": "object", "title": "ShipmentmodeResponse", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "ShippinglineResponse": { "type": "object", "title": "ShippinglineResponse", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "location": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "LoginResponse": { "type": "object", "title": "LoginResponse", "properties": { "token": { "type": "string" } } }, "UserResponse": { "type": "object", "title": "UserResponse", "properties": { "id": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "roleId": { "type": "number" }, "branchId": { "type": "number" }, "status": { "type": "number" }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "branch": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } }, "MSLoginResponse": { "type": "object", "title": "MSLoginResponse", "properties": { "token": { "type": "string" }, "mscAccessToken": { "type": "string" } } }, "RegistrationResponse": { "type": "object", "title": "RegistrationResponse", "properties": { "message": { "type": "string" } } } }, "securitySchemes": { "jwt": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [] }