Edge API that proxies external client requests to the FOLIO mod-ill module.
Endpoints mirror the mod-ill ill interface as declared in its module descriptor.
Receives an ISO18626 xml message
| tenantId required | string Example: diku |
{ }{- "errors": [
- {
- "code": "validation",
- "type": "BadRequest",
- "message": "The input provided is invalid.",
- "parameters": [
- {
- "name": "field",
- "value": "must not be empty"
}
]
}
], - "total_records": 1
}Get OpenURL for patron; Interprets an OpenUrl version 0.1 or 1.0
| tenantId required | string Example: diku |
object Interprets an OpenURL version 0.1 or 1.0. All parameters are accepted as query parameters and passed as a map containing: Request Parameters (v1.0):
Referent Metadata Parameters (v1.0):
Service Parameters (v1.0):
Legacy Parameters (v0.1):
|
{ }View the document associated with the patron request
| tenantId required | string Example: diku |
| patronRequestId required | string Example: 3c3f172c-6874-4c56-88e1-2350a3d90320 |
{- "errors": [
- {
- "code": "validation",
- "type": "BadRequest",
- "message": "The input provided is invalid.",
- "parameters": [
- {
- "name": "field",
- "value": "must not be empty"
}
]
}
], - "total_records": 1
}Test document delivery offer
| tenantId required | string Example: diku |
| systemId required | string The id of the institution an order is to be placed for |
| url required | string The url of the document delivery system |
| privateKey required | string The private key to use |
| offerReference required | string The reference for this document |
| documentTitle | string The title for this offer |
| pin required | string The pin the user has to use to access the document |
| documentSecurityLevel required | string Enum: "DRM" "MARKED" "NONE" "SECURE" The document security level |
| offerType | string Enum: "DOCUMENT_STREAM" "URL" The type of offer being made |
| attestationLevel required | string Value: "SIMPLE" The attestation level |
| patronEmail | string The patron's email |
| rawSourceMimeType | string The mime type for the document |
| workflow | string The workflow we want this offer to follow |
| file | string <binary> The file to be uploaded, either this property of the rawSourceUrl property must be specified |
{ }Test document delivery registration
| tenantId required | string Example: diku |
| systemCode required | string The code of the institution we want to register |
| url required | string The url of the document delivery system |
| name required | string The name of the institution we are registering for |
| attestationLevel required | string Value: "SIMPLE" The attestation level |
{ }Perform Remote Action
| tenantId required | string Example: diku |
| id required | string |
{- "errors": [
- {
- "code": "validation",
- "type": "BadRequest",
- "message": "The input provided is invalid.",
- "parameters": [
- {
- "name": "field",
- "value": "must not be empty"
}
]
}
], - "total_records": 1
}