Transfers criteria (v1)

http://github.com/org/folio/mod-feesfines

Table of contents

Transfers criteria API

This documents the API calls that can be made to query and manage fee/fine of the system

/transfer-criterias

Collection of transfer-criteria items.

GET /transfer-criterias

Return a list of transfer criteria

GET /transfer-criterias
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
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of transfer-criteria items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of tranfer criterias",
  "type": "object",
  "properties": {
    "transferCriterias": {
      "description": "List of transfer criteria items",
      "type": "array",
      "id": "transferCriteriaData",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Transfer criteria schema",
        "description": "CRUD Fee/Fine transfer criteria",
        "properties": {
          "criteria": {
            "description": "Not implemented yet",
            "type": "string"
          },
          "type": {
            "description": "Not implemented yet",
            "type": "string"
          },
          "value": {
            "description": "Not implemented yet",
            "javaType": "org.folio.rest.domain.MonetaryValue",
            "type": "number"
          },
          "interval": {
            "description": "Not implemented yet",
            "type": "string"
          },
          "id": {
            "description": "Transfer criteria id, UUID",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          }
        },
        "additionalProperties": false
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "transferCriterias",
    "totalRecords"
  ]
}

Example:

{
  "transferCriterias":[
    {
      "criteria": "Transfer student fees/fines",
      "type": "1",
      "value": 14,
      "interval": "days",
      "id": "0bab56e5-1ab6-4ac2-afdf-8b2df0438769"
    },
    {
      "criteria": "Transfer employee fees/fines",
      "type": "2",
      "value": 14,
      "interval": "days",
      "id": "0bab56e5-1ab6-4ac2-afdf-8b2df0434575"
    }
  ],
  "totalRecords":2
}

Response 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 transfer-criterias -- malformed parameter 'query', syntax error at column 6

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list transfer-criterias -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /transfer-criterias

Create a transfer criteria

POST /transfer-criterias
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": "Transfer criteria schema",
  "description": "CRUD Fee/Fine transfer criteria",
  "type": "object",
  "properties": {
    "criteria": {
      "description": "Not implemented yet",
      "type": "string"
    },
    "type": {
      "description": "Not implemented yet",
      "type": "string"
    },
    "value": {
      "description": "Not implemented yet",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "interval": {
      "description": "Not implemented yet",
      "type": "string"
    },
    "id": {
      "description": "Transfer criteria id, UUID",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    }
  },
  "additionalProperties": false
}

Example:

{
  "criteria": "student",
  "type": "1",
  "value": 14,
  "interval": "days",
  "id": "0bab56e5-1ab6-4ac2-afdf-8b2df0438769"
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created transfer-criteria item

Body

Media type: application/json

Type: any

Example:

{
  "criteria": "student",
  "type": "1",
  "value": 14,
  "interval": "days",
  "id": "0bab56e5-1ab6-4ac2-afdf-8b2df0438769"
}

Response 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 transfer-criteria -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create transfer-criterias -- unauthorized

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.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#",
        "id": "error.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": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /transfer-criterias/{transferCriteriaId}

Get a single transfer criteria

GET /transfer-criterias/{transferCriteriaId}
URI Parameters
  • transferCriteriaId: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Transfer criteria schema",
  "description": "CRUD Fee/Fine transfer criteria",
  "type": "object",
  "properties": {
    "criteria": {
      "description": "Not implemented yet",
      "type": "string"
    },
    "type": {
      "description": "Not implemented yet",
      "type": "string"
    },
    "value": {
      "description": "Not implemented yet",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "interval": {
      "description": "Not implemented yet",
      "type": "string"
    },
    "id": {
      "description": "Transfer criteria id, UUID",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    }
  },
  "additionalProperties": false
}

Example:

{
  "criteria": "student",
  "type": "1",
  "value": 14,
  "interval": "days",
  "id": "0bab56e5-1ab6-4ac2-afdf-8b2df0438769"
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"transfer-criteria not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

DELETE /transfer-criterias/{transferCriteriaId}

Delete transfer-criteria item with given {transfer-criteriaId}

DELETE /transfer-criterias/{transferCriteriaId}
URI Parameters
  • transferCriteriaId: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

Item deleted successfully

Response 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 transfer-criteria -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"transfer-criteria not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

PUT /transfer-criterias/{transferCriteriaId}

Update transfer-criteria item with given {transfer-criteriaId}

PUT /transfer-criterias/{transferCriteriaId}
URI Parameters
  • transferCriteriaId: 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": "Transfer criteria schema",
  "description": "CRUD Fee/Fine transfer criteria",
  "type": "object",
  "properties": {
    "criteria": {
      "description": "Not implemented yet",
      "type": "string"
    },
    "type": {
      "description": "Not implemented yet",
      "type": "string"
    },
    "value": {
      "description": "Not implemented yet",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "interval": {
      "description": "Not implemented yet",
      "type": "string"
    },
    "id": {
      "description": "Transfer criteria id, UUID",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    }
  },
  "additionalProperties": false
}

Example:

{
  "criteria": "student",
  "type": "1",
  "value": 14,
  "interval": "days",
  "id": "0bab56e5-1ab6-4ac2-afdf-8b2df0438769"
}

Response 204

Item successfully updated

Response 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 transfer-criteria -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"transfer-criteria not found"

Response 409

Optimistic locking version conflict

Body

Media type: text/plain

Type: any

Example:

version conflict

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator