From c8368ab003f031a12446ddae103dbd2d8ffbcbdb Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Wed, 5 Mar 2025 14:08:57 +0100 Subject: [PATCH] OVPAY-1518 - Changed GET query params to OData. --- src/openapi/fiko/fiko-crud.yaml | 1307 +++++++++++++------------------ 1 file changed, 564 insertions(+), 743 deletions(-) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 9e956d0..33fb229 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -15,152 +15,70 @@ paths: tags: - Transactions v2.2 parameters: - - in: query - name: transactionItemId - schema: - type: string - format: uuid - example: 75174a9d-fff4-4682-b66b-ebd93cbe7ea3 - description: The id of the transaction item. - - in: query - name: transactionType + - $ref: "#/components/parameters/top" + - $ref: "#/components/parameters/skip" + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/count" + - name: $orderby + in: query + description: Order items by property values + required: false + style: form + explode: false schema: + uniqueItems: true type: array items: type: string - example: [sales] + enum: + - transactionItemRowId + - transactionItemId + - transactionType + - sourceName + - transactionId + - transactionLineId + - name + - quantity + - taxCode + - amountExclTax + - amountInclTax + - amountTax + - occurredOn + - type + - articleNumber + - status + - aggregationReference + - accountingSystemReference + - name: $select + in: query + description: Select properties to be returned + required: false + style: form explode: false - description: Possible types of the transaction ('sales'). - - in: query - name: sourceName - schema: - type: string - example: Verkoopengine - description: Source name of the transaction. - - in: query - name: transactionId - schema: - type: string - example: 1001236 - description: The id of the transaction. - - in: query - name: transactionLineId - schema: - type: string - example: 1 - description: The line id of the transaction. - - in: query - name: name - schema: - type: string - example: HTM Maandkorting 20% - description: The name of the product on the transaction. - - in: query - name: quantity - schema: - type: integer - example: 1 - description: The quantity of the transaction. - - in: query - name: taxCode - schema: - type: string - example: V21 - description: The tax code of the transaction. - - in: query - name: amountExclTax - schema: - type: integer - example: 100 - description: The amount of the transaction excluding tax in cents. - - in: query - name: amountInclTax - schema: - type: integer - example: 121 - description: The amount of the transaction including tax in cents. - - in: query - name: amountTax - schema: - type: integer - example: 21 - description: The tax amount of the transaction in cents. - - in: query - name: occurredBefore - schema: - type: string - format: date-time - example: 2024-10-04T00:00:00Z - description: Timestamp before which the transaction occurred. - - in: query - name: occurredAfter - schema: - type: string - format: date-time - example: 2024-10-04T00:00:00Z - description: Timestamp after which the transaction occurred. - - in: query - name: type schema: + uniqueItems: true type: array items: type: string - example: [debit, credit] - explode: false - description: Possible types of the transaction ('debit' or 'credit'). - - in: query - name: articleNumber - schema: - type: string - example: 4031 - description: The article number of the transaction. - - in: query - name: status - schema: - type: array - items: - type: string - example: - [ - created, - succeeded, - failed, - returned to trx-db, - returned to src, - re-entered, - ] - explode: false - description: Possible statuses of the transaction ('created', 'succeeded', 'failed', 'returned to trx-db', 'returned to src', 're-entered'). - - in: query - name: aggregationReference - schema: - type: string - example: FIKO-123456 - description: The aggregation reference of the transaction. %00 is searching for NULL-values. - - in: query - name: accountingSystemReference - schema: - type: string - example: U4F-123456 - description: The accounting system reference of the transaction. %00 is searching for NULL-values. - - in: query - name: sort - schema: - type: string - example: occurredOn - description: The field by which the transaction items in the result body are sorted. - - in: query - name: limit - schema: - type: integer - example: 15 - description: The limit of the transaction items in the result body. - - in: query - name: offset - schema: - type: integer - example: 15 - description: The offset of the transaction items in the result body. + enum: + - transactionItemRowId + - transactionItemId + - transactionType + - sourceName + - transactionId + - transactionLineId + - name + - quantity + - taxCode + - amountExclTax + - amountInclTax + - amountTax + - occurredOn + - type + - articleNumber + - status + - aggregationReference + - accountingSystemReference responses: "200": description: OK @@ -585,94 +503,63 @@ paths: tags: - Audit Trail v2.2 parameters: - - in: query - name: transactionAuditTrailId - schema: - type: string - format: uuid - example: 498e11fd-86c7-4e26-8ca9-c5ed9049da9e - description: The id of the audit trail. - - in: query - name: transactionItemId - schema: - type: string - format: uuid - example: 9834b346-d68c-438d-9bd5-6716422c2657 - description: The id of the transaction item. - - in: query - name: user - schema: - type: string - example: fiko - description: The user who created the audit trail. - - in: query - name: timestampBefore - schema: - type: string - example: 2022-01-01 00:00:00 - description: The timestamp before the event occured. - - in: query - name: timestampAfter - schema: - type: string - example: 2022-01-01 00:00:00 - description: The timestamp after the event occured. - - in: query - name: action + - $ref: "#/components/parameters/top" + - $ref: "#/components/parameters/skip" + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/count" + - name: $orderby + in: query + description: Order items by property values + required: false + style: form + explode: false schema: + uniqueItems: true type: array items: type: string - example: [create, update] + enum: + - transactionAuditTrailRowId + - transactionAuditTrailId + - transactionItemId + - user + - timestamp + - action + - status + - correlationId + - name: $select + in: query + description: Select properties to be returned + required: false + style: form explode: false - description: The action of the event. - - in: query - name: status schema: + uniqueItems: true type: array items: type: string - example: - [ - created, - succeeded, - failed, - returned to trx-db, - returned to src, - re-entered, - ] + enum: + - transactionAuditTrailRowId + - transactionAuditTrailId + - transactionItemId + - user + - timestamp + - action + - status + - correlationId + - name: $expand + in: query + description: Expand related entities + required: false + style: form explode: false - description: The status of the transaction item. - - in: query - name: description schema: - type: string - example: Transaction created. - description: The description of the event. - - in: query - name: correlationId - schema: - type: string - example: a3891560-3084-42cb-867c-f289e7cda47d - description: The correlation id of the event. - - in: query - name: sort - schema: - type: string - example: timestamp - description: The field by which the transaction audit trails in the result body are sorted. - - in: query - name: limit - schema: - type: integer - example: 15 - description: The limit of the transaction audit trails in the result body. - - in: query - name: offset - schema: - type: integer - example: 15 - description: The offset of the transaction audit trails in the result body. + uniqueItems: true + type: array + items: + type: string + enum: + - TransactionItem responses: "200": description: OK @@ -808,86 +695,67 @@ paths: tags: - Failures v2.2 parameters: - - in: query - name: processingFailureId + - $ref: "#/components/parameters/top" + - $ref: "#/components/parameters/skip" + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/count" + - name: $orderby + in: query + description: Order items by property values + required: false + style: form + explode: false schema: - type: string - format: uuid - example: 9834b346-d68c-438d-9bd5-6716422c2657 - description: The id of the processing failure. - - in: query - name: transactionItemId + uniqueItems: true + type: array + items: + type: string + enum: + - processingFailureRowId + - processingFailureId + - transactionItemId + - timestamp + - element + - value + - reasonCode + - reasonDescription + - resolved + - change + - name: $select + in: query + description: Select properties to be returned + required: false + style: form + explode: false schema: - type: string - format: uuid - example: 9834b346-d68c-438d-9bd5-6716422c2657 - description: The id of the transaction item. - - in: query - name: timestampBefore + uniqueItems: true + type: array + items: + type: string + enum: + - processingFailureRowId + - processingFailureId + - transactionItemId + - timestamp + - element + - value + - reasonCode + - reasonDescription + - resolved + - change + - name: $expand + in: query + description: Expand related entities + required: false + style: form + explode: false schema: - type: string - example: 2022-01-01 00:00:00 - description: The timestamp before the event occured. - - in: query - name: timestampAfter - schema: - type: string - example: 2022-01-01 00:00:00 - description: The timestamp after the event occured. - - in: query - name: element - schema: - type: string - example: contraAccount - description: The element on which the validation failed. - - in: query - name: value - schema: - type: string - example: 84955 - description: The value of th element on which the validation failed. - - in: query - name: reasonCode - schema: - type: string - example: "002" - description: The code of the validation failure reason. - - in: query - name: reasonDescription - schema: - type: string - example: Contra account does not exist. - description: The description of the validation failure reason. - - in: query - name: resolved - schema: - type: boolean - example: true - description: Whether the failure is resolved. - - in: query - name: change - schema: - type: string - example: Adapt config - description: Description of what was changed to resolve the failure. - - in: query - name: sort - schema: - type: string - example: timestamp - description: The field by which the processing failures in the result body are sorted. - - in: query - name: limit - schema: - type: integer - example: 15 - description: The limit of the processing failures in the result body. - - in: query - name: offset - schema: - type: integer - example: 15 - description: The offset of the processing failures in the result body. + uniqueItems: true + type: array + items: + type: string + enum: + - TransactionItem responses: "200": description: OK @@ -1023,52 +891,44 @@ paths: tags: - Booking Processes v2.2 parameters: - - in: query - name: bookingProcessId - schema: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: The id of the booking process. - - in: query - name: name - schema: - type: string - example: Verkooptransacties - description: The name of the booking process. - - in: query - name: transactionType + - $ref: "#/components/parameters/top" + - $ref: "#/components/parameters/skip" + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/count" + - name: $orderby + in: query + description: Order items by property values + required: false + style: form + explode: false schema: + uniqueItems: true type: array items: type: string - example: [sales, purchase] + enum: + - bookingProcessRowId + - bookingProcessId + - name + - transactionType + - identifyingFieldName + - name: $select + in: query + description: Select properties to be returned + required: false + style: form explode: false - description: The transaction type of the booking process. - - in: query - name: identifyingFieldName schema: - type: string - example: articleNumber - description: The identifying field name of the booking process. - - in: query - name: sort - schema: - type: string - example: name - description: The field by which the booking processes in the result body are sorted. - - in: query - name: limit - schema: - type: integer - example: 15 - description: The limit of the booking processes in the result body. - - in: query - name: offset - schema: - type: integer - example: 15 - description: The offset of the booking processes in the result body. + uniqueItems: true + type: array + items: + type: string + enum: + - bookingProcessRowId + - bookingProcessId + - name + - transactionType + - identifyingFieldName responses: "200": description: OK @@ -1222,92 +1082,73 @@ paths: tags: - Booking Processes v2.2 parameters: - - in: query - name: bookingMetadataId + - $ref: "#/components/parameters/top" + - $ref: "#/components/parameters/skip" + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/count" + - name: $orderby + in: query + description: Order items by property values + required: false + style: form + explode: false schema: - type: string - format: uuid - example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - description: The id of the booking metadata. - - in: query - name: bookingProcessId + uniqueItems: true + type: array + items: + type: string + enum: + - bookingMetadataRowId + - bookingMetadataId + - bookingProcessId + - description + - department + - costType + - documentCode + - hasSeparateTaxLine + - hasLinePerIdentifyingField + - hasLinePerSource + - hasLinePerConcession + - validFrom + - validUntil + - name: $select + in: query + description: Select properties to be returned + required: false + style: form + explode: false schema: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: The id of the parent booking process. - - in: query - name: description + uniqueItems: true + type: array + items: + type: string + enum: + - bookingMetadataRowId + - bookingMetadataId + - bookingProcessId + - description + - department + - costType + - documentCode + - hasSeparateTaxLine + - hasLinePerIdentifyingField + - hasLinePerSource + - hasLinePerConcession + - validFrom + - validUntil + - name: $expand + in: query + description: Expand related entities + required: false + style: form + explode: false schema: - type: string - example: Dagkaart - description: The description of the booking. - - in: query - name: department - schema: - type: string - example: 900 - description: The department of the booking. - - in: query - name: costType - schema: - type: string - example: 84956 - description: The cost type of the booking. - - in: query - name: documentCode - schema: - type: string - example: FIKO-OPBR - description: The document code of the booking. - - in: query - name: hasSeparateTaxLine - schema: - type: boolean - example: true - description: Whether the booking has a separate tax line. - - in: query - name: hasLinePerIdentifyingField - schema: - type: boolean - example: true - description: Whether the booking has a line per identifying field. - - in: query - name: hasLinePerSource - schema: - type: boolean - example: true - description: Whether the booking has a line per source. - - in: query - name: hasLinePerConcession - schema: - type: boolean - example: true - description: Whether the booking has a line per concession. - - in: query - name: validAt - schema: - type: string - example: 2024-01-01T00:00:00.000 - description: Timestamp that the booking metadata is valid. - - in: query - name: sort - schema: - type: string - example: validFrom - description: The field by which the booking metadata in the result body are sorted. - - in: query - name: limit - schema: - type: integer - example: 15 - description: The limit of the booking metadata in the result body. - - in: query - name: offset - schema: - type: integer - example: 15 - description: The offset of the booking metadata in the result body. + uniqueItems: true + type: array + items: + type: string + enum: + - BookingProcess responses: "200": description: OK @@ -1505,44 +1346,55 @@ paths: tags: - Booking Processes v2.2 parameters: - - in: query - name: bookingGroupFieldId + - $ref: "#/components/parameters/top" + - $ref: "#/components/parameters/skip" + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/count" + - name: $orderby + in: query + description: Order items by property values + required: false + style: form + explode: false schema: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: The id of the booking group field. - - in: query - name: bookingMetadataId + uniqueItems: true + type: array + items: + type: string + enum: + - bookingGroupFieldRowId + - bookingGroupFieldId + - bookingMetadataId + - identifyingFieldValue + - name: $select + in: query + description: Select properties to be returned + required: false + style: form + explode: false schema: - type: string - format: uuid - example: 63d4a7e2-62c3-428b-a4bb-e4ee45516f2a - description: The id of the parent booking metadata. - - in: query - name: identifyingFieldValue + uniqueItems: true + type: array + items: + type: string + enum: + - bookingGroupFieldRowId + - bookingGroupFieldId + - bookingMetadataId + - identifyingFieldValue + - name: $expand + in: query + description: Expand related entities + required: false + style: form + explode: false schema: - type: string - example: 1737 - description: The identifying field value. - - in: query - name: sort - schema: - type: string - example: bookingMetadataId - description: The field by which the booking group fields in the result body are sorted. - - in: query - name: limit - schema: - type: integer - example: 15 - description: The limit of the booking group fields in the result body. - - in: query - name: offset - schema: - type: integer - example: 15 - description: The offset of the booking group fields in the result body. + uniqueItems: true + type: array + items: + type: string + enum: + - BookingMetadata responses: "200": description: OK @@ -1632,131 +1484,83 @@ paths: tags: - Booking Processes v2.2 parameters: - - in: query - name: bookingLineMetadataId - schema: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: The id of the booking line metadata. - - in: query - name: bookingMetadataId - schema: - type: string - format: uuid - example: 63d4a7e2-62c3-428b-a4bb-e4ee45516f2a - description: The id of the parent booking metadata. - - in: query - name: name - schema: - type: string - example: Dakaart - BUS - description: The name of the booking line metadata. - - in: query - name: sourceMetadataId - schema: - type: string - example: 9b371ab4-2c47-4aa5-bcf8-6642385278ac - description: The source of the booking line metadata. - - in: query - name: identifyingFieldValue - schema: - type: string - example: 1737 - description: The identifying field value. - - in: query - name: concessionId - schema: - type: array - items: - type: integer - example: [1, 2] + - $ref: "#/components/parameters/top" + - $ref: "#/components/parameters/skip" + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/count" + - name: $orderby + in: query + description: Order items by property values + required: false + style: form explode: false - description: The name of the concession. - - in: query - name: lineType schema: + uniqueItems: true type: array items: type: string - example: [summary, analysis, tax] + enum: + - bookingLineMetadataRowId + - bookingLineMetadataId + - bookingMetadataId + - name + - sourceMetadataId + - identifyingFieldValue + - concessionId + - lineType + - lineSense + - costCenter + - articleName + - extRef1 + - extRef2 + - extRef3 + - extRef4 + - extRef5 + - extRef6 + - name: $select + in: query + description: Select properties to be returned + required: false + style: form explode: false - description: The type of the line. - - in: query - name: lineSense schema: + uniqueItems: true type: array items: type: string - example: [debit, credit] + enum: + - bookingLineMetadataRowId + - bookingLineMetadataId + - bookingMetadataId + - name + - sourceMetadataId + - identifyingFieldValue + - concessionId + - lineType + - lineSense + - costCenter + - articleName + - extRef1 + - extRef2 + - extRef3 + - extRef4 + - extRef5 + - extRef6 + - name: $expand + in: query + description: Expand related entities + required: false + style: form explode: false - description: The sense of the line. - - in: query - name: costCenter schema: - type: string - example: 603031 - description: The cost center of the booking line metadata. - - in: query - name: artcleName - schema: - type: string - example: Dagkaart - description: The article name of the booking line metadata. - - in: query - name: extRef1 - schema: - type: string - example: extRef1 - description: External reference 1. - - in: query - name: extRef2 - schema: - type: string - example: extRef2 - description: External reference 2. - - in: query - name: extRef3 - schema: - type: string - example: extRef3 - description: External reference 3. - - in: query - name: extRef4 - schema: - type: string - example: extRef4 - description: External reference 4. - - in: query - name: extRef5 - schema: - type: string - example: extRef5 - description: External reference 5. - - in: query - name: extRef6 - schema: - type: string - example: extRef6 - description: External reference 6. - - in: query - name: sort - schema: - type: string - example: lineType - description: The field by which the booking line metadata in the result body are sorted. - - in: query - name: limit - schema: - type: integer - example: 15 - description: The limit of the booking line metadata in the result body. - - in: query - name: offset - schema: - type: integer - example: 15 - description: The offset of the booking line metadata in the result body. + uniqueItems: true + type: array + items: + type: string + enum: + - BookingMetadata + - SourceMetadata + - Concession responses: "200": description: OK @@ -2002,56 +1806,48 @@ paths: tags: - Metadata v2.2 parameters: - - in: query - name: taxMetadataId + - $ref: "#/components/parameters/top" + - $ref: "#/components/parameters/skip" + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/count" + - name: $orderby + in: query + description: Order items by property values + required: false + style: form + explode: false schema: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: The id of the tax metadata. - - in: query - name: taxCode + uniqueItems: true + type: array + items: + type: string + enum: + - taxMetadataRowId + - taxMetadataId + - taxCode + - taxPercentageAmount + - description + - validFrom + - validUntil + - name: $select + in: query + description: Select properties to be returned + required: false + style: form + explode: false schema: - type: string - example: V21 - description: The tax code. - - in: query - name: taxPercentageAmount - schema: - type: number - example: 21 - description: The tax percentage amount. - - in: query - name: description - schema: - type: string - example: BTW VERKOOP HOOG 21% - description: The description of the tax metadata. - - in: query - name: validAt - schema: - type: string - format: date-time - example: 2024-03-22T09:00:00 - description: Timestamp that the metadata is valid. - - in: query - name: sort - schema: - type: string - example: validFrom - description: The field by which the tax metadata in the result body are sorted. - - in: query - name: limit - schema: - type: integer - example: 15 - description: The limit of the tax metadata in the result body. - - in: query - name: offset - schema: - type: integer - example: 15 - description: The offset of the tax metadata in the result body. + uniqueItems: true + type: array + items: + type: string + enum: + - taxMetadataRowId + - taxMetadataId + - taxCode + - taxPercentageAmount + - description + - validFrom + - validUntil responses: "200": description: OK @@ -2183,70 +1979,50 @@ paths: tags: - Metadata v2.2 parameters: - - in: query - name: sourceMetadataId - schema: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: The id of the source metadata. - - in: query - name: incomingName - schema: - type: string - example: VerkoopEngine - description: The name of the source. - - in: query - name: incomingEntity - schema: - type: string - example: OrderLine - description: The entity of the source. - - in: query - name: outgoingName - schema: - type: string - example: Website Verkopen - description: The name of the destination. - - in: query - name: businessOwner - schema: - type: string - example: Koos Verweg - description: The business owner of the source. - - in: query - name: rejectionProcessing + - $ref: "#/components/parameters/top" + - $ref: "#/components/parameters/skip" + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/count" + - name: $orderby + in: query + description: Order items by property values + required: false + style: form + explode: false schema: + uniqueItems: true type: array items: type: string - example: [mail, system] + enum: + - sourceMetadataRowId + - sourceMetadataId + - incomingName + - incomingEntity + - outgoingName + - businessOwner + - rejectionProcessing + - rejectionInfo + - name: $select + in: query + description: Select properties to be returned + required: false + style: form explode: false - description: The rejection processing of the source. - - in: query - name: rejectionInfo schema: - type: string - example: api.htm.nl/v2/account/12345/msgs/abc - description: The rejection info of the source. - - in: query - name: sort - schema: - type: string - example: incomingName - description: The field by which the source metadata in the result body are sorted. - - in: query - name: limit - schema: - type: integer - example: 15 - description: The limit of the source metadata in the result body. - - in: query - name: offset - schema: - type: integer - example: 15 - description: The offset of the source metadata in the result body. + uniqueItems: true + type: array + items: + type: string + enum: + - sourceMetadataRowId + - sourceMetadataId + - incomingName + - incomingEntity + - outgoingName + - businessOwner + - rejectionProcessing + - rejectionInfo responses: "200": description: OK @@ -2364,43 +2140,42 @@ paths: tags: - Metadata v2.2 parameters: - - in: query - name: accountingPeriodMetadataId + - $ref: "#/components/parameters/top" + - $ref: "#/components/parameters/skip" + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/count" + - name: $orderby + in: query + description: Order items by property values + required: false + style: form + explode: false schema: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: The id of the accounting period metadata. - - in: query - name: accountingPeriod + uniqueItems: true + type: array + items: + type: string + enum: + - accountingPeriodMetadataRowId + - accountingPeriodMetadataId + - accountingPeriod + - isOpen + - name: $select + in: query + description: Select properties to be returned + required: false + style: form + explode: false schema: - type: string - example: 2024/01 - description: The accounting period. - - in: query - name: isOpen - schema: - type: boolean - example: true - description: Whether the accounting period is open. - - in: query - name: sort - schema: - type: string - example: accountingPeriod - description: The field by which the accounting period metadata in the result body are sorted. - - in: query - name: limit - schema: - type: integer - example: 15 - description: The limit of the accounting period metadata in the result body. - - in: query - name: offset - schema: - type: integer - example: 15 - description: The offset of the accounting period metadata in the result body. + uniqueItems: true + type: array + items: + type: string + enum: + - accountingPeriodMetadataRowId + - accountingPeriodMetadataId + - accountingPeriod + - isOpen responses: "200": description: OK @@ -2502,52 +2277,59 @@ paths: tags: - Metadata v2.2 parameters: - - in: query - name: concessionMetadataId - schema: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: The id of the concession metadata. - - in: query - name: concessionId + - $ref: "#/components/parameters/top" + - $ref: "#/components/parameters/skip" + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/count" + - name: $orderby + in: query + description: Order items by property values + required: false + style: form + explode: false schema: + uniqueItems: true type: array items: - type: integer - example: [1, 2] + type: string + enum: + - concessionMetadataRowId + - concessionMetadataId + - concessionId + - percentage + - validFrom + - validUntil + - name: $select + in: query + description: Select properties to be returned + required: false + style: form explode: false - description: The name of the concession. - - in: query - name: percentage schema: - type: number - example: 84.021 - description: The percentage of the concession. - - in: query - name: validAt + uniqueItems: true + type: array + items: + type: string + enum: + - concessionMetadataRowId + - concessionMetadataId + - concessionId + - percentage + - validFrom + - validUntil + - name: $expand + in: query + description: Expand related entities + required: false + style: form + explode: false schema: - type: string - example: 2024-01-01T00:00:00.000 - description: Timestamp that the metadata is valid. - - in: query - name: sort - schema: - type: string - example: validFrom - description: The field by which the concession metadata in the result body are sorted. - - in: query - name: limit - schema: - type: integer - example: 15 - description: The limit of the concession metadata in the result body. - - in: query - name: offset - schema: - type: integer - example: 15 - description: The offset of the concession metadata in the result body. + uniqueItems: true + type: array + items: + type: string + enum: + - Concession responses: "200": description: OK @@ -4514,3 +4296,42 @@ components: example: - "/account/12345" - "/account/67890" + parameters: + top: + name: $top + in: query + description: Show only the first n items + required: false + style: form + explode: true + schema: + minimum: 0 + type: integer + skip: + name: $skip + in: query + description: Skip the first n items + required: false + style: form + explode: true + schema: + minimum: 0 + type: integer + count: + name: $count + in: query + description: Include count of items + required: false + style: form + explode: true + schema: + type: boolean + filter: + name: $filter + in: query + description: Filter items by property values + required: false + style: form + explode: true + schema: + type: string