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

Compare commits

base: PRM_Software_AG:094262e414e7622a977867c0e9fa8eb40ee8134e
Branches Tags
PRM_Software_AG:master
PRM_Software_AG:development
..
compare: PRM_Software_AG:8cd81994171720b71be533d6bff5872c14a05d45
Branches Tags
PRM_Software_AG:master
PRM_Software_AG:development

2 Commits
094262e414 ... 8cd8199417

Author SHA1 Message Date
Nico Kroll 8cd8199417 New fields for article references and the function to rearrange the customer storage 2025-06-19 14:05:05 +02:00
Nico Kroll 738aaa0a6d Amount in cart is now a complex object 2025-06-19 13:38:08 +02:00
2 changed files with 84 additions and 3 deletions
Show Stats Expand all files Collapse all files

14
src/v2/shop.yaml
View File

@ -1,7 +1,7 @@
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: "TyrePro-API, Shop" title: "TyrePro-API, Shop"
version: "Version 8" version: "Version 9"
servers: servers:
- url: "https://musterreifen.com/api/shop" - url: "https://musterreifen.com/api/shop"
description: "Development server, customers domain" description: "Development server, customers domain"
@ -1371,7 +1371,17 @@ components:
type: "string" type: "string"
format: "date" format: "date"
AmountInCart: AmountInCart:
type: "number" type: "array"
items:
type: "object"
required:
- "GuidCart"
- "Amount"
properties:
GuidCart:
type: "string"
Amount:
type: "number"
MaterialType: MaterialType:
type: "object" type: "object"
required: required:

73
src/v2/tpms.yaml
View File

@ -1,7 +1,7 @@
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: "TyrePro-API, TPMS" title: "TyrePro-API, TPMS"
version: "Version 4" version: "Version 6"
servers: servers:
- url: "https://musterreifen.com/api/tpms" - url: "https://musterreifen.com/api/tpms"
description: "Development server" description: "Development server"
@ -167,6 +167,23 @@ paths:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
security: security:
- SessionScheme: [] - SessionScheme: []
/CustomerStorages/{Guid}/custommethods/Rearrange:
post:
tags:
- "TPMS / customer storage"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: "#/components/schemas/CustomerStorage"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/CustomerStoragePositions/{Guid}: /CustomerStoragePositions/{Guid}:
get: get:
tags: tags:
@ -572,6 +589,7 @@ paths:
$ref: "#/components/schemas/Customer" $ref: "#/components/schemas/Customer"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/CustomerStorages: /CustomerStorages:
@ -599,6 +617,7 @@ paths:
$ref: "#/components/schemas/CustomerStorage" $ref: "#/components/schemas/CustomerStorage"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/CustomerVehicles: /CustomerVehicles:
@ -625,6 +644,7 @@ paths:
$ref: "#/components/schemas/CustomerVehicle" $ref: "#/components/schemas/CustomerVehicle"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/CustomerVehicles/{Guid}/CustomerStorages: /CustomerVehicles/{Guid}/CustomerStorages:
@ -653,6 +673,7 @@ paths:
$ref: "#/components/schemas/CustomerStorage" $ref: "#/components/schemas/CustomerStorage"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/CustomerVehicles/{Guid}/TpmsMeasurements: /CustomerVehicles/{Guid}/TpmsMeasurements:
@ -680,6 +701,7 @@ paths:
$ref: "#/components/schemas/TpmsMeasurement" $ref: "#/components/schemas/TpmsMeasurement"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
post: post:
@ -702,6 +724,7 @@ paths:
$ref: "#/components/schemas/TpmsMeasurement" $ref: "#/components/schemas/TpmsMeasurement"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/DbBlobs/{Guid}: /DbBlobs/{Guid}:
@ -722,6 +745,7 @@ paths:
$ref: "#/components/schemas/DbBlob" $ref: "#/components/schemas/DbBlob"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/DmsFiles: /DmsFiles:
@ -743,6 +767,7 @@ paths:
$ref: "#/components/schemas/DmsFile" $ref: "#/components/schemas/DmsFile"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/Documents: /Documents:
@ -782,6 +807,7 @@ paths:
$ref: "#/components/schemas/Document" $ref: "#/components/schemas/Document"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/Documents/{Guid}: /Documents/{Guid}:
@ -799,6 +825,7 @@ paths:
$ref: "#/components/schemas/Document" $ref: "#/components/schemas/Document"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/Employees: /Employees:
@ -826,6 +853,7 @@ paths:
$ref: "#/components/schemas/Employee" $ref: "#/components/schemas/Employee"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/Employees/{Guid}: /Employees/{Guid}:
@ -843,6 +871,7 @@ paths:
$ref: "#/components/schemas/Employee" $ref: "#/components/schemas/Employee"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/TpmsMeasurements: /TpmsMeasurements:
@ -864,6 +893,7 @@ paths:
$ref: "#/components/schemas/TpmsMeasurement" $ref: "#/components/schemas/TpmsMeasurement"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/TpmsMeasurements/{Guid}: /TpmsMeasurements/{Guid}:
@ -881,6 +911,7 @@ paths:
$ref: "#/components/schemas/TpmsMeasurement" $ref: "#/components/schemas/TpmsMeasurement"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
patch: patch:
@ -904,6 +935,7 @@ paths:
$ref: "#/components/schemas/TpmsMeasurement" $ref: "#/components/schemas/TpmsMeasurement"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/TpmsMeasurements/{Guid}/DmsFiles: /TpmsMeasurements/{Guid}/DmsFiles:
@ -931,6 +963,7 @@ paths:
$ref: "#/components/schemas/DmsFile" $ref: "#/components/schemas/DmsFile"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
post: post:
@ -953,6 +986,7 @@ paths:
$ref: "#/components/schemas/DmsFile" $ref: "#/components/schemas/DmsFile"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/TpmsMeasurements/{Guid}/TpmsMeasurementPositions: /TpmsMeasurements/{Guid}/TpmsMeasurementPositions:
@ -980,6 +1014,7 @@ paths:
$ref: "#/components/schemas/TpmsMeasurementPosition" $ref: "#/components/schemas/TpmsMeasurementPosition"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
post: post:
@ -1002,6 +1037,7 @@ paths:
$ref: "#/components/schemas/TpmsMeasurementPosition" $ref: "#/components/schemas/TpmsMeasurementPosition"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/TpmsMeasurementPositions: /TpmsMeasurementPositions:
@ -1023,6 +1059,7 @@ paths:
$ref: "#/components/schemas/TpmsMeasurementPosition" $ref: "#/components/schemas/TpmsMeasurementPosition"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/TpmsMeasurementPositions/{Guid}: /TpmsMeasurementPositions/{Guid}:
@ -1040,6 +1077,7 @@ paths:
$ref: "#/components/schemas/TpmsMeasurementPosition" $ref: "#/components/schemas/TpmsMeasurementPosition"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
patch: patch:
@ -1063,6 +1101,7 @@ paths:
$ref: "#/components/schemas/TpmsMeasurementPosition" $ref: "#/components/schemas/TpmsMeasurementPosition"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/TpmsMeasurementPositions/{Guid}/DmsFiles: /TpmsMeasurementPositions/{Guid}/DmsFiles:
@ -1090,6 +1129,7 @@ paths:
$ref: "#/components/schemas/DmsFile" $ref: "#/components/schemas/DmsFile"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
post: post:
@ -1112,6 +1152,7 @@ paths:
$ref: "#/components/schemas/DmsFile" $ref: "#/components/schemas/DmsFile"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/VehicleTypes: /VehicleTypes:
@ -1139,6 +1180,7 @@ paths:
$ref: "#/components/schemas/VehicleType" $ref: "#/components/schemas/VehicleType"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
/VehicleTypes/{Guid}: /VehicleTypes/{Guid}:
@ -1156,6 +1198,7 @@ paths:
$ref: "#/components/schemas/VehicleType" $ref: "#/components/schemas/VehicleType"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
deprecated: true
security: security:
- SessionScheme: [] - SessionScheme: []
components: components:
@ -1233,10 +1276,13 @@ components:
type: "object" type: "object"
required: required:
- "Guid" - "Guid"
- "Score"
- "Number" - "Number"
properties: properties:
Guid: Guid:
type: "string" type: "string"
Score:
type: "number"
Number: Number:
type: "integer" type: "integer"
Name1: Name1:
@ -1255,11 +1301,14 @@ components:
type: "object" type: "object"
required: required:
- "Guid" - "Guid"
- "Score"
- "GuidCustomer" - "GuidCustomer"
- "CustomerNumber" - "CustomerNumber"
properties: properties:
Guid: Guid:
type: "string" type: "string"
Score:
type: "number"
LicenceTagNumber: LicenceTagNumber:
type: "string" type: "string"
GuidCustomer: GuidCustomer:
@ -1274,14 +1323,24 @@ components:
type: "object" type: "object"
required: required:
- "Guid" - "Guid"
- "Score"
- "Number" - "Number"
- "ContractStartDate"
- "IsActive"
- "GuidCustomer" - "GuidCustomer"
- "CustomerNumber" - "CustomerNumber"
properties: properties:
Guid: Guid:
type: "string" type: "string"
Score:
type: "number"
Number: Number:
type: "integer" type: "integer"
ContractStartDate:
type: "string"
format: "date"
IsActive:
type: "boolean"
DimensionFrontLeft: DimensionFrontLeft:
type: "string" type: "string"
LicenceTagNumber: LicenceTagNumber:
@ -1300,6 +1359,7 @@ components:
type: "object" type: "object"
required: required:
- "Guid" - "Guid"
- "Score"
- "DocumentTypeDesignation" - "DocumentTypeDesignation"
- "Date" - "Date"
- "Number" - "Number"
@ -1310,6 +1370,8 @@ components:
properties: properties:
Guid: Guid:
type: "string" type: "string"
Score:
type: "number"
DocumentTypeDesignation: DocumentTypeDesignation:
type: "string" type: "string"
Date: Date:
@ -1339,12 +1401,15 @@ components:
type: "object" type: "object"
required: required:
- "Guid" - "Guid"
- "Score"
- "StartMoment" - "StartMoment"
- "Designation" - "Designation"
- "WasCreatedByOnlineScheduler" - "WasCreatedByOnlineScheduler"
properties: properties:
Guid: Guid:
type: "string" type: "string"
Score:
type: "number"
StartMoment: StartMoment:
type: "string" type: "string"
format: "date-time" format: "date-time"
@ -1414,6 +1479,8 @@ components:
readOnly: true readOnly: true
PositionDescription: PositionDescription:
type: "string" type: "string"
GuidArticleTyre:
type: "string"
TyreDimension: TyreDimension:
type: "string" type: "string"
TyreManufacturer: TyreManufacturer:
@ -1430,6 +1497,8 @@ components:
type: "integer" type: "integer"
TyreDotWeek: TyreDotWeek:
type: "integer" type: "integer"
GuidArticleRim:
type: "string"
RimDimension: RimDimension:
type: "string" type: "string"
RimManufacturer: RimManufacturer:
@ -1445,6 +1514,8 @@ components:
- "SteelRim" - "SteelRim"
- "WithoutRim" - "WithoutRim"
- "Unknown" - "Unknown"
GuidArticleTpms:
type: "string"
TpmsSensorId: TpmsSensorId:
type: "string" type: "string"
TpmsSensorBatteryInPercent: TpmsSensorBatteryInPercent: