claim-item-returned.raml

#%RAML 1.0
title: Claim item returned
version: v0.2
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost:9130

documentation:
  - title: API for declaring loaned item as claimed returned
    content: <b>Claim item returned API</b>

types:
  errors: !include raml-util/schemas/errors.schema

traits:
  validate: !include raml-util/traits/validation.raml

/circulation/loans/{id}:
  /claim-item-returned:
    post:
      is: [validate]
      body:
        application/json:
          type: !include claim-item-returned-request.json
      responses:
        204:
          description: "The loaned item has been successfully marked as claimed returned"
        422:
          description: "The loan is closed"
        404:
          description: "The loan is not found"
        500:
          description: "Internal server error, e.g. due to misconfiguration"
          body:
            text/plain:
              example: "Internal server error, contact administrator"
  /declare-claimed-returned-item-as-missing:
    post:
      is: [validate]
      body:
        application/json:
          type: !include declare-claimed-returned-item-as-missing-request.json
      responses:
        204:
          description: "The loaned claimed returned item has been successfully marked as missing"
        422:
          description: "The loan is closed"
        404:
          description: "The loan is not found"
        500:
          description: "Internal server error, e.g. due to misconfiguration"
          body:
            text/plain:
              example: "Internal server error, contact administrator"