Owners (v1)

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

Table of contents

Owners API

This documents the API calls that can be made to query and manage owner of the system

/owners

Collection of owner items.

GET /owners

Return a list of owners

GET /owners
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 owner items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "owners": {
      "type": "array",
      "id": "ownersData",
      "items": {
        "type": "object",
        "$ref": "ownerdata.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "owners",
    "totalRecords"
  ]
}

Example:

{
  "owners": [
   {
    "owner": "Main Admin",
    "desc": "Main Library Administration Office",
    "servicePointOwner": [{
      "value": "3a40852d-49fd-4df2-a1f9-6e2641a6e91f",
      "label": "Main Lib Circ Desk"
    }],
    "metadata": {
      "createdDate": "2018-05-22T21:21:02Z",
      "createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
      "createdByUsername": "Doe",
      "updatedDate": "2018-05-22T21:21:02Z",
      "updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
      "updatedByUsername": "robertjones"
    },
    "id": "8166df0e-36be-4bf8-8cb7-97b252d9989d"
   }
  ],
  "totalRecords": 1
}

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 owners -- 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 owners -- 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 /owners

Create a owner

POST /owners
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": "Owner Schema",
  "type": "object",
  "properties": {
    "owner": {
      "type": "string"
    },
    "desc": {
      "type": "string"
    },
    "servicePointOwner": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string"
          },
          "label": {
            "type": "string"
          }
        },
        "required": [
          "value"
        ]
      }
    },
    "metadata" : {
      "type" : "object",
      "$ref" : "raml-util/schemas/metadata.schema"
    },
    "id": {
      "type": "string"
     }
    },
  "additionalProperties": false,
  "required": [
     "id"
  ]
}

Example:

{
  "owner": "Main Circ",
  "desc": "Main Library Circulation Desk",
  "servicePointOwner": [{
    "value": "3a40852d-49fd-4df2-a1f9-6e2641a6e91f",
    "label": "Main Lib Circ Desk"
  }],
  "metadata": {
    "createdDate": "2018-05-22T21:21:02Z",
    "createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
    "createdByUsername": "Doe",
    "updatedDate": "2018-05-22T21:21:02Z",
    "updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
    "updatedByUsername": "robertjones"
  },
  "id": "8166df0e-36be-4bf8-8cb7-97b252d9989d"
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created owner item

Body

Media type: application/json

Type: any

Example:

{
  "owner": "Main Circ",
  "desc": "Main Library Circulation Desk",
  "servicePointOwner": [{
    "value": "3a40852d-49fd-4df2-a1f9-6e2641a6e91f",
    "label": "Main Lib Circ Desk"
  }],
  "metadata": {
    "createdDate": "2018-05-22T21:21:02Z",
    "createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
    "createdByUsername": "Doe",
    "updatedDate": "2018-05-22T21:21:02Z",
    "updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
    "updatedByUsername": "robertjones"
  },
  "id": "8166df0e-36be-4bf8-8cb7-97b252d9989d"
}

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 owner -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create owners -- unauthorized

Response 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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /owners/{ownerId}

Get a single owner

GET /owners/{ownerId}
URI Parameters
  • ownerId: 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": "Owner Schema",
  "type": "object",
  "properties": {
    "owner": {
      "type": "string"
    },
    "desc": {
      "type": "string"
    },
    "servicePointOwner": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string"
          },
          "label": {
            "type": "string"
          }
        },
        "required": [
          "value"
        ]
      }
    },
    "metadata" : {
      "type" : "object",
      "$ref" : "raml-util/schemas/metadata.schema"
    },
    "id": {
      "type": "string"
     }
    },
  "additionalProperties": false,
  "required": [
     "id"
  ]
}

Example:

{
  "owner": "Main Circ",
  "desc": "Main Library Circulation Desk",
  "servicePointOwner": [{
    "value": "3a40852d-49fd-4df2-a1f9-6e2641a6e91f",
    "label": "Main Lib Circ Desk"
  }],
  "metadata": {
    "createdDate": "2018-05-22T21:21:02Z",
    "createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
    "createdByUsername": "Doe",
    "updatedDate": "2018-05-22T21:21:02Z",
    "updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
    "updatedByUsername": "robertjones"
  },
  "id": "8166df0e-36be-4bf8-8cb7-97b252d9989d"
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"owner 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 /owners/{ownerId}

Delete owner item with given {ownerId}

DELETE /owners/{ownerId}
URI Parameters
  • ownerId: 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 owner -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"owner 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 /owners/{ownerId}

Update owner item with given {ownerId}

PUT /owners/{ownerId}
URI Parameters
  • ownerId: 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": "Owner Schema",
  "type": "object",
  "properties": {
    "owner": {
      "type": "string"
    },
    "desc": {
      "type": "string"
    },
    "servicePointOwner": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string"
          },
          "label": {
            "type": "string"
          }
        },
        "required": [
          "value"
        ]
      }
    },
    "metadata" : {
      "type" : "object",
      "$ref" : "raml-util/schemas/metadata.schema"
    },
    "id": {
      "type": "string"
     }
    },
  "additionalProperties": false,
  "required": [
     "id"
  ]
}

Example:

{
  "owner": "Main Circ",
  "desc": "Main Library Circulation Desk",
  "servicePointOwner": [{
    "value": "3a40852d-49fd-4df2-a1f9-6e2641a6e91f",
    "label": "Main Lib Circ Desk"
  }],
  "metadata": {
    "createdDate": "2018-05-22T21:21:02Z",
    "createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
    "createdByUsername": "Doe",
    "updatedDate": "2018-05-22T21:21:02Z",
    "updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
    "updatedByUsername": "robertjones"
  },
  "id": "8166df0e-36be-4bf8-8cb7-97b252d9989d"
}

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

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

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