develop #38

Merged
bboterm merged 451 commits from develop into main 2025-11-19 14:28:14 +00:00
Showing only changes of commit 36a2ccb03c - Show all commits

View File

@ -581,17 +581,17 @@ paths:
example: Dagkaart example: Dagkaart
description: The description of the booking. description: The description of the booking.
- in: query - in: query
name: element1 name: department
schema: schema:
type: string type: string
example: 900 example: 900
description: The first element of the booking. description: The department of the booking.
- in: query - in: query
name: element2 name: costType
schema: schema:
type: string type: string
example: 84956 example: 84956
description: The second element of the booking. description: The cost type of the booking.
- in: query - in: query
name: documentCode name: documentCode
schema: schema:
@ -799,11 +799,11 @@ paths:
example: Dakaart - BUS example: Dakaart - BUS
description: The name of the booking line metadata. description: The name of the booking line metadata.
- in: query - in: query
name: incomingName name: sourceMetadataId
schema: schema:
type: string type: string
example: Webshop example: 9b371ab4-2c47-4aa5-bcf8-6642385278ac
description: The incoming name of the booking line metadata. description: The source of the booking line metadata.
- in: query - in: query
name: identifyingFieldValue name: identifyingFieldValue
schema: schema:
@ -811,12 +811,12 @@ paths:
example: 1737 example: 1737
description: The identifying field value. description: The identifying field value.
- in: query - in: query
name: concessionName name: concessionId
schema: schema:
type: array type: array
items: items:
type: string type: integer
example: [BUS, RAIL] example: [1, 2]
explode: false explode: false
description: The name of the concession. description: The name of the concession.
- in: query - in: query
@ -838,17 +838,17 @@ paths:
explode: false explode: false
description: The sense of the line. description: The sense of the line.
- in: query - in: query
name: element3 name: costCenter
schema: schema:
type: string type: string
example: 603031 example: 603031
description: The element 3 of the booking line metadata. description: The cost center of the booking line metadata.
- in: query - in: query
name: element4 name: artcleName
schema: schema:
type: string type: string
example: Dagkaart example: Dagkaart
description: The element 4 of the booking line metadata. description: The article name of the booking line metadata.
- in: query - in: query
name: extRef1 name: extRef1
schema: schema:
@ -1067,12 +1067,6 @@ paths:
type: string type: string
example: api.htm.nl/v2/account/12345/msgs/abc example: api.htm.nl/v2/account/12345/msgs/abc
description: The rejection info of the source. description: The rejection info of the source.
- in: query
name: validAt
schema:
type: string
example: 2024-01-01T00:00:00.000
description: Timestamp that the metadata is valid.
responses: responses:
"200": "200":
description: OK description: OK
@ -1220,12 +1214,12 @@ paths:
example: 37a8095b-19db-498f-9349-5f37d21c5bdf example: 37a8095b-19db-498f-9349-5f37d21c5bdf
description: The id of the concession metadata. description: The id of the concession metadata.
- in: query - in: query
name: name name: concessionId
schema: schema:
type: array type: array
items: items:
type: string type: integer
example: [BUS, RAIL] example: [1, 2]
explode: false explode: false
description: The name of the concession. description: The name of the concession.
- in: query - in: query
@ -1407,6 +1401,19 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/MetadataAuditTrailsPostResponseBody" $ref: "#/components/schemas/MetadataAuditTrailsPostResponseBody"
/concessions:
get:
summary: Get all concessions.
description: Get all concessions.
tags:
- References v2
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/ConcessionsGetResponseBody"
components: components:
securitySchemes: securitySchemes:
bearerToken: bearerToken:
@ -2048,10 +2055,10 @@ components:
description: description:
type: string type: string
example: Dagkaart example: Dagkaart
element1: department:
type: string type: string
example: 900 example: 900
element2: costType:
type: string type: string
example: 84956 example: 84956
documentCode: documentCode:
@ -2082,8 +2089,8 @@ components:
- bookingMetadataId - bookingMetadataId
- bookingProcessId - bookingProcessId
- description - description
- element1 - department
- element2 - costType
- documentCode - documentCode
- hasSeparateTaxLine - hasSeparateTaxLine
- hasLinePerIdentifyingField - hasLinePerIdentifyingField
@ -2102,10 +2109,10 @@ components:
description: description:
type: string type: string
example: Dagkaart example: Dagkaart
element1: department:
type: string type: string
example: 900 example: 900
element2: costType:
type: string type: string
example: 84956 example: 84956
documentCode: documentCode:
@ -2134,8 +2141,8 @@ components:
example: null example: null
required: required:
- description - description
- element1 - department
- element2 - costType
- documentCode - documentCode
- hasSeparateTaxLine - hasSeparateTaxLine
- hasLinePerIdentifyingField - hasLinePerIdentifyingField
@ -2158,11 +2165,11 @@ components:
type: string type: string
nullable: true nullable: true
example: Dagkaart example: Dagkaart
element1: department:
type: string type: string
nullable: true nullable: true
example: 900 example: 900
element2: costType:
type: string type: string
nullable: true nullable: true
example: 84956 example: 84956
@ -2257,17 +2264,18 @@ components:
name: name:
type: string type: string
example: Dagkaart - BUS example: Dagkaart - BUS
incomingName: sourceMetadataId:
type: string type: string
format: uuid
example: null example: null
nullable: true nullable: true
identifyingFieldValue: identifyingFieldValue:
type: string type: string
example: null example: null
nullable: true nullable: true
concessionName: concessionId:
type: string type: integer
example: RAIL example: 1
nullable: true nullable: true
lineType: lineType:
type: string type: string
@ -2282,11 +2290,11 @@ components:
- debit - debit
- credit - credit
example: credit example: credit
element3: costCenter:
type: string type: string
example: 603031 example: 603031
nullable: true nullable: true
element4: articleName:
type: string type: string
example: dagkaart example: dagkaart
nullable: true nullable: true
@ -2346,20 +2354,16 @@ components:
name: name:
type: string type: string
example: Dagkaart - BUS example: Dagkaart - BUS
incomingName: sourceMetadata:
type: string type: object
example: null $ref: '#/components/schemas/SourceMetadata'
nullable: true
identifyingFieldValue: identifyingFieldValue:
type: string type: string
example: null example: null
nullable: true nullable: true
concessionName: concession:
type: string type: object
enum: $ref: '#/components/schemas/Concession'
- RAIL
- BUS
example: RAIL
lineType: lineType:
type: string type: string
enum: enum:
@ -2373,11 +2377,11 @@ components:
- debit - debit
- credit - credit
example: credit example: credit
element3: costCenter:
type: string type: string
example: 603031 example: 603031
nullable: true nullable: true
element4: articleName:
type: string type: string
example: dagkaart example: dagkaart
nullable: true nullable: true
@ -2424,21 +2428,19 @@ components:
type: string type: string
nullable: true nullable: true
example: Dagkaart - BUS example: Dagkaart - BUS
incomingName: sourceMetadataId:
type: string type: string
format: uuid
nullable: true nullable: true
example: null example: null
identifyingFieldValue: identifyingFieldValue:
type: string type: string
nullable: true nullable: true
example: null example: null
concessionName: concessionId:
type: string type: integer
nullable: true nullable: true
enum: example: 1
- RAIL
- BUS
example: RAIL
lineType: lineType:
type: string type: string
nullable: true nullable: true
@ -2454,11 +2456,11 @@ components:
- debit - debit
- credit - credit
example: credit example: credit
element3: costCenter:
type: string type: string
nullable: true nullable: true
example: 603031 example: 603031
element4: articleName:
type: string type: string
nullable: true nullable: true
example: dagkaart example: dagkaart
@ -2759,15 +2761,6 @@ components:
rejectionInfo: rejectionInfo:
type: string type: string
example: api.htm.nl/v2/account/12345/msgs/abc example: api.htm.nl/v2/account/12345/msgs/abc
validFrom:
type: string
format: date-time
example: 2024-01-01T00:00:00.000
validUntil:
type: string
format: date-time
nullable: true
example: null
required: required:
- sourceMetadataId - sourceMetadataId
- incomingName - incomingName
@ -2776,7 +2769,6 @@ components:
- businessOwner - businessOwner
- rejectionProcessing - rejectionProcessing
- rejectionInfo - rejectionInfo
- validFrom
SourceMetadataPostResponseBody: SourceMetadataPostResponseBody:
type: object type: object
properties: properties:
@ -2807,15 +2799,6 @@ components:
rejectionInfo: rejectionInfo:
type: string type: string
example: api.htm.nl/v2/account/12345/msgs/abc example: api.htm.nl/v2/account/12345/msgs/abc
validFrom:
type: string
format: date-time
example: 2024-01-01T00:00:00.000
validUntil:
type: string
format: date-time
nullable: true
example: null
SourceMetadataPatchResponseBody: SourceMetadataPatchResponseBody:
type: object type: object
properties: properties:
@ -2903,12 +2886,9 @@ components:
type: string type: string
format: en format: en
example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb
name: concession:
type: string type: object
enum: $ref: "#/components/schemas/Concession"
- RAIL
- BUS
example: RAIL
percentage: percentage:
type: number type: number
example: 84.021 example: 84.021
@ -2934,12 +2914,9 @@ components:
ConcessionMetadataPostRequestBody: ConcessionMetadataPostRequestBody:
type: object type: object
properties: properties:
name: concessionId:
type: string type: integer
enum: example: 1
- RAIL
- BUS
example: RAIL
percentage: percentage:
type: number type: number
example: 84.021 example: 84.021
@ -2953,7 +2930,7 @@ components:
nullable: true nullable: true
example: null example: null
required: required:
- name - concessionId
- percentage - percentage
- validFrom - validFrom
ConcessionMetadataPostResponseBody: ConcessionMetadataPostResponseBody:
@ -2968,12 +2945,9 @@ components:
ConcessionMetadataPatchRequestBody: ConcessionMetadataPatchRequestBody:
type: object type: object
properties: properties:
name: concessionId:
type: string type: integer
enum: example: 1
- RAIL
- BUS
example: RAIL
percentage: percentage:
type: number type: number
example: 84.021 example: 84.021
@ -2995,6 +2969,30 @@ components:
example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb
required: required:
- concessionMetadataId - concessionMetadataId
ConcessionsGetResponseBody:
type: object
properties:
concessions:
type: array
items:
$ref: '#/components/schemas/Concession'
href:
type: string
nullable: true
description: URI for pagination.
example: null
Concession:
type: object
properties:
concessionId:
type: integer
example: 1
name:
type: string
example: BUS
required:
- concessionId
- name
SourceMetadata: SourceMetadata:
type: object type: object
properties: properties:
@ -3020,15 +3018,6 @@ components:
rejectionInfo: rejectionInfo:
type: string type: string
example: api.htm.nl/v2/account/12345/msgs/abc example: api.htm.nl/v2/account/12345/msgs/abc
validFrom:
type: string
format: date-time
example: 2024-01-01T00:00:00.000
validUntil:
type: string
format: date-time
nullable: true
example: null
required: required:
- sourceMetadataId - sourceMetadataId
- incomingName - incomingName