Description
Serialize repository, series and volumeToken as a JSON-array source key, and flag volume presence by trimmed nonempty text.
Historical and public-register references combine repositories, series, titles and local identifiers. A syntactic token or hierarchy count helps organize records without authenticating the source or establishing a document's historical or legal meaning.
Serialize repository, series and volumeToken as a JSON-array source key, and flag volume presence by trimmed nonempty text.
When to use this tool
Use Public Register Volume Token when you need a literal archival or public-register record operation.
How to use the tool and how it works
- Enter volumeToken, series, repository. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read sourceKey, hasVolume. Inspect hasVolume before interpreting the associated values.
Serialize repository, series and volumeToken as a JSON-array source key, and flag volume presence by trimmed nonempty text.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| volumeToken | Volume Token | Required. Text; maximum UTF-16 length 8192. |
| series | Series | Required. Text; maximum UTF-16 length 8192. |
| repository | Repository | Required. Text; maximum UTF-16 length 8192. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| sourceKey | JSON-array serialization of the stated supplied reference components. | Required. Text; maximum UTF-16 length 8192. |
| hasVolume | Has Volume | Required. Boolean. |
{
"input": {
"volumeToken": "IV",
"series": "births",
"repository": "archive-A"
},
"output": {
"sourceKey": "[\"archive-A\",\"births\",\"IV\"]",
"hasVolume": true
}
}Limitations and assumptions
- The original volume spelling, including whitespace, stays in the key. No repository source, catalog entry, access rights or historical identity is verified.
- Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
Alternative or Complementary methods
Consult the source repository's catalog and description conventions for identity and interpretation. Preserve original references and resolve language, hierarchy and identifier rules before treating a token match as an authenticated record.
References
Similar or alternative tools
- Public Register Series Depth
Count collectionParts and seriesParts and add one to combinedDepth only when includeCollectionRoot.
- Public Register Folio Token
Accept exactly one matching suffix whose preceding tail is a positive integer without leading zero, and return folio number and side token.