Service Points API (v3.5)

http://localhost

Service Points API
/service-points

Service Points API

This documents the API calls that can be made to query and manage service points in the system

/service-points

Collection of service-point items.

GET /service-points

Return a list of service points

GET /service-points

Query Parameters

includeRoutingServicePoints: (boolean - default: false)
Should ECS request routing service points be included in the response
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
```
totalRecords: (string - default: auto - pattern: exact|estimated|none|auto)
How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
```
none
```
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. Using limit=0 will return totalRecords with the exact value. For details about totalRecords see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
```
10
```

Response 200

Returns a list of service-point items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of service points",
  "type": "object",
  "properties": {
    "servicepoints": {
      "description": "List of service points",
      "id": "servicepoint",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "A service point",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id of service-point object"
          },
          "name": {
            "type": "string",
            "description": "service-point name, a required field"
          },
          "code": {
            "type": "string",
            "description": "service-point code, a required field"
          },
          "discoveryDisplayName": {
            "type": "string",
            "description": "display name, a required field"
          },
          "description": {
            "type": "string",
            "description": "description of the service-point"
          },
          "shelvingLagTime": {
            "type": "integer",
            "description": "shelving lag time"
          },
          "pickupLocation": {
            "type": "boolean",
            "description": "indicates whether or not the service point is a pickup location"
          },
          "holdShelfExpiryPeriod": {
            "type": "object",
            "description": "expiration period for items on the hold shelf at the service point",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "duration": {
                "type": "integer",
                "description": "Duration interval"
              },
              "intervalId": {
                "type": "string",
                "description": "Unit of time for the duration",
                "enum": [
                  "Minutes",
                  "Hours",
                  "Days",
                  "Weeks",
                  "Months"
                ],
                "default": "Days"
              }
            },
            "required": [
              "duration",
              "intervalId"
            ],
            "additionalProperties": false
          },
          "holdShelfClosedLibraryDateManagement": {
            "type": "string",
            "description": "enum for closedLibraryDateManagement associated with hold shelf",
            "enum": [
              "Keep_the_current_due_date",
              "Move_to_the_end_of_the_previous_open_day",
              "Move_to_the_end_of_the_next_open_day",
              "Keep_the_current_due_date_time",
              "Move_to_end_of_current_service_point_hours",
              "Move_to_beginning_of_next_open_service_point_hours"
            ],
            "default": "Keep_the_current_due_date"
          },
          "defaultCheckInActionForUseAtLocation": {
            "type": "string",
            "description": "enum for defining the default action when checking in an item that is for use in the library (i.e. in reading room)",
            "enum": [
              "Keep_on_hold_shelf",
              "Close_loan_and_return_item",
              "Ask_for_action"
            ]
          },
          "staffSlips": {
            "type": "array",
            "description": "List of staff slips for this service point",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "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}$",
                  "description": "The ID of the staff slip"
                },
                "printByDefault": {
                  "type": "boolean",
                  "description": "Whether or not to print the staff slip by default"
                }
              },
              "additionalProperties": false,
              "required": [
                "id",
                "printByDefault"
              ]
            }
          },
          "ecsRequestRouting": {
            "type": "boolean",
            "description": "Indicates a service point used for the ECS functionality",
            "default": false
          },
          "metadata": {
            "type": "object",
            "readonly": true,
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "metadata.schema",
            "title": "Metadata Schema",
            "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
            "properties": {
              "createdDate": {
                "description": "Date and time when the record was created",
                "type": "string",
                "format": "date-time"
              },
              "createdByUserId": {
                "description": "ID of the user who created the record (when available)",
                "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}$"
              },
              "createdByUsername": {
                "description": "Username of the user who created the record (when available)",
                "type": "string"
              },
              "updatedDate": {
                "description": "Date and time when the record was last updated",
                "type": "string",
                "format": "date-time"
              },
              "updatedByUserId": {
                "description": "ID of the user who last updated the record (when available)",
                "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}$"
              },
              "updatedByUsername": {
                "description": "Username of the user who last updated the record (when available)",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "createdDate"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "name",
          "code",
          "discoveryDisplayName"
        ]
      }
    },
    "totalRecords": {
      "description": "Estimated or exact total number of records",
      "type": "integer"
    }
  },
  "required": [
    "servicepoints",
    "totalRecords"
  ]
}

Example:

{
  "servicepoints": [
    {
      "name": "Circ Desk 1",
      "code": "cd1",
      "discoveryDisplayName": "Circulation Desk -- Hallway"
    }
  ],
  "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 service-points -- 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 service-points -- 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 /service-points

Create a new service point

POST /service-points

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A service point",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Id of service-point object"
    },
    "name": {
      "type": "string",
      "description": "service-point name, a required field"
    },
    "code": {
      "type": "string",
      "description": "service-point code, a required field"
    },
    "discoveryDisplayName": {
      "type": "string",
      "description": "display name, a required field"
    },
    "description": {
      "type": "string",
      "description": "description of the service-point"
    },
    "shelvingLagTime": {
      "type": "integer",
      "description": "shelving lag time"
    },
    "pickupLocation": {
      "type": "boolean",
      "description": "indicates whether or not the service point is a pickup location"
    },
    "holdShelfExpiryPeriod": {
      "type": "object",
      "description": "expiration period for items on the hold shelf at the service point",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "type": "integer",
          "description": "Duration interval"
        },
        "intervalId": {
          "type": "string",
          "description": "Unit of time for the duration",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months"
          ],
          "default": "Days"
        }
      },
      "required": [
        "duration",
        "intervalId"
      ],
      "additionalProperties": false
    },
    "holdShelfClosedLibraryDateManagement": {
      "type": "string",
      "description": "enum for closedLibraryDateManagement associated with hold shelf",
      "enum": [
        "Keep_the_current_due_date",
        "Move_to_the_end_of_the_previous_open_day",
        "Move_to_the_end_of_the_next_open_day",
        "Keep_the_current_due_date_time",
        "Move_to_end_of_current_service_point_hours",
        "Move_to_beginning_of_next_open_service_point_hours"
      ],
      "default": "Keep_the_current_due_date"
    },
    "defaultCheckInActionForUseAtLocation": {
      "type": "string",
      "description": "enum for defining the default action when checking in an item that is for use in the library (i.e. in reading room)",
      "enum": [
        "Keep_on_hold_shelf",
        "Close_loan_and_return_item",
        "Ask_for_action"
      ]
    },
    "staffSlips": {
      "type": "array",
      "description": "List of staff slips for this service point",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "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}$",
            "description": "The ID of the staff slip"
          },
          "printByDefault": {
            "type": "boolean",
            "description": "Whether or not to print the staff slip by default"
          }
        },
        "additionalProperties": false,
        "required": [
          "id",
          "printByDefault"
        ]
      }
    },
    "ecsRequestRouting": {
      "type": "boolean",
      "description": "Indicates a service point used for the ECS functionality",
      "default": false
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "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}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "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}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code",
    "discoveryDisplayName"
  ]
}

Example:

{
  "id": "79faacf1-4ba4-42c7-8b2a-566b259e4641",
  "name": "Circ Desk 1",
  "code": "cd1",
  "discoveryDisplayName": "Circulation Desk -- Hallway"
}

Response 201

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

Headers

Location: required (string)
URI to the created service-point item

Body

Media type: application/json

Type: any

Example:

{
  "id": "79faacf1-4ba4-42c7-8b2a-566b259e4641",
  "name": "Circ Desk 1",
  "code": "cd1",
  "discoveryDisplayName": "Circulation Desk -- Hallway"
}

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

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create service-points -- unauthorized

Response 422

Validation error

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

DELETE /service-points

Delete all service points

DELETE /service-points

Response 204

All service points delete

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

PUT /service-points/{servicepointId}

Update a service point

PUT /service-points/{servicepointId}

URI Parameters

servicepointId: required (string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A service point",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Id of service-point object"
    },
    "name": {
      "type": "string",
      "description": "service-point name, a required field"
    },
    "code": {
      "type": "string",
      "description": "service-point code, a required field"
    },
    "discoveryDisplayName": {
      "type": "string",
      "description": "display name, a required field"
    },
    "description": {
      "type": "string",
      "description": "description of the service-point"
    },
    "shelvingLagTime": {
      "type": "integer",
      "description": "shelving lag time"
    },
    "pickupLocation": {
      "type": "boolean",
      "description": "indicates whether or not the service point is a pickup location"
    },
    "holdShelfExpiryPeriod": {
      "type": "object",
      "description": "expiration period for items on the hold shelf at the service point",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "type": "integer",
          "description": "Duration interval"
        },
        "intervalId": {
          "type": "string",
          "description": "Unit of time for the duration",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months"
          ],
          "default": "Days"
        }
      },
      "required": [
        "duration",
        "intervalId"
      ],
      "additionalProperties": false
    },
    "holdShelfClosedLibraryDateManagement": {
      "type": "string",
      "description": "enum for closedLibraryDateManagement associated with hold shelf",
      "enum": [
        "Keep_the_current_due_date",
        "Move_to_the_end_of_the_previous_open_day",
        "Move_to_the_end_of_the_next_open_day",
        "Keep_the_current_due_date_time",
        "Move_to_end_of_current_service_point_hours",
        "Move_to_beginning_of_next_open_service_point_hours"
      ],
      "default": "Keep_the_current_due_date"
    },
    "defaultCheckInActionForUseAtLocation": {
      "type": "string",
      "description": "enum for defining the default action when checking in an item that is for use in the library (i.e. in reading room)",
      "enum": [
        "Keep_on_hold_shelf",
        "Close_loan_and_return_item",
        "Ask_for_action"
      ]
    },
    "staffSlips": {
      "type": "array",
      "description": "List of staff slips for this service point",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "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}$",
            "description": "The ID of the staff slip"
          },
          "printByDefault": {
            "type": "boolean",
            "description": "Whether or not to print the staff slip by default"
          }
        },
        "additionalProperties": false,
        "required": [
          "id",
          "printByDefault"
        ]
      }
    },
    "ecsRequestRouting": {
      "type": "boolean",
      "description": "Indicates a service point used for the ECS functionality",
      "default": false
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "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}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "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}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code",
    "discoveryDisplayName"
  ]
}

Example:

{
  "id": "79faacf1-4ba4-42c7-8b2a-566b259e4641",
  "name": "Circ Desk 1",
  "code": "cd1",
  "discoveryDisplayName": "Circulation Desk -- Hallway"
}

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

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"service-point not found"

Response 409

Optimistic locking version conflict

Body

Media type: text/plain

Type: any

Example:

version conflict

Response 422

Validation error

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 /service-points/{servicepointId}

Retrieve service-point item with given {service-pointId}

GET /service-points/{servicepointId}

URI Parameters

servicepointId: required (string)

Response 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A service point",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Id of service-point object"
    },
    "name": {
      "type": "string",
      "description": "service-point name, a required field"
    },
    "code": {
      "type": "string",
      "description": "service-point code, a required field"
    },
    "discoveryDisplayName": {
      "type": "string",
      "description": "display name, a required field"
    },
    "description": {
      "type": "string",
      "description": "description of the service-point"
    },
    "shelvingLagTime": {
      "type": "integer",
      "description": "shelving lag time"
    },
    "pickupLocation": {
      "type": "boolean",
      "description": "indicates whether or not the service point is a pickup location"
    },
    "holdShelfExpiryPeriod": {
      "type": "object",
      "description": "expiration period for items on the hold shelf at the service point",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "type": "integer",
          "description": "Duration interval"
        },
        "intervalId": {
          "type": "string",
          "description": "Unit of time for the duration",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months"
          ],
          "default": "Days"
        }
      },
      "required": [
        "duration",
        "intervalId"
      ],
      "additionalProperties": false
    },
    "holdShelfClosedLibraryDateManagement": {
      "type": "string",
      "description": "enum for closedLibraryDateManagement associated with hold shelf",
      "enum": [
        "Keep_the_current_due_date",
        "Move_to_the_end_of_the_previous_open_day",
        "Move_to_the_end_of_the_next_open_day",
        "Keep_the_current_due_date_time",
        "Move_to_end_of_current_service_point_hours",
        "Move_to_beginning_of_next_open_service_point_hours"
      ],
      "default": "Keep_the_current_due_date"
    },
    "defaultCheckInActionForUseAtLocation": {
      "type": "string",
      "description": "enum for defining the default action when checking in an item that is for use in the library (i.e. in reading room)",
      "enum": [
        "Keep_on_hold_shelf",
        "Close_loan_and_return_item",
        "Ask_for_action"
      ]
    },
    "staffSlips": {
      "type": "array",
      "description": "List of staff slips for this service point",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "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}$",
            "description": "The ID of the staff slip"
          },
          "printByDefault": {
            "type": "boolean",
            "description": "Whether or not to print the staff slip by default"
          }
        },
        "additionalProperties": false,
        "required": [
          "id",
          "printByDefault"
        ]
      }
    },
    "ecsRequestRouting": {
      "type": "boolean",
      "description": "Indicates a service point used for the ECS functionality",
      "default": false
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "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}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "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}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code",
    "discoveryDisplayName"
  ]
}

Example:

{
  "id": "79faacf1-4ba4-42c7-8b2a-566b259e4641",
  "name": "Circ Desk 1",
  "code": "cd1",
  "discoveryDisplayName": "Circulation Desk -- Hallway"
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"service-point 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 /service-points/{servicepointId}

Delete service-point item with given {service-pointId}

DELETE /service-points/{servicepointId}

URI Parameters

servicepointId: required (string)

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 service-point -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"service-point 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

Service Points API (v3.5)

Table of contents