Created
June 20, 2023 09:32
-
-
Save danmichaelo/573c1a9f3f8a8906513d18b702b29798 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| openapi: 3.0.0 | |
| info: | |
| version: 0.1.0 | |
| title: Libry Platform - Libry Content Service | |
| description: API for Search in Libry Platform | |
| servers: | |
| - url: https://platform.libry.dk/api/content | |
| description: Production server (uses live data) | |
| - url: https://platform-staging.libry.dk/api/content | |
| description: Staging server | |
| - url: https://platform-dev.libry.dk/api/content | |
| description: Dev server | |
| - url: http://localhost:8080/api/content | |
| description: Localhost server | |
| paths: | |
| /{customerId}/auth/login: | |
| post: | |
| tags: | |
| - Authorization | |
| description: Login, returns a session token that is used for authetication in other calls. | |
| parameters: | |
| - name: customerId | |
| in: path | |
| required: true | |
| description: device id | |
| schema: | |
| type: string | |
| default: 75de8c9e-00d1-4a63-a9ec-411b8cf5496c | |
| requestBody: | |
| description: user login | |
| required: true | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/UserCredentials' | |
| example: | |
| username: "255d41514c" | |
| password: "1234" | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ButlerUser' | |
| '4XX': | |
| description: Some known error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Errors' | |
| '500': | |
| description: Some unknown server error | |
| /{customerId}/auth/logout: | |
| get: | |
| tags: | |
| - Authorization | |
| description: logout, logs out the user and deletes the session token in the database. | |
| security: | |
| - ApiKeyAuth: [ ] | |
| parameters: | |
| - name: customerId | |
| in: path | |
| required: true | |
| description: device id | |
| schema: | |
| type: string | |
| default: 75de8c9e-00d1-4a63-a9ec-411b8cf5496c | |
| responses: | |
| '200': | |
| description: User logout was successful | |
| '4XX': | |
| description: Some known error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Errors' | |
| '500': | |
| description: Some unknown server error | |
| /{customerId}/auth/isAuthenticated: | |
| get: | |
| tags: | |
| - Authorization | |
| description: check if a user is stil logged in. | |
| security: | |
| - ApiKeyAuth: [ ] | |
| parameters: | |
| - name: customerId | |
| in: path | |
| required: true | |
| description: device id | |
| schema: | |
| type: string | |
| default: 75de8c9e-00d1-4a63-a9ec-411b8cf5496c | |
| responses: | |
| '200': | |
| description: User is still logged in. | |
| '4XX': | |
| description: Some known error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Errors' | |
| '500': | |
| description: Some unknown server error | |
| /{customerId}/patron/info: | |
| get: | |
| tags: | |
| - Patron | |
| description: Get full infomation on the logged in patron. The result contains [PatronInfo](#model-PatronInfo) | |
| security: | |
| - ApiKeyAuth: [ ] | |
| parameters: | |
| - name: customerId | |
| in: path | |
| description: Device id | |
| schema: | |
| type: string | |
| default: 75de8c9e-00d1-4a63-a9ec-411b8cf5496c | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/PatronInfo' | |
| '4XX': | |
| description: Some known error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Errors' | |
| '500': | |
| description: Some unknown server error | |
| /{customerId}/patron/loans: | |
| get: | |
| tags: | |
| - Loan | |
| security: | |
| - ApiKeyAuth: [ ] | |
| description: Renews a loan specified by the renew loan Id that comes from getLoans. | |
| parameters: | |
| - name: customerId | |
| in: path | |
| required: true | |
| description: Device id | |
| schema: | |
| type: string | |
| default: 75de8c9e-00d1-4a63-a9ec-411b8cf5496c | |
| responses: | |
| '200': | |
| description: "Successful response - A list of loans the user have" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Loans' | |
| '4XX': | |
| description: Some known error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Errors' | |
| '500': | |
| description: Some unknown server error | |
| /{customerId}/patron/loan/{loanId}: | |
| put: | |
| tags: | |
| - Loan | |
| security: | |
| - ApiKeyAuth: [ ] | |
| description: Returns a list of the loans for the logged in user. | |
| parameters: | |
| - name: customerId | |
| in: path | |
| required: true | |
| description: Device id | |
| schema: | |
| type: string | |
| default: 75de8c9e-00d1-4a63-a9ec-411b8cf5496c | |
| - name: loanId | |
| in: path | |
| required: true | |
| description: the id used to renew a loan | |
| schema: | |
| type: string | |
| default: loanId | |
| responses: | |
| '200': | |
| description: "Successful response - Loan has be renewed" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Loan' | |
| '4XX': | |
| description: Some known error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Errors' | |
| '500': | |
| description: Some unknown server error | |
| /{customerId}/patron/reservations: | |
| get: | |
| tags: | |
| - Reservation | |
| security: | |
| - ApiKeyAuth: [ ] | |
| description: Returns a list of the reservations for the logged in user. The list contains both reservations that are ready for pickup and those stille pending. | |
| parameters: | |
| - name: customerId | |
| in: path | |
| required: true | |
| description: Device id | |
| schema: | |
| type: string | |
| default: 75de8c9e-00d1-4a63-a9ec-411b8cf5496c | |
| responses: | |
| '200': | |
| description: "Successful response - A list of reservations and pickups the user have" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Reservations' | |
| '4XX': | |
| description: Some known error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Errors' | |
| '500': | |
| description: Some unknown server error | |
| /{customerId}/patron/reservation: | |
| post: | |
| tags: | |
| - Reservation | |
| security: | |
| - ApiKeyAuth: [ ] | |
| description: Make a reservation from reserve id acquired from calling holdings on a publication id. the branch is taken from the logged in users main branch | |
| parameters: | |
| - name: customerId | |
| in: path | |
| description: Device id | |
| schema: | |
| type: string | |
| default: 75de8c9e-00d1-4a63-a9ec-411b8cf5496c | |
| requestBody: | |
| required: true | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/CreatePatronReservation' | |
| example: | |
| holdingId: "4353434534" | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Reservation' | |
| '4XX': | |
| description: Some known error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Errors' | |
| '500': | |
| description: Some unknown server error | |
| /{customerId}/patron/reservation/{reservationId}: | |
| delete: | |
| tags: | |
| - Reservation | |
| security: | |
| - ApiKeyAuth: [ ] | |
| description: deletes a reservation from the reservation Id based on getReservation | |
| parameters: | |
| - name: customerId | |
| in: path | |
| required: true | |
| description: Device id | |
| schema: | |
| type: string | |
| default: 75de8c9e-00d1-4a63-a9ec-411b8cf5496c | |
| - name: reservationId | |
| in: path | |
| schema: | |
| type: string | |
| default: reservationId | |
| responses: | |
| '200': | |
| description: "Successful response" | |
| '4XX': | |
| description: Some known error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Errors' | |
| '500': | |
| description: Some unknown server error | |
| # COMPONENTS | |
| components: | |
| securitySchemes: | |
| ApiKeyAuth: | |
| type: http | |
| scheme: bearer | |
| schemas: | |
| ButlerTag: | |
| properties: | |
| dateOfScan: | |
| type: string | |
| tagId: | |
| type: string | |
| data: | |
| type: string | |
| reversedData: | |
| type: string | |
| isReversed: | |
| type: boolean | |
| blockSize: | |
| type: integer | |
| pid: | |
| type: string | |
| isil: | |
| type: string | |
| placeCode: | |
| type: string | |
| SearchResult: | |
| properties: | |
| totalCount: | |
| type: integer | |
| more: | |
| type: boolean | |
| records: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SearchRecord' | |
| facets: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Facet' | |
| SearchRecord: | |
| properties: | |
| id: | |
| type: string | |
| title: | |
| type: string | |
| contributors: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Contributor' | |
| languages: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Language' | |
| partOfSeries: | |
| type: string | |
| partNo: | |
| type: string | |
| untranscribedTitle: | |
| type: string | |
| mediaType: | |
| type: string | |
| firstYearOfPublication: | |
| type: string | |
| publicationYear: | |
| type: string | |
| coverUrl: | |
| type: string | |
| coverType: | |
| type: string | |
| literaryForms: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SearchableWithDisplayText' | |
| subjects: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SearchableWithDisplayText' | |
| genres: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SearchableWithDisplayText' | |
| isFiction: | |
| type: boolean | |
| highlightedResult: | |
| type: string | |
| Contributors: | |
| properties: | |
| type: | |
| type: string | |
| contributors: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Contributor' | |
| Contributor: | |
| properties: | |
| search: | |
| $ref: '#/components/schemas/SearchableValue' | |
| displayText: | |
| type: string | |
| type: | |
| type: string | |
| description: Types can be found at <https://www.loc.gov/marc/relators/> | |
| isMain: | |
| type: boolean | |
| name: | |
| type: string | |
| gender: | |
| type: string | |
| birthYear: | |
| type: string | |
| deathYear: | |
| type: string | |
| nationalities: | |
| type: array | |
| items: | |
| type: string | |
| Language: | |
| properties: | |
| search: | |
| $ref: '#/components/schemas/SearchableValue' | |
| displayText: | |
| type: string | |
| code: | |
| type: string | |
| description: Codes can be found at <http://www.loc.gov/marc/languages/> | |
| isPrime: | |
| type: boolean | |
| Facet: | |
| properties: | |
| type: | |
| type: string | |
| terms: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Term' | |
| Term: | |
| properties: | |
| term: | |
| type: string | |
| value: | |
| type: string | |
| quantity: | |
| type: integer | |
| Work: | |
| properties: | |
| id: | |
| type: string | |
| audiences: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SearchableWithDisplayText' | |
| title: | |
| type: string | |
| subTitle: | |
| type: string | |
| partNumber: | |
| type: string | |
| partTitle: | |
| type: string | |
| description: | |
| type: string | |
| firstYearOfPublication: | |
| type: string | |
| ageLimit: | |
| type: string | |
| originalLanguages: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Language' | |
| isFiction: | |
| type: boolean | |
| literaryForms: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SearchableWithDisplayText' | |
| countriesOfOrigin: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SearchableWithDisplayText' | |
| classifications: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SearchableWithDisplayText' | |
| compositionTypes: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SearchableWithDisplayText' | |
| facilitators: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SearchableWithDisplayText' | |
| musicalKeys: | |
| type: array | |
| items: | |
| type: string | |
| instrumentations: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Instrumentations' | |
| contributors: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Contributors' | |
| genres: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SearchableWithDisplayText' | |
| workSeries: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Series' | |
| workRelations: | |
| $ref: '#/components/schemas/Relations' | |
| subjects: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SearchableWithDisplayText' | |
| publicationIds: | |
| type: array | |
| items: | |
| type: string | |
| Publication: | |
| properties: | |
| id: | |
| type: string | |
| publicationYear: | |
| type: string | |
| recordId: | |
| type: string | |
| title: | |
| type: string | |
| untranscribedTitle: | |
| type: string | |
| binding: | |
| type: string | |
| ean: | |
| type: string | |
| partNumber: | |
| type: string | |
| mainTitle: | |
| type: string | |
| partTitle: | |
| type: string | |
| subTitle: | |
| type: string | |
| duration: | |
| type: string | |
| coverUrl: | |
| type: string | |
| coverType: | |
| type: string | |
| ageLimit: | |
| type: string | |
| currentNoOfReservations: | |
| type: integer | |
| changePickupBranch: | |
| type: boolean | |
| subtitles: | |
| type: array | |
| items: | |
| type: string | |
| notes: | |
| type: array | |
| items: | |
| type: string | |
| extents: | |
| type: array | |
| items: | |
| type: string | |
| formats: | |
| type: array | |
| items: | |
| type: string | |
| isbn: | |
| type: array | |
| items: | |
| type: string | |
| languages: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Language' | |
| mediaTypes: | |
| type: array | |
| items: | |
| type: string | |
| numberOfPages: | |
| type: array | |
| items: | |
| type: string | |
| adaptations: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SearchableWithDisplayText' | |
| contributors: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Contributors' | |
| placeOfPublications: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/PublicationPlaceOfPublication' | |
| publicationParts: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/PublicationPart' | |
| serialIssues: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/PublicationSerialIssue' | |
| publishers: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/PublicationPublisher' | |
| PublicationPart: | |
| properties: | |
| partNumber: | |
| type: integer | |
| partTitle: | |
| type: string | |
| contributor: | |
| type: string | |
| PublicationPlaceOfPublication: | |
| properties: | |
| id: | |
| type: string | |
| type: | |
| type: string | |
| prefLabel: | |
| type: string | |
| specification: | |
| type: string | |
| alternativeName: | |
| type: string | |
| PublicationSerialIssue: | |
| properties: | |
| search: | |
| $ref: '#/components/schemas/SearchableValue' | |
| displayText: | |
| type: string | |
| uri: | |
| type: string | |
| name: | |
| type: string | |
| PublicationPublisher: | |
| properties: | |
| search: | |
| $ref: '#/components/schemas/SearchableValue' | |
| displayText: | |
| type: string | |
| id: | |
| type: string | |
| type: | |
| type: string | |
| name: | |
| type: string | |
| place: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/PublicationPlaceOfPublication' | |
| specification: | |
| type: string | |
| HoldingObject: | |
| properties: | |
| reservationId: | |
| type: string | |
| wayfindingId: | |
| type: string | |
| description: To be used with the wayfinding service | |
| reservable: | |
| type: boolean | |
| notForLoan: | |
| type: boolean | |
| isPeriodical: | |
| type: boolean | |
| nofCopiesAvailableForLoan: | |
| type: integer | |
| nofCheckedOutCopies: | |
| type: integer | |
| nofTotalCopies: | |
| type: integer | |
| holdings: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Holding' | |
| Holding: | |
| properties: | |
| branchId: | |
| type: string | |
| departmentId: | |
| type: string | |
| locationId: | |
| type: string | |
| subLocationId: | |
| type: string | |
| reservationId: | |
| type: string | |
| shelfmark: | |
| type: string | |
| wayfindingId: | |
| type: string | |
| description: To be used with the wayfinding service | |
| reservable: | |
| type: boolean | |
| nofCheckedOutCopies: | |
| type: integer | |
| nofCopiesAvailableForLoan: | |
| type: integer | |
| nofTotalCopies: | |
| type: integer | |
| periodical: | |
| type: array | |
| items: | |
| type: string | |
| items: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/HoldingItem' | |
| notForLoan: | |
| type: boolean | |
| notForLoanAndCheckedOut: | |
| type: boolean | |
| Series: | |
| properties: | |
| search: | |
| $ref: '#/components/schemas/SearchableValue' | |
| displayText: | |
| type: string | |
| numberInSeries: | |
| type: string | |
| Relations: | |
| properties: | |
| relatedWork: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/RelatedWork' | |
| continuedIn: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ContinuedIn' | |
| continuationOf: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ContinuationOf' | |
| partOf: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/PartOf' | |
| SearchableWithDisplayText: | |
| properties: | |
| search: | |
| $ref: '#/components/schemas/SearchableValue' | |
| displayText: | |
| type: string | |
| SearchableValue: | |
| properties: | |
| type: | |
| type: string | |
| value: | |
| type: string | |
| RelatedWork: | |
| properties: | |
| title: | |
| type: string | |
| publicationId: | |
| type: string | |
| ContinuedIn: | |
| properties: | |
| title: | |
| type: string | |
| publicationId: | |
| type: string | |
| ContinuationOf: | |
| properties: | |
| title: | |
| type: string | |
| publicationId: | |
| type: string | |
| PartOf: | |
| properties: | |
| title: | |
| type: string | |
| publicationId: | |
| type: string | |
| BlockedStatus: | |
| properties: | |
| type: | |
| type: string | |
| reason: | |
| type: string | |
| Token: | |
| properties: | |
| type: | |
| type: string | |
| value: | |
| type: string | |
| expire: | |
| type: integer | |
| nullable: true | |
| UserCredentials: | |
| properties: | |
| username: | |
| type: string | |
| password: | |
| type: string | |
| LoanRequest: | |
| properties: | |
| barcode: | |
| type: string | |
| CheckinOfflineRequests: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/CheckinOfflineRequest' | |
| CheckinOfflineRequest: | |
| properties: | |
| barcode: | |
| type: string | |
| transactionDate: | |
| type: number | |
| ButlerConfig: | |
| properties: | |
| deviceName: | |
| type: string | |
| sortBins: | |
| $ref: '#/components/schemas/SortBins' | |
| branchId: | |
| type: string | |
| departmentId: | |
| type: string | |
| branches: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Branch' | |
| facet: | |
| properties: | |
| materialType: | |
| type: string | |
| facets: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ButlerConfigFacet' | |
| reservationBranches: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ReservationBranch' | |
| contributors: | |
| properties: | |
| eng: | |
| type: string | |
| dan: | |
| type: string | |
| nob: | |
| type: string | |
| translations: | |
| properties: | |
| eng: | |
| type: string | |
| dan: | |
| type: string | |
| nob: | |
| type: string | |
| coverTypes: | |
| properties: | |
| string: | |
| $ref: '#/components/schemas/CoverType' | |
| departments: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Department' | |
| locations: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Location' | |
| subLocations: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SubLocation' | |
| publicKey: | |
| type: string | |
| ButlerUser: | |
| properties: | |
| username: | |
| type: string | |
| borrowerName: | |
| type: string | |
| firstName: | |
| type: string | |
| surname: | |
| type: string | |
| email: | |
| type: string | |
| mainBranch: | |
| type: string | |
| type: | |
| type: string | |
| enableCheckout: | |
| type: boolean | |
| blocked: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/BlockedStatus' | |
| token: | |
| $ref: '#/components/schemas/Token' | |
| QueryParserSettings: | |
| properties: | |
| materialeType: | |
| type: string | |
| emne: | |
| type: string | |
| filial: | |
| type: string | |
| år: | |
| type: string | |
| sprog: | |
| type: string | |
| litteratur: | |
| type: string | |
| SortBins: | |
| properties: | |
| default: | |
| type: integer | |
| bins: | |
| type: array | |
| items: | |
| type: string | |
| Branch: | |
| properties: | |
| name: | |
| type: string | |
| id: | |
| type: string | |
| Department: | |
| properties: | |
| name: | |
| type: string | |
| id: | |
| type: string | |
| Location: | |
| properties: | |
| name: | |
| type: string | |
| id: | |
| type: string | |
| SubLocation: | |
| properties: | |
| name: | |
| type: string | |
| id: | |
| type: string | |
| ReservationBranch: | |
| properties: | |
| text: | |
| type: string | |
| id: | |
| type: string | |
| ButlerConfigFacet: | |
| properties: | |
| type: | |
| type: string | |
| translationKey: | |
| type: string | |
| CoverType: | |
| properties: | |
| backgroundColor: | |
| type: string | |
| square: | |
| type: string | |
| Checkout: | |
| properties: | |
| success: | |
| type: boolean | |
| barcode: | |
| type: string | |
| branchId: | |
| type: string | |
| cardNumber: | |
| type: string | |
| patronName: | |
| type: string | |
| patronMail: | |
| type: string | |
| dueDate: | |
| type: integer | |
| materialMetaData: | |
| $ref: '#/components/schemas/MaterialMetaData' | |
| message: | |
| type: string | |
| CheckoutOfflineRequests: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/CheckoutOfflineRequest' | |
| CheckoutOfflineRequest: | |
| properties: | |
| barcode: | |
| type: string | |
| dueDate: | |
| type: number | |
| transactionDate: | |
| type: number | |
| user: | |
| type: string | |
| pass: | |
| type: string | |
| Checkin: | |
| properties: | |
| success: | |
| type: boolean | |
| barcode: | |
| type: string | |
| branchId: | |
| type: string | |
| cardNumber: | |
| type: string | |
| patronName: | |
| type: string | |
| patronMail: | |
| type: string | |
| sortBin: | |
| type: string | |
| materialMetaData: | |
| $ref: '#/components/schemas/MaterialMetaData' | |
| message: | |
| type: string | |
| Loan: | |
| properties: | |
| publicationId: | |
| type: string | |
| barcode: | |
| type: string | |
| loanMetaData: | |
| $ref: '#/components/schemas/MaterialMetaData' | |
| loanDueDate: | |
| type: integer | |
| loanDate: | |
| type: integer | |
| loanBranch: | |
| type: string | |
| renewLoanId: | |
| type: string | |
| remainingRenewals: | |
| type: integer | |
| publicationYear: | |
| type: string | |
| isLoanRenewable: | |
| type: boolean | |
| isILL: | |
| type: boolean | |
| Loans: | |
| properties: | |
| loans: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Loan' | |
| Reservation: | |
| properties: | |
| publicationId: | |
| type: string | |
| barcode: | |
| type: string | |
| reservationMetaData: | |
| $ref: '#/components/schemas/MaterialMetaData' | |
| created: | |
| type: integer | |
| estimatedReady: | |
| $ref: '#/components/schemas/EstimatedReady' | |
| pickUpBranch: | |
| type: string | |
| pickUpGuide: | |
| type: string | |
| pickUpExpireDate: | |
| type: integer | |
| queueNumber: | |
| type: integer | |
| reservationRemoveId: | |
| type: string | |
| isReady: | |
| type: boolean | |
| isILL: | |
| type: boolean | |
| Reservations: | |
| properties: | |
| reservations: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Reservation' | |
| MaterialMetaData: | |
| properties: | |
| identifier: | |
| type: string | |
| barcode: | |
| type: string | |
| mediaType: | |
| type: string | |
| title: | |
| type: string | |
| creators: | |
| type: array | |
| items: | |
| type: string | |
| publicationYear: | |
| type: string | |
| note: | |
| type: string | |
| coverUrl: | |
| type: string | |
| coverType: | |
| type: string | |
| EstimatedReady: | |
| properties: | |
| text: | |
| type: string | |
| ButlerFee: | |
| properties: | |
| id: | |
| type: string | |
| type: | |
| type: string | |
| amount: | |
| type: number | |
| currency: | |
| type: string | |
| payable: | |
| type: boolean | |
| outstandings: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ButlerOutstandingFee' | |
| nextDueDate: | |
| type: integer | |
| firstCreated: | |
| type: integer | |
| ButlerOutstandingFee: | |
| properties: | |
| id: | |
| type: string | |
| amount: | |
| type: number | |
| currency: | |
| type: string | |
| materials: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/MaterialMetaData' | |
| reason: | |
| type: string | |
| loanReturnedDate: | |
| description: If don't this, it's set to -1 | |
| type: integer | |
| due: | |
| type: integer | |
| created: | |
| type: integer | |
| HoldingItem: | |
| description: notForLoan represents for use at the library only. availble is if the item is at the library. | |
| properties: | |
| barcode: | |
| type: string | |
| notForLoan: | |
| type: boolean | |
| available: | |
| type: boolean | |
| Notify: | |
| properties: | |
| language: | |
| type: string | |
| recipient: | |
| type: string | |
| typeOfNotification: | |
| type: string | |
| NotifyMaterialList: | |
| properties: | |
| language: | |
| type: string | |
| recipient: | |
| type: string | |
| typeOfNotification: | |
| type: string | |
| ids: | |
| type: array | |
| items: | |
| type: string | |
| NotifyCheckout: | |
| properties: | |
| language: | |
| type: string | |
| recipient: | |
| type: string | |
| typeOfNotification: | |
| type: string | |
| materials: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/NotifyMaterialCheckout' | |
| NotifyCheckin: | |
| properties: | |
| language: | |
| type: string | |
| recipient: | |
| type: string | |
| typeOfNotification: | |
| type: string | |
| materials: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/NotifyMaterialCheckin' | |
| NotifyMaterialCheckout: | |
| properties: | |
| id: | |
| type: string | |
| title: | |
| type: string | |
| creators: | |
| type: array | |
| items: | |
| type: string | |
| duedate: | |
| type: integer | |
| NotifyMaterialCheckin: | |
| properties: | |
| id: | |
| type: string | |
| title: | |
| type: string | |
| creators: | |
| type: array | |
| items: | |
| type: string | |
| PatronInfo: | |
| properties: | |
| patronId: | |
| type: string | |
| cardNumber: | |
| type: string | |
| branchId: | |
| type: string | |
| fullName: | |
| type: string | |
| firstName: | |
| type: string | |
| address: | |
| type: string | |
| zipCode: | |
| type: string | |
| city: | |
| type: string | |
| country: | |
| type: string | |
| mobile: | |
| type: string | |
| telephone: | |
| type: string | |
| email: | |
| type: string | |
| birthDate: | |
| type: integer | |
| loanerCardIssued: | |
| type: integer | |
| loanerCategory: | |
| type: string | |
| doorAccess: | |
| type: boolean | |
| blocked: | |
| $ref: '#/components/schemas/PatronBlocked' | |
| notificationSettings: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/PatronNotificationSettings' | |
| PatronNotificationSettings: | |
| properties: | |
| type: | |
| type: string | |
| email: | |
| type: boolean | |
| sms: | |
| type: boolean | |
| PatronBlocked: | |
| properties: | |
| headline: | |
| type: string | |
| text: | |
| type: string | |
| CreatePatronReservation: | |
| properties: | |
| holdingId: | |
| type: string | |
| Instrumentations: | |
| properties: | |
| search: | |
| $ref: '#/components/schemas/SearchableValue' | |
| displayText: | |
| type: string | |
| instrument: | |
| type: string | |
| quantity: | |
| type: string | |
| PaymentDemo: | |
| properties: | |
| feeIds: | |
| type: array | |
| items: | |
| type: string | |
| Suggestions: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Suggestion' | |
| Suggestion: | |
| properties: | |
| displayText: | |
| type: string | |
| searchTerm: | |
| type: string | |
| facetType: | |
| type: string | |
| Errors: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Error' | |
| Error: | |
| description: | | |
| All error code over 99999 can change, and should not be used. | |
| 10: missing required url param <br> | |
| 11: bad body <br> | |
| 12: Reservation was not deleted <br> | |
| 20: the user session has expired, please login and try again <br> | |
| 21: user access data does not exist at device <br> | |
| 22: invalid authorization header <br> | |
| 50: device id not found <br> | |
| 51: no devices with deviceId found <br> | |
| 52: multi devices found <br> | |
| 60: too soon <br> | |
| 61: too many attempts <br> | |
| 62: item is deleted <br> | |
| 63: material is age restricted and patron too young <br> | |
| 64: patron has outstanding fees <br> | |
| 65: not for loan <br> | |
| 66: item restricted <br> | |
| 67: item is reserved <br> | |
| 68: mail to patron is bouncing, contact staff to update address <br> | |
| 69: patron card is registered as lost <br> | |
| 70: patron is debarred <br> | |
| 71: patron library card expired <br> | |
| 72: patron is quaranting for other patron <br> | |
| 73: patron blocked due to outstanding fees <br> | |
| 74: item couldn't be renewed <br> | |
| 75: return not possible <br> | |
| 76: item not found <br> | |
| 100: wrong username or password <br> | |
| 101: patron blocked <br> | |
| 105: login missing password <br> | |
| 107: no valid scopes provided <br> | |
| 418: method not implemented <br> | |
| 666: unknown error <br> | |
| Other potential errors: <br> | |
| 100001: wrong username or password <br> | |
| 100002: patron blocked <br> | |
| 100003: access denied <br> | |
| 100004: ACS unit is offline <br> | |
| 10400: method not implemented <br> | |
| 11001: the user session has expired, please login and try again <br> | |
| 11010: invalid authorization header <br> | |
| 11011: invalid authorization token <br> | |
| 11012: user is invalid <br> | |
| 11013: bad session Id <br> | |
| 51001: no env is set for paymentDemo object <br> | |
| 51002: no baseUrl is set for paymentDemo object <br> | |
| 100005: too soon <br> | |
| 100006: too many attempts <br> | |
| 100007: item is deleted <br> | |
| 100008: material is age restricted and patron too young <br> | |
| 100009: not for loan <br> | |
| 100010: item restricted <br> | |
| 100011: item is reserved <br> | |
| 100012: item couldn't be renewed <br> | |
| 100013: return not possible <br> | |
| 100014: item not found <br> | |
| 100015: patron not found <br> | |
| 100016: mail to patron is bouncing, contact staff to update address <br> | |
| 100017: patron card is registered as lost <br> | |
| 100018: patron is debarred <br> | |
| 100019: patron library card expired <br> | |
| 100020: patron is quaranting for other patron <br> | |
| 100021: patron blocked due to outstanding fees <br> | |
| 100022: patron has outstanding fees <br> | |
| 11210: redia.renewed <br> | |
| 11211: redia.checked_out <br> | |
| 11212: redia.reserved <br> | |
| 11213: redia.no_checkout <br> | |
| 11214: redia.limit_exceeded <br> | |
| 11215: redia.restricted <br> | |
| 11216: redia.other <br> | |
| 11217: redia.unsuccessful <br> | |
| 11218: redia.material_not_found <br> | |
| 11221: redia.material_not_for_checkout <br> | |
| 11219: redia.profile_not_found <br> | |
| 11220: redia.patron_not_found <br> | |
| 100023: reservation was unsuccessful <br> | |
| 11510: active session already exists <br> | |
| 11515: the session is closed <br> | |
| 11710: journal session not found <br> | |
| 100024: no shelf in session <br> | |
| 11520: deleting from shelf inventory failed <br> | |
| 21011: butler offline <br> | |
| 21012: username is empty <br> | |
| 100025: item is already on a pickup shelf <br> | |
| 100026: item not found <br> | |
| 100027: item not picked <br> | |
| 100028: item not reserved <br> | |
| 100029: item reserved to another branch <br> | |
| 100030: item not deleted from old shelf <br> | |
| 100031: no branch implementation <br> | |
| 100032: device id not found <br> | |
| 100033: no devices with deviceId found <br> | |
| 100034: multi devices found <br> | |
| 100035: customer id not found <br> | |
| 100036: customer name not found <br> | |
| 100037: there are no new customer data <br> | |
| 100038: there are no new device data <br> | |
| 100039: finger print already in use <br> | |
| 21010: input device id is badly formatted <br> | |
| 100040: no change <br> | |
| 100041: change not allowed, item checked out <br> | |
| 100042: location not found <br> | |
| 100043: no patron info <br> | |
| 100044: session not found <br> | |
| 100051: reservation not found <br> | |
| 100061: the provider are missing a sip2 url <br> | |
| 100071: work not found <br> | |
| 100072: get branches failed <br> | |
| 100073: get departments failed <br> | |
| 100074: the provider are missing a sip2 url <br> | |
| 100131: no branch implementation <br> | |
| 100132: notification type not implemented <br> | |
| 100133: unknown notification type <br> | |
| 100134: no materials where found when creating notify for material list <br> | |
| 100135: no reservations are ready for pickup <br> | |
| 100136: no loans on the user <br> | |
| 100137: no departments implementation <br> | |
| 100138: no locations implementation <br> | |
| 100139: no sublocations implementation <br> | |
| 100140: getting user loans failed <br> | |
| 100141: getting user reservations failed <br> | |
| 100142: adding reservation failed <br> | |
| 100143: deleting reservation failed <br> | |
| properties: | |
| code: | |
| type: integer | |
| enum: [ 10, 11, 12, 20, 21, 22, 50, 51, 52, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 100, 101, 105, 107, 418, 666, 100001, 100002, 100003, 100004, 10400, 11001, 11010, 11011, 11012, 11013, 51001, 51002, 100005, 100006, 100007, 100008, 100009, 100010, 100011, 100012, 100013, 100014, 100015, 100016, 100017, 100018, 100019, 100020, 100021, 100022, 11210, 11211, 11212, 11213, 11214, 11215, 11216, 11217, 11218, 11221, 11219, 11220, 100023, 11510, 11515, 11710, 100024, 11520, 100025, 100026, 100027, 100028, 100029, 100030, 100031, 100032, 100033, 100034, 100035, 100036, 100037, 100038, 100039, 21010, 100040, 100041, 100042, 100043, 100044, 100051, 100061, 100071, 100072, 100073, 100074, 100131, 100132, 100133, 100134, 100135, 100136, 100137, 100138, 100139, 100140, 100141, 100142, 100143 ] | |
| info: | |
| type: string | |
| data: | |
| type: object | |
| nullable: true |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment