API docs by Redocly

Folio Licenses (7.3.0)

URL: https://www.k-int.com

API for the Folio library services platform mod-licenses app

Get a set of license records.

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Create license record

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
name
required
string

The name of the license or amendment

description
string

A description of the license or amendment

string or RefData (object)

The status (e.g. In negotiation, Not yet active, Active, Rejected, Expired)

One of
string

The status (e.g. In negotiation, Not yet active, Active, Rejected, Expired)

startDate
string <date>

The date on which the license or amendment becomes active

endDate
string <date>

The date on which the license or amendment expires

string or RefData (object)

How the end date should be interpreted (e.g. Explicit, Open ended, Implicit)

One of
string

How the end date should be interpreted (e.g. Explicit, Open ended, Implicit)

openEnded
boolean

Derived flag indicating whether the license or amendment is open-ended

Array of objects (Tag)

Tags applied to the license or amendment

Array
value
string
normValue
string
Array of objects (DocumentAttachment)

Documents attached to the license or amendment

Array
name
string
note
string
url
string <uri>
Array of objects (DocumentAttachment)

Supplementary documents attached to the license or amendment

Array
name
string
note
string
url
string <uri>
Array of objects (InternalContact)

Internal contacts associated with the license or amendment

Array
user
string <uuid>
string or RefData (object)

The contact's role in relation to the license

object

Custom properties (license terms) — keys are property names, values are arrays of property value instances

additional property
Array of objects (CustomPropertyValue)
string or RefData (object)

The license type (e.g. Local, Consortial, National, Alliance)

One of
string

The license type (e.g. Local, Consortial, National, Alliance)

localReference
string

A local reference identifier for the license

Array of objects (AlternateName)

Alternative names for the license

Array
name
required
string
Array of objects (LicenseOrg)

Organisations associated with the license

Array
object (Organisation)
primaryOrg
boolean
Default: false

Whether this is the primary organisation for the license

note
string

A note about this organisation's relationship to the license

Array of objects

The roles this organisation plays in relation to the license

Array of objects (LicenseAmendment)

Amendments to the license, sorted by start date descending

Array
name
required
string

The name of the license or amendment

description
string

A description of the license or amendment

string or RefData (object)

The status (e.g. In negotiation, Not yet active, Active, Rejected, Expired)

startDate
string <date>

The date on which the license or amendment becomes active

endDate
string <date>

The date on which the license or amendment expires

string or RefData (object)

How the end date should be interpreted (e.g. Explicit, Open ended, Implicit)

openEnded
boolean

Derived flag indicating whether the license or amendment is open-ended

Array of objects (Tag)

Tags applied to the license or amendment

Array of objects (DocumentAttachment)

Documents attached to the license or amendment

Array of objects (DocumentAttachment)

Supplementary documents attached to the license or amendment

Array of objects (InternalContact)

Internal contacts associated with the license or amendment

object

Custom properties (license terms) — keys are property names, values are arrays of property value instances

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "status": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "endDateSemantics": "string",
  • "openEnded": true,
  • "tags": [
    ],
  • "docs": [],
  • "supplementaryDocs": [],
  • "contacts": [
    ],
  • "customProperties": {
    },
  • "type": "string",
  • "localReference": "string",
  • "alternateNames": [
    ],
  • "orgs": [
    ],
  • "amendments": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "status": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "endDateSemantics": "string",
  • "openEnded": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "docs": [
    ],
  • "supplementaryDocs": [
    ],
  • "contacts": [
    ],
  • "customProperties": {
    },
  • "type": "string",
  • "localReference": "string",
  • "alternateNames": [
    ],
  • "orgs": [
    ],
  • "amendments": [
    ]
}

Get a specified license record

Authorizations:
accessTokenokapiToken
path Parameters
licenseId
required
string <uuid>

UUID for a license

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "status": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "endDateSemantics": "string",
  • "openEnded": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "docs": [
    ],
  • "supplementaryDocs": [
    ],
  • "contacts": [
    ],
  • "customProperties": {
    },
  • "type": "string",
  • "localReference": "string",
  • "alternateNames": [
    ],
  • "orgs": [
    ],
  • "amendments": [
    ]
}

Update license record

Authorizations:
accessTokenokapiToken
path Parameters
licenseId
required
string <uuid>

UUID for a license

Request Body schema: application/json
required
name
required
string

The name of the license or amendment

description
string

A description of the license or amendment

string or RefData (object)

The status (e.g. In negotiation, Not yet active, Active, Rejected, Expired)

One of
string

The status (e.g. In negotiation, Not yet active, Active, Rejected, Expired)

startDate
string <date>

The date on which the license or amendment becomes active

endDate
string <date>

The date on which the license or amendment expires

string or RefData (object)

How the end date should be interpreted (e.g. Explicit, Open ended, Implicit)

One of
string

How the end date should be interpreted (e.g. Explicit, Open ended, Implicit)

openEnded
boolean

Derived flag indicating whether the license or amendment is open-ended

Array of objects (Tag)

Tags applied to the license or amendment

Array
value
string
normValue
string
Array of objects (DocumentAttachment)

Documents attached to the license or amendment

Array
name
string
note
string
url
string <uri>
Array of objects (DocumentAttachment)

Supplementary documents attached to the license or amendment

Array
name
string
note
string
url
string <uri>
Array of objects (InternalContact)

Internal contacts associated with the license or amendment

Array
user
string <uuid>
string or RefData (object)

The contact's role in relation to the license

object

Custom properties (license terms) — keys are property names, values are arrays of property value instances

additional property
Array of objects (CustomPropertyValue)
string or RefData (object)

The license type (e.g. Local, Consortial, National, Alliance)

One of
string

The license type (e.g. Local, Consortial, National, Alliance)

localReference
string

A local reference identifier for the license

Array of objects (AlternateName)

Alternative names for the license

Array
name
required
string
Array of objects (LicenseOrg)

Organisations associated with the license

Array
object (Organisation)
primaryOrg
boolean
Default: false

Whether this is the primary organisation for the license

note
string

A note about this organisation's relationship to the license

Array of objects

The roles this organisation plays in relation to the license

Array of objects (LicenseAmendment)

Amendments to the license, sorted by start date descending

Array
name
required
string

The name of the license or amendment

description
string

A description of the license or amendment

string or RefData (object)

The status (e.g. In negotiation, Not yet active, Active, Rejected, Expired)

startDate
string <date>

The date on which the license or amendment becomes active

endDate
string <date>

The date on which the license or amendment expires

string or RefData (object)

How the end date should be interpreted (e.g. Explicit, Open ended, Implicit)

openEnded
boolean

Derived flag indicating whether the license or amendment is open-ended

Array of objects (Tag)

Tags applied to the license or amendment

Array of objects (DocumentAttachment)

Documents attached to the license or amendment

Array of objects (DocumentAttachment)

Supplementary documents attached to the license or amendment

Array of objects (InternalContact)

Internal contacts associated with the license or amendment

object

Custom properties (license terms) — keys are property names, values are arrays of property value instances

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "status": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "endDateSemantics": "string",
  • "openEnded": true,
  • "tags": [
    ],
  • "docs": [],
  • "supplementaryDocs": [],
  • "contacts": [
    ],
  • "customProperties": {
    },
  • "type": "string",
  • "localReference": "string",
  • "alternateNames": [
    ],
  • "orgs": [
    ],
  • "amendments": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "status": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "endDateSemantics": "string",
  • "openEnded": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "docs": [
    ],
  • "supplementaryDocs": [
    ],
  • "contacts": [
    ],
  • "customProperties": {
    },
  • "type": "string",
  • "localReference": "string",
  • "alternateNames": [
    ],
  • "orgs": [
    ],
  • "amendments": [
    ]
}

Delete a specified license record

Authorizations:
accessTokenokapiToken
path Parameters
licenseId
required
string <uuid>

UUID for a license

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0
}

Get a set of amendment records.

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Create amendment record

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
name
required
string

The name of the license or amendment

description
string

A description of the license or amendment

string or RefData (object)

The status (e.g. In negotiation, Not yet active, Active, Rejected, Expired)

One of
string

The status (e.g. In negotiation, Not yet active, Active, Rejected, Expired)

startDate
string <date>

The date on which the license or amendment becomes active

endDate
string <date>

The date on which the license or amendment expires

string or RefData (object)

How the end date should be interpreted (e.g. Explicit, Open ended, Implicit)

One of
string

How the end date should be interpreted (e.g. Explicit, Open ended, Implicit)

openEnded
boolean

Derived flag indicating whether the license or amendment is open-ended

Array of objects (Tag)

Tags applied to the license or amendment

Array
value
string
normValue
string
Array of objects (DocumentAttachment)

Documents attached to the license or amendment

Array
name
string
note
string
url
string <uri>
Array of objects (DocumentAttachment)

Supplementary documents attached to the license or amendment

Array
name
string
note
string
url
string <uri>
Array of objects (InternalContact)

Internal contacts associated with the license or amendment

Array
user
string <uuid>
string or RefData (object)

The contact's role in relation to the license

object

Custom properties (license terms) — keys are property names, values are arrays of property value instances

additional property
Array of objects (CustomPropertyValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "status": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "endDateSemantics": "string",
  • "openEnded": true,
  • "tags": [
    ],
  • "docs": [],
  • "supplementaryDocs": [],
  • "contacts": [
    ],
  • "customProperties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "status": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "endDateSemantics": "string",
  • "openEnded": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "docs": [
    ],
  • "supplementaryDocs": [
    ],
  • "contacts": [
    ],
  • "customProperties": {
    }
}

Get a specified amendment record

Authorizations:
accessTokenokapiToken
path Parameters
amendmentId
required
string <uuid>

UUID for an amendment

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "status": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "endDateSemantics": "string",
  • "openEnded": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "docs": [
    ],
  • "supplementaryDocs": [
    ],
  • "contacts": [
    ],
  • "customProperties": {
    }
}

Update amendment record

Authorizations:
accessTokenokapiToken
path Parameters
amendmentId
required
string <uuid>

UUID for an amendment

Request Body schema: application/json
required
name
required
string

The name of the license or amendment

description
string

A description of the license or amendment

string or RefData (object)

The status (e.g. In negotiation, Not yet active, Active, Rejected, Expired)

One of
string

The status (e.g. In negotiation, Not yet active, Active, Rejected, Expired)

startDate
string <date>

The date on which the license or amendment becomes active

endDate
string <date>

The date on which the license or amendment expires

string or RefData (object)

How the end date should be interpreted (e.g. Explicit, Open ended, Implicit)

One of
string

How the end date should be interpreted (e.g. Explicit, Open ended, Implicit)

openEnded
boolean

Derived flag indicating whether the license or amendment is open-ended

Array of objects (Tag)

Tags applied to the license or amendment

Array
value
string
normValue
string
Array of objects (DocumentAttachment)

Documents attached to the license or amendment

Array
name
string
note
string
url
string <uri>
Array of objects (DocumentAttachment)

Supplementary documents attached to the license or amendment

Array
name
string
note
string
url
string <uri>
Array of objects (InternalContact)

Internal contacts associated with the license or amendment

Array
user
string <uuid>
string or RefData (object)

The contact's role in relation to the license

object

Custom properties (license terms) — keys are property names, values are arrays of property value instances

additional property
Array of objects (CustomPropertyValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "status": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "endDateSemantics": "string",
  • "openEnded": true,
  • "tags": [
    ],
  • "docs": [],
  • "supplementaryDocs": [],
  • "contacts": [
    ],
  • "customProperties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "status": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "endDateSemantics": "string",
  • "openEnded": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "docs": [
    ],
  • "supplementaryDocs": [
    ],
  • "contacts": [
    ],
  • "customProperties": {
    }
}

Delete a specified amendment record

Authorizations:
accessTokenokapiToken
path Parameters
amendmentId
required
string <uuid>

UUID for an amendment

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0
}