Location API (v3.0)

http://github.com/org/folio/mod-inventory-storage

Table of contents

Locations API

This documents the API calls that can be made to query and manage (shelf) locations of the system

/locations

Collection of location items.

GET /locations

Return a list of locations

GET /locations
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]

Response 200

Returns a list of location items

Body

Media type: application/json

Type: json

Content:

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

Example:

{
  "locations": [
    {
      "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
      "name": "Miller General Stacks",
      "code": "UA/CB/LC/GS",
      "isActive": true,
      "institutionId": "4b2a3d97-01c3-4ef3-98a5-ae4e853429b4",
      "campusId": "b595d838-b1d5-409e-86ac-af3b41bde0be",
      "libraryId": "e2889f93-92f2-4937-b944-5452a575367e",
      "details": {
        "a": "b",
        "foo": "bar"
      },
      "primaryServicePoint": "79faacf1-4ba4-42c7-8b2a-566b259e4641",
      "servicePointIds": [
        "79faacf1-4ba4-42c7-8b2a-566b259e4641"
      ]
    },
    {
      "id": "97ee6cd9-17ef-47f8-acbb-ec16fb2cb98d",
      "name": "Special Reading Room",
      "code": "UX/BB/LC/RR",
      "isActive": true,
      "institutionId": "4b2a3d97-01c3-4ef3-98a5-ae4e853429b4",
      "campusId": "b595d838-b1d5-409e-86ac-af3b41bde0be",
      "libraryId": "a23d1dbc-e7ba-4c00-baf4-9770bdfb87c6",
      "details": {
        "foo": "gryf"
      },
      "primaryServicePoint": "79faacf1-4ba4-42c7-8b2a-566b259e4641",
      "servicePointIds": [
        "79faacf1-4ba4-42c7-8b2a-566b259e4641"
      ]
    }
  ],
  "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 locations -- 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 locations -- 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 /locations

Create a new location

POST /locations
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#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "code": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "discoveryDisplayName": {
      "type": "string"
    },
    "isActive": {
      "type": "boolean"
    },
    "institutionId": {
      "type": "string"
    },
    "campusId": {
      "type": "string"
    },
    "libraryId": {
      "type": "string"
    },
    "details": {
      "type": "object"
    },
    "primaryServicePoint": {
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
      "type": "string"
    },
    "servicePointIds": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
        "not": {
          "type": "null"
        }
      }
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code",
    "institutionId",
    "campusId",
    "libraryId",
    "primaryServicePoint"
  ]
}

Example:

{
  "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
  "name": "Miller General Stacks",
  "code": "UA/CB/LC/GS",
  "isActive": true,
  "description": "The very general stacks of Miller",
  "discoveryDisplayName": "Miller General",
  "institutionId": "4b2a3d97-01c3-4ef3-98a5-ae4e853429b4",
  "campusId": "b595d838-b1d5-409e-86ac-af3b41bde0be",
  "libraryId": "e2889f93-92f2-4937-b944-5452a575367e",
  "details": {
    "a": "b",
    "foo": "bar"
  },
  "primaryServicePoint": "79faacf1-4ba4-42c7-8b2a-566b259e4641",
  "servicePointIds": [
    "79faacf1-4ba4-42c7-8b2a-566b259e4641"
  ]

}

Response 201

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

Headers
  • Location: required (string)

    URI to the created location item

Body

Media type: application/json

Type: any

Example:

{
  "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
  "name": "Miller General Stacks",
  "code": "UA/CB/LC/GS",
  "isActive": true,
  "description": "The very general stacks of Miller",
  "discoveryDisplayName": "Miller General",
  "institutionId": "4b2a3d97-01c3-4ef3-98a5-ae4e853429b4",
  "campusId": "b595d838-b1d5-409e-86ac-af3b41bde0be",
  "libraryId": "e2889f93-92f2-4937-b944-5452a575367e",
  "details": {
    "a": "b",
    "foo": "bar"
  },
  "primaryServicePoint": "79faacf1-4ba4-42c7-8b2a-566b259e4641",
  "servicePointIds": [
    "79faacf1-4ba4-42c7-8b2a-566b259e4641"
  ]

}

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

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create locations -- unauthorized

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "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

DELETE /locations

Delete all locations

DELETE /locations
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

All locations deleted

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /locations/{id}

Retrieve location item with given {locationId}

GET /locations/{id}
URI Parameters
  • id: 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#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "code": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "discoveryDisplayName": {
      "type": "string"
    },
    "isActive": {
      "type": "boolean"
    },
    "institutionId": {
      "type": "string"
    },
    "campusId": {
      "type": "string"
    },
    "libraryId": {
      "type": "string"
    },
    "details": {
      "type": "object"
    },
    "primaryServicePoint": {
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
      "type": "string"
    },
    "servicePointIds": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
        "not": {
          "type": "null"
        }
      }
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code",
    "institutionId",
    "campusId",
    "libraryId",
    "primaryServicePoint"
  ]
}

Example:

{
  "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
  "name": "Miller General Stacks",
  "code": "UA/CB/LC/GS",
  "isActive": true,
  "description": "The very general stacks of Miller",
  "discoveryDisplayName": "Miller General",
  "institutionId": "4b2a3d97-01c3-4ef3-98a5-ae4e853429b4",
  "campusId": "b595d838-b1d5-409e-86ac-af3b41bde0be",
  "libraryId": "e2889f93-92f2-4937-b944-5452a575367e",
  "details": {
    "a": "b",
    "foo": "bar"
  },
  "primaryServicePoint": "79faacf1-4ba4-42c7-8b2a-566b259e4641",
  "servicePointIds": [
    "79faacf1-4ba4-42c7-8b2a-566b259e4641"
  ]

}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"location 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 /locations/{id}

Update a location by id

PUT /locations/{id}
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#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "code": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "discoveryDisplayName": {
      "type": "string"
    },
    "isActive": {
      "type": "boolean"
    },
    "institutionId": {
      "type": "string"
    },
    "campusId": {
      "type": "string"
    },
    "libraryId": {
      "type": "string"
    },
    "details": {
      "type": "object"
    },
    "primaryServicePoint": {
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
      "type": "string"
    },
    "servicePointIds": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
        "not": {
          "type": "null"
        }
      }
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code",
    "institutionId",
    "campusId",
    "libraryId",
    "primaryServicePoint"
  ]
}

Example:

{
  "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
  "name": "Miller General Stacks",
  "code": "UA/CB/LC/GS",
  "isActive": true,
  "description": "The very general stacks of Miller",
  "discoveryDisplayName": "Miller General",
  "institutionId": "4b2a3d97-01c3-4ef3-98a5-ae4e853429b4",
  "campusId": "b595d838-b1d5-409e-86ac-af3b41bde0be",
  "libraryId": "e2889f93-92f2-4937-b944-5452a575367e",
  "details": {
    "a": "b",
    "foo": "bar"
  },
  "primaryServicePoint": "79faacf1-4ba4-42c7-8b2a-566b259e4641",
  "servicePointIds": [
    "79faacf1-4ba4-42c7-8b2a-566b259e4641"
  ]

}

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

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"location not found"

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "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

DELETE /locations/{id}

Delete location item with given {locationId}

DELETE /locations/{id}
URI Parameters
  • id: 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 location -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

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