API for managing locations and service points
Return a list of locations.
| query | string CQL query expression. |
| limit | integer >= 0 Default: 10 Limit the number of elements returned. |
| offset | integer >= 0 Default: 0 Skip over a number of elements. |
| includeShadow | boolean Default: false Whether to include shadow records in the response or not. |
{- "totalRecords": 0,
- "locations": [
- {
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "institutionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "discoveryDisplayName": "discoveryDisplayName",
- "libraryId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "campusId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "description": "description",
- "isActive": true,
- "primaryServicePoint": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isFloatingCollection": true,
- "name": "name",
- "details": {
- "key": ""
}, - "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false,
- "servicePointIds": [
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
]
}, - {
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "institutionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "discoveryDisplayName": "discoveryDisplayName",
- "libraryId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "campusId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "description": "description",
- "isActive": true,
- "primaryServicePoint": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isFloatingCollection": true,
- "name": "name",
- "details": {
- "key": ""
}, - "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false,
- "servicePointIds": [
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
]
}
]
}Create a new location.
| id | string <uuid> ID of the location | ||
| name required | string Name of the location | ||
| code required | string Code of the location, usually an abbreviation of the name | ||
| description | string Description of the location | ||
| discoveryDisplayName | string Name of the location to be shown in the discovery | ||
| isActive | boolean Whether this location is active. Inactive locations can no longer been used | ||
| institutionId required | string <uuid> The ID of the institution, the first-level location unit, this location belongs to | ||
| campusId required | string <uuid> The ID of the campus, the second-level location unit, this location belongs to | ||
| libraryId required | string <uuid> The ID of the library, the third-level location unit, this location belongs to | ||
object Details about this location | |||
| |||
| primaryServicePoint required | string <uuid> The ID of the primary service point of this location | ||
| servicePointIds | Array of strings <uuid> [ items <uuid > ] All service points that this location has | ||
| isFloatingCollection | boolean Items checked in/out from this location can be checked in/out to other locations with the same flag | ||
| isShadow | boolean Default: false Whether this location is a shadow location. Shadow locations are used to represent virtual locations that no items are assignable to them. They only relate to external libraries and virtual items. | ||
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "institutionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "discoveryDisplayName": "discoveryDisplayName",
- "libraryId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "campusId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "description": "description",
- "isActive": true,
- "primaryServicePoint": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isFloatingCollection": true,
- "name": "name",
- "details": {
- "key": ""
}, - "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false,
- "servicePointIds": [
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
]
}{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "institutionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "discoveryDisplayName": "discoveryDisplayName",
- "libraryId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "campusId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "description": "description",
- "isActive": true,
- "primaryServicePoint": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isFloatingCollection": true,
- "name": "name",
- "details": {
- "key": ""
}, - "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false,
- "servicePointIds": [
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
]
}Retrieve a location by id.
| id required | string <uuid> Record identifier. |
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "institutionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "discoveryDisplayName": "discoveryDisplayName",
- "libraryId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "campusId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "description": "description",
- "isActive": true,
- "primaryServicePoint": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isFloatingCollection": true,
- "name": "name",
- "details": {
- "key": ""
}, - "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false,
- "servicePointIds": [
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
]
}Update a location by id.
| id required | string <uuid> Record identifier. |
| id | string <uuid> ID of the location | ||
| name required | string Name of the location | ||
| code required | string Code of the location, usually an abbreviation of the name | ||
| description | string Description of the location | ||
| discoveryDisplayName | string Name of the location to be shown in the discovery | ||
| isActive | boolean Whether this location is active. Inactive locations can no longer been used | ||
| institutionId required | string <uuid> The ID of the institution, the first-level location unit, this location belongs to | ||
| campusId required | string <uuid> The ID of the campus, the second-level location unit, this location belongs to | ||
| libraryId required | string <uuid> The ID of the library, the third-level location unit, this location belongs to | ||
object Details about this location | |||
| |||
| primaryServicePoint required | string <uuid> The ID of the primary service point of this location | ||
| servicePointIds | Array of strings <uuid> [ items <uuid > ] All service points that this location has | ||
| isFloatingCollection | boolean Items checked in/out from this location can be checked in/out to other locations with the same flag | ||
| isShadow | boolean Default: false Whether this location is a shadow location. Shadow locations are used to represent virtual locations that no items are assignable to them. They only relate to external libraries and virtual items. | ||
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "institutionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "discoveryDisplayName": "discoveryDisplayName",
- "libraryId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "campusId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "description": "description",
- "isActive": true,
- "primaryServicePoint": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isFloatingCollection": true,
- "name": "name",
- "details": {
- "key": ""
}, - "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false,
- "servicePointIds": [
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
]
}{- "errors": [
- {
- "message": "Illegal argument error",
- "type": "IllegalArgumentException",
- "code": "unknown_error"
}
], - "total_records": 1
}Return a list of institutions.
| query | string CQL query expression. |
| limit | integer >= 0 Default: 10 Limit the number of elements returned. |
| offset | integer >= 0 Default: 0 Skip over a number of elements. |
| includeShadow | boolean Default: false Whether to include shadow records in the response or not. |
{- "locinsts": [
- {
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}, - {
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}
], - "totalRecords": 0
}Create a new institution.
| id | string <uuid> ID of institution |
| name required | string Name of institution |
| code required | string Distinct code for institution |
| isShadow | boolean Default: false Whether this is a shadow location. Shadow locations are used to represent virtual locations that no items are assignable to them. They only relate to external libraries and virtual items. |
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}Delete an existing institution by its unique identifier.
| id required | string <uuid> Record identifier. |
{- "errors": [
- {
- "message": "Illegal argument error",
- "type": "IllegalArgumentException",
- "code": "unknown_error"
}
], - "total_records": 1
}Retrieve a single institution by its unique identifier.
| id required | string <uuid> Record identifier. |
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}Update an existing institution by its unique identifier.
| id required | string <uuid> Record identifier. |
| id | string <uuid> ID of institution |
| name required | string Name of institution |
| code required | string Distinct code for institution |
| isShadow | boolean Default: false Whether this is a shadow location. Shadow locations are used to represent virtual locations that no items are assignable to them. They only relate to external libraries and virtual items. |
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}{- "errors": [
- {
- "message": "Illegal argument error",
- "type": "IllegalArgumentException",
- "code": "unknown_error"
}
], - "total_records": 1
}Return a list of campuses.
| query | string CQL query expression. |
| limit | integer >= 0 Default: 10 Limit the number of elements returned. |
| offset | integer >= 0 Default: 0 Skip over a number of elements. |
| includeShadow | boolean Default: false Whether to include shadow records in the response or not. |
{- "loccamps": [
- {
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "institutionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}, - {
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "institutionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}
], - "totalRecords": 0
}Create a new campus record.
| id | string <uuid> ID of the campus |
| name required | string Name of the campus |
| code required | string Distinct code for the campus |
| institutionId required | string <uuid> ID of the institution that the campus unit belongs to |
| isShadow | boolean Default: false Whether this is a shadow location. Shadow locations are used to represent virtual locations that no items are assignable to them. They only relate to external libraries and virtual items. |
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "institutionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "institutionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}Delete an existing campus by its unique identifier.
| id required | string <uuid> Record identifier. |
{- "errors": [
- {
- "message": "Illegal argument error",
- "type": "IllegalArgumentException",
- "code": "unknown_error"
}
], - "total_records": 1
}Retrieve a single campus by its unique identifier.
| id required | string <uuid> Record identifier. |
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "institutionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}Update an existing campus by its unique identifier.
| id required | string <uuid> Record identifier. |
| id | string <uuid> ID of the campus |
| name required | string Name of the campus |
| code required | string Distinct code for the campus |
| institutionId required | string <uuid> ID of the institution that the campus unit belongs to |
| isShadow | boolean Default: false Whether this is a shadow location. Shadow locations are used to represent virtual locations that no items are assignable to them. They only relate to external libraries and virtual items. |
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "institutionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}{- "errors": [
- {
- "message": "Illegal argument error",
- "type": "IllegalArgumentException",
- "code": "unknown_error"
}
], - "total_records": 1
}Return a list of libraries.
| query | string CQL query expression. |
| limit | integer >= 0 Default: 10 Limit the number of elements returned. |
| offset | integer >= 0 Default: 0 Skip over a number of elements. |
| includeShadow | boolean Default: false Whether to include shadow records in the response or not. |
{- "totalRecords": 0,
- "loclibs": [
- {
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "name": "name",
- "campusId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}, - {
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "name": "name",
- "campusId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}
]
}Create a new library record.
| id | string <uuid> ID of the library |
| name required | string Name of the library |
| code required | string Distinct code for the library |
| campusId required | string <uuid> ID of the campus that the library belongs to |
| isShadow | boolean Default: false Whether this is a shadow location. Shadow locations are used to represent virtual locations that no items are assignable to them. They only relate to external libraries and virtual items. |
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "name": "name",
- "campusId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "name": "name",
- "campusId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}Delete an existing library by its unique identifier.
| id required | string <uuid> Record identifier. |
{- "errors": [
- {
- "message": "Illegal argument error",
- "type": "IllegalArgumentException",
- "code": "unknown_error"
}
], - "total_records": 1
}Retrieve a single library by its unique identifier.
| id required | string <uuid> Record identifier. |
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "name": "name",
- "campusId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}Update an existing library by its unique identifier.
| id required | string <uuid> Record identifier. |
| id | string <uuid> ID of the library |
| name required | string Name of the library |
| code required | string Distinct code for the library |
| campusId required | string <uuid> ID of the campus that the library belongs to |
| isShadow | boolean Default: false Whether this is a shadow location. Shadow locations are used to represent virtual locations that no items are assignable to them. They only relate to external libraries and virtual items. |
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "name": "name",
- "campusId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "isShadow": false
}{- "errors": [
- {
- "message": "Illegal argument error",
- "type": "IllegalArgumentException",
- "code": "unknown_error"
}
], - "total_records": 1
}Return a list of service points.
| query | string CQL query expression. |
| limit | integer >= 0 Default: 10 Limit the number of elements returned. |
| offset | integer >= 0 Default: 0 Skip over a number of elements. |
| includeRoutingServicePoints | boolean Default: false Should ECS request routing service points be included in the response. |
{- "totalRecords": 1,
- "servicepoints": [
- {
- "holdShelfClosedLibraryDateManagement": "Keep_the_current_due_date",
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "discoveryDisplayName": "discoveryDisplayName",
- "description": "description",
- "pickupLocation": true,
- "staffSlips": [
- {
- "printByDefault": true,
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - {
- "printByDefault": true,
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}
], - "defaultCheckInActionForUseAtLocation": "Keep_on_hold_shelf",
- "ecsRequestRouting": false,
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "shelvingLagTime": 0,
- "holdShelfExpiryPeriod": {
- "duration": 6,
- "intervalId": "Days"
}
}, - {
- "holdShelfClosedLibraryDateManagement": "Keep_the_current_due_date",
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "discoveryDisplayName": "discoveryDisplayName",
- "description": "description",
- "pickupLocation": true,
- "staffSlips": [
- {
- "printByDefault": true,
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - {
- "printByDefault": true,
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}
], - "defaultCheckInActionForUseAtLocation": "Keep_on_hold_shelf",
- "ecsRequestRouting": false,
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "shelvingLagTime": 0,
- "holdShelfExpiryPeriod": {
- "duration": 6,
- "intervalId": "Days"
}
}
]
}Create a new service point record.
| id | string <uuid> ID of the service point | ||||
| name required | string Name of the service point | ||||
| code required | string Code of the service point | ||||
| discoveryDisplayName required | string Discovery display name of the service point | ||||
| description | string Description of the service point | ||||
| shelvingLagTime | integer Shelving lag time | ||||
| pickupLocation | boolean Indicates whether or not the service point is a pickup location | ||||
object (Hold Shelf Expiry Period) Expiration period for items on the hold shelf at the service point | |||||
| |||||
| holdShelfClosedLibraryDateManagement | string Default: "Keep_the_current_due_date" 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" Closed library date management associated with hold shelf | ||||
| defaultCheckInActionForUseAtLocation | string Enum: "Keep_on_hold_shelf" "Close_loan_and_return_item" "Ask_for_action" Default action when checking in an item that is for use in the library (i.e. in reading room) | ||||
Array of objects (Service Point Staff Slip) List of staff slips for this service point | |||||
Array
| |||||
| ecsRequestRouting | boolean Default: false Indicates a service point used for the ECS functionality | ||||
{- "holdShelfClosedLibraryDateManagement": "Keep_the_current_due_date",
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "discoveryDisplayName": "discoveryDisplayName",
- "description": "description",
- "pickupLocation": true,
- "staffSlips": [
- {
- "printByDefault": true,
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - {
- "printByDefault": true,
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}
], - "defaultCheckInActionForUseAtLocation": "Keep_on_hold_shelf",
- "ecsRequestRouting": false,
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "shelvingLagTime": 0,
- "holdShelfExpiryPeriod": {
- "duration": 6,
- "intervalId": "Days"
}
}{- "holdShelfClosedLibraryDateManagement": "Keep_the_current_due_date",
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "discoveryDisplayName": "discoveryDisplayName",
- "description": "description",
- "pickupLocation": true,
- "staffSlips": [
- {
- "printByDefault": true,
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - {
- "printByDefault": true,
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}
], - "defaultCheckInActionForUseAtLocation": "Keep_on_hold_shelf",
- "ecsRequestRouting": false,
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "shelvingLagTime": 0,
- "holdShelfExpiryPeriod": {
- "duration": 6,
- "intervalId": "Days"
}
}Delete an existing service point by its unique identifier.
| id required | string <uuid> Record identifier. |
{- "errors": [
- {
- "message": "Illegal argument error",
- "type": "IllegalArgumentException",
- "code": "unknown_error"
}
], - "total_records": 1
}Retrieve a single service point by its unique identifier.
| id required | string <uuid> Record identifier. |
{- "holdShelfClosedLibraryDateManagement": "Keep_the_current_due_date",
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "discoveryDisplayName": "discoveryDisplayName",
- "description": "description",
- "pickupLocation": true,
- "staffSlips": [
- {
- "printByDefault": true,
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - {
- "printByDefault": true,
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}
], - "defaultCheckInActionForUseAtLocation": "Keep_on_hold_shelf",
- "ecsRequestRouting": false,
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "shelvingLagTime": 0,
- "holdShelfExpiryPeriod": {
- "duration": 6,
- "intervalId": "Days"
}
}Update an existing service point by its unique identifier.
| id required | string <uuid> Record identifier. |
| id | string <uuid> ID of the service point | ||||
| name required | string Name of the service point | ||||
| code required | string Code of the service point | ||||
| discoveryDisplayName required | string Discovery display name of the service point | ||||
| description | string Description of the service point | ||||
| shelvingLagTime | integer Shelving lag time | ||||
| pickupLocation | boolean Indicates whether or not the service point is a pickup location | ||||
object (Hold Shelf Expiry Period) Expiration period for items on the hold shelf at the service point | |||||
| |||||
| holdShelfClosedLibraryDateManagement | string Default: "Keep_the_current_due_date" 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" Closed library date management associated with hold shelf | ||||
| defaultCheckInActionForUseAtLocation | string Enum: "Keep_on_hold_shelf" "Close_loan_and_return_item" "Ask_for_action" Default action when checking in an item that is for use in the library (i.e. in reading room) | ||||
Array of objects (Service Point Staff Slip) List of staff slips for this service point | |||||
Array
| |||||
| ecsRequestRouting | boolean Default: false Indicates a service point used for the ECS functionality | ||||
{- "holdShelfClosedLibraryDateManagement": "Keep_the_current_due_date",
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "code": "code",
- "discoveryDisplayName": "discoveryDisplayName",
- "description": "description",
- "pickupLocation": true,
- "staffSlips": [
- {
- "printByDefault": true,
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - {
- "printByDefault": true,
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}
], - "defaultCheckInActionForUseAtLocation": "Keep_on_hold_shelf",
- "ecsRequestRouting": false,
- "name": "name",
- "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "shelvingLagTime": 0,
- "holdShelfExpiryPeriod": {
- "duration": 6,
- "intervalId": "Days"
}
}{- "errors": [
- {
- "message": "Illegal argument error",
- "type": "IllegalArgumentException",
- "code": "unknown_error"
}
], - "total_records": 1
}Return a list of service points users.
| query | string CQL query expression. |
| limit | integer >= 0 Default: 10 Limit the number of elements returned. |
| offset | integer >= 0 Default: 0 Skip over a number of elements. |
{- "totalRecords": 0,
- "servicePointsUsers": [
- {
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "defaultServicePointId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "servicePointsIds": [
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
], - "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "userId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - {
- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "defaultServicePointId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "servicePointsIds": [
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
], - "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "userId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}
]
}Create a new service points user record.
| id | string <uuid> ID of the service points user |
| userId required | string <uuid> ID of the user |
| servicePointsIds | Array of strings <uuid> [ items <uuid > ] List of service points a user is allowed to work at |
| defaultServicePointId | string <uuid> ID of the user's default service point |
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "defaultServicePointId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "servicePointsIds": [
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
], - "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "userId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "defaultServicePointId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "servicePointsIds": [
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
], - "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "userId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Retrieve a single service points user by their unique identifier.
| id required | string <uuid> Record identifier. |
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "defaultServicePointId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "servicePointsIds": [
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
], - "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "userId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Update an existing service points user by their unique identifier.
| id required | string <uuid> Record identifier. |
| id | string <uuid> ID of the service points user |
| userId required | string <uuid> ID of the user |
| servicePointsIds | Array of strings <uuid> [ items <uuid > ] List of service points a user is allowed to work at |
| defaultServicePointId | string <uuid> ID of the user's default service point |
{- "metadata": {
- "createdByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "createdDate": "2000-01-23T04:56:07.000+00:00",
- "updatedDate": "2000-01-23T04:56:07.000+00:00",
- "updatedByUserId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, - "defaultServicePointId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "servicePointsIds": [
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
], - "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
- "userId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}