Batch printing (v1)

getPrintEntries

Get batch printing entries with optional CQL query. X-Okapi-Permissions must include batch-print.entries.collection.get

query Parameters

limit	integer >= 0 Default: 10 Limit the number of elements returned in the response
offset	integer >= 0 Default: 0 Skip over number of elements (default is first element)
query	string CQL query

header Parameters

X-Okapi-Permissions required	string A JSON array with client permissions
X-Okapi-Tenant required	string^[_a-z][_a-z0-9]*$ Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL
X-Okapi-User-Id	string Okapi user identifier

Responses

Response samples

200
400
404

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created": "string",
"type": "string",
"sortingField": "string",
"content": "string"
}
],
"resultInfo": {"totalRecords": 0,
"diagnostics": [{"message": "string"
}
],
"facets": [{"facetValues": [{"count": 0,
"value": null
}
],
"type": "string"
}
]
}
}

deletePrintEntries

Delete batch printing entries by comma separated IDs. X-Okapi-Permissions must include batch-print.entries.collection.delete

query Parameters

ids

required

string

Comma seperated IDs of items

header Parameters

X-Okapi-Permissions required	string A JSON array with client permissions
X-Okapi-Tenant required	string^[_a-z][_a-z0-9]*$ Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL
X-Okapi-User-Id	string Okapi user identifier

Responses

Response samples

400

Content type

text/plain

No sample

postPrintEntry

Create print entry. X-Okapi-Permissions must include batch-print.entries.item.post

header Parameters

X-Okapi-Permissions required	string A JSON array with client permissions
X-Okapi-Tenant required	string^[_a-z][_a-z0-9]*$ Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL
X-Okapi-User-Id	string Okapi user identifier

Request Body schema: application/json

id required	string <uuid> Identifier
created required	string Creation date time
type required	string Print entry type
sortingField	string Print entry sorting field
content required	string Print entry content

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created": "string",
"type": "string",
"sortingField": "string",
"content": "string"
}

Response samples

400
403

Content type

text/plain

No sample

getPrintEntry

Get print entry by id. X-Okapi-Permissions must include batch-print.entries.item.get

path Parameters

id

required

string <uuid>

Print entry identifier

header Parameters

X-Okapi-Permissions required	string A JSON array with client permissions
X-Okapi-Tenant required	string^[_a-z][_a-z0-9]*$ Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL
X-Okapi-User-Id	string Okapi user identifier

Responses

Response samples

200
400
403
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created": "string",
"type": "string",
"sortingField": "string",
"content": "string"
}

deletePrintEntry

Delete print entry. X-Okapi-Permissions must include batch-print.entries.item.delete

path Parameters

id

required

string <uuid>

Print entry identifier

header Parameters

X-Okapi-Permissions required	string A JSON array with client permissions
X-Okapi-Tenant required	string^[_a-z][_a-z0-9]*$ Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL
X-Okapi-User-Id	string Okapi user identifier

Responses

Response samples

400
404

Content type

text/plain

No sample

updatePrintEntry

Update print entry. X-Okapi-Permissions must include batch-print.entries.item.put

path Parameters

id

required

string <uuid>

Print entry identifier

header Parameters

X-Okapi-Permissions required	string A JSON array with client permissions
X-Okapi-Tenant required	string^[_a-z][_a-z0-9]*$ Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL
X-Okapi-User-Id	string Okapi user identifier

Request Body schema: application/json

id required	string <uuid> Identifier
created required	string Creation date time
type required	string Print entry type
sortingField	string Print entry sorting field
content required	string Print entry content

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created": "string",
"type": "string",
"sortingField": "string",
"content": "string"
}

Response samples

400
404

Content type

text/plain

No sample

saveMail

Send mail to create print entry. X-Okapi-Permissions must include batch-print.entries.mail.post

header Parameters

X-Okapi-Permissions required	string A JSON array with client permissions
X-Okapi-Tenant required	string^[_a-z][_a-z0-9]*$ Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL
X-Okapi-User-Id	string Okapi user identifier

Request Body schema: application/json

notificationId	string notification ID
from	string sender's address
to	string receiver's address
outputFormat	string format type: `text/html` or `text/plain`
body required	string text of email
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"notificationId": "string",
"from": "string",
"to": "string",
"outputFormat": "string",
"body": "string"
}

Response samples

200
400
403

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

createBatch

Send mail to create print entry. X-Okapi-Permissions must include batch-print.print.write

header Parameters

X-Okapi-Tenant required	string^[_a-z][_a-z0-9]*$ Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL
X-Okapi-User-Id	string Okapi user identifier

Responses

Response samples

400
403

Content type

text/plain

No sample