Feefines API documentation

/feefines

Collection of feefine items.

/feefines get post

get

Return a list of feefines

post

Create a feefine

Return a list of feefines

Request
Response

Query Parameters

query: (string)
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
with valid searchable fields
Example:
```
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode

active=true
```
orderBy: (string)
Order by field: field A, field B
order: (one of desc, asc - default: desc)
Order
offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
```
0
```
limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response
Example:
```
10
```
facets: (array of )
facets to return in the collection result set, can be suffixed by a count of facet values to return, for example, patronGroup:10 default to top 5 facet values
lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

HTTP status code 200

Returns a list of feefine items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "feefines": {
      "type": "array",
      "id": "feefinesData",
      "items": {
        "type": "object",
        "$ref": "feefinedata.json"
      }
    },
    "totalRecords": {
      "type": "integer"
     },
    "resultInfo":{
      "$ref": "raml-util/schemas/resultInfo.schema",
      "readonly":true
    }

  },
  "required": [
    "feefines",
    "totalRecords"
  ]
}

Example:

{
  "feefines":[
    {
      "feeFineType":"overdue",
      "defaultAmount":100,
      "actionNotice": [{
        "name": "Fee receipt notice",
        "id": "a8fcb171-5bd2-4913-97ef-4c7ed322b3ed"
      }],
      "actionNotice": [{
        "name": "Fee receipt notice",
        "id": "a8fcb171-5bd2-4913-97ef-4c7ed322b3ed"
      }],
      "ownerId":"03ece16e-3fc6-4390-8511-ca7a7882c5c6",
      "id":"39a14e03-c372-4659-860b-5423c970633e"
    }
  ],
  "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 feefines -- 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 feefines -- unauthorized

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

Create a feefine

Request
Response

Query Parameters

lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title": "Fee/Fine Schema",
  "type": "object",
  "properties": {
    "feeFineType": {
      "type": "string"
    },
    "defaultAmount": {
      "type": "number"
    },
    "chargeNotice": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "actionNotice": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "ownerId": {
      "type": "string"
    },
    "metadata" : {
      "type" : "object",
      "$ref" : "raml-util/schemas/metadata.schema"
    },
    "id": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "feeFineType",
    "ownerId"
   ]
}

Example:

{
  "feeFineType": "overdue",
  "defaultAmount": 100,
  "chargeNotice": [{
    "name": "Fee notice",
    "id": "09eb3fcb-eeec-4aca-a38e-3cbaac495cfc"
  }],
  "actionNotice": [{
    "name": "Fee receipt notice",
    "id": "a8fcb171-5bd2-4913-97ef-4c7ed322b3ed"
  }],
  "ownerId": "03ece16e-3fc6-4390-8511-ca7a7882c5c6",
  "id": "39a14e03-c372-4659-860b-5423c970633e"
}

HTTP status code 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers

Location: required (string)
URI to the created feefine item

Body

Media type: application/json

Type: any

Example:

{
  "feeFineType": "overdue",
  "defaultAmount": 100,
  "chargeNotice": [{
    "name": "Fee notice",
    "id": "09eb3fcb-eeec-4aca-a38e-3cbaac495cfc"
  }],
  "actionNotice": [{
    "name": "Fee receipt notice",
    "id": "a8fcb171-5bd2-4913-97ef-4c7ed322b3ed"
  }],
  "ownerId": "03ece16e-3fc6-4390-8511-ca7a7882c5c6",
  "id": "39a14e03-c372-4659-860b-5423c970633e"
}

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 feefine -- 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 feefines -- unauthorized

HTTP status code 422

Validation errors

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": {
      "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

/feefines/{feefineId} get delete put

Entity representing a feefine

get

Get a single feefine

delete

Delete feefine item with given {feefineId}

put

Update feefine item with given {feefineId}

Get a single feefine

Request
Response

URI Parameters

feefineId: required (string)

Query Parameters

lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

HTTP status code 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title": "Fee/Fine Schema",
  "type": "object",
  "properties": {
    "feeFineType": {
      "type": "string"
    },
    "defaultAmount": {
      "type": "number"
    },
    "chargeNotice": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "actionNotice": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "ownerId": {
      "type": "string"
    },
    "metadata" : {
      "type" : "object",
      "$ref" : "raml-util/schemas/metadata.schema"
    },
    "id": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "feeFineType",
    "ownerId"
   ]
}

Example:

{
  "feeFineType": "overdue",
  "defaultAmount": 100,
  "chargeNotice": [{
    "name": "Fee notice",
    "id": "09eb3fcb-eeec-4aca-a38e-3cbaac495cfc"
  }],
  "actionNotice": [{
    "name": "Fee receipt notice",
    "id": "a8fcb171-5bd2-4913-97ef-4c7ed322b3ed"
  }],
  "ownerId": "03ece16e-3fc6-4390-8511-ca7a7882c5c6",
  "id": "39a14e03-c372-4659-860b-5423c970633e"
}

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"feefine 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

Delete feefine item with given {feefineId}

Request
Response

URI Parameters

feefineId: required (string)

Query Parameters

lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

HTTP status code 204

Item deleted successfully

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 delete feefine -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"feefine 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

Update feefine item with given {feefineId}

Request
Response

URI Parameters

feefineId: required (string)

Query Parameters

lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title": "Fee/Fine Schema",
  "type": "object",
  "properties": {
    "feeFineType": {
      "type": "string"
    },
    "defaultAmount": {
      "type": "number"
    },
    "chargeNotice": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "actionNotice": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "ownerId": {
      "type": "string"
    },
    "metadata" : {
      "type" : "object",
      "$ref" : "raml-util/schemas/metadata.schema"
    },
    "id": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "feeFineType",
    "ownerId"
   ]
}

Example:

{
  "feeFineType": "overdue",
  "defaultAmount": 100,
  "chargeNotice": [{
    "name": "Fee notice",
    "id": "09eb3fcb-eeec-4aca-a38e-3cbaac495cfc"
  }],
  "actionNotice": [{
    "name": "Fee receipt notice",
    "id": "a8fcb171-5bd2-4913-97ef-4c7ed322b3ed"
  }],
  "ownerId": "03ece16e-3fc6-4390-8511-ca7a7882c5c6",
  "id": "39a14e03-c372-4659-860b-5423c970633e"
}

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 feefine -- malformed JSON at 13:4"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"feefine 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

Feefines API documentation version v1

Feefines API

/feefines

/feefines get post

get /feefines

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 500

Body

post /feefines

Query Parameters

Body

HTTP status code 201

Headers

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 422

Body

HTTP status code 500

Body

/feefines/{feefineId} get delete put

get /feefines/{feefineId}

URI Parameters

Query Parameters

HTTP status code 200

Body

HTTP status code 404

Body

HTTP status code 500

Body

delete /feefines/{feefineId}

URI Parameters

Query Parameters

HTTP status code 204

HTTP status code 400

Body

HTTP status code 404

Body

HTTP status code 500

Body

put /feefines/{feefineId}

URI Parameters

Query Parameters

Body

HTTP status code 204

HTTP status code 400

Body

HTTP status code 404

Body

HTTP status code 500

Body