mod-kb-ebsco-java (v1)

https://github.com/folio-org/mod-kb-ebsco-java

Table of contents

mod-kb-ebsco-java

Implements the eholdings interface using EBSCO KB as backend.

Access Types

GET /eholdings/access-types

Get a list of access types.

GET /eholdings/access-types

Response 200

OK

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Access Types Collection Schema",
  "description": "Access Types Collection Schema",
  "javaType": "org.folio.rest.jaxrs.model.AccessTypeCollection",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "array",
      "description": "List of access types",
      "items": {
        "type": "object",
        "$ref": "accessType.json"
      }
    },
    "meta": {
      "type": "object",
      "description": "metadata containing total results in collection",
      "$ref": "../metaTotalResults.json",
      "readonly": true
    },
    "jsonapi": {
      "type": "object",
      "description": "version of json api",
      "$ref": "../jsonapi.json"
    }
  },
  "required": ["data", "meta", "jsonapi"]
}

Example:

{
  "data": [
    {
      "id": "6b30f929-6075-4e18-82fa-525f1355acd7",
      "type": "accessTypes",
      "attributes": {
        "name": "my custom type 1",
        "description": "Description 1",
        "credentialsId": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
      },
      "creator": {
        "lastName": "Doe",
        "firstName": "John",
        "middleName": "Joseph"
      },
      "metadata": {
        "createdDate": "2020-02-03T13:23:56.784",
        "updatedDate": "2020-02-03T13:23:56.784+0000",
        "createdByUserId": "22222222-2222-2222-a222-222222222222",
        "updatedByUserId": "22222222-2222-2222-a222-222222222222",
        "createdByUsername": "john_doe"
      }
    },
    {
      "id": "342dcb99-c476-4f93-b430-471874b18e2a",
      "type": "accessTypes",
      "attributes": {
        "name": "my custom type 2",
        "description": "Description 2",
        "credentialsId": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
      },
      "creator": {
        "lastName": "Doe",
        "firstName": "John",
        "middleName": "Joseph"
      },
      "updater": {
        "lastName": "Doe",
        "firstName": "Jane",
        "middleName": "Rosemary"
      },
      "metadata": {
        "createdDate": "2020-02-03T13:23:56.784+0000",
        "updatedDate": "2020-02-03T14:36:06.234+0000",
        "createdByUserId": "22222222-2222-2222-a222-222222222222",
        "updatedByUserId": "33333333-3333-3333-a333-333333333333",
        "createdByUsername": "john_doe",
        "updatedByUsername": "jane_doe"
      }
    }
  ],
  "meta": {
    "totalResults": 2
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /eholdings/access-types/{id}

Retrieve specific Access Types by Id

GET /eholdings/access-types/{id}
URI Parameters
  • id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

Response 200

OK

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Access Type object schema for a collection",
  "description": "Access Type object schema for a collection",
  "javaType": "org.folio.rest.jaxrs.model.AccessType",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of access type",
      "$ref": "../../raml-util/schemas/uuid.schema",
      "example": "f973c3b6-85fc-4d35-bda8-f31b568957bf"
    },
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": ["accessTypes"],
      "example": "accessTypes"
    },
    "attributes": {
      "type": "object",
      "description": "Custom label object data attributes",
      "$ref": "accessTypeDataAttributes.json"
    },
    "creator": {
      "type": "object",
      "description": "User display info for creator of the note",
      "$ref": "userDisplayInfo.json",
      "readonly": true
    },
    "updater": {
      "type": "object",
      "description": "User display info for updater of the note",
      "$ref": "userDisplayInfo.json",
      "readonly": true
    },
    "usageNumber": {
      "type": "integer",
      "description": "Number of records that use the access type",
      "readonly": true
    },
    "metadata": {
      "type": "object",
      "description": "Metadata for the entity",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": ["type", "attributes"]
}

Example:

{
  "id": "3866efa9-4af8-4c4e-8fab-2451963cf0ea",
  "type": "accessTypes",
  "attributes": {
    "name": "Access Type 1",
    "description": "Access Type description 1"
  },
  "creator": {
    "lastName": "last name",
    "firstName": "first name"
  },
  "metadata": {
    "createdDate": "2020-02-03T13:23:56.784+0000",
    "updatedDate": "2020-02-03T13:23:56.784+0000",
    "createdByUserId": "22222222-2222-2222-a222-222222222222",
    "updatedByUserId": "22222222-2222-2222-a222-222222222222",
    "createdByUsername": "john_doe"
  }
}

Response 400

Bad Request

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Invalid id '99999999-9999-2-9999-999999999999'"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Response 404

Not Found

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Access type with id '99999999-9999-9999-9999-999999999999' not found"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Response 422

Unprocessable Entity

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Invalid id '99999999-9999-2-9999-9999-999999999999'",
      "detail": "Id should follow UUID format %s"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Access Types

Access Types belongs to specific KB Credentials

GET /eholdings/kb-credentials/{id}/access-types

Get a list of access types related to specific KB credentials.

GET /eholdings/kb-credentials/{id}/access-types
URI Parameters
  • id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

Response 200

OK

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Access Types Collection Schema",
  "description": "Access Types Collection Schema",
  "javaType": "org.folio.rest.jaxrs.model.AccessTypeCollection",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "array",
      "description": "List of access types",
      "items": {
        "type": "object",
        "$ref": "accessType.json"
      }
    },
    "meta": {
      "type": "object",
      "description": "metadata containing total results in collection",
      "$ref": "../metaTotalResults.json",
      "readonly": true
    },
    "jsonapi": {
      "type": "object",
      "description": "version of json api",
      "$ref": "../jsonapi.json"
    }
  },
  "required": ["data", "meta", "jsonapi"]
}

Example:

{
  "data": [
    {
      "id": "6b30f929-6075-4e18-82fa-525f1355acd7",
      "type": "accessTypes",
      "attributes": {
        "name": "my custom type 1",
        "description": "Description 1",
        "credentialsId": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
      },
      "creator": {
        "lastName": "Doe",
        "firstName": "John",
        "middleName": "Joseph"
      },
      "metadata": {
        "createdDate": "2020-02-03T13:23:56.784",
        "updatedDate": "2020-02-03T13:23:56.784+0000",
        "createdByUserId": "22222222-2222-2222-a222-222222222222",
        "updatedByUserId": "22222222-2222-2222-a222-222222222222",
        "createdByUsername": "john_doe"
      }
    },
    {
      "id": "342dcb99-c476-4f93-b430-471874b18e2a",
      "type": "accessTypes",
      "attributes": {
        "name": "my custom type 2",
        "description": "Description 2",
        "credentialsId": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
      },
      "creator": {
        "lastName": "Doe",
        "firstName": "John",
        "middleName": "Joseph"
      },
      "updater": {
        "lastName": "Doe",
        "firstName": "Jane",
        "middleName": "Rosemary"
      },
      "metadata": {
        "createdDate": "2020-02-03T13:23:56.784+0000",
        "updatedDate": "2020-02-03T14:36:06.234+0000",
        "createdByUserId": "22222222-2222-2222-a222-222222222222",
        "updatedByUserId": "33333333-3333-3333-a333-333333333333",
        "createdByUsername": "john_doe",
        "updatedByUsername": "jane_doe"
      }
    }
  ],
  "meta": {
    "totalResults": 2
  },
  "jsonapi": {
    "version": "1.0"
  }
}

POST /eholdings/kb-credentials/{id}/access-types

Create an access type in specific KB Credentials

POST /eholdings/kb-credentials/{id}/access-types
URI Parameters
  • id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "POST Request To Access Type Collection Schema",
  "description": "POST Request To Access Type Collection Schema",
  "javaType": "org.folio.rest.jaxrs.model.AccessTypePostRequest",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "description": "Access type object",
      "$ref": "accessType.json"
    }
  },
  "required": [
    "data"
  ]
}

Example:

{
  "data": {
    "type": "accessTypes",
    "attributes": {
      "name": "Subscribed",
      "description": "Indicates subscription of the entity",
      "credentialsId": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
    }
  }
}

Response 201

Created

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Access Type object schema for a collection",
  "description": "Access Type object schema for a collection",
  "javaType": "org.folio.rest.jaxrs.model.AccessType",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of access type",
      "$ref": "../../raml-util/schemas/uuid.schema",
      "example": "f973c3b6-85fc-4d35-bda8-f31b568957bf"
    },
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": ["accessTypes"],
      "example": "accessTypes"
    },
    "attributes": {
      "type": "object",
      "description": "Custom label object data attributes",
      "$ref": "accessTypeDataAttributes.json"
    },
    "creator": {
      "type": "object",
      "description": "User display info for creator of the note",
      "$ref": "userDisplayInfo.json",
      "readonly": true
    },
    "updater": {
      "type": "object",
      "description": "User display info for updater of the note",
      "$ref": "userDisplayInfo.json",
      "readonly": true
    },
    "usageNumber": {
      "type": "integer",
      "description": "Number of records that use the access type",
      "readonly": true
    },
    "metadata": {
      "type": "object",
      "description": "Metadata for the entity",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": ["type", "attributes"]
}

Example:

{
  "id": "11111111-1111-1111-a111-111111111111",
  "type": "accessTypes",
  "attributes": {
    "name": "Subscribed",
    "description": "Indicates subscription of the entity",
    "credentialsId": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
  },
  "creator": {
    "lastName": "Doe",
    "firstName": "John",
    "middleName": "Joseph"
  },
  "metadata": {
    "createdDate": "2020-02-03T13:23:56.784",
    "updatedDate": "2020-02-03T13:23:56.784+0000",
    "createdByUserId": "22222222-2222-2222-a222-222222222222",
    "updatedByUserId": "22222222-2222-2222-a222-222222222222",
    "createdByUsername": "john_doe"
  }
}

Response 400

Bad Request

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "duplicate key value violates unique constraint \"access_types_pkey\"",
      "detail": "Key (id)=(11111111-1111-1111-a111-111111111111) already exists."
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Response 404

Not Found

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "KB credentials with id '99999999-9999-9999-9999-999999999999' not found"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Response 422

Unprocessable Entity

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Invalid name",
      "detail": "name is too long (maximum is 75 characters)"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

GET /eholdings/kb-credentials/{id}/access-types/{accessTypeId}

Retrieve specific Access Types by Id related to specific KB credentials

GET /eholdings/kb-credentials/{id}/access-types/{accessTypeId}
URI Parameters
  • id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
  • accessTypeId: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

Response 200

OK

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Access Type object schema for a collection",
  "description": "Access Type object schema for a collection",
  "javaType": "org.folio.rest.jaxrs.model.AccessType",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of access type",
      "$ref": "../../raml-util/schemas/uuid.schema",
      "example": "f973c3b6-85fc-4d35-bda8-f31b568957bf"
    },
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": ["accessTypes"],
      "example": "accessTypes"
    },
    "attributes": {
      "type": "object",
      "description": "Custom label object data attributes",
      "$ref": "accessTypeDataAttributes.json"
    },
    "creator": {
      "type": "object",
      "description": "User display info for creator of the note",
      "$ref": "userDisplayInfo.json",
      "readonly": true
    },
    "updater": {
      "type": "object",
      "description": "User display info for updater of the note",
      "$ref": "userDisplayInfo.json",
      "readonly": true
    },
    "usageNumber": {
      "type": "integer",
      "description": "Number of records that use the access type",
      "readonly": true
    },
    "metadata": {
      "type": "object",
      "description": "Metadata for the entity",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": ["type", "attributes"]
}

Example:

{
  "id": "3866efa9-4af8-4c4e-8fab-2451963cf0ea",
  "type": "accessTypes",
  "attributes": {
    "name": "Access Type 1",
    "description": "Access Type description 1"
  },
  "creator": {
    "lastName": "last name",
    "firstName": "first name"
  },
  "metadata": {
    "createdDate": "2020-02-03T13:23:56.784+0000",
    "updatedDate": "2020-02-03T13:23:56.784+0000",
    "createdByUserId": "22222222-2222-2222-a222-222222222222",
    "updatedByUserId": "22222222-2222-2222-a222-222222222222",
    "createdByUsername": "john_doe"
  }
}

Response 400

Bad Request

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Invalid id '99999999-9999-2-9999-999999999999'"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Response 404

Not Found

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Access type with id '99999999-9999-9999-9999-999999999999' not found"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Response 422

Unprocessable Entity

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Invalid id '99999999-9999-2-9999-9999-999999999999'",
      "detail": "Id should follow UUID format %s"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

PUT /eholdings/kb-credentials/{id}/access-types/{accessTypeId}

Update a Access Type by Id related to specific KB credentials

PUT /eholdings/kb-credentials/{id}/access-types/{accessTypeId}
URI Parameters
  • id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
  • accessTypeId: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PUT Request To Access Type Collection Schema",
  "description": "PUT Request To Access Type Collection Schema",
  "javaType": "org.folio.rest.jaxrs.model.AccessTypePutRequest",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "description": "Access type object",
      "$ref": "accessType.json"
    }
  },
  "required": [
    "data"
  ]
}

Example:

{
  "data": {
    "type": "accessTypes",
    "attributes": {
      "name": "Subscribed updated",
      "description": "Indicates subscription of the entity updated",
      "credentialsId": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
    }
  }
}

Response 204

Item successfully updated

Response 400

Bad Request

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Missing user id header, cannot look up user"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Response 404

Not Found

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Access Type with id '99999999-9999-9999-9999-999999999999' doesn't exist"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Response 422

Unprocessable Entity

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Invalid id '99999999-9999-2-9999-9999-999999999999'",
      "detail": "Id should follow UUID format %s"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

DELETE /eholdings/kb-credentials/{id}/access-types/{accessTypeId}

Delete a Access Type by Id

DELETE /eholdings/kb-credentials/{id}/access-types/{accessTypeId}
URI Parameters
  • id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
  • accessTypeId: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

Response 204

No Content

Response 400

Bad Request

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Can't delete access type that has assigned records"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Response 422

Unprocessable Entity

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "Invalid id '99999999-9999-2-9999-9999-999999999999'",
      "detail": "Id should follow UUID format %s"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}