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

Compare commits

base: PRM_Software_AG:8cd81994171720b71be533d6bff5872c14a05d45
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

24 Commits
8cd8199417 ... 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
Nico Kroll
1c7255fa72 Abfrage von Zuhebörteilen, wie z.B. Schläuchen 2025-10-16 11:33:09 +02:00
Nico Kroll
574b8caf49 Reorganization for better understanding 2025-10-16 10:14:28 +02:00
Nico Kroll
dacc6cade4 Pair- or Couplesearch implementation 
For different dimensions of front and rear axle
 2025-10-16 09:25:45 +02:00
Nico Kroll
6d93e58c98 New Endpoint for StockDetails of an article 
And some more descriptions for stock coloumns. The clients are using often abbreviations
 2025-10-15 11:17:18 +02:00
Nico Kroll
1edeb5178d Raw ProgramIdentifier 2025-10-07 09:28:58 +02:00
Nico Kroll
1e6a843330 Added designations for any UI, to show 2025-09-12 10:27:34 +02:00
Nico Kroll
b797105afc Added GuidOnlineService-Parameter 2025-09-04 06:38:13 +02:00
Nico Kroll
741f6c34dd Providing information about top sold articles 2025-08-21 10:28:38 +02:00
Nico Kroll
cb2e4d1d60 Added Areas 
These are blocks on the page to show custom content. Like typical advertisment-blocks on other websites.
 2025-08-21 09:40:40 +02:00
Nico Kroll
7449bb1a06 Wrong type 2025-08-21 07:44:08 +02:00
Nico Kroll
791d46ff6b ShopArticleInformation added. I.e. photos and marketing stuff 2025-08-21 07:40:44 +02:00
Nico Kroll
5b9a836c65 V10 - rework of Blob-Handling 2025-08-20 10:33:58 +02:00
Nico Kroll
cec3fa68ad The updated document gets returned 2025-08-20 10:30:59 +02:00
Nico Kroll
00243eb3b5 Small enhancements due to requests 2025-08-05 14:23:49 +02:00
4 changed files with 1029 additions and 259 deletions
Expand all files Collapse all files

2
docs/README.md
View File

@@ -19,6 +19,7 @@ https://www.astera.com/de/type/blog/api-design-best-practices
https://www.citusdata.com/blog/2016/03/30/five-ways-to-paginate/
https://stackoverflow.blog/2021/10/06/best-practices-for-authentication-and-authorization-for-rest-apis/
https://www.akamai.com/blog/security/rest-api-security-best-practices
https://jakarta.ee/specifications/data/1.0/
# Examples
@@ -26,3 +27,4 @@ https://docs.hetzner.cloud/
https://opensource.zalando.com/restful-api-guidelines
https://kubernetes.io/docs/reference/using-api/api-concepts
https://docs.stripe.com/api/prices
https://developer.clickup.com/docs/authentication

84
src/v1/openapi.yaml
View File

@@ -1287,6 +1287,62 @@ paths:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/Documents/{Guid}/custommethods/AcceptOffer:
post:
tags:
- "Documents"
description: "Accepts an offer. Dependant on the implementation, it could be that the offer is after the operation an order."
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
- $ref: "#/components/parameters/_HashValueParameter"
- name: "Comment"
in: "query"
required: false
schema:
type: "string"
default: null
example: "Thanks you!"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: "#/components/schemas/Document"
401:
$ref: "#/components/responses/SessionOfOnlineUserOrHigherRequired"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/Documents/{Guid}/custommethods/RejectOffer:
post:
tags:
- "Documents"
description: "Rejects an offer. Dependant on the implementation, the offer keeps beeing open for further responses or gets historic."
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
- $ref: "#/components/parameters/_HashValueParameter"
- name: "Comment"
in: "query"
required: false
schema:
type: "string"
default: null
example: "The price is higher than excepted. Can you make another offer?"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: "#/components/schemas/Document"
401:
$ref: "#/components/responses/SessionOfOnlineUserOrHigherRequired"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/DocumentPositions:
get:
tags:
@@ -4137,6 +4193,7 @@ components:
- "GuidOnlineSchedulerService"
- "GuidBranch"
- "IsDefault"
- "Hints"
properties:
Guid:
type: "string"
@@ -4146,6 +4203,22 @@ components:
type: "string"
IsDefault:
type: "string"
Hints:
type: "array"
items:
type: "object"
required:
- "AttentionLevel"
- "Hint"
properties:
AttentionLevel:
type: "string"
enum:
- "Low"
- "Mid"
- "High"
Hint:
type: "string"
_HashValue:
$ref: "#/components/schemas/_HashValue"
example:
@@ -4206,6 +4279,7 @@ components:
- "UsersMayEnterANewLicenceTag"
- "IsConnectedWithATyreStorage"
- "DeadlineTimeInSecondsSinceMidnight"
- "DeadlineTimeInSecondsSinceMidnight"
properties:
Guid:
type: "string"
@@ -4230,6 +4304,16 @@ components:
type: "boolean"
DeadlineTimeInSecondsSinceMidnight:
type: "integer"
RedirectUrlType:
type: "string"
enum:
- "None"
- "NewTab"
- "SameTab"
RedirectUrl:
type: "string"
RedirectUrlShallBeShownAsOptionalButton:
type: "boolean"
_HashValue:
$ref: "#/components/schemas/_HashValue"
example:

1142
src/v2/shop.yaml
View File

File diff suppressed because it is too large Load Diff

60
src/v2/tpms.yaml
View File

@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: "TyrePro-API, TPMS"
version: "Version 6"
version: "Version 7"
servers:
- url: "https://musterreifen.com/api/tpms"
description: "Development server"
@@ -167,6 +167,23 @@ paths:
$ref: "#/components/responses/GenericError"
security:
- 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:
post:
tags:
@@ -184,6 +201,23 @@ paths:
$ref: "#/components/responses/GenericError"
security:
- 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}:
get:
tags:
@@ -1353,6 +1387,12 @@ components:
type: "integer"
CustomerName1:
type: "string"
StorageDesignation:
type: "string"
StoragePlaceDesignation:
type: "string"
RemoteStorageReference:
type: "string"
Documents:
type: "array"
items:
@@ -1458,6 +1498,8 @@ components:
type: "string"
GuidStorageLocation:
type: "string"
RemoteStorageReference:
type: "string"
CommentExternal:
type: "string"
CommentInternal:
@@ -1470,6 +1512,7 @@ components:
- "Guid"
- "GuidCustomerStorage"
- "PositionDescription"
- "PositionDescriptionDesignation"
properties:
Guid:
type: "string"
@@ -1479,6 +1522,8 @@ components:
readOnly: true
PositionDescription:
type: "string"
PositionDescriptionDesignation:
type: "string"
GuidArticleTyre:
type: "string"
TyreDimension:
@@ -1547,10 +1592,13 @@ components:
type: "object"
readOnly: true
required:
- "Guid"
- "Type"
- "Designation"
- "Axles"
properties:
Guid:
type: "string"
Type:
type: "string"
enum:
@@ -1574,6 +1622,7 @@ components:
- "IsDrivingAxle"
- "IsReserveAxle"
- "IsSteeringAxle"
- "Designation"
- "Positions"
properties:
BlockNumberFrontToBack:
@@ -1584,6 +1633,8 @@ components:
type: "boolean"
IsSteeringAxle:
type: "boolean"
Designation:
type: "string"
Positions:
type: "array"
items:
@@ -1591,11 +1642,14 @@ components:
required:
- "BlockNumberLeftToRight"
- "PositionDescription"
- "Designation"
properties:
BlockNumberLeftToRight:
type: "integer"
PositionDescription:
type: "string"
Designation:
type: "string"
ChassisNumber:
type: "string"
EgTypeApprovalNumber:
@@ -1640,6 +1694,7 @@ components:
type: "object"
required:
- "Guid"
- "ProgramIdentifier"
- "ProgramIdentifierDesignation"
- "Type"
- "Designation"
@@ -1651,6 +1706,9 @@ components:
ProgramIdentifierDesignation:
type: "string"
readOnly: true
ProgramIdentifier:
type: "string"
readOnly: true
Type:
type: "string"
enum: