Overdue Fine Policies API documentation version v1.0

HTTP status code 200

Return Overdue Fine Policy list

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of overdue fine policies",
  "type": "object",
  "properties": {
    "overdueFinePolicies": {
      "description": "List of overdue fine policies",
      "id": "overdueFinePolicies",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "overdue-fine-policy.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "overdueFinePolicies",
    "totalRecords"
  ]
}

Example:

{
  "overdueFinePolicies":[
    {
      "name": "Faculty standard",
      "description": "This is description for Faculty standard",
      "overdueFine": {
        "quantity": 5.0,
        "intervalId": "day"
       },
      "countClosed": true,
      "maxOverdueFine": 50.00,
      "forgiveOverdueFine": true,
      "overdueRecallFine": {
        "quantity": 1.0,
        "intervalId": "hour"
      },
      "gracePeriodRecall": false,
      "maxOverdueRecallFine": 50.00,
      "id": "b712dffc-c107-4e88-b3d5-fba2fb35755e" 
    }
  ],
  "totalRecords":1
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

unable to list overdue-fines-policies -- malformed parameter 'query', syntax error at column 6

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list overdue-fines-policies -- unauthorized

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

HTTP status code 201

Overdue fine policy created

Headers

• Location: required(string)

  URI to the created overdue-fines-policy item

Body

Media type: application/json

Type: json

Content:

{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title": "Overdue fine policies schema",
  "description": "Overdue fine policy to be associated with a loan policy by the Circulation Rules Editor",
  "type": "object",
  "properties": {
    "name": {
      "description": "Overdue fine policy name",
      "type": "string"
    },
    "description": {
      "description": "Overdue fine policy description",
      "type": "string"
    },
    "overdueFine": {
      "description": "Fine for overdue",
      "type": "object",
      "$ref": "quantity.json"
    },
    "countClosed": {
      "description": "A flag to determine if a fine is count closed",
      "type": "boolean"
    },
    "maxOverdueFine": {
      "description": "Maximum overdue fine",
      "type": "number"
    },
    "forgiveOverdueFine": {
      "description": "A flag to determine forgive overdue fine if item renewed",
      "type": "boolean"
    },
    "overdueRecallFine": {
      "description": "Fine overdue recall fine",
      "type": "object",
      "$ref": "quantity.json"
    },
    "gracePeriodRecall": {
      "description": "Grace period for recall",
      "type": "boolean"
    },
    "maxOverdueRecallFine": {
      "description": "Maximum overdue recall fine",
      "type": "number"
    },
    "metadata": {
      "description": "Metadata about creation to overdue fine policy, provided by the server",
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema"
    },
    "id": {
      "description": "Overdue fine policy id, UUID",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
   ]
}

Example:

{
  "name": "Faculty standard",
  "description": "This is description for Faculty standard",
  "overdueFine": {
    "quantity": 5.0,
    "intervalId": "day"
  },
  "countClosed": true,
  "maxOverdueFine": 50.00,
  "forgiveOverdueFine": true,
  "overdueRecallFine": {
    "quantity": 1.0,
    "intervalId": "hour"
  },
  "gracePeriodRecall": false,
  "maxOverdueRecallFine": 50.00,
  "id": "b712dffc-c107-4e88-b3d5-fba2fb35755e"
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to add overdue-fines-policy -- malformed JSON at 13:3"

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create overdue-fines-policies -- unauthorized

HTTP status code 422

Unprocessable entity

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",
        "$ref": "error.schema"
      }
    },
    "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

Body

Media type: text/plain

Type: any

Example:

Internal server error

HTTP status code 200

Return Overdue Fine Policy

Body

Media type: application/json

Type: json

Content:

{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title": "Overdue fine policies schema",
  "description": "Overdue fine policy to be associated with a loan policy by the Circulation Rules Editor",
  "type": "object",
  "properties": {
    "name": {
      "description": "Overdue fine policy name",
      "type": "string"
    },
    "description": {
      "description": "Overdue fine policy description",
      "type": "string"
    },
    "overdueFine": {
      "description": "Fine for overdue",
      "type": "object",
      "$ref": "quantity.json"
    },
    "countClosed": {
      "description": "A flag to determine if a fine is count closed",
      "type": "boolean"
    },
    "maxOverdueFine": {
      "description": "Maximum overdue fine",
      "type": "number"
    },
    "forgiveOverdueFine": {
      "description": "A flag to determine forgive overdue fine if item renewed",
      "type": "boolean"
    },
    "overdueRecallFine": {
      "description": "Fine overdue recall fine",
      "type": "object",
      "$ref": "quantity.json"
    },
    "gracePeriodRecall": {
      "description": "Grace period for recall",
      "type": "boolean"
    },
    "maxOverdueRecallFine": {
      "description": "Maximum overdue recall fine",
      "type": "number"
    },
    "metadata": {
      "description": "Metadata about creation to overdue fine policy, provided by the server",
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema"
    },
    "id": {
      "description": "Overdue fine policy id, UUID",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
   ]
}

Example:

{
  "name": "Faculty standard",
  "description": "This is description for Faculty standard",
  "overdueFine": {
    "quantity": 5.0,
    "intervalId": "day"
  },
  "countClosed": true,
  "maxOverdueFine": 50.00,
  "forgiveOverdueFine": true,
  "overdueRecallFine": {
    "quantity": 1.0,
    "intervalId": "hour"
  },
  "gracePeriodRecall": false,
  "maxOverdueRecallFine": 50.00,
  "id": "b712dffc-c107-4e88-b3d5-fba2fb35755e"
}

HTTP status code 404

Not found

Body

Media type: text/plain

Type: any

Example:

Not found

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

HTTP status code 204

Source record deleted

HTTP status code 400

Bad request, e.g. malformed request body, query parameter or constraint violation.

Body

Media type: text/plain

Type: any

Example:

Cannot delete in use fine policy

HTTP status code 404

There is no source record for that overdueFinePolicyId

Body

Media type: text/plain

Type: any

Example:

Not found

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

HTTP status code 204

Item successfully updated

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to update overdue-fines-policy -- malformed JSON at 13:4"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"overdue-fines-policy not found"

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