diff --git a/src/v2/tpms.yaml b/src/v2/tpms.yaml index 938595d..a97fdd1 100644 --- a/src/v2/tpms.yaml +++ b/src/v2/tpms.yaml @@ -1,12 +1,30 @@ openapi: 3.0.0 info: title: "TyrePro-API, TPMS" - version: "Version 3" + version: "Version 4" servers: - url: "https://musterreifen.com/api/tpms" description: "Development server" paths: - /Customers/{Guid}: + # Referenced Resources + /Storages: + get: + tags: + - "Referenced Resources" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + type: "array" + items: + $ref: "#/components/schemas/Storage" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + /Storages/{Guid}: get: tags: - "Referenced Resources" @@ -18,42 +36,82 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/Customer" + $ref: "#/components/schemas/Storage" default: $ref: "#/components/responses/GenericError" security: - SessionScheme: [] - /CustomerStorages: + /Storages/{Guid}/StorageLocations: get: tags: - - "Customer storages" + - "Referenced Resources" parameters: - - $ref: "#/components/parameters/OffsetParameter" - - $ref: "#/components/parameters/LimitParameter" - - $ref: "#/components/parameters/SearchTermParameter" - - $ref: "#/components/parameters/IsActiveParameter" + - $ref: "#/components/parameters/GuidPathParameter" + - $ref: "#/components/parameters/OnlyWithAvailableCapacityParameter" responses: 200: description: "successful operation" - headers: - TotalNumberOfEntries: - schema: - type: integer - description: The total number of results of this operation. Please be aware that this number could be wrong if the parameter SearchTerm is used, due to processing the SearchTerm over the acutal result array. content: application/json: schema: type: "array" items: - $ref: "#/components/schemas/CustomerStorage" + $ref: "#/components/schemas/StorageLocation" default: $ref: "#/components/responses/GenericError" security: - SessionScheme: [] + /StorageLocations/{Guid}: + get: + tags: + - "Referenced Resources" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + - $ref: "#/components/parameters/OnlyWithAvailableCapacityParameter" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + $ref: "#/components/schemas/StorageLocation" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + + # Search + /Search: + get: + tags: + - "Search" + parameters: + - name: "SearchTerm" + description: "During the search, all non-ciphers and non-letters will be ignored. This will provide a more robust search result." + in: "query" + required: true + schema: + type: "string" + default: null + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + type: "array" + items: + $ref: "#/components/schemas/SearchResult" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + + # TPMS / customer storage /CustomerStorages/{Guid}: get: tags: - - "Customer storages" + - "TPMS / customer storage" parameters: - $ref: "#/components/parameters/GuidPathParameter" responses: @@ -69,7 +127,7 @@ paths: - SessionScheme: [] patch: tags: - - "Customer storages" + - "TPMS / customer storage" parameters: - $ref: "#/components/parameters/GuidPathParameter" - $ref: "#/components/parameters/_HashValueParameter" @@ -93,20 +151,12 @@ paths: /CustomerStorages/{Guid}/CustomerStoragePositions: get: tags: - - "Customer storages" + - "TPMS / customer storage" parameters: - - $ref: "#/components/parameters/OffsetParameter" - - $ref: "#/components/parameters/LimitParameter" - - $ref: "#/components/parameters/SearchTermParameter" - $ref: "#/components/parameters/GuidPathParameter" responses: 200: description: "successful operation" - headers: - TotalNumberOfEntries: - schema: - type: integer - description: The total number of results of this operation. Please be aware that this number could be wrong if the parameter SearchTerm is used, due to processing the SearchTerm over the acutal result array. content: application/json: schema: @@ -117,61 +167,10 @@ paths: $ref: "#/components/responses/GenericError" security: - SessionScheme: [] - /CustomerStorages/{Guid}/DmsFiles: - get: - tags: - - "Customer storages" - - "DMS files" - parameters: - - $ref: "#/components/parameters/OffsetParameter" - - $ref: "#/components/parameters/LimitParameter" - - $ref: "#/components/parameters/SearchTermParameter" - - $ref: "#/components/parameters/GuidPathParameter" - responses: - 200: - description: "successful operation" - headers: - TotalNumberOfEntries: - schema: - type: integer - description: The total number of results of this operation. Please be aware that this number could be wrong if the parameter SearchTerm is used, due to processing the SearchTerm over the acutal result array. - content: - application/json: - schema: - type: "array" - items: - $ref: "#/components/schemas/DmsFile" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] - post: - tags: - - "Customer storages" - - "DMS files" - parameters: - - $ref: "#/components/parameters/GuidPathParameter" - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/DmsFile" - responses: - 200: - description: "successful operation" - content: - application/json: - schema: - $ref: "#/components/schemas/DmsFile" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] /CustomerStoragePositions/{Guid}: get: tags: - - "Customer storages" + - "TPMS / customer storage" parameters: - $ref: "#/components/parameters/GuidPathParameter" responses: @@ -187,7 +186,7 @@ paths: - SessionScheme: [] patch: tags: - - "Customer storages" + - "TPMS / customer storage" parameters: - $ref: "#/components/parameters/GuidPathParameter" - $ref: "#/components/parameters/_HashValueParameter" @@ -208,24 +207,112 @@ paths: $ref: "#/components/responses/GenericError" security: - SessionScheme: [] - /CustomerStoragePositions/{Guid}/DmsFiles: + /CustomerVehicles/{Guid}: get: tags: - - "Customer storages" - - "DMS files" + - "TPMS / customer storage" parameters: - - $ref: "#/components/parameters/OffsetParameter" - - $ref: "#/components/parameters/LimitParameter" - - $ref: "#/components/parameters/SearchTermParameter" - $ref: "#/components/parameters/GuidPathParameter" responses: 200: description: "successful operation" - headers: - TotalNumberOfEntries: + content: + application/json: schema: - type: integer - description: The total number of results of this operation. Please be aware that this number could be wrong if the parameter SearchTerm is used, due to processing the SearchTerm over the acutal result array. + $ref: "#/components/schemas/CustomerVehicle" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + patch: + tags: + - "TPMS / customer storage" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + - $ref: "#/components/parameters/_HashValueParameter" + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CustomerVehicle" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomerVehicle" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + + # DMS / file attachments + /DmsFiles/{Guid}: + get: + tags: + - "DMS / file attachments" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + - $ref: "#/components/parameters/ContentTypeParameter" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + $ref: "#/components/schemas/DmsFile" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + patch: + tags: + - "DMS / file attachments" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + - $ref: "#/components/parameters/_HashValueParameter" + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DmsFile" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + $ref: "#/components/schemas/DmsFile" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + delete: + tags: + - "DMS / file attachments" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + - $ref: "#/components/parameters/_HashValueParameter" + responses: + 200: + description: "successful operation" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + /DmsFiles/{Guid}/DmsFiles: + get: + tags: + - "DMS / file attachments" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + - $ref: "#/components/parameters/ContentTypeParameter" + responses: + 200: + description: "successful operation" content: application/json: schema: @@ -238,8 +325,7 @@ paths: - SessionScheme: [] post: tags: - - "Customer storages" - - "DMS files" + - "DMS / file attachments" parameters: - $ref: "#/components/parameters/GuidPathParameter" requestBody: @@ -259,10 +345,266 @@ paths: $ref: "#/components/responses/GenericError" security: - SessionScheme: [] + /Customers/{Guid}/DmsFiles: + get: + tags: + - "DMS / file attachments" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + - $ref: "#/components/parameters/ContentTypeParameter" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + type: "array" + items: + $ref: "#/components/schemas/DmsFile" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + post: + tags: + - "DMS / file attachments" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DmsFile" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + $ref: "#/components/schemas/DmsFile" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + /CustomerStorages/{Guid}/DmsFiles: + get: + tags: + - "DMS / file attachments" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + - $ref: "#/components/parameters/ContentTypeParameter" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + type: "array" + items: + $ref: "#/components/schemas/DmsFile" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + post: + tags: + - "DMS / file attachments" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DmsFile" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + $ref: "#/components/schemas/DmsFile" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + /CustomerStoragePositions/{Guid}/DmsFiles: + get: + tags: + - "DMS / file attachments" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + - $ref: "#/components/parameters/ContentTypeParameter" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + type: "array" + items: + $ref: "#/components/schemas/DmsFile" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + post: + tags: + - "DMS / file attachments" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DmsFile" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + $ref: "#/components/schemas/DmsFile" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + /CustomerVehicles/{Guid}/DmsFiles: + get: + tags: + - "DMS / file attachments" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + - $ref: "#/components/parameters/ContentTypeParameter" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + type: "array" + items: + $ref: "#/components/schemas/DmsFile" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + post: + tags: + - "DMS / file attachments" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DmsFile" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + $ref: "#/components/schemas/DmsFile" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + /Documents/{Guid}/DmsFiles: + get: + tags: + - "DMS / file attachments" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + - $ref: "#/components/parameters/ContentTypeParameter" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + type: "array" + items: + $ref: "#/components/schemas/DmsFile" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + post: + tags: + - "DMS / file attachments" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DmsFile" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + $ref: "#/components/schemas/DmsFile" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + + # Deprecated + /Customers/{Guid}: + get: + tags: + - "Deprecated" + parameters: + - $ref: "#/components/parameters/GuidPathParameter" + responses: + 200: + description: "successful operation" + content: + application/json: + schema: + $ref: "#/components/schemas/Customer" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] + /CustomerStorages: + get: + tags: + - "Deprecated" + parameters: + - $ref: "#/components/parameters/OffsetParameter" + - $ref: "#/components/parameters/LimitParameter" + - $ref: "#/components/parameters/SearchTermParameter" + - $ref: "#/components/parameters/IsActiveParameter" + responses: + 200: + description: "successful operation" + headers: + TotalNumberOfEntries: + schema: + type: integer + description: The total number of results of this operation. Please be aware that this number could be wrong if the parameter SearchTerm is used, due to processing the SearchTerm over the acutal result array. + content: + application/json: + schema: + type: "array" + items: + $ref: "#/components/schemas/CustomerStorage" + default: + $ref: "#/components/responses/GenericError" + security: + - SessionScheme: [] /CustomerVehicles: get: tags: - - "Customer vehicles" + - "Deprecated" parameters: - $ref: "#/components/parameters/OffsetParameter" - $ref: "#/components/parameters/LimitParameter" @@ -285,51 +627,10 @@ paths: $ref: "#/components/responses/GenericError" security: - SessionScheme: [] - /CustomerVehicles/{Guid}: - get: - tags: - - "Customer vehicles" - parameters: - - $ref: "#/components/parameters/GuidPathParameter" - responses: - 200: - description: "successful operation" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomerVehicle" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] - patch: - tags: - - "Customer vehicles" - parameters: - - $ref: "#/components/parameters/GuidPathParameter" - - $ref: "#/components/parameters/_HashValueParameter" - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/CustomerVehicle" - responses: - 200: - description: "successful operation" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomerVehicle" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] /CustomerVehicles/{Guid}/CustomerStorages: get: tags: - - "Customer vehicles" - - "Customer storages" + - "Deprecated" parameters: - $ref: "#/components/parameters/OffsetParameter" - $ref: "#/components/parameters/LimitParameter" @@ -354,62 +655,10 @@ paths: $ref: "#/components/responses/GenericError" security: - SessionScheme: [] - /CustomerVehicles/{Guid}/DmsFiles: - get: - tags: - - "Customer vehicles" - - "DMS files" - parameters: - - $ref: "#/components/parameters/OffsetParameter" - - $ref: "#/components/parameters/LimitParameter" - - $ref: "#/components/parameters/SearchTermParameter" - - $ref: "#/components/parameters/GuidPathParameter" - responses: - 200: - description: "successful operation" - headers: - TotalNumberOfEntries: - schema: - type: integer - description: The total number of results of this operation. Please be aware that this number could be wrong if the parameter SearchTerm is used, due to processing the SearchTerm over the acutal result array. - content: - application/json: - schema: - type: "array" - items: - $ref: "#/components/schemas/DmsFile" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] - post: - tags: - - "Customer vehicles" - - "DMS files" - parameters: - - $ref: "#/components/parameters/GuidPathParameter" - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/DmsFile" - responses: - 200: - description: "successful operation" - content: - application/json: - schema: - $ref: "#/components/schemas/DmsFile" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] /CustomerVehicles/{Guid}/TpmsMeasurements: get: tags: - - "Customer vehicles" - - "TPMS" + - "Deprecated" parameters: - $ref: "#/components/parameters/OffsetParameter" - $ref: "#/components/parameters/LimitParameter" @@ -435,8 +684,7 @@ paths: - SessionScheme: [] post: tags: - - "Customer vehicles" - - "TPMS" + - "Deprecated" parameters: - $ref: "#/components/parameters/GuidPathParameter" requestBody: @@ -459,7 +707,7 @@ paths: /DbBlobs/{Guid}: get: tags: - - "DMS files" + - "Deprecated" parameters: - $ref: "#/components/parameters/GuidPathParameter" - $ref: "#/components/parameters/BinaryResponseParameter" @@ -479,73 +727,7 @@ paths: /DmsFiles: post: tags: - - "DMS files" - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/DmsFile" - responses: - 200: - description: "successful operation" - content: - application/json: - schema: - $ref: "#/components/schemas/DmsFile" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] - /DmsFiles/{Guid}: - get: - tags: - - "DMS files" - parameters: - - $ref: "#/components/parameters/GuidPathParameter" - responses: - 200: - description: "successful operation" - content: - application/json: - schema: - $ref: "#/components/schemas/DmsFile" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] - /DmsFiles/{Guid}/DmsFiles: - get: - tags: - - "DMS files" - parameters: - - $ref: "#/components/parameters/OffsetParameter" - - $ref: "#/components/parameters/LimitParameter" - - $ref: "#/components/parameters/SearchTermParameter" - - $ref: "#/components/parameters/GuidPathParameter" - responses: - 200: - description: "successful operation" - headers: - TotalNumberOfEntries: - schema: - type: integer - description: The total number of results of this operation. Please be aware that this number could be wrong if the parameter SearchTerm is used, due to processing the SearchTerm over the acutal result array. - content: - application/json: - schema: - type: "array" - items: - $ref: "#/components/schemas/DmsFile" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] - post: - tags: - - "DMS files" - parameters: - - $ref: "#/components/parameters/GuidPathParameter" + - "Deprecated" requestBody: required: true content: @@ -566,7 +748,7 @@ paths: /Documents: get: tags: - - "Documents" + - "Deprecated" parameters: - $ref: "#/components/parameters/OffsetParameter" - $ref: "#/components/parameters/LimitParameter" @@ -605,7 +787,7 @@ paths: /Documents/{Guid}: get: tags: - - "Documents" + - "Deprecated" parameters: - $ref: "#/components/parameters/GuidPathParameter" responses: @@ -619,61 +801,10 @@ paths: $ref: "#/components/responses/GenericError" security: - SessionScheme: [] - /Documents/{Guid}/DmsFiles: - get: - tags: - - "Documents" - - "DMS files" - parameters: - - $ref: "#/components/parameters/OffsetParameter" - - $ref: "#/components/parameters/LimitParameter" - - $ref: "#/components/parameters/SearchTermParameter" - - $ref: "#/components/parameters/GuidPathParameter" - responses: - 200: - description: "successful operation" - headers: - TotalNumberOfEntries: - schema: - type: integer - description: The total number of results of this operation. Please be aware that this number could be wrong if the parameter SearchTerm is used, due to processing the SearchTerm over the acutal result array. - content: - application/json: - schema: - type: "array" - items: - $ref: "#/components/schemas/DmsFile" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] - post: - tags: - - "Documents" - - "DMS files" - parameters: - - $ref: "#/components/parameters/GuidPathParameter" - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/DmsFile" - responses: - 200: - description: "successful operation" - content: - application/json: - schema: - $ref: "#/components/schemas/DmsFile" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] /Employees: get: tags: - - "Referenced Resources" + - "Deprecated" parameters: - $ref: "#/components/parameters/OffsetParameter" - $ref: "#/components/parameters/LimitParameter" @@ -700,7 +831,7 @@ paths: /Employees/{Guid}: get: tags: - - "Referenced Resources" + - "Deprecated" parameters: - $ref: "#/components/parameters/GuidPathParameter" responses: @@ -714,98 +845,10 @@ paths: $ref: "#/components/responses/GenericError" security: - SessionScheme: [] - /Storages: - get: - tags: - - "Referenced Resources" - parameters: - - $ref: "#/components/parameters/OffsetParameter" - - $ref: "#/components/parameters/LimitParameter" - - $ref: "#/components/parameters/IsActiveParameter" - - $ref: "#/components/parameters/SearchTermParameter" - responses: - 200: - description: "successful operation" - headers: - TotalNumberOfEntries: - schema: - type: integer - description: The total number of results of this operation. Please be aware that this number could be wrong if the parameter SearchTerm is used, due to processing the SearchTerm over the acutal result array. - content: - application/json: - schema: - type: "array" - items: - $ref: "#/components/schemas/Storage" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] - /Storages/{Guid}: - get: - tags: - - "Referenced Resources" - parameters: - - $ref: "#/components/parameters/GuidPathParameter" - responses: - 200: - description: "successful operation" - content: - application/json: - schema: - $ref: "#/components/schemas/Storage" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] - /Storages/{Guid}/StorageLocations: - get: - tags: - - "Referenced Resources" - parameters: - - $ref: "#/components/parameters/OffsetParameter" - - $ref: "#/components/parameters/LimitParameter" - - $ref: "#/components/parameters/SearchTermParameter" - - $ref: "#/components/parameters/GuidPathParameter" - responses: - 200: - description: "successful operation" - headers: - TotalNumberOfEntries: - schema: - type: integer - description: The total number of results of this operation. Please be aware that this number could be wrong if the parameter SearchTerm is used, due to processing the SearchTerm over the acutal result array. - content: - application/json: - schema: - type: "array" - items: - $ref: "#/components/schemas/StorageLocation" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] - /StorageLocations/{Guid}: - get: - tags: - - "Referenced Resources" - parameters: - - $ref: "#/components/parameters/GuidPathParameter" - responses: - 200: - description: "successful operation" - content: - application/json: - schema: - $ref: "#/components/schemas/StorageLocation" - default: - $ref: "#/components/responses/GenericError" - security: - - SessionScheme: [] /TpmsMeasurements: post: tags: - - "TPMS" + - "Deprecated" requestBody: required: true content: @@ -826,7 +869,7 @@ paths: /TpmsMeasurements/{Guid}: get: tags: - - "TPMS" + - "Deprecated" parameters: - $ref: "#/components/parameters/GuidPathParameter" responses: @@ -842,7 +885,7 @@ paths: - SessionScheme: [] patch: tags: - - "TPMS" + - "Deprecated" parameters: - $ref: "#/components/parameters/GuidPathParameter" - $ref: "#/components/parameters/_HashValueParameter" @@ -866,8 +909,7 @@ paths: /TpmsMeasurements/{Guid}/DmsFiles: get: tags: - - "TPMS" - - "DMS files" + - "Deprecated" parameters: - $ref: "#/components/parameters/OffsetParameter" - $ref: "#/components/parameters/LimitParameter" @@ -893,8 +935,7 @@ paths: - SessionScheme: [] post: tags: - - "TPMS" - - "DMS files" + - "Deprecated" parameters: - $ref: "#/components/parameters/GuidPathParameter" requestBody: @@ -917,7 +958,7 @@ paths: /TpmsMeasurements/{Guid}/TpmsMeasurementPositions: get: tags: - - "TPMS" + - "Deprecated" parameters: - $ref: "#/components/parameters/OffsetParameter" - $ref: "#/components/parameters/LimitParameter" @@ -943,7 +984,7 @@ paths: - SessionScheme: [] post: tags: - - "TPMS" + - "Deprecated" parameters: - $ref: "#/components/parameters/GuidPathParameter" requestBody: @@ -966,7 +1007,7 @@ paths: /TpmsMeasurementPositions: post: tags: - - "TPMS" + - "Deprecated" requestBody: required: true content: @@ -987,7 +1028,7 @@ paths: /TpmsMeasurementPositions/{Guid}: get: tags: - - "TPMS" + - "Deprecated" parameters: - $ref: "#/components/parameters/GuidPathParameter" responses: @@ -1003,7 +1044,7 @@ paths: - SessionScheme: [] patch: tags: - - "TPMS" + - "Deprecated" parameters: - $ref: "#/components/parameters/GuidPathParameter" - $ref: "#/components/parameters/_HashValueParameter" @@ -1027,8 +1068,7 @@ paths: /TpmsMeasurementPositions/{Guid}/DmsFiles: get: tags: - - "TPMS" - - "DMS files" + - "Deprecated" parameters: - $ref: "#/components/parameters/OffsetParameter" - $ref: "#/components/parameters/LimitParameter" @@ -1054,8 +1094,7 @@ paths: - SessionScheme: [] post: tags: - - "TPMS" - - "DMS files" + - "Deprecated" parameters: - $ref: "#/components/parameters/GuidPathParameter" requestBody: @@ -1078,7 +1117,7 @@ paths: /VehicleTypes: get: tags: - - "Referenced Resources" + - "Deprecated" parameters: - $ref: "#/components/parameters/OffsetParameter" - $ref: "#/components/parameters/LimitParameter" @@ -1105,7 +1144,7 @@ paths: /VehicleTypes/{Guid}: get: tags: - - "Referenced Resources" + - "Deprecated" parameters: - $ref: "#/components/parameters/GuidPathParameter" responses: @@ -1136,20 +1175,191 @@ components: Details: "Progress.Lang.AppError\n Ihr Anwender wurde nicht gefunden.\nat sourcecode.line 123" _HashValue: type: "string" + readOnly: true description: "HashValue of the object which you'll need to process write-operations." example: "f50df554352ac91635f900026860e3371a71999d" - Customer: + + # Referenced Resources + Storage: type: "object" required: - "Guid" + - "Designation" - "Number" properties: Guid: type: "string" + Designation: + type: "string" Number: type: "integer" _HashValue: $ref: "#/components/schemas/_HashValue" + StorageLocation: + type: "object" + required: + - "Guid" + - "GuidStorage" + - "Designation" + - "Number" + - "HasAvailableCapacity" + properties: + Guid: + type: "string" + GuidStorage: + type: "string" + Designation: + type: "string" + Number: + type: "integer" + HasAvailableCapacity: + type: "boolean" + _HashValue: + $ref: "#/components/schemas/_HashValue" + + # Search + SearchResult: + type: "object" + required: + - "Customers" + - "CustomerVehicles" + - "CustomerStorages" + - "Documents" + - "SchedulerAppointments" + properties: + Customers: + type: "array" + items: + type: "object" + required: + - "Guid" + - "Number" + properties: + Guid: + type: "string" + Number: + type: "integer" + Name1: + type: "string" + Name2: + type: "string" + PostalCode: + type: "string" + Town: + type: "string" + Street: + type: "string" + CustomerVehicles: + type: "array" + items: + type: "object" + required: + - "Guid" + - "GuidCustomer" + - "CustomerNumber" + properties: + Guid: + type: "string" + LicenceTagNumber: + type: "string" + GuidCustomer: + type: "string" + CustomerNumber: + type: "integer" + CustomerName1: + type: "string" + CustomerStorages: + type: "array" + items: + type: "object" + required: + - "Guid" + - "Number" + - "GuidCustomer" + - "CustomerNumber" + properties: + Guid: + type: "string" + Number: + type: "integer" + DimensionFrontLeft: + type: "string" + LicenceTagNumber: + type: "string" + CustomerReferenceId: + type: "string" + GuidCustomer: + type: "string" + CustomerNumber: + type: "integer" + CustomerName1: + type: "string" + Documents: + type: "array" + items: + type: "object" + required: + - "Guid" + - "DocumentTypeDesignation" + - "Date" + - "Number" + - "BranchNumber" + - "TotalPriceNet" + - "TotalPriceGross" + - "GuidCustomer" + properties: + Guid: + type: "string" + DocumentTypeDesignation: + type: "string" + Date: + type: "string" + format: "date" + Number: + type: "integer" + BranchNumber: + type: "integer" + TotalPriceNet: + type: "number" + TotalPriceGross: + type: "number" + GuidCustomer: + type: "string" + CustomerNumber: + type: "integer" + CustomerName1: + type: "string" + LicenceTagNumber: + type: "string" + ExternalOrderNumber: + type: "string" + SchedulerAppointments: + type: "array" + items: + type: "object" + required: + - "Guid" + - "StartMoment" + - "Designation" + - "WasCreatedByOnlineScheduler" + properties: + Guid: + type: "string" + StartMoment: + type: "string" + format: "date-time" + Designation: + type: "string" + LicenceTagNumber: + type: "string" + StatusDesignation: + type: "string" + WasCreatedByOnlineScheduler: + type: "boolean" + _HashValue: + $ref: "#/components/schemas/_HashValue" + + # TPMS / customer storage CustomerStorage: type: "object" required: @@ -1160,17 +1370,20 @@ components: properties: Guid: type: "string" + readOnly: true Number: type: "integer" + readOnly: true Date: type: "string" format: "date" - IsActive: - type: "boolean" + readOnly: true GuidCustomerVehicle: type: "string" + readOnly: true GuidCustomer: type: "string" + readOnly: true StorageType: type: "string" enum: @@ -1180,6 +1393,10 @@ components: type: "string" GuidStorageLocation: type: "string" + CommentExternal: + type: "string" + CommentInternal: + type: "string" _HashValue: $ref: "#/components/schemas/_HashValue" CustomerStoragePosition: @@ -1191,8 +1408,10 @@ components: properties: Guid: type: "string" + readOnly: true GuidCustomerStorage: type: "string" + readOnly: true PositionDescription: type: "string" TyreDimension: @@ -1226,6 +1445,15 @@ components: - "SteelRim" - "WithoutRim" - "Unknown" + TpmsSensorId: + type: "string" + TpmsSensorBatteryInPercent: + type: "integer" + description: "If you just can provide [ok, low, empty] use please [100, 10, 0] as values." + TpmsTyrePressureInBar: + type: "number" + TpmsTyreTemperatureInDegreeCelsius: + type: "number" _HashValue: $ref: "#/components/schemas/_HashValue" CustomerVehicle: @@ -1233,17 +1461,70 @@ components: required: - "Guid" - "GuidCustomer" - - "IsActive" - "LicenceTagNumber" properties: Guid: type: "string" + readOnly: true GuidCustomer: type: "string" - IsActive: - type: "boolean" + readOnly: true LicenceTagNumber: type: "string" + readOnly: true + Configuration: + type: "object" + readOnly: true + required: + - "Type" + - "Designation" + - "Axles" + properties: + Type: + type: "string" + enum: + - "Motorcycle" + - "Car" + - "LightTruck" + - "Truck" + - "Bus" + - "EarthMachine" + - "Plane" + - "SpecialMachine" + - "Trailer" + Designation: + type: "string" + Axles: + type: "array" + items: + type: "object" + required: + - "BlockNumberFrontToBack" + - "IsDrivingAxle" + - "IsReserveAxle" + - "IsSteeringAxle" + - "Positions" + properties: + BlockNumberFrontToBack: + type: "integer" + IsDrivingAxle: + type: "boolean" + IsReserveAxle: + type: "boolean" + IsSteeringAxle: + type: "boolean" + Positions: + type: "array" + items: + type: "object" + required: + - "BlockNumberLeftToRight" + - "PositionDescription" + properties: + BlockNumberLeftToRight: + type: "integer" + PositionDescription: + type: "string" ChassisNumber: type: "string" EgTypeApprovalNumber: @@ -1282,6 +1563,73 @@ components: format: "date" _HashValue: $ref: "#/components/schemas/_HashValue" + + # DMS / file attachments + DmsFile: + type: "object" + required: + - "Guid" + - "ProgramIdentifierDesignation" + - "Type" + - "Designation" + - "SizeInBytes" + properties: + Guid: + type: "string" + readOnly: true + ProgramIdentifierDesignation: + type: "string" + readOnly: true + Type: + type: "string" + enum: + - "Directory" + - "File" + Comment: + type: "string" + Designation: + type: "string" + SizeInBytes: + type: "integer" + readOnly: true + NumberOfFiles: + type: "integer" + description: "Only when Type=Directory." + readOnly: true + CharacterSet: + type: "string" + description: "Only when Type=File." + MimeType: + type: "string" + description: "Only when Type=File." + readOnly: true + LastFileModificationMoment: + type: "string" + format: "date-time" + description: "Only when Type=File." + ContentHashValue: + type: "string" + description: "Only when Type=File." + readOnly: true + Content: + type: "string" + description: "Only when Type=File." + _HashValue: + $ref: "#/components/schemas/_HashValue" + + # Deprecated + Customer: + type: "object" + required: + - "Guid" + - "Number" + properties: + Guid: + type: "string" + Number: + type: "integer" + _HashValue: + $ref: "#/components/schemas/_HashValue" DbBlob: type: "object" required: @@ -1313,46 +1661,6 @@ components: type: "string" _HashValue: $ref: "#/components/schemas/_HashValue" - DmsFile: - type: "object" - required: - - "Guid" - - "TableName" - - "GuidOfTableName" - - "ProgramIdentifier" - - "ProgramIdentifierDesignation" - - "Type" - properties: - Guid: - type: "string" - TableName: - type: "string" - enum: - - "Customer" - - "CustomerStorage" - - "CustomerVehicle" - - "Document" - - "SchedulerAppointment" - - "DmsFile" - GuidOfTableName: - type: "string" - ProgramIdentifier: - type: "string" - ProgramIdentifierDesignation: - type: "string" - Type: - type: "string" - enum: - - "Directory" - - "File" - Designation: - type: "string" - GuidDbBlob: - type: "string" - Description: - type: "string" - _HashValue: - $ref: "#/components/schemas/_HashValue" Document: type: "object" required: @@ -1403,44 +1711,6 @@ components: type: "string" _HashValue: $ref: "#/components/schemas/_HashValue" - Storage: - type: "object" - required: - - "Guid" - - "IsActive" - - "Designation" - - "Number" - properties: - Guid: - type: "string" - IsActive: - type: "boolean" - Designation: - type: "string" - Number: - type: "integer" - _HashValue: - $ref: "#/components/schemas/_HashValue" - StorageLocation: - type: "object" - required: - - "Guid" - - "IsActive" - - "Designation" - - "Number" - properties: - Guid: - type: "string" - GuidStorage: - type: "string" - IsActive: - type: "boolean" - Designation: - type: "string" - Number: - type: "integer" - _HashValue: - $ref: "#/components/schemas/_HashValue" TpmsMeasurement: type: "object" required: @@ -1543,6 +1813,39 @@ components: type: "string" default: null example: "f50df554352ac91635f900026860e3371a71999d" + GuidPathParameter: + name: "Guid" + in: "path" + description: "The primary identifier of the entry (in the database)." + required: true + schema: + type: "string" + default: null + example: "ebb89e89-8d25-809e-7814-c53b686ae164" + OnlyWithAvailableCapacityParameter: + name: "OnlyWithAvailableCapacity" + description: "Shows only storage locations with available capacity." + in: "query" + required: false + schema: + type: "string" + default: true + example: true + ContentTypeParameter: + name: "ContentType" + in: "query" + description: "Determines what you will find in the field content." + required: false + schema: + type: "string" + enum: + - "Base64" + - "UrlWithInlineContentDisposition" + - "UrlWithAttachmentContentDisposition" + default: "UrlWithInlineContentDisposition" + example: "UrlWithInlineContentDisposition" + + # Deprecated BinaryResponseParameter: name: "BinaryResponse" in: "query" @@ -1573,15 +1876,6 @@ components: type: "boolean" default: false example: true - GuidPathParameter: - name: "Guid" - in: "path" - description: "The primary identifier of the entry (in the database)." - required: true - schema: - type: "string" - default: null - example: "ebb89e89-8d25-809e-7814-c53b686ae164" IsActiveParameter: name: "IsActive" in: "query" @@ -1629,3 +1923,55 @@ components: application/json: schema: $ref: "#/components/schemas/GenericError" + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +