Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
#%RAML 1.0
title: Batch voucher exports
version: v1.0
protocols: [ HTTP, HTTPS ]
baseUri: http://github.com/folio-org/mod-invoice-storage
documentation:
- title: Batch voucher exports CRUD API
content: This documents the API calls that can be made to manage batch voucher exports
types:
batchVoucherExport: !include acq-models/mod-invoice-storage/schemas/batch_voucher_export.json
batchVoucherExportCollection: !include acq-models/mod-invoice-storage/schemas/batch_voucher_export_collection.json
errors: !include raml-util/schemas/errors.schema
UUID:
type: string
pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
traits:
validate: !include raml-util/traits/validation.raml
language: !include raml-util/traits/language.raml
pageable: !include raml-util/traits/pageable.raml
searchable: !include raml-util/traits/searchable.raml
resourceTypes:
collection: !include raml-util/rtypes/collection.raml
collection-item: !include raml-util/rtypes/item-collection.raml
/batch-voucher-storage/batch-voucher-exports:
type:
collection:
schemaCollection: batchVoucherExportCollection
schemaItem: batchVoucherExport
exampleCollection: !include acq-models/mod-invoice-storage/examples/batch_voucher_export_collection.sample
exampleItem: !include acq-models/mod-invoice-storage/examples/batch_voucher_export.sample
post:
is: [validate]
get:
description: Get list of batch voucher exports
is: [
validate,
pageable,
searchable: {description: "with valid searchable fields: for example format", example: "format==\"Application/xml\""}
]
/{id}:
uriParameters:
id:
description: The UUID of a batch voucher exports
type: UUID
type:
collection-item:
schema: batchVoucherExport
exampleItem: !include acq-models/mod-invoice-storage/examples/batch_voucher_export.sample
get:
is: [validate]
put:
is: [validate]
delete:
is: [validate]