Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
#%RAML 1.0
title: GOBI® (Global Online Bibliographic Information) Integration
baseUri: https://github.com/folio-org/mod-gobi
protocols: [ HTTPS ]
version: v1
documentation:
- title: GOBI® (Global Online Bibliographic Information) Integration
content: |
GOBI® (Global Online Bibliographic Information) is the leading web-based
acquisitions tool for finding, ordering and managing e-books and print
books for libraries. This module allows GOBI initiated orders to be
fulfilled by FOLIO.
/gobi:
/validate:
displayName: Validate Access to GOBI Inegration service
description: Validates the user has proper access to the module
get:
description: Validates the user has proper access to the module
responses:
200:
description: The user is valid
body:
application/xml:
example: "<test>GET - OK</test>"
401:
description: Not authorized to perform requested action
body:
text/plain:
example: unable to get account -- unauthorized
403:
description: Access Denied
body:
text/plain:
example: Access Denied
500:
description: Internal server error, e.g. due to misconfiguration
body:
text/plain:
example: internal server error, contact administrator
post:
description: Validates the user has proper access to the module
responses:
200:
description: The user is valid
body:
application/xml:
example: "<test>POST - OK</test>"
401:
description: Not authorized to perform requested action
body:
text/plain:
example: unable to get account -- unauthorized
403:
description: Access Denied
body:
text/plain:
example: Access Denied
500:
description: Internal server error, e.g. due to misconfiguration
body:
text/plain:
example: internal server error, contact administrator
/orders:
displayName: Fulfill an order
description: Fulfill an order that is delivered in GOBI format
post:
description: Fulfill an order that is delivered in GOBI format
body:
application/xml:
type: string
example: !include examples/po.xml
responses:
201:
description: Creates a new order within FOLIO
body:
application/xml:
example: !include examples/response.xml
400:
description: Bad request
body:
application/xml:
example: !include examples/error.xml
401:
description: Not authorized to perform requested action
body:
text/plain:
example: unable to renew loan -- unauthorized
403:
description: Access Denied
body:
text/plain:
example: Access Denied
500:
description: |
Internal server error, e.g. due to misconfiguration
body:
text/plain:
example: internal server error, contact administrator