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

Compare commits

base: PRM_Software_AG:1c7255fa725b946ce3831014dc7fd0191a701569
Branches Tags
PRM_Software_AG:master PRM_Software_AG:development
..
compare: PRM_Software_AG:master
Branches Tags
PRM_Software_AG:master PRM_Software_AG:development

10 Commits
1c7255fa72 ... master

Author SHA1 Message Date
Nico Kroll
eb8630ff24 New Endpoint /Filters2, to make implementation easier 2026-04-09 14:34:58 +02:00
Nico Kroll
2960d1bd36 Each branch has now hints 2026-02-24 09:41:23 +01:00
Nico Kroll
6eda09efbe More fields and some bugfixes 2026-01-30 07:45:25 +01:00
Nico Kroll
dc1751b852 Update README.md 2026-01-30 07:44:50 +01:00
Nico Kroll
760da37fe3 Methods to search the exact predecessor and successor 2026-01-30 07:44:48 +01:00
Nico Kroll
adb589ef49 New fields for redirecting to a customer url 2025-10-29 08:42:56 +01:00
Nico Kroll
fbcb1ff6bb Filters extended for PairSearch 2025-10-20 09:08:40 +02:00
Nico Kroll
68eca53428 Added Motorcycle-Data 2025-10-17 09:41:45 +02:00
Nico Kroll
694582091b Typing error 2025-10-16 15:16:36 +02:00
Nico Kroll
254d3b09ae Search by motorcycles 2025-10-16 14:57:10 +02:00
4 changed files with 470 additions and 105 deletions
Expand all files Collapse all files

1
docs/README.md
View File

@@ -27,3 +27,4 @@ https://docs.hetzner.cloud/
https://opensource.zalando.com/restful-api-guidelines https://opensource.zalando.com/restful-api-guidelines
https://kubernetes.io/docs/reference/using-api/api-concepts https://kubernetes.io/docs/reference/using-api/api-concepts
https://docs.stripe.com/api/prices https://docs.stripe.com/api/prices
https://developer.clickup.com/docs/authentication

28
src/v1/openapi.yaml
View File

@@ -4193,6 +4193,7 @@ components:
- "GuidOnlineSchedulerService" - "GuidOnlineSchedulerService"
- "GuidBranch" - "GuidBranch"
- "IsDefault" - "IsDefault"
- "Hints"
properties: properties:
Guid: Guid:
type: "string" type: "string"
@@ -4202,6 +4203,22 @@ components:
type: "string" type: "string"
IsDefault: IsDefault:
type: "string" type: "string"
Hints:
type: "array"
items:
type: "object"
required:
- "AttentionLevel"
- "Hint"
properties:
AttentionLevel:
type: "string"
enum:
- "Low"
- "Mid"
- "High"
Hint:
type: "string"
_HashValue: _HashValue:
$ref: "#/components/schemas/_HashValue" $ref: "#/components/schemas/_HashValue"
example: example:
@@ -4262,6 +4279,7 @@ components:
- "UsersMayEnterANewLicenceTag" - "UsersMayEnterANewLicenceTag"
- "IsConnectedWithATyreStorage" - "IsConnectedWithATyreStorage"
- "DeadlineTimeInSecondsSinceMidnight" - "DeadlineTimeInSecondsSinceMidnight"
- "DeadlineTimeInSecondsSinceMidnight"
properties: properties:
Guid: Guid:
type: "string" type: "string"
@@ -4286,6 +4304,16 @@ components:
type: "boolean" type: "boolean"
DeadlineTimeInSecondsSinceMidnight: DeadlineTimeInSecondsSinceMidnight:
type: "integer" type: "integer"
RedirectUrlType:
type: "string"
enum:
- "None"
- "NewTab"
- "SameTab"
RedirectUrl:
type: "string"
RedirectUrlShallBeShownAsOptionalButton:
type: "boolean"
_HashValue: _HashValue:
$ref: "#/components/schemas/_HashValue" $ref: "#/components/schemas/_HashValue"
example: example:

478
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 13" version: "Version 19"
servers: servers:
- url: "https://musterreifen.com/api/shop" - url: "https://musterreifen.com/api/shop"
description: "Development server, customers domain" description: "Development server, customers domain"
@@ -453,7 +453,20 @@ paths:
- $ref: "#/components/parameters/GuidOffset" - $ref: "#/components/parameters/GuidOffset"
- $ref: "#/components/parameters/GuidHubBoreHole" - $ref: "#/components/parameters/GuidHubBoreHole"
- $ref: "#/components/parameters/GuidManufacturer" - $ref: "#/components/parameters/GuidManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleDisplacement"
- $ref: "#/components/parameters/GuidMotorcycleModel"
- $ref: "#/components/parameters/GuidBranch" - $ref: "#/components/parameters/GuidBranch"
- $ref: "#/components/parameters/SearchTerm2"
- $ref: "#/components/parameters/GuidWidth2"
- $ref: "#/components/parameters/GuidSection2"
- $ref: "#/components/parameters/GuidDiameter2"
- $ref: "#/components/parameters/GuidSpeedIndex2"
- $ref: "#/components/parameters/GuidLoadIndex2"
- $ref: "#/components/parameters/GuidHoleCount2"
- $ref: "#/components/parameters/GuidHoleCircle2"
- $ref: "#/components/parameters/GuidOffset2"
- $ref: "#/components/parameters/GuidHubBoreHole2"
- name: "Type" - name: "Type"
description: "Provide the types you want to get. If this parameter is not provided, all types will be returned." description: "Provide the types you want to get. If this parameter is not provided, all types will be returned."
in: "query" in: "query"
@@ -475,6 +488,74 @@ paths:
- "Offset" - "Offset"
- "HubBoreHole" - "HubBoreHole"
- "Manufacturer" - "Manufacturer"
- "MotorcycleManufacturer"
- "MotorcycleDisplacement"
- "MotorcycleModel"
- "Width2"
- "Section2"
- "Diameter2"
- "SpeedIndex2"
- "LoadIndex2"
- "HoleCount2"
- "HoleCircle2"
- "Offset2"
- "HubBoreHole2"
- name: "MaximumNumberOfOptions"
in: "query"
required: false
schema:
type: "integer"
default: 1000
example: 1000
responses:
200:
description: "successful operation"
headers:
Developer-Hint:
schema:
type: "string"
description: "To prevent data intense calls, we may manipulate your request. If so, you get a hint here, what exactly we've done."
content:
application/json:
schema:
type: "array"
items:
$ref: "#/components/schemas/Filter"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/Filters2:
get:
tags:
- "Search"
parameters:
- $ref: "#/components/parameters/GuidOnlineService"
- $ref: "#/components/parameters/GuidBranch"
- $ref: "#/components/parameters/SearchTerm1"
- $ref: "#/components/parameters/SearchTerm2"
- $ref: "#/components/parameters/GuidMaterialType"
- $ref: "#/components/parameters/GuidVehicleType"
- $ref: "#/components/parameters/GuidWidth"
- $ref: "#/components/parameters/GuidSection"
- $ref: "#/components/parameters/GuidDiameter"
- $ref: "#/components/parameters/GuidSpeedIndex"
- $ref: "#/components/parameters/GuidLoadIndex"
- $ref: "#/components/parameters/GuidHoleCount"
- $ref: "#/components/parameters/GuidHoleCircle"
- $ref: "#/components/parameters/GuidOffset"
- $ref: "#/components/parameters/GuidHubBoreHole"
- $ref: "#/components/parameters/GuidManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleDisplacement"
- $ref: "#/components/parameters/GuidMotorcycleModel"
- name: "MaximumNumberOfOptions"
in: "query"
required: false
schema:
type: "integer"
default: 200
example: 200
responses: responses:
200: 200:
description: "successful operation" description: "successful operation"
@@ -483,7 +564,7 @@ paths:
schema: schema:
type: "array" type: "array"
items: items:
$ref: "#/components/schemas/Filter" $ref: "#/components/schemas/Filter2"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
security: security:
@@ -545,6 +626,9 @@ paths:
- $ref: "#/components/parameters/GuidOffset" - $ref: "#/components/parameters/GuidOffset"
- $ref: "#/components/parameters/GuidHubBoreHole" - $ref: "#/components/parameters/GuidHubBoreHole"
- $ref: "#/components/parameters/GuidManufacturer" - $ref: "#/components/parameters/GuidManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleDisplacement"
- $ref: "#/components/parameters/GuidMotorcycleModel"
- $ref: "#/components/parameters/BinaryObjectContentType" - $ref: "#/components/parameters/BinaryObjectContentType"
- $ref: "#/components/parameters/GuidDeliveryType" - $ref: "#/components/parameters/GuidDeliveryType"
- $ref: "#/components/parameters/GuidBranch" - $ref: "#/components/parameters/GuidBranch"
@@ -587,61 +671,24 @@ paths:
- $ref: "#/components/parameters/GuidOffset" - $ref: "#/components/parameters/GuidOffset"
- $ref: "#/components/parameters/GuidHubBoreHole" - $ref: "#/components/parameters/GuidHubBoreHole"
- $ref: "#/components/parameters/GuidManufacturer" - $ref: "#/components/parameters/GuidManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleDisplacement"
- $ref: "#/components/parameters/GuidMotorcycleModel"
- $ref: "#/components/parameters/BinaryObjectContentType" - $ref: "#/components/parameters/BinaryObjectContentType"
- $ref: "#/components/parameters/GuidDeliveryType" - $ref: "#/components/parameters/GuidDeliveryType"
- $ref: "#/components/parameters/GuidBranch" - $ref: "#/components/parameters/GuidBranch"
- $ref: "#/components/parameters/GuidCalculationProfile" - $ref: "#/components/parameters/GuidCalculationProfile"
- $ref: "#/components/parameters/GuidShopArticleConfig" - $ref: "#/components/parameters/GuidShopArticleConfig"
- name: "SearchTerm2" - $ref: "#/components/parameters/SearchTerm2"
in: "query" - $ref: "#/components/parameters/GuidWidth2"
required: false - $ref: "#/components/parameters/GuidSection2"
schema: - $ref: "#/components/parameters/GuidDiameter2"
type: "string" - $ref: "#/components/parameters/GuidSpeedIndex2"
- name: "GuidWidth2" - $ref: "#/components/parameters/GuidLoadIndex2"
in: "query" - $ref: "#/components/parameters/GuidHoleCount2"
required: false - $ref: "#/components/parameters/GuidHoleCircle2"
schema: - $ref: "#/components/parameters/GuidOffset2"
type: "string" - $ref: "#/components/parameters/GuidHubBoreHole2"
- name: "GuidSection2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidDiameter2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidSpeedIndex2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidLoadIndex2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidHoleCount2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidHoleCircle2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidOffset2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidHubBoreHole2"
in: "query"
required: false
schema:
type: "string"
responses: responses:
200: 200:
description: "successful operation" description: "successful operation"
@@ -675,11 +722,6 @@ paths:
responses: responses:
200: 200:
description: "successful operation" description: "successful operation"
headers:
Guid-Shop-Article-Config:
schema:
type: "string"
description: "The ShopArticleConfig which was used to build the response. With this unification the configuration is maybe not precise, but you can show the results in a unified form (columns). Currently it's a response header. In the future we will maybe change this as a field in a response object."
content: content:
application/json: application/json:
schema: schema:
@@ -723,11 +765,6 @@ paths:
responses: responses:
200: 200:
description: "successful operation" description: "successful operation"
headers:
Guid-Shop-Article-Config:
schema:
type: "string"
description: "The ShopArticleConfig which was used to build the response. With this unification the configuration is maybe not precise, but you can show the results in a unified form (columns). Currently it's a response header. In the future we will maybe change this as a field in a response object."
content: content:
application/json: application/json:
schema: schema:
@@ -738,6 +775,54 @@ paths:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
security: security:
- SessionScheme: [] - SessionScheme: []
# MotorcycleDetails
/ShopArticleMotorcycleInformations:
get:
tags:
- "MotorcycleDetails"
parameters:
- $ref: "#/components/parameters/BinaryObjectContentType"
- $ref: "#/components/parameters/GuidShopArticle"
- $ref: "#/components/parameters/GuidMotorcycleModel"
- name: "GuidShopArticle2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
type: "array"
items:
$ref: "#/components/schemas/ShopArticleMotorcycleInformation"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/ShopArticleMotorcycles:
get:
tags:
- "MotorcycleDetails"
parameters:
- $ref: "#/components/parameters/GuidShopArticle"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
type: "array"
items:
$ref: "#/components/schemas/ShopArticleMotorcycle"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
# Calculation # Calculation
/CalculationProfiles: /CalculationProfiles:
get: get:
@@ -1303,6 +1388,7 @@ components:
- "Designation" - "Designation"
- "Number" - "Number"
- "IsActive" - "IsActive"
- "DefaultDeliveryDate"
properties: properties:
Guid: Guid:
type: "string" type: "string"
@@ -1324,6 +1410,9 @@ components:
type: "number" type: "number"
Longitude: Longitude:
type: "number" type: "number"
DefaultDeliveryDate:
type: "string"
format: "date"
example: example:
Guid: "ebb89e89-8d25-809e-7814-c53b686ae164" Guid: "ebb89e89-8d25-809e-7814-c53b686ae164"
Designation: "Zentrale" Designation: "Zentrale"
@@ -1376,9 +1465,16 @@ components:
type: "object" type: "object"
required: required:
- "Guid" - "Guid"
- "DesiredAmountOfDirectSearch"
- "DesiredAmountOfCombinationSearch"
- "Columns"
properties: properties:
Guid: Guid:
type: "string" type: "string"
DesiredAmountOfDirectSearch:
type: "number"
DesiredAmountOfCombinationSearch:
type: "number"
Columns: Columns:
type: "array" type: "array"
items: items:
@@ -1442,6 +1538,16 @@ components:
type: "string" type: "string"
GuidVehicleType: GuidVehicleType:
type: "string" type: "string"
TypeGroups:
type: "array"
items:
type: "object"
required:
- "Designation"
- "Types"
properties:
Designation:
type: "string"
Types: Types:
type: "array" type: "array"
items: items:
@@ -1467,6 +1573,9 @@ components:
- "Offset" - "Offset"
- "HubBoreHole" - "HubBoreHole"
- "Manufacturer" - "Manufacturer"
- "MotorcycleManufacturer"
- "MotorcycleDisplacement"
- "MotorcycleModel"
Filter: Filter:
type: "object" type: "object"
required: required:
@@ -1494,6 +1603,15 @@ components:
- "Offset" - "Offset"
- "HubBoreHole" - "HubBoreHole"
- "Manufacturer" - "Manufacturer"
- "Width2"
- "Section2"
- "Diameter2"
- "SpeedIndex2"
- "LoadIndex2"
- "HoleCount2"
- "HoleCircle2"
- "Offset2"
- "HubBoreHole2"
Options: Options:
type: "array" type: "array"
items: items:
@@ -1512,6 +1630,68 @@ components:
type: "string" type: "string"
ParameterValue: ParameterValue:
type: "string" type: "string"
Filter2:
type: "object"
required:
- "Type"
- "Designation"
- "Fields"
properties:
Type:
type: "string"
enum:
- "Basic"
- "Detail"
- "Motorcycle"
Designation:
type: "string"
Fields:
type: "array"
items:
type: "object"
required:
- "Type"
- "Designation"
- "ParameterKey"
- "Options"
properties:
Type:
type: "string"
enum:
- "MaterialType"
- "VehicleType"
- "Width"
- "Section"
- "Diameter"
- "SpeedIndex"
- "LoadIndex"
- "HoleCount"
- "HoleCircle"
- "Offset"
- "HubBoreHole"
- "Manufacturer"
- "MotorcycleManufacturer"
- "MotorcycleDisplacement"
- "MotorcycleModel"
Designation:
type: "string"
ParameterKey:
type: "string"
Options:
type: "array"
items:
type: "object"
required:
- "Designation"
- "NumberOfResults"
- "ParameterValue"
properties:
Designation:
type: "string"
NumberOfResults:
type: "integer"
ParameterValue:
type: "string"
ShopArticle: ShopArticle:
type: "object" type: "object"
required: required:
@@ -1638,6 +1818,43 @@ components:
DeliveryDate: DeliveryDate:
type: "string" type: "string"
format: "date" format: "date"
ShopArticleMotorcycleInformation:
type: "object"
required:
- "Notes"
properties:
CertificateFile:
$ref: "#/components/schemas/DbBlob"
Notes:
type: "array"
items:
type: "string"
ShopArticleMotorcycle:
type: "object"
required:
- "GuidMotorcycle"
- "Manufacturer"
- "Model"
- "Type"
properties:
GuidMotorcycleModel:
type: "string"
Manufacturer:
type: "string"
Model:
type: "string"
Type:
type: "string"
DisplacementInCcm:
type: "integer"
PowerInKw:
type: "integer"
ConstructionYearFrom:
type: "integer"
ConstructionYearTo:
type: "integer"
AdditionalDesignation:
type: "string"
MaterialType: MaterialType:
type: "object" type: "object"
required: required:
@@ -1780,6 +1997,7 @@ components:
- "Guid" - "Guid"
- "GuidCurrency" - "GuidCurrency"
- "DefaultAmount" - "DefaultAmount"
- "DefaultDeliveryDate"
- "OneClickPurchase" - "OneClickPurchase"
- "FullTaxPercentage" - "FullTaxPercentage"
- "ReducedTaxPercentage" - "ReducedTaxPercentage"
@@ -1805,6 +2023,10 @@ components:
DefaultAmount: DefaultAmount:
type: "number" type: "number"
readOnly: true readOnly: true
DefaultDeliveryDate:
type: "string"
format: "date"
readOnly: true
OneClickPurchase: OneClickPurchase:
type: "boolean" type: "boolean"
readOnly: true readOnly: true
@@ -2194,6 +2416,30 @@ components:
type: "string" type: "string"
default: null default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164" example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidMotorcycleManufacturer:
name: "GuidMotorcycleManufacturer"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidMotorcycleDisplacement:
name: "GuidMotorcycleDisplacement"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidMotorcycleModel:
name: "GuidMotorcycleModel"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidBranch: GuidBranch:
name: "GuidBranch" name: "GuidBranch"
description: "Required for providing stock and price information." description: "Required for providing stock and price information."
@@ -2236,14 +2482,94 @@ components:
type: "string" type: "string"
default: null default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164" example: "ebb89e89-8d25-809e-7814-c53b686ae164"
SearchTerm: SearchTerm1:
name: "SearchTerm" name: "SearchTerm1"
in: "query" in: "query"
required: false required: false
schema: schema:
type: "string" type: "string"
default: null default: null
example: "2055516" example: "2055516"
SearchTerm2:
name: "SearchTerm2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "2055516"
GuidWidth2:
name: "GuidWidth2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidSection2:
name: "GuidSection2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidDiameter2:
name: "GuidDiameter2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidSpeedIndex2:
name: "GuidSpeedIndex2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidLoadIndex2:
name: "GuidLoadIndex2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidHoleCount2:
name: "GuidHoleCount2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidHoleCircle2:
name: "GuidHoleCircle2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidOffset2:
name: "GuidOffset2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidHubBoreHole2:
name: "GuidHubBoreHole2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
BinaryObjectContentType: BinaryObjectContentType:
name: "BinaryObjectContentType" name: "BinaryObjectContentType"
in: "query" in: "query"
@@ -2264,27 +2590,3 @@ components:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/GenericError" $ref: "#/components/schemas/GenericError"
# MISSING
# GET /Vehicles

34
src/v2/tpms.yaml
View File

@@ -167,6 +167,23 @@ paths:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
security: security:
- SessionScheme: [] - SessionScheme: []
/CustomerStorages/{Guid}/custommethods/Predecessor:
get:
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: []
/CustomerStorages/{Guid}/custommethods/Rearrange: /CustomerStorages/{Guid}/custommethods/Rearrange:
post: post:
tags: tags:
@@ -184,6 +201,23 @@ paths:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
security: security:
- SessionScheme: [] - SessionScheme: []
/CustomerStorages/{Guid}/custommethods/Successor:
get:
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: