Item dameged statuses API API documentation

/item-damaged-statuses

Collection of item-damaged-status items.

/item-damaged-statuses get post

get

Return a list of item damaged status

post

Create a new item damaged status

Return a list of item damaged status

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

name=aaa
```
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]

HTTP status code 200

Returns a list of item-damaged-status items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of item damage statuses",
  "type": "object",
  "properties": {
    "itemDamageStatuses": {
      "description": "List of item damage statuses",
      "id": "itemDamageStatus",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "itemdamagedstatus.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "itemDamageStatuses",
    "totalRecords"
  ]
}

Example:

{
  "itemDamageStatuses" : [ {
    "id" : "54d1dd76-ea33-4bcb-955b-6b29df4f7930",
    "name" : "Damaged",
    "source" : "local"
  }, {
    "id" : "516b82eb-1f19-4a63-8c48-8f1a3e9ff311",
    "name" : "Not Damaged",
    "source" : "local"
  } ],
  "totalRecords" : 2
}

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 item-damaged-statuses -- 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 item-damaged-statuses -- 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 new item damaged status

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#",
  "description": "An item damage status",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the item damage status; a UUID"
    },
    "name": {
      "type": "string",
      "description": "name of the item damage status"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the item damage status entry originates from, i.e. 'folio' or 'local'"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "source"
  ]
}

Example:

{
  "id" : "54d1dd76-ea33-4bcb-955b-6b29df4f7930",
  "name" : "Damaged",
  "source" : "local"
}

HTTP status code 201

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

Headers

Location: required(string)
URI to the created item-damaged-status item

Body

Media type: application/json

Type: any

Example:

{
  "id" : "54d1dd76-ea33-4bcb-955b-6b29df4f7930",
  "name" : "Damaged",
  "source" : "local"
}

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 item-damaged-status -- 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 item-damaged-statuses -- 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": {
      "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

/item-damaged-statuses/{id} get delete put

Pass in the item damaged status id

get

Retrieve item-damaged-status item with given {item-damaged-statusId}

delete

Delete item-damaged-status item with given {item-damaged-statusId}

put

Update item-damaged-status item with given {item-damaged-statusId}

Retrieve item-damaged-status item with given {item-damaged-statusId}

Request
Response

URI Parameters

id: 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#",
  "description": "An item damage status",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the item damage status; a UUID"
    },
    "name": {
      "type": "string",
      "description": "name of the item damage status"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the item damage status entry originates from, i.e. 'folio' or 'local'"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "source"
  ]
}

Example:

{
  "id" : "54d1dd76-ea33-4bcb-955b-6b29df4f7930",
  "name" : "Damaged",
  "source" : "local"
}

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"item-damaged-status 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 item-damaged-status item with given {item-damaged-statusId}

Request
Response

URI Parameters

id: 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 item-damaged-status -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"item-damaged-status 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 item-damaged-status item with given {item-damaged-statusId}

Request
Response

URI Parameters

id: 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#",
  "description": "An item damage status",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the item damage status; a UUID"
    },
    "name": {
      "type": "string",
      "description": "name of the item damage status"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the item damage status entry originates from, i.e. 'folio' or 'local'"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "source"
  ]
}

Example:

{
  "id" : "54d1dd76-ea33-4bcb-955b-6b29df4f7930",
  "name" : "Damaged",
  "source" : "local"
}

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 item-damaged-status -- malformed JSON at 13:4"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"item-damaged-status 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

Item dameged statuses API API documentation version v1.0