{ "$schema": "http://json-schema.org/draft-04/schema#", "id": "https://tt.se/spec/ttninjs/ttninjs-schema_1.0.json#", "type": "object", "title": "TT variant of IPTC ninjs - News in JSON - version 1.0", "description": "A TT news item as JSON object -- Derived from https://www.iptc.org/std/ninjs/ninjs-schema_1.0.json -- (c) Copyright 2015 TT - TT Nyhetsbyrån - tt.se - This document is published under the Creative Commons Attribution 3.0 license, see http://creativecommons.org/licenses/by/3.0/", "additionalProperties": false, "required": ["uri"], "properties": { "uri": { "description": "The identifier for this news object", "type": "string", "format": "uri" }, "type": { "description": "The generic news type of this news object. $$TT: TT added 'component' for items with, for example, embed codes for toolbox deliveries. TT also added event for items with data describing a coming event.", "type": "string", "enum": [ "text", "audio", "video", "picture", "graphic", "composite", "planning", "component", "event" ] }, "mimetype": { "description": "A MIME type which applies to this news object", "type": "string" }, "representationtype": { "description": "Indicates how complete this representation of a news item is. $$TT: associated is a TT-extension used when the news item appears as an association considered as a link without renditions.", "type": "string", "enum": [ "complete", "incomplete", "associated" ] }, "profile": { "description": "An identifier for the kind of content of this news object. $$TT: Possible values are PUBL, DATA, INFO or RAW. PUBL is a news item that can be published. DATA is data such as tables and figures (that are not meant to be edited). INFO is for information purposes only (not to be published). RAW is raw data, such as unedited videos, that is meant to be further edited before publishing.", "type": "string", "enum": [ "PUBL", "DATA", "INFO", "RAW" ] }, "version": { "description": "The version of the news object which is identified by the uri property", "type": "string" }, "versioncreated": { "description": "The date and time when this version of the news object was created", "type": "string", "format": "date-time" }, "versionstored": { "description": "$$TT: The date and time when this version of the news object was persisted. For a photo, versioncreated is when photo was taken, versionstored is when we indexed it to the database.", "type": "string", "format": "date-time" }, "embargoed": { "description": "The date and time before which all versions of the news object are embargoed. If absent, this object is not embargoed.", "type": "string", "format": "date-time" }, "date": { "description": "$$TT Used for items that concern a specific date such as planning posts. Notice that this holds date only, no time. See also datetime.", "type": "string", "format": "date" }, "datetime": { "description": "$$TT For items that concern a specific date and time. See also date.", "type": "string", "format": "date-time" }, "enddate": { "description": "$$TT Used for items that concern a specific date such as planning posts and has a specific enddate. Notice that this holds date only, no time. See also enddatetime.", "type": "string", "format": "date" }, "enddatetime": { "description": "$$TT For items that concern a specific enddate and time. See also enddate.", "type": "string", "format": "date-time" }, "embargoedreason": { "description": "$$TT: Textual description of why article is embargoed.", "type": "string" }, "job": { "description": "$$TT: Identifier of a grouping job this item belongs to. Typically the id of the job the article belong to, normally something like 327890.", "type": "string" }, "pubstatus": { "description": "The publishing status of the news object, its value is *usable* by default. $$TT: replaced and comissioned added by TT.", "type": "string", "enum": [ "usable", "withheld", "canceled", "replaced", "commissioned" ] }, "copyrightholder": { "description": "The person or organisation claiming the intellectual property for the content.", "type": "string" }, "copyrightnotice": { "description": "Any necessary copyright notice for claiming the intellectual property for the content.", "type": "string" }, "language": { "description": "The human language used by the content. The value should follow IETF BCP47", "type": "string" }, "week": { "description": "$$TT: The number of the week the item is planned to be published. Mainly used for feature-articles and ready pages.", "type": "number" }, "urgency": { "description": "The editorial urgency of the content from 1 to 9. 1 represents the highest urgency, 9 the lowest. $$TT: 1 is most urgent. 4 is normal. Definition here http://tt.se/spec/prio/1.0", "type": "number" }, "webprio": { "description": "$TT: TT managed editorial sort order. Priority numbers range from 1 (most important) to 3 (least). A 0 indicates that the item needs manual attention before publishning. Definitions and sort logic are defined here http://tt.se/spec/webprio/1.0", "type": "number" }, "source": { "description": "$$TT: String identifier for originating source of document.", "type": "string" }, "commissioncode": { "description": "$$TT: String identifier for who receives commission for this object.", "type": "string" }, "description_text": { "description": "$$TT: Textual description of the item as text.", "type": "string" }, "description_usage": { "description": "$$TT: TT editorial information. Can be anything from planned re-relases of object to restrictions.", "type": "string" }, "usageterms": { "description": "A natural-language statement about the usage terms pertaining to the content. $$TT: Specifically contains image usage restrictions from TT's suppliers.", "type": "string" }, "body_text": { "description": "$$TT: The textual content of the news object as untagged text. Only present if type is PUBL or DATA.", "type": "string" }, "body_html5": { "description": "$$TT: The textual content of the news object as HTML5. Only present if type is PUBL or DATA.", "type": "string" }, "body_event": { "description": "$$TT: Object with properties containing data from the event database.", "type": "object", "additionalProperties": false, "properties": { "arena": { "description": "$$TT: Name of the arena where the event will take place.", "type": "string" }, "city": { "description": "$$TT: Name of the city where the event will take place.", "type": "string" }, "address": { "description": "$$TT: Address to the place where the event will take place.", "type": "string" }, "country": { "description": "$$TT: Three letter code for the country where the event will take place.", "type": "string" }, "eventurl": { "description": "$$TT: URL to a web site with information about the event.", "type": "string" }, "eventphone": { "description": "$$TT: Phone number to call for more information about the event.", "type": "string" }, "eventweb": { "description": "$$TT: Details on following the event online", "type": "string" }, "organizer": { "description": "$$TT: Name of the organizer of the event", "type": "string" }, "organizerurl": { "description": "$$TT: URL to a web page for the organizer", "type": "string" }, "organizerphone": { "description": "$$TT: Phone number to the organizer of the event.", "type": "string" }, "organizermail": { "description": "$$TT: Mail address to the organizer of the event.", "type": "string" }, "eventstatus": { "description": "$$TT: Status code for the event.", "type": "string" }, "eventstatus_text": { "description": "$$TT: Status for the event as a phrase.", "type": "string" }, "region": { "description": "$$TT: For events in Sweden, the code of the region.", "type": "string" }, "region_text": { "description": "$$TT: For events in Sweden, the name of the region.", "type": "string" }, "municipality": { "description": "$$TT: For events in Sweden, the code of the municipality.", "type": "string" }, "municipality_text": { "description": "$$TT: For events in Sweden the name of the municipality.", "type": "string" }, "eventtags": { "description": "$$TT: Tags of the event.", "type": "string" }, "eventtype": { "description": "$$TT: Code for type of event.", "type": "string" }, "eventtype_text": { "description": "$$TT: Type of event as text.", "type": "string" }, "note_extra": { "description": "$$TT: Extra information about the event.", "type": "string" }, "note_pm": { "description": "$$TT: Text intended to be used by TT on planning lists of upcoming events.", "type": "string" }, "accreditation": { "description": "$$TT: Information about how to get accreditation to the event.", "type": "string" }, "extraurl": { "description": "$$TT: If there are more information concerning the event.", "type": "string" }, "createddate": { "description": "$$TT: When the item was created in the TT event database.", "type": "string", "format": "date-time" }, "createdby": { "description": "$$TT: Initials of the person creating the item in the TT event database.", "type": "string" }, "changeddate": { "description": "$$TT: When the item was last updated in the TT event database.", "type": "string", "format": "date-time" }, "changedby": { "description": "$$TT: Initials of the person doing the last update to the item.", "type": "string" }, "courtcasenumber": { "description": "$$TT: If the event is a trial this property hold the casenumber.", "type": "string" } } }, "body_sportsml": { "description": "$$TT: When the news object is some form of sportsresults, table etc the data is delivered as sportsml. Only present if type is PUBL or DATA.", "type": "string" }, "body_pages": { "description": "$$TT: One or more objects describing the pages in this delivery.", "type": "object", "additionalProperties": false, "patternProperties": { "^[a-zA-Z0-9]+": { "description": "$$TT: Description of one of the pages in this delivery.", "type": "object", "additionalProperties": false, "properties": { "innermargin": { "description": "$$TT: Inner margin for this page. In the unit named in unit.", "type": "number" }, "bottommargin": { "description": "$$TT: Bottom margin for this page. In the unit named in unit.", "type": "number" }, "pagina": { "description": "$$TT: The pagenumber, but not nescessary a number. Can be a letter too.", "type": "string" }, "outermargin": { "description": "$$TT: Outer margin for this page. In the unit named in unit.", "type": "number" }, "unit": { "description": "$$TT: Unit in which the margins are given. Normally MM för millimeter.", "type": "string" }, "topmargin": { "description": "$$TT: Top margin for this page. In the unit named in unit.", "type": "number" }, "leftmargin": { "description": "$$TT: Left margin for this page. In the unit named in unit.", "type": "number" }, "rightmargin": { "description": "$$TT: Right margin for this page. In the unit named in unit.", "type": "number" } } } } }, "commissionedby": { "description": "$$TT: When pubstatus is 'commissioned', this field tells who commissioned it.", "type": "array", "items": {"type": "string"} }, "charcount": { "description": "$$TT: The total character count in the article excluding figure captions.", "type": "number" }, "originaltransmissionreference": { "description": "$$TT: Identifier in the originating system/source.", "type": "string" }, "signals": { "description": "$$TT: signals is suggested by AP but not yet included in ninjs. When included it will probably hold a large number of properties.", "type": "object", "additionalProperties": false, "properties": { "pageproduct": { "description": "$$TT: What type of page product. An abbreviation like IURDAG.", "type": "string" }, "multipagecount": { "description": "$$TT: Number of pages in this delivery.", "type": "number" }, "paginae": { "description": "$$TT: Array of pagenumbers for the pages in this delivery. (A pagenumber can also be a letter.)", "type": "array", "items": {"type": "string"} }, "pagecode": { "description": "$$TT: Code for this page product", "type": "string" }, "pagevariant": { "description": "$$TT: Variant of this page product", "type": "string" } } }, "product": { "description": "$$TT: TT Product classification codes. See http://tt.se/spec/product/1.0", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The name of the product code. \"Feature Fritid\", \"Nyheter Nöje\", etc", "type": "string" }, "scheme": { "description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the product. http://tt.se/spec/product/1.0", "type": "string", "format": "uri" }, "code": { "description": "The code for the subject in a scheme (= controlled vocabulary) which is identified by the scheme property. \"FTFRI\", \"TTNJE\"", "type": "string" } } } }, "person": { "description": "An individual human being", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The name of a person", "type": "string" }, "rel": { "description": "The relationship of the content of the news object to the person", "type": "string" }, "scheme": { "description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the person", "type": "string", "format": "uri" }, "code": { "description": "The code for the person in a scheme (= controlled vocabulary) which is identified by the scheme property. $$TT: http://tt.se/spec/person/1.0", "type": "string" } } } }, "organisation": { "description": "An administrative and functional structure which may act as as a business, as a political party or not-for-profit party", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The name of the organisation", "type": "string" }, "rel": { "description": "The relationship of the content of the news object to the organisation", "type": "string" }, "scheme": { "description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the organisation", "type": "string", "format": "uri" }, "code": { "description": "The code for the organisation in a scheme (= controlled vocabulary) which is identified by the scheme property", "type": "string" }, "symbols": { "description": "Symbols used for a finanical instrument linked to the organisation at a specific market place", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "ticker": { "description": "Ticker symbol used for the financial instrument", "type": "string" }, "exchange": { "description": "Identifier for the marketplace which uses the ticker symbols of the ticker property", "type": "string" } } } } } } }, "place": { "description": "A named location", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The name of the place", "type": "string" }, "rel": { "description": "The relationship of the content of the news object to the place", "type": "string" }, "scheme": { "description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the place. $$TT: http://tt.se/spec/place/1.0", "type": "string", "format": "uri" }, "code": { "description": "The code for the place in a scheme (= controlled vocabulary) which is identified by the scheme property", "type": "string" }, "geometry_geojson": { "descripion": "$$TT: An optional GeoJSON description of the place.", "type": "object" } } } }, "subject": { "description": "A concept with a relationship to the content. $$TT: Used for content classification in swedish equivalent of IPTC Subject Reference see http://tt.se/spec/subref/1.0", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The name of the subject", "type": "string" }, "rel": { "description": "The relationship of the content of the news object to the subject", "type": "string" }, "scheme": { "description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the subject. $$TT: http://tt.se/spec/subref/1.0 http://tt.se/spec/keyword/1.0 ", "type": "string", "format": "uri" }, "code": { "description": "The code for the subject in a scheme (= controlled vocabulary) which is identified by the scheme property", "type": "string" } } } }, "event": { "description": "Something which happens in a planned or unplanned manner", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The name of the event", "type": "string" }, "rel": { "description": "The relationship of the content of the news object to the event", "type": "string" }, "scheme": { "description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the event", "type": "string", "format": "uri" }, "code": { "description": "The code for the event in a scheme (= controlled vocabulary) which is identified by the scheme property", "type": "string" } } } }, "object": { "description": "Something material, excluding persons", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The name of the object", "type": "string" }, "rel": { "description": "The relationship of the content of the news object to the object", "type": "string" }, "scheme": { "description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the object", "type": "string", "format": "uri" }, "code": { "description": "The code for the object in a scheme (= controlled vocabulary) which is identified by the scheme property", "type": "string" } } } }, "byline": { "description": "The name(s) of the creator(s) of the content", "type": "string" }, "bylines": { "description": "Holder of one or more byline objects.", "type": "array", "items": { "type": "object", "properties": { "byline": { "type": "string", "description": "When the complete byline is sent as one string. Same as byline on root level. Example: Albert Jonsson/SvD/TT" }, "firstname": { "type": "string", "description": "When byline is divided, holds the first name of the person. Example: Albert" }, "lastname": { "type": "string", "description": "When byline is divided, holds the last name of the person. Example: Jonsson" }, "role": { "type": "string", "description": "Role of the person in the byline in relation to this ttninjs item, as string. Example: Photographer" }, "email": { "type": "string", "description": "Email address of the person in this byline. albert.jonsson@acme.com" }, "jobtitle": { "type": "string", "description": "Jobtitle can differ from role and is normally more connected to the person and not to the combination person-newsItem. Example: Editor in Chief" }, "internal": { "type": "string", "description": "Whether byline is for internal purposes. Example: true. If not present it means false." }, "phone": { "type": "string", "description": "Phone number of the person in this byline. Example: +46555123456" }, "initials": { "type": "string", "description": "Initials of byline. Mainly used for records marked as internal. Example: mag" }, "affiliation": { "type": "string", "description": "The affiliation of the person. Example: SvD/TT" } } } }, "headline": { "description": "A brief and snappy introduction to the content, designed to catch the reader's attention", "type": "string" }, "slug": { "description": "$$TT: Short name given to article while in production.", "type": "string" }, "located": { "description": "The name of the location from which the content originates.", "type": "string" }, "renditions": { "description": "Wrapper for different renditions of non-textual content of the news object", "type": "object", "additionalProperties": false, "patternProperties": { "^[a-zA-Z0-9]+": { "description": "A specific rendition of a non-textual content of the news object.", "type": "object", "additionalProperties": false, "properties": { "href": { "description": "The URL for accessing the rendition as a resource", "type": "string", "format": "uri" }, "mimetype": { "description": "A MIME type which applies to the rendition", "type": "string" }, "title": { "description": "A title for the link to the rendition resource", "type": "string" }, "height": { "description": "For still and moving images: the height of the display area measured in $$TT: unit and defaults to pixels", "type": "number" }, "width": { "description": "For still and moving images: the width of the display area measured in $$TT: unit and defaults to pixels", "type": "number" }, "sizeinbytes": { "description": "The size of the rendition resource in bytes", "type": "number" }, "usage": { "description": "$$TT: One of 'Thumbnail', 'Preview', 'Hires' or 'Hidef'", "type": "string" }, "variant": { "description": "$$TT: One of 'Normal', 'Watermark', 'BlackAndWhite', 'Cropped' or 'Framegrab'", "type": "string" }, "unit": { "description": "$$TT: The unit for width/height. Either px or mm", "type": "string" }, "bitrate": { "description": "$$TT: Video bitrate (if video)", "type": "string" }, "duration": { "description": "$$TT: Video clip curation in seconds.", "type": "number" }, "format": { "description": "$$TT: Suggested by AP, so probably in the official ninjs schema at the next update.", "type": "string" }, "printsize": { "description": "Calculated size of a 300 dpi upsampled image", "type": "number" } } } } }, "replacing": { "description": "$$TT: Array of identifiers of news objects this object is replacing.", "type": "array", "items": { "type": "string", "format": "uri" } }, "replacedby" : { "description" : "$$TT: The identifier of the news object this one is replaced by.", "type" : "string", "format" : "uri" }, "associations" : { "description" : "Content of news objects which are associated with this news object.", "type" : "object", "additionalProperties" : false, "patternProperties" : { "^[a-zA-Z0-9]+" : { "$ref": "#" } } }, "revisions": { "description": "$$TT: Array of previous versions of this news object. See http://spec.tt.se/revisions.html", "type": "array", "items": { "type": "object", "additionalProperties": true, "required": ["uri"], "properties": { "uri": { "description": "$$TT: The identifier of the previous revision.", "type": "string", "format": "uri" }, "slug": { "description": "$$TT: Short name given to article while in production.", "type": "string" }, "replacing": { "description": "$$TT: Array of identifiers this revision is replacing.", "type": "array", "items": { "type": "string", "format": "uri" } } } } }, "sector": { "description": "$$TT: Designator for the 'big 5' ways of grouping content (inrikes, utrikes, etc) and PRM for press releases. Not mandatory, often omitted.", "type": "string", "enum": [ "INR", "UTR", "EKO", "KLT", "SPT", "PRM" ] } } }