Skip to main content

StationPiece

One instalment, and what the station has done with it

Attributes (21)
AttributeTypeRequiredDescription
idstringYesThe station's own id for this piece
seriesIdstringYesQualified, matching StationSeries.id
pieceIdstringYesThe plugin's own id for the piece, stable across refreshes
seriesTitlestringYes
titlestringYes
order'serial' | 'latest'YesHow its series is worked through, copied onto the piece by every refresh
authorstringNo
summarystringNoWhat it is about, as plain text
urlstringNoThe piece's page, for a person
artworkUrlstringNo
ordinalnumberNoWhere it comes in a serial, from 0. Absent for a latest series
publishedAtstringNoISO-8601
wordCountnumberNoRoughly how many words it runs to, as the plugin counted them
seenAtstringYesISO-8601: when a refresh last saw it listed
withdrawnAtstringNoISO-8601: when a refresh found its plugin no longer listing it. The station never picks a withdrawn piece; the row is kept so what was done with it is not lost
renderedbooleanYesWhether the station has the spoken audio, ready to air
renderingbooleanYesWhether the words are being spoken right now
renderRequestedAtstringNoISO-8601: when the station last asked for it to be spoken
renderErrorstringNoWhy the last attempt to speak it failed, when it did
scheduledForstringNoISO-8601: the slot it was made for
airedAtstringNoISO-8601: when a listener could first have heard it. A piece airs once, and for a serial this is also the station's place in the book