On this page

TextAPI

Migration Guide to TextAPI 2.0.0

Changes per TextAPI Object

TextAPI Collection Object

• title --> titles. The title is now an array of string instead of an object. The main title is the first string in the array. [required]
• collector --> collectors [required]
• textapiType: new key (string) [required] must be TextApiCollection here
• revision: new key (string) [required]
• editors: new key (array of Actor Objects)
• funders: new key (array of Actor Objects)
• collections: new key (array of IRIs or embedded object) [required, but mutually exclusive with manifests]
• manifests: new key (array of IRIs or embedded object) [required, but mutually exclusive with collections]
• via: new key (string)
• prevRevision: new key (IRI)
• sequence: removed in favour of collections and manifests
• modules: removed
• total is now [required]
• textapi --> textapiVersion

---

TextAPI Manifest Object

• copyright: new key (string) [required]
• sequence --> items (array of IRIs or embedded object) [required]
• license: string instead of object [required]
• revision: new key (string) [required]
• actor --> agents
• support --> assets
• partOf: new key (array of string)
• prevRevision: new key (IRI)
• origin: new key (string)
• identifier: new key (string)
• textClasses: new key (array of string)
• via: new key (string)
• textapiType: new key (string) [required] must be TextApiManifest here
• metadata: metadata sub-key has been removed; value is now required and can hold either a string or an array of metadata objects
• textapi --> textapiVersion (now [optional])
• @context is now [optional]

---

TextAPI Item Object

• textapiType --> new key (string) [required]
• lang --> languages (new: array of string instead of string) [required]
• content --> contents [required]
• revision: new key (string) [required]
• prevRevision: new key (IRI)
• title --> titles. The title is now an array of string instead of an object. The main title is the first string in the array.
• n --> division
• image --> images (new: array of Image Objects instead of single Image Object)
• via: new key (string)
• modules: removed
• textapi --> textapiVersion (now [optional])
• @context is now [optional]
• textapiType: new key (string)

---

TextAPI Actor Object (renamed to Agents Object)

• role --> roles [required]
• idref --> sameAs. sameAs is either null or an array of strings instead of an object.
• textapiType: new key (string)

---

TextAPI Image Object

• license: string instead of object
• type: new key (string)
• copyright: new key (string)
• mimetype: new key, either a string (likely starting with image/ or application/ld+json;profile="http://iiif.io/api/presentation/3/context.json" for pointing to a IIIF manifest or application/ld+json;profile="http://iiif.io/api/image/3/context.json" for pointing to an IIIF Image API resource)
• manifest: new key (string)

---

TextAPI Repository Object

• externalId: new key (IRI) [required]
• url --> id [required]
• country: new key (string)
• place: new key (string)
• textapiType: new key (string)
• baseURL: deleted

---

TextAPI Assets Object (formerly: Support Object)

• type was font or css now replaced by a MIME type in contentType (string)
• url --> id

---

Other

Restrictions for ID of Collection, Manifest, and Item

IDs of collections, manifests, and items within the end point structure must not contain one of the following characters:

• ?
• #
• /
• =
• ;
• :
• @
• &
• +
• ,
• $

---

Changes in End Point Structure

Collections

Version	URL Schema
TextAPI 1.4.0	https://{server}{/prefix}/{collection}/collection.json
TextAPI 2.0.0	https://{server}{/prefix}/collections/{collection}

Manifests

Version	URL Schema
TextAPI 1.4.0	https://{server}{/prefix}{/collection?}/{manifest}/manifest.json
TextAPI 2.0.0	https://{server}{/prefix}/manifests/{manifest}

Items

All items are served at https://{server}{/prefix}/items/{item}, regardless of the item being the full content or not.