Declare item lost version v0.3

http://localhost:9130

API for declaring loaned item lost

Declare item lost API

/circulation

post

post

URI Parameters

  • id: required(string)

Body

Media type: application/json

Type:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Request body schema for declare item lost API",
  "properties": {
    "declaredLostDateTime": {
      "description": "The date and time when the item is to be declared lost",
      "type": "string",
      "format": "date-time"
    },
    "comment": {
      "description": "Comment explaining why the item has been declared lost",
      "type": "string"
    },
    "servicePointId": {
      "description": "Current service point, where the item is being declared lost",
      "type": "string",
      "$ref": "uuid.json"
    }
  },
  "required": [
    "declaredLostDateTime",
    "servicePointId"
  ]
}

HTTP status code 204

The loaned item has been successfully declared lost

HTTP status code 404

The loan is not found

HTTP status code 422

The loan is closed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "type": "object",
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator