description: Internal identifier for the parent bibliographic record
required: true
type: string
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - items
+ collectionFormat: csv
- "$ref": "../swagger.yaml#/parameters/match"
- "$ref": "../swagger.yaml#/parameters/order_by"
- "$ref": "../swagger.yaml#/parameters/page"
x-koha-authorization:
permissions:
catalogue: "manage_item_groups"
- x-koha-embed:
- - items
post:
x-mojo-to: Biblios::ItemGroups#add
operationId: addItemGroup
description: Internal identifier for the item_group
required: true
type: string
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - items
+ collectionFormat: csv
produces:
- application/yaml
responses:
description: Under maintenance
schema:
"$ref": "../swagger.yaml#/definitions/error"
- x-koha-embed:
- - items
x-koha-authorization:
permissions:
catalogue: "manage_item_groups"
type: integer
description: Position in waiting queue
additionalProperties: false
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - items
+ collectionFormat: csv
produces:
- application/yaml
responses:
x-koha-authorization:
permissions:
catalogue: "manage_item_groups"
- x-koha-embed:
- - items
delete:
x-mojo-to: Biblios::ItemGroups#delete
operationId: deleteItemGroup
type: integer
description: Internal identifier for an item to be linked
additionalProperties: false
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - items
+ collectionFormat: csv
produces:
- application/yaml
responses:
x-koha-authorization:
permissions:
catalogue: "manage_item_groups"
- x-koha-embed:
- - items
"/biblios/{biblio_id}/item_groups/{item_group_id}/items/{item_id}":
delete:
x-mojo-to: Biblios::ItemGroups::Items#delete
x-koha-authorization:
permissions:
circulate: circulate_remaining_permissions
- x-koha-embed:
- - renewer
"/checkouts/{checkout_id}/allows_renewal":
get:
x-mojo-to: Checkouts#allows_renewal
- application/json
parameters:
- $ref: "../swagger.yaml#/parameters/agreement_id_pp"
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - periods
+ - user_roles
+ - user_roles.patron
+ - agreement_licenses
+ - agreement_licenses.license
+ - agreement_relationships
+ - agreement_relationships.agreement
+ - agreement_relationships.related_agreement
+ - documents
+ - packages
+ collectionFormat: csv
responses:
200:
description: An agreement
x-koha-authorization:
permissions:
erm: 1
- x-koha-embed:
- - periods
- - user_roles
- - user_roles.patron
- - agreement_licenses
- - agreement_licenses.license
- - agreement_relationships
- - agreement_relationships.agreement
- - agreement_relationships.related_agreement
- - documents
- - packages
put:
x-mojo-to: ERM::Agreements#update
operationId: updateErmAgreements
required: true
schema:
$ref: "../swagger.yaml#/definitions/erm_agreement"
-
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - periods
+ - user_roles
+ - agreement_licenses
+ - agreement_relationships
+ - documents
+ collectionFormat: csv
responses:
200:
description: A successfully updated agreement
x-koha-authorization:
permissions:
erm: 1
- x-koha-embed:
- - periods
- - user_roles
- - agreement_licenses
- - agreement_relationships
- - documents
delete:
x-mojo-to: ERM::Agreements#delete
operationId: deleteErmAgreements
- $ref: "../swagger.yaml#/parameters/q_param"
- $ref: "../swagger.yaml#/parameters/q_body"
- $ref: "../swagger.yaml#/parameters/q_header"
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - vendors
+ - resources+count
+ collectionFormat: csv
responses:
200:
description: A list of package
x-koha-authorization:
permissions:
erm: 1
- x-koha-embed:
- - vendors
- - resources+count
post:
x-mojo-to: ERM::EHoldings::Packages#add
operationId: addErmEHoldingsPackages
required: true
type: string
- $ref: "../swagger.yaml#/parameters/eholdings_package_id_pp"
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - agreements
+ - resources
+ collectionFormat: csv
responses:
200:
description: A package
x-koha-authorization:
permissions:
erm: 1
- x-koha-embed:
- - agreements
- - resources
put:
x-mojo-to: ERM::EHoldings::Packages#update
operationId: updateErmEHoldingsPackages
required: true
schema:
$ref: "../swagger.yaml#/definitions/erm_eholdings_package"
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - agreements
+ - resources
+ collectionFormat: csv
responses:
200:
description: A successfully updated package
x-koha-authorization:
permissions:
erm: 1
- x-koha-embed:
- - agreements
- - resources
delete:
x-mojo-to: ERM::EHoldings::Packages#delete
operationId: deleteErmEHoldingsPackages
- $ref: "../swagger.yaml#/parameters/q_param"
- $ref: "../swagger.yaml#/parameters/q_body"
- $ref: "../swagger.yaml#/parameters/q_header"
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - title.publication_title
+ collectionFormat: csv
responses:
200:
description: A list of eHoldings resources
x-koha-authorization:
permissions:
erm: 1
- x-koha-embed:
- - title.publication_title
required: true
type: string
- $ref: "../swagger.yaml#/parameters/eholdings_title_id_pp"
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - resources
+ - resources.package
+ collectionFormat: csv
responses:
200:
description: An eHolding title
x-koha-authorization:
permissions:
erm: 1
- x-koha-embed:
- - resources
- - resources.package
put:
x-mojo-to: ERM::EHoldings::Titles#update
operationId: updateErmEHoldingsTitles
required: true
schema:
$ref: "../swagger.yaml#/definitions/erm_eholdings_title"
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - resources
+ - resources.package
+ collectionFormat: csv
responses:
200:
description: A successfully updated title
x-koha-authorization:
permissions:
erm: 1
- x-koha-embed:
- - resources
- - resources.package
delete:
x-mojo-to: ERM::EHoldings::Titles#delete
operationId: deleteErmEHoldingsTitles
- $ref: "../swagger.yaml#/parameters/q_param"
- $ref: "../swagger.yaml#/parameters/q_body"
- $ref: "../swagger.yaml#/parameters/q_header"
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - title.publication_title
+ collectionFormat: csv
responses:
200:
description: A list of eHoldings resources
x-koha-authorization:
permissions:
erm: 1
- x-koha-embed:
- - title.publication_title
- application/json
parameters:
- $ref: "../swagger.yaml#/parameters/license_id_pp"
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - user_roles
+ - user_roles.patron
+ - documents
+ collectionFormat: csv
responses:
200:
description: license
x-koha-authorization:
permissions:
erm: 1
- x-koha-embed:
- - user_roles
- - user_roles.patron
- - documents
put:
x-mojo-to: ERM::Licenses#update
operationId: updateERMlicenses
required: true
schema:
$ref: "../swagger.yaml#/definitions/erm_license"
-
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - user_roles
+ - documents
+ collectionFormat: csv
responses:
200:
description: a successfully updated license
x-koha-authorization:
permissions:
erm: 1
- x-koha-embed:
- - user_roles
- - documents
delete:
x-mojo-to: ERM::Licenses#delete
operationId: deleteERMlicenses
- $ref: "../swagger.yaml#/parameters/q_param"
- $ref: "../swagger.yaml#/parameters/q_body"
- $ref: "../swagger.yaml#/parameters/q_header"
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - extended_attributes
+ collectionFormat: csv
produces:
- application/json
responses:
x-koha-authorization:
permissions:
erm: 1
- x-koha-embed:
- - extended_attributes
- $ref: "../swagger.yaml#/parameters/q_param"
- $ref: "../swagger.yaml#/parameters/q_body"
- $ref: "../swagger.yaml#/parameters/q_header"
+ - name: x-koha-embed
+ in: header
+ required: false
+ description: Embed list sent as a request header
+ type: array
+ items:
+ type: string
+ enum:
+ - biblio
+ - checkout
+ - return_claims
+ - return_claim
+ - return_claim.patron
+ collectionFormat: csv
consumes:
- application/json
produces:
x-koha-authorization:
permissions:
catalogue: "1"
- x-koha-embed:
- - biblio
- - checkout
- - return_claims
- - return_claim
- - return_claim.patron
"/items/{item_id}/bundled_items/{bundled_item_id}":
delete:
x-mojo-to: Items#remove_from_bundle