PRM_Software_AG
/
api-documentation
12
1
Fork 0
Code Issues 10 Pull Requests Activity

Adding Tags for more clearance and slight adjustments

This commit is contained in:
Nico Kroll 2024-05-22 13:59:28 +02:00
parent 1441a8b92d
commit 6d620be849
1 changed files with 128 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

191
src/v2/tpms.yaml
View File

@ -1,15 +1,15 @@
openapi: 3.0.0
info:
title: "TyrePro-API, TPMS"
version: "1"
version: "2"
servers:
- url: "https://musterreifen.com/api/tpms"
description: "Demo server"
- url: "https://onlineservices.demo.rz2.prm-ag.de/O6J20ZebmghzkNgrdD759A/api/tpms"
description: "Development server"
paths:
/Customers/{Guid}:
get:
tags:
- "Referenced Resources"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
@ -25,6 +25,8 @@ paths:
- SessionScheme: []
/CustomerStorages:
get:
tags:
- "Customer storages"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -50,6 +52,8 @@ paths:
- SessionScheme: []
/CustomerStorages/{Guid}:
get:
tags:
- "Customer storages"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
@ -64,6 +68,8 @@ paths:
security:
- SessionScheme: []
patch:
tags:
- "Customer storages"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
- $ref: "#/components/parameters/_HashValueParameter"
@ -86,6 +92,8 @@ paths:
- SessionScheme: []
/CustomerStorages/{Guid}/CustomerStoragePositions:
get:
tags:
- "Customer storages"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -111,6 +119,9 @@ paths:
- SessionScheme: []
/CustomerStorages/{Guid}/DmsFiles:
get:
tags:
- "Customer storages"
- "DMS files"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -135,6 +146,9 @@ paths:
security:
- SessionScheme: []
post:
tags:
- "Customer storages"
- "DMS files"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
requestBody:
@ -156,6 +170,8 @@ paths:
- SessionScheme: []
/CustomerStoragePositions/{Guid}:
get:
tags:
- "Customer storages"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
@ -170,6 +186,8 @@ paths:
security:
- SessionScheme: []
patch:
tags:
- "Customer storages"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
- $ref: "#/components/parameters/_HashValueParameter"
@ -192,6 +210,9 @@ paths:
- SessionScheme: []
/CustomerStoragePositions/{Guid}/DmsFiles:
get:
tags:
- "Customer storages"
- "DMS files"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -216,6 +237,9 @@ paths:
security:
- SessionScheme: []
post:
tags:
- "Customer storages"
- "DMS files"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
requestBody:
@ -237,6 +261,8 @@ paths:
- SessionScheme: []
/CustomerVehicles:
get:
tags:
- "Customer vehicles"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -261,6 +287,8 @@ paths:
- SessionScheme: []
/CustomerVehicles/{Guid}:
get:
tags:
- "Customer vehicles"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
@ -275,6 +303,8 @@ paths:
security:
- SessionScheme: []
patch:
tags:
- "Customer vehicles"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
- $ref: "#/components/parameters/_HashValueParameter"
@ -297,6 +327,9 @@ paths:
- SessionScheme: []
/CustomerVehicles/{Guid}/CustomerStorages:
get:
tags:
- "Customer vehicles"
- "Customer storages"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -323,6 +356,9 @@ paths:
- SessionScheme: []
/CustomerVehicles/{Guid}/DmsFiles:
get:
tags:
- "Customer vehicles"
- "DMS files"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -347,6 +383,9 @@ paths:
security:
- SessionScheme: []
post:
tags:
- "Customer vehicles"
- "DMS files"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
requestBody:
@ -368,6 +407,9 @@ paths:
- SessionScheme: []
/CustomerVehicles/{Guid}/TpmsMeasurements:
get:
tags:
- "Customer vehicles"
- "TPMS"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -392,6 +434,9 @@ paths:
security:
- SessionScheme: []
post:
tags:
- "Customer vehicles"
- "TPMS"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
requestBody:
@ -413,6 +458,8 @@ paths:
- SessionScheme: []
/DbBlobs/{Guid}:
get:
tags:
- "DMS files"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
- $ref: "#/components/parameters/BinaryResponseParameter"
@ -431,6 +478,8 @@ paths:
- SessionScheme: []
/DmsFiles:
post:
tags:
- "DMS files"
requestBody:
required: true
content:
@ -450,6 +499,8 @@ paths:
- SessionScheme: []
/DmsFiles/{Guid}:
get:
tags:
- "DMS files"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
@ -465,6 +516,8 @@ paths:
- SessionScheme: []
/DmsFiles/{Guid}/DmsFiles:
get:
tags:
- "DMS files"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -489,6 +542,8 @@ paths:
security:
- SessionScheme: []
post:
tags:
- "DMS files"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
requestBody:
@ -510,6 +565,8 @@ paths:
- SessionScheme: []
/Documents:
get:
tags:
- "Documents"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -547,6 +604,8 @@ paths:
- SessionScheme: []
/Documents/{Guid}:
get:
tags:
- "Documents"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
@ -562,6 +621,9 @@ paths:
- SessionScheme: []
/Documents/{Guid}/DmsFiles:
get:
tags:
- "Documents"
- "DMS files"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -586,6 +648,9 @@ paths:
security:
- SessionScheme: []
post:
tags:
- "Documents"
- "DMS files"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
requestBody:
@ -607,6 +672,8 @@ paths:
- SessionScheme: []
/Employees:
get:
tags:
- "Referenced Resources"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -632,6 +699,8 @@ paths:
- SessionScheme: []
/Employees/{Guid}:
get:
tags:
- "Referenced Resources"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
@ -647,6 +716,8 @@ paths:
- SessionScheme: []
/Storages:
get:
tags:
- "Referenced Resources"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -672,6 +743,8 @@ paths:
- SessionScheme: []
/Storages/{Guid}:
get:
tags:
- "Referenced Resources"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
@ -685,13 +758,15 @@ paths:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/StorageLocations:
/Storages/{Guid}/StorageLocations:
get:
tags:
- "Referenced Resources"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
- $ref: "#/components/parameters/IsActiveParameter"
- $ref: "#/components/parameters/SearchTermParameter"
- $ref: "#/components/parameters/GuidPathParameter"
responses:
200:
description: "successful operation"
@ -712,6 +787,8 @@ paths:
- SessionScheme: []
/StorageLocations/{Guid}:
get:
tags:
- "Referenced Resources"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
@ -727,6 +804,8 @@ paths:
- SessionScheme: []
/TpmsMeasurements:
post:
tags:
- "TPMS"
requestBody:
required: true
content:
@ -746,6 +825,8 @@ paths:
- SessionScheme: []
/TpmsMeasurements/{Guid}:
get:
tags:
- "TPMS"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
@ -761,6 +842,9 @@ paths:
- SessionScheme: []
/TpmsMeasurements/{Guid}/DmsFiles:
get:
tags:
- "TPMS"
- "DMS files"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -785,6 +869,9 @@ paths:
security:
- SessionScheme: []
post:
tags:
- "TPMS"
- "DMS files"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
requestBody:
@ -806,6 +893,8 @@ paths:
- SessionScheme: []
/TpmsMeasurements/{Guid}/TpmsMeasurementPositions:
get:
tags:
- "TPMS"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -830,6 +919,8 @@ paths:
security:
- SessionScheme: []
post:
tags:
- "TPMS"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
requestBody:
@ -851,6 +942,8 @@ paths:
- SessionScheme: []
/TpmsMeasurementPositions:
post:
tags:
- "TPMS"
requestBody:
required: true
content:
@ -870,6 +963,8 @@ paths:
- SessionScheme: []
/TpmsMeasurementPositions/{Guid}:
get:
tags:
- "TPMS"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
@ -885,6 +980,9 @@ paths:
- SessionScheme: []
/TpmsMeasurementPositions/{Guid}/DmsFiles:
get:
tags:
- "TPMS"
- "DMS files"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -909,6 +1007,9 @@ paths:
security:
- SessionScheme: []
post:
tags:
- "TPMS"
- "DMS files"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
requestBody:
@ -930,6 +1031,8 @@ paths:
- SessionScheme: []
/VehicleTypes:
get:
tags:
- "Referenced Resources"
parameters:
- $ref: "#/components/parameters/OffsetParameter"
- $ref: "#/components/parameters/LimitParameter"
@ -955,6 +1058,8 @@ paths:
- SessionScheme: []
/VehicleTypes/{Guid}:
get:
tags:
- "Referenced Resources"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
@ -999,9 +1104,6 @@ components:
type: "integer"
_HashValue:
$ref: "#/components/schemas/_HashValue"
example:
Guid: "ebb89e89-8d25-809e-7814-c53b686ae164"
Number: 123456
CustomerStorage:
type: "object"
required:
@ -1023,21 +1125,17 @@ components:
type: "string"
GuidCustomer:
type: "string"
StorageType:
type: "string"
enum:
- "Customer"
- "Storage"
GuidStorage:
type: "string"
GuidStorageLocation:
type: "string"
_HashValue:
$ref: "#/components/schemas/_HashValue"
example:
Guid: "ebb89e89-8d25-809e-7814-c53b686ae164"
Number: 123456
Date: "2021-02-02"
GuidCustomerVehicle: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidCustomer: "ebb89e89-8d25-809e-7814-c53b686ae164"
RimType: "AlloyRimAftermarket"
GuidStorage: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidStorageLocation: "ebb89e89-8d25-809e-7814-c53b686ae164"
CustomerStoragePosition:
type: "object"
required:
@ -1089,12 +1187,15 @@ components:
required:
- "Guid"
- "GuidCustomer"
- "IsActive"
- "LicenceTagNumber"
properties:
Guid:
type: "string"
GuidCustomer:
type: "string"
IsActive:
type: "boolean"
LicenceTagNumber:
type: "string"
ChassisNumber:
@ -1135,18 +1236,6 @@ components:
format: "date"
_HashValue:
$ref: "#/components/schemas/_HashValue"
example:
Guid: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidCustomer: "ebb89e89-8d25-809e-7814-c53b686ae164"
LicenceTagNumber: "A-BC 1234"
ChassisNumber: null
KbaNumber1: "8004"
KbaNumber2: "AHE"
VehicleManufacturer: "Skoda"
VehicleDesignation: "Octavia"
VehicleType: "Limosine"
VehicleModel: "1Z, Facelift"
RegistrationDate: "2021-02-02"
DbBlob:
type: "object"
required:
@ -1178,15 +1267,6 @@ components:
type: "string"
_HashValue:
$ref: "#/components/schemas/_HashValue"
example:
Guid: "ebb89e89-8d25-809e-7814-c53b686ae164"
Designation: "Hinweis.txt"
Characterset: "UTF-8"
ContentType: "Txt"
SizeInBytes: 123
LastFileModificationMoment: "2021-02-02T10:36:10.172"
HashValue: "ebb89e898d25809e7814c53b686ae164"
Content: "some binary content..."
DmsFile:
type: "object"
required:
@ -1227,16 +1307,6 @@ components:
type: "string"
_HashValue:
$ref: "#/components/schemas/_HashValue"
example:
Guid: "ebb89e89-8d25-809e-7814-c53b686ae164"
TableName: "DmsFile"
GuidOfTableName: "ebb89e89-8d25-809e-7814-c53b686ae164"
ProgramIdentifier: "Direct"
ProgramIdentifierDesignation: "Manuell hinzugefügte Dateien"
Type: "File"
GuidDbBlob: "ebb89e89-8d25-809e-7814-c53b686ae164"
Designation: null
Description: null
Document:
type: "object"
required:
@ -1287,11 +1357,6 @@ components:
type: "string"
_HashValue:
$ref: "#/components/schemas/_HashValue"
example:
Guid: "ebb89e89-8d25-809e-7814-c53b686ae164"
IsActive: true
Number: 1
Name: "Max Mustermann"
Storage:
type: "object"
required:
@ -1310,11 +1375,6 @@ components:
type: "integer"
_HashValue:
$ref: "#/components/schemas/_HashValue"
example:
Guid: "ebb89e89-8d25-809e-7814-c53b686ae164"
IsActive: true
Designation: "Reifen"
Number: 1
StorageLocation:
type: "object"
required:
@ -1335,11 +1395,6 @@ components:
type: "integer"
_HashValue:
$ref: "#/components/schemas/_HashValue"
example:
Guid: "ebb89e89-8d25-809e-7814-c53b686ae164"
IsActive: true
Designation: "Reifen"
Number: 1
TpmsMeasurement:
type: "object"
required:
@ -1392,6 +1447,16 @@ components:
type: "string"
Type:
type: "string"
enum:
- "Motorcycle"
- "Car"
- "LightTruck"
- "Truck"
- "Bus"
- "EarthMachine"
- "Plane"
- "SpecialMachine"
- "Trailer"
Axles:
type: "array"
items: