# title
IPTC ninjs - News in JSON - version 3.0.1

# description
A news item as JSON object -- copyright 2024 IPTC - International Press Telecommunications Council - www.iptc.org - This document is published under the Creative Commons Attribution 4.0 license, see  http://creativecommons.org/licenses/by/4.0/

# $defs.commissionedType.properties.by.description
The person or party that commissioned the content.

# $defs.commissionedType.properties.on.description
The date at which the content was commissioned.

# $defs.commissionedType.properties.references.description
Identifiers that help with the commissioning process such as purchase orders and work order numbers.

# $defs.contactInfoType.properties.type.description
Type would be method of communication like phone, mobile, address etc.

# $defs.contactInfoType.properties.address.description
The address of a person, place or organisation.

# $defs.contactInfoType.properties.address.properties.area.description
A subdivision of a country part of the address.

# $defs.contactInfoType.properties.address.properties.lines.description
An array of lines to construct an address. The order is important to construct a correct address.

# $defs.contactInfoType.properties.address.properties.locality.description
A city/town/village etc. part of the address.

# $defs.contactInfoType.properties.lang.description
Language of this contactInfo instance. The value should follow IETF BCP47.

# $defs.contactInfoType.properties.name.description
Human-readable name of the contact method, such as a name for a web page, name of persons twitter account etc

# $defs.contactInfoType.properties.role.description
Role refers to type and could be private, office etc

# $defs.contactInfoType.properties.value.description
Actual phone number, email address, web url etc.

# $defs.datesObjectType.description
All dates pertaining to an event, a planning or a coverage, in particular the start and end date and any recurrence information

# $defs.datesObjectType.properties.endDate.description
The date and time at which the event ends.

# $defs.datesObjectType.properties.expectedDuration.description
The time period that the event or coverage is expected to last. Must use the iCalendar duration format (RFC 5545). (Actual duration can be calculated from startDate and endDate)

# $defs.datesObjectType.properties.expectedEndDate.description
The approximate date (and optionally time) at which the event or coverage is expected to end.

# $defs.datesObjectType.properties.expectedStartDate.description
The approximate date (and optionally time) at which the event or coverage is expected to start.

# $defs.datesObjectType.properties.recurrence.description
Specifies recurrence information about the event.

# $defs.datesObjectType.properties.recurrence.properties.recurrenceDates.description
Date(s) (and optionally times) on which the event occurs.

# $defs.datesObjectType.properties.recurrence.properties.recurrenceRules.description
Date(s) (and optionally times) on which the event occurs.

# $defs.datesObjectType.properties.recurrence.properties.recurrenceRules.items.properties.count.description
The COUNT rule part defines the number of occurrences at which to range-bound the recurrence.

# $defs.datesObjectType.properties.recurrence.properties.recurrenceRules.items.properties.frequency.description
The FREQ rule part identifies the type of recurrence rule.

# $defs.datesObjectType.properties.recurrence.properties.recurrenceRules.items.properties.interval.description
The INTERVAL rule part contains a positive integer representing how often the recurrence rule repeats.

# $defs.datesObjectType.properties.recurrence.properties.recurrenceRules.items.properties.until.description
The UNTIL rule part defines a date-time value which bounds the recurrence rule in an inclusive manner.

# $defs.datesObjectType.properties.startDate.description
The date and time at which the event starts.

# $defs.newsObjectType.description
The generic news type of this news object. Based on http://cv.iptc.org/newscodes/ninature/

# $defs.ninjsType.description
The root schema of ninjs as a type to make it possible to combine schema parts.

# $defs.ninjsType.properties.title.description
A short natural-language name for the item. Title is metadata, use headlines for publishable headlines.

# $defs.ninjsType.properties.altIds.description
Alternative identifiers assigned to the content. Each alternative id can have a role and a value.

# $defs.ninjsType.properties.associations.description
An array of objects with content of news objects which are associated with this news object.

# $defs.ninjsType.properties.associations.items.description
Each associated object can use all properties in ninjs.

# $defs.ninjsType.properties.associations.items.properties.name.description
Human-readable name of the associated object.

# $defs.ninjsType.properties.associations.items.properties.rel.description
The relationship between this document and the associated document.

# $defs.ninjsType.properties.bodies.description
An array of body objects with the content as text or with markup. For a simple body use an array with one object only containing the value property. If role and contentType are undefined, their interpretation is up to the provider.

# $defs.ninjsType.properties.bodies.items.properties.charCount.description
The total character count in this body excluding figure captions.

# $defs.ninjsType.properties.bodies.items.properties.contentType.description
The IANA (Internet Assigned Numbers Authority) media type of the content of this body. Previously known as MIME Type.

# $defs.ninjsType.properties.bodies.items.properties.value.description
The body text identified with the above role and contentType.

# $defs.ninjsType.properties.bodies.items.properties.wordCount.description
The total number of words in this body excluding figure captions.

# $defs.ninjsType.properties.by.description
A natural-language statement about the creator (author, photographer etc.) of the content.

# $defs.ninjsType.properties.contentCreated.description
The date and time when the content of this ninjs object was originally created. For example an old photo that is now handled as a ninjs object.

# $defs.ninjsType.properties.copyrightHolder.description
The person or organisation claiming the intellectual property for the content.

# $defs.ninjsType.properties.copyrightNotice.description
Any necessary copyright notice for claiming the intellectual property for the content.

# $defs.ninjsType.properties.descriptions.description
An array of one or more descriptions of the ninjs object. See also edNote for information from provider to reciever. Descriptions are seen as metadata. For a simple description use an array with one object only containing the value property. Role and contentType are then undefined and their interpretation is up to the provider.

# $defs.ninjsType.properties.descriptions.items.properties.contentType.description
The IANA (Internet Assigned Numbers Authority) media type of the content of this description. Previously known as MIME Type.

# $defs.ninjsType.properties.descriptions.items.properties.value.description
The descriptive text identified with the above role and/or contentType.

# $defs.ninjsType.properties.edNote.description
A note that is intended to be read by internal staff at the receiving organisation, but not intended to be published. Consider using this before using the descriptions array.

# $defs.ninjsType.properties.embargoedUntil.description
The date and time before which all versions of the news object are embargoed. If absent, this object is not embargoed.

# $defs.ninjsType.properties.eventDetails.description
A container for properties related to a planned event.

# $defs.ninjsType.properties.eventDetails.properties.eventStatus.description
Status of the event (as opposed to the status of coverage of the event). Suggested CV: http://cv.iptc.org/newscodes/eventstatus/

# $defs.ninjsType.properties.eventDetails.properties.organiser.description
A person or organisation organising the event.

# $defs.ninjsType.properties.eventDetails.properties.plannedCoverageStatus.description
Status of the coverage (as opposed to the status of the event itself). Suggested CV: http://cv.iptc.org/newscodes/newscoveragestatus/

# $defs.ninjsType.properties.events.description
An array of objects describing something which happens in a planned or unplanned manner.

# $defs.ninjsType.properties.events.items.properties.literal.description
An identifier for the event as a free-text string.

# $defs.ninjsType.properties.events.items.properties.rel.description
The relationship of the content of the news object to the event.

# $defs.ninjsType.properties.events.items.properties.uri.description
The identifier for the event as a complete uri.

# $defs.ninjsType.properties.expires.description
The date and time after which the Item is no longer considered editorially relevant by its provider.

# $defs.ninjsType.properties.firstCreated.description
Indicates when the first version of this ninjs object was created.

# $defs.ninjsType.properties.genres.description
Indicates a nature, journalistic or intellectual characteristic of the news item.

# $defs.ninjsType.properties.genres.items.properties.literal.description
An identifier for the genre as a free-text string.

# $defs.ninjsType.properties.genres.items.properties.uri.description
The identifier of the genre as a complete URI. Suggested CV: http://cv.iptc.org/newscodes/genre

# $defs.ninjsType.properties.headlines.description
An array of objects containing various types of headlines. For a simple headline use an array with one object only containing the value property. Role and contentType are then undefined and it is up to the provider.

# $defs.ninjsType.properties.headlines.items.properties.contentType.description
The IANA (Internet Assigned Numbers Authority) media type of the content of this headline. Previously known as MIME Type.

# $defs.ninjsType.properties.headlines.items.properties.value.description
The headline identified with the above role and/or contentType.

# $defs.ninjsType.properties.infoSources.description
An array of parties (person or organisation) which originated, modified, enhanced, distributed, aggregated or supplied the content or provided some information used to create or enhance the content.

# $defs.ninjsType.properties.infoSources.items.properties.literal.description
An identifier for the infoSource as a free-text string.

# $defs.ninjsType.properties.infoSources.items.properties.role.description
The role the infoSource in relationship to the content.

# $defs.ninjsType.properties.infoSources.items.properties.uri.description
The identifier of the infosource as a complete uri.

# $defs.ninjsType.properties.language.description
The human language used by the content. The value should follow IETF BCP47.

# $defs.ninjsType.properties.located.description
The name of the location from which the content originates.

# $defs.ninjsType.properties.objects.description
An array of objects describing something material, excluding persons.

# $defs.ninjsType.properties.objects.items.properties.literal.description
An identifier for the object as a free-text string.

# $defs.ninjsType.properties.objects.items.properties.rel.description
The relationship of the content of the news object to the object.

# $defs.ninjsType.properties.objects.items.properties.uri.description
The identifier for the object as a complete uri.

# $defs.ninjsType.properties.organisations.description
An array of objects describing administrative and functional structures which may, for example, act as a business, as a political party or not-for-profit entity.

# $defs.ninjsType.properties.people.description
An array of objects describing individual human beings.

# $defs.ninjsType.properties.people.items.properties.literal.description
An identifier for the person as a free-text string.

# $defs.ninjsType.properties.people.items.properties.rel.description
The relationship of the content of the news object to the person

# $defs.ninjsType.properties.people.items.properties.uri.description
The identifier for the person as a complete uri with the code.

# $defs.ninjsType.properties.places.items.properties.literal.description
An identifier for the place as a free-text string.

# $defs.ninjsType.properties.places.items.properties.rel.description
The relationship of the content of the news object to the place

# $defs.ninjsType.properties.places.items.properties.uri.description
The identifier for the place as a complete uri

# $defs.ninjsType.properties.plannedCoverage.description
An array of objects specifying planned coverage which may or may not be related to an event.

# $defs.ninjsType.properties.plannedCoverage.items.properties.title.description
A human-readable title for the planned content.

# $defs.ninjsType.properties.plannedCoverage.items.properties.type.description
The generic news type of the planned content. Based on: http://cv.iptc.org/newscodes/ninature/ nar:itemClass

# $defs.ninjsType.properties.plannedCoverage.items.properties.audiences.description
Intended audiences for the planned content.

# $defs.ninjsType.properties.plannedCoverage.items.properties.audiences.items.properties.significance.description
A qualifier which indicates the expected significance of the content for this specific audience.

# $defs.ninjsType.properties.plannedCoverage.items.properties.commissioned.description
Information about the commissioning of this content.

# $defs.ninjsType.properties.plannedCoverage.items.properties.dates.description
Dates and times for this planned content.

# $defs.ninjsType.properties.plannedCoverage.items.properties.edNote.description
Additional natural language information about the planned content addressed to the editorial people receiving and processing the item.

# $defs.ninjsType.properties.plannedCoverage.items.properties.exclAudience.description
Excluded audience(s) for the planned content.

# $defs.ninjsType.properties.plannedCoverage.items.properties.itemCount.description
Number of planned items of this kind expressed by a range.

# $defs.ninjsType.properties.plannedCoverage.items.properties.language.description
The human language used by the planned content. The value should follow IETF BCP47.

# $defs.ninjsType.properties.plannedCoverage.items.properties.pubStatus.description
The publishing status of the plannedCoverage object. Default value is 'usable'.

# $defs.ninjsType.properties.plannedCoverage.items.properties.renditions.description
An array of objects showing the planned renditions of the news object.

# $defs.ninjsType.properties.plannedCoverage.items.properties.urgency.description
The editorial urgency of the planned content, as scoped by the parent element.

# $defs.ninjsType.properties.plannedCoverage.items.properties.uri.description
The local identifier of the element which MUST be persistent for all versions of the item, i.e. for its entire lifecycle.

# $defs.ninjsType.properties.profile.description
An identifier for the structure of the news object. This can be any string but we suggest something identifying the structure of the content such as 'text-only' or 'text-photo'. Profiles are typically provider-specific.

# $defs.ninjsType.properties.pubStatus.description
The publishing status of the news object. Default value is 'usable'.

# $defs.ninjsType.properties.renditions.description
An array of objects with different renditions of the news object.

# $defs.ninjsType.properties.representationType.description
Indicates how complete this representation of a news item is.

# $defs.ninjsType.properties.rightsInfo.description
Expression of rights to be applied to content.

# $defs.ninjsType.properties.rightsInfo.properties.encodedRights.description
Contains a rights expression as defined by a Rights Expression Language.

# $defs.ninjsType.properties.rightsInfo.properties.langId.description
Identifier for the Rights Expression language used.

# $defs.ninjsType.properties.rightsInfo.properties.linkedRights.description
A link from the current Item to Web resource with rights related information.

# $defs.ninjsType.properties.slugline.description
A human-readable identifier for the item.

# $defs.ninjsType.properties.standard.description
An object with information about standard, version and schema this instance is valid against.

# $defs.ninjsType.properties.standard.properties.name.description
The name of the standard to which this instance conforms, for example 'ninjs'.

# $defs.ninjsType.properties.standard.properties.schema.description
The URI of the JSON Schema to use for validating this instance, for example 'http://www.iptc.org/std/ninjs/ninjs-schema_3.0.json#'

# $defs.ninjsType.properties.standard.properties.version.description
The version of the standard to which this instance conforms, for example '3.0'.

# $defs.ninjsType.properties.subjects.description
An array of objects holding concepts with a relationship to the content.

# $defs.ninjsType.properties.subjects.items.properties.confidence.description
The confidence with which the metadata has been assigned.

# $defs.ninjsType.properties.subjects.items.properties.creator.description
Specifies which entity (person, organisation or system) that created or last edited the property.

# $defs.ninjsType.properties.subjects.items.properties.literal.description
An identifier for the subject as a free-text string.

# $defs.ninjsType.properties.subjects.items.properties.rel.description
The relationship of the content of the news object to the subject

# $defs.ninjsType.properties.subjects.items.properties.relevance.description
The relevance of the metadata to the news item.

# $defs.ninjsType.properties.subjects.items.properties.uri.description
The identifier of the subject as a complete uri.

# $defs.ninjsType.properties.trustIndicators.description
An array of objects to allow links to documents about trust indicators.

# $defs.ninjsType.properties.trustIndicators.items.properties.title.description
The title of the resource being referenced.

# $defs.ninjsType.properties.trustIndicators.items.properties.href.description
The URL for accessing the trust indicator resource.

# $defs.ninjsType.properties.trustIndicators.items.properties.role.description
The role of the trust indicator as a complete URI. Suggested CV: http://cv.iptc.org/newscodes/trustindicator

# $defs.ninjsType.properties.urgency.description
The editorial urgency of the content. Values from 1 to 9. 1 represents the highest urgency, 9 the lowest.

# $defs.ninjsType.properties.uri.description
The global unique identifier for this news object. This is the only required property and should be used to identify the ninjs object, not for links to external resources etc.

# $defs.ninjsType.properties.usageTerms.description
A natural-language statement about the usage terms pertaining to the content.

# $defs.ninjsType.properties.version.description
The version of the news object which is identified by the uri property.

# $defs.ninjsType.properties.versionCreated.description
The date and time when this version of this ninjs object was created.

# $defs.organisationType.properties.literal.description
An identifier for the organisation as a free-text string.

# $defs.organisationType.properties.rel.description
The relationship of the content of the news object to the organisation.

# $defs.organisationType.properties.symbols.description
Symbols used for a financial instrument linked to the organisation at a specific market place

# $defs.organisationType.properties.symbols.items.properties.exchange.description
Identifier for the marketplace which uses the ticker symbols of the symbol property

# $defs.organisationType.properties.symbols.items.properties.symbol.description
Symbol identifier, including ticker symbols.

# $defs.organisationType.properties.uri.description
The identifier of the organisation as a complete uri.

# $defs.renditionType.description
A specific rendition of the content of the news object.

# $defs.renditionType.properties.title.description
A title for the link to the rendition resource

# $defs.renditionType.properties.format.description
A refinement of a generic content type (i.e. IANA media type) by a literal string value. Suggested CV: http://cv.iptc.org/newscodes/format/

# $defs.renditionType.properties.aspectRatio.description
Aspect ratio of an image or video file, which is the ratio of the pixel width to its height, such as 16:9 and 4:3.

# $defs.renditionType.properties.bitrate.description
The bitrate of the video. Should always include units, e.g. 400 kbps.

# $defs.renditionType.properties.contentType.description
The IANA Media Type which applies to this rendition.

# $defs.renditionType.properties.duration.description
The total time duration of the content in seconds (fractional seconds are allowed).

# $defs.renditionType.properties.frameRate.description
The number of video frames per second, which is the rate at which the material should be shown in order to achieve the intended visual effect.

# $defs.renditionType.properties.height.description
For still and moving images: the height of the display area measured in pixels.

# $defs.renditionType.properties.href.description
The URL for accessing the rendition as a resource.

# $defs.renditionType.properties.name.description
The name of this object in the array of renditions, for example 'thumbnail'. Suggested CV: http://cv.iptc.org/newscodes/rendition/

# $defs.renditionType.properties.poi.description
The main point of interest of the rendition, expressed in pixels from the top left.

# $defs.renditionType.properties.poi.properties.x.description
The x-coordinate of the point of interest of the rendition.

# $defs.renditionType.properties.poi.properties.y.description
The y-coordinate of the point of interest of the rendition.

# $defs.renditionType.properties.scanType.description
The scan type of the video i.e. progressive or interlaced.

# $defs.renditionType.properties.sizeInBytes.description
The size of the rendition resource in bytes.

# $defs.renditionType.properties.transportProtocol.description
The transport/flow type of the flow (B2B stream).

# $defs.renditionType.properties.videoCodec.description
The video encoding system used to create the content. Suggested CV: http://cv.iptc.org/newscodes/videocodec/

# $defs.renditionType.properties.width.description
For still and moving images: the width of the display area measured in pixels.

# $defs.truncatedDateTimeType.description
Allows any of year (xs:gYear, YYYY), year/month (xs:gYearMonth, YYYY-MM), year/month/day (xs:date YYYY-MM-DD), and full datetime (xs:dateTime, YYYY-MM-DDTHH:MM:SS+HH:MM), all with an optional timezone suffix. Note that this does NOT include ISO8601 month of year (xs:gMonth, --MM) or yearly day (xs:gMonthDay, --MM-DD)