Data Fields – Base Object Type

Summary

All content types share the EIDR Base Object Data. The base type extends the DOI Kernel metadata.[1] Certain Base Object fields can map to DOI fields as indicated in the Type or Explanatory Notes columns of the metadata table. For more information on this mapping see Appendix II: DOI Resolution.

The following Referent Types can be created using only a base object type:

  • Movie
  • TV
  • Web
  • Short
  • Supplemental

If only Base Object Data are used to create a record, then it will be the fundamental version (Abstraction) at the root of a record tree: e.g., the Abstraction of a Movie or a one-time-only TV show. Other versions of the content, such as Edits, Clips, and Manifestations, will be registered using derived types with additional metadata (as described in the “Derived Types” section below).

Field NameTypeCardinalityExplanatory Notes
IDEIDR Content ID: e.g., 10.5240/4DDF-A111-8543-E67B-58F6-2   <xs:element name=”ID” type=”eidr:assetDOIType”/>1 Conditionally RequiredThe EIDR Content ID assigned to the work, version, encoding, etc.   Included with a record’s metadata when retrieved from the Registry (via a resolve or query), but not included by the user when registering a record.
StructuralTypeEnumeration: Abstraction, Performance, Digital <xs:element name=”StructuralType” type=”doiavs:creationStructuralType”/>1 RequiredAbstraction: A work in general, without reference to a specific cut, encoding, etc., including Collections such as Series, Seasons, and Compilations of Abstraction records. This cannot be used with Edit, Clip, or Manifestation. Performance: A particular cut or creative version of a work. Used for Edit and Clip records and Compilations of Edits or Clips.Digital: An encoding of a work. Typically, a particular digital file. Used for Manifestation records and Compilations of Manifestations.
ModeEnumeration: AudioVisual, Visual, Audio, Other <xs:element name=”Mode” type=”eidr:modeType”/>1 RequiredAudioVisual: Works with both audio and visual components. This is the most common mode in EIDR.Visual: Silent works that do not have a soundtrack[2] and video or timed text components registered on their own (as video or subtitle tracks in Manifestations).Audio: For audio-only works (Radio programs) and audio components registered on their own (audio tracks in Manifestations).Other: Material that does not fit within a specific Mode.
ReferentTypeEnumeration: Series, Season, TV, Movie, Short, Web, Compilation, Supplemental <xs:element name=”ReferentType” type=”eidr:referentType”/>1 RequiredThe basic nature of the work .   See “Referent Type Details” below.
ResourceNameUnicode 128 character string: e.g., Ben Hur <xs:element name=”ResourceName” type=”eidr:titleType”/>1 RequiredThe primary name (title) of the work. See “Title Details” and “Rules for EIDR Titles” below.
 @titleClassEnumeration: release, abbreviated, working, acronym, fan-based, internal, series numeric, series date, regional, broadcast, AKA, FKA, transliterated, other <xs:attribute name=”titleClass” type=”eidr:titleClassType” use=”optional”/>0-1 OptionalThe general type of the title in Resource Name.
 @langLMT written language code: e.g., en <xs:attribute name=”lang” type=”md:language-redefine” use=”required”/>1 RequiredThe language of the title in Resource Name. (This is not the language(s) of the work itself, which are recorded in Original and Version Language.) See “Language Code Details,” below, and Using EIDR Language Codes.
 @systemGeneratedBoolean: e.g., true <xs:attribute name=”systemGenerated” type=”xs:boolean” use=”optional”/>0-1 OptionalSet by the Registry when it generates the Resource Name for Seasons and Episodes. If the attribute is missing, it is presumed to be false.
AlternateResourceNameUnicode 128 character string: e.g., Ben-Hur: A Tale of the Christ <xs:element maxOccurs=”128″ minOccurs=”0″ name=”AlternateResourceName” type=”eidr:titleType”/>0-128 OptionalAlternate names for the work. See “Title Details” and “Rules for EIDR Titles” below.
 @titleClassEnumeration: release, abbreviated, working, acronym, fan-based, internal, series numeric, series date, regional, broadcast, AKA, FKA, transliterated, other <xs:attribute name=”titleClass” type=”eidr:titleClassType” use=”optional”/>0-1 OptionalThe general type of the Alternate Resource Name.
 @langLMT written language code: e.g., en <xs:attribute name=”lang” type=”md:language-redefine” use=”required”/>1 RequiredThe language of the Alternate Resource Name. (This is not the language(s) of the work itself, which are recorded in Original and Version Language.) See “Language Code Details,” below, and Using EIDR Language Codes.
OriginalLanguageLMT language code, including “und” for “undetermined” and “zxx” for “no linguistic content”: e.g., pt <xs:element maxOccurs=”32″ name=”OriginalLanguage” type=”eidr:languageType”/>1-32 RequiredThe principal language(s) in the work.   Cannot be set directly in Edit and Manifestation records, where Version Language applies and Original Language is inherited from the parent.   See “Language Code Details,” below, and Using EIDR Language Codes.
 @modeEnumeration: Audio, Visual <xs:attribute name=”mode” type=”eidr:doiModeRestricted” use=”required”/>1 RequiredThe presentation mode of the Original Language, whether spoken (Audio), written (Visual), or signed (Visual).
 @typeEnumeration: primary, narration, dialogcentric, commentary, normal, SDH, large, forced, easyreader, other <xs:attribute name=”type” type=”eidr:languageTrackTypeType”/>0-1 OptionalHow the Original Language appears or is used within the work.
VersionLanguageEnumeration: primary, narration, dialogcentric, commentary, normal, SDH, large, forced, easyreader, other <xs:element maxOccurs=”64″ minOccurs=”0″ name=”VersionLanguage” type=”eidr:languageType”/>0-64 OptionalThe language(s) of a derivative object to the extent they differ from the Original Language(s) of the parent, such as subtitles or dubbing of an Edit, Clip, or Manifestation. See “Language Code Details” below.   Cannot be applied at the root, Season, or Episode, where Original Language applies.   Any user-provided values are replaced with Registry-generated values for Manifestations Audio, Video, or Subtitle Track languages.   See “Language Code Details,” below, and Using EIDR Language Codes.
 @modeEnumeration: Audio, Visual <xs:attribute name=”mode” type=”eidr:doiModeRestricted” use=”required”/>1 RequiredThe presentation mode of the Original Language, whether spoken (Audio), written (Visual), or signed (Visual).
 @typeEnumeration: primary, narration, dialogcentric, commentary, normal, SDH, large, forced, easyreader, other <xs:attribute name=”type” type=”eidr:languageTrackTypeType”/>0-1 OptionalHow the Original Language appears or is used within the work.
AssociatedOrg<xs:element maxOccurs=”16″ minOccurs=”0″ name=”AssociatedOrg” type=”md:AssociatedOrg-type”/>0-16 Conditionally RequiredOrganizations that are most responsible for creating the work.   Required unless at least 1 Director or 4 Actors are present. May be inherited in child records.   Associated Org is a complex type where all data are recorded in child elements and attributes. See “AssociatedOrg Details” below.   See also “Parties” in the Registry Technical Overview.
 @organizationIDA text string (of type xs:string), constrained by the idType EIDRPartyID: e.g., 10.5237/2135-296EISNI: e.g., 0000-0001-2307-5070 <xs:attribute name=”organizationID” type=”md:orgID-type”/>0-1 OptionalA unique identifier of the type identified in ID Type that is associated with the Associated Org.
 @idTypeEnumeration: EIDRPartyID, ISNI <xs:attribute name=”idType” type=”md:string-OrgName-idType”/>0-1 Conditionally RequiredThe type of ID used in the organization ID field. Required if an Organization ID is provided.   NOTE: ISNI (International Standard Name Identifier) is a separate ISO standard identifier. It can be used as an Associated Org ID in the EIDR Registry, but EIDR does not provide any ISNI registration or resolution services.
 @roleEnumeration: producer, distributor, broadcaster, editor, encoder, other <xs:attribute name=”role” type=”md:string-AssociatedOrg-role” use=”required”/>1 RequiredThe basic contribution of the Associated Org to the creation or presentation of the work.
 /md:DisplayNameUnicode 128 character string: e.g., Σπύρος Σκούρας Σ.A. <xs:element name=”DisplayName”>   <xs:complexType>     <xs:simpleContent>       <xs:extension base=”md:string128Type”>       …       </xs:extension>     </xs:simpleContent>   </xs:complexType> </xs:element>1 Conditionally RequiredThe Associated Org’s primary business name. Required if an Organization ID is not provided. (The Registry will look up the Organization ID and fill in the Display Name, replacing any Display Name provided by the user.)
 /md:AlternateNameUnicode 128 character string: e.g., Σκούρας <xs:element maxOccurs=”32″ minOccurs=”0″ name=”DisplayName”>   <xs:complexType>     <xs:simpleContent>       <xs:extension base=”md:string128Type”>       …       </xs:extension>     </xs:simpleContent>   </xs:complexType> </xs:element>0-32 OptionalAdditional names by which the Associated Org is known.   The Registry will look up the Organization ID (if provided) and fill in the Alternate Names, replacing any Alternate Names provided by the user.
ReleaseDateA date (of type xs:date) or four-digit year (of type xs:gYear): e.g., 1959-11-18 <xs:element name=”ReleaseDate” type=”eidr:dateType”/>1 RequiredThe date the work was first released, broadcast, offered for retail sale, or otherwise made available for public viewing. Either a full date (preferred) or a four-digit year.   See “Time and Date” below.
CountryOfOriginISO 3166-1 alpha-2, two-character country code, DOI four-character obsolete country code, or “XX” for “unknown”: e.g., FR <xs:element maxOccurs=”32″ name=”CountryOfOrigin” type=”eidr:countryType”/>1-32 Conditionally RequiredThe home country of the companies that had primary creative control of the creation of the work, generally the producers (Associated Orgs with a “producer” role).   May be inherited in child records. (Child records can have a different Country of Origin than the parent, if applicable.)
StatusEnumeration:  valid, in development <xs:element name=”Status” type=”eidr:statusType”/>1 Requiredvalid: Most records – including all released works – will be “valid.” (Valid records are visible to all EIDR users, including the general public.)in development: Use with caution. (Contrary to the name, this is not for projects that are in development, but for records that should be private.) Such records are hidden and can only be seen by their Registrant, parties explicitly added to the record’s ACL (Access Control List), and EIDR administrators. They should be promoted to “valid” as soon as possible.   A child record’s Status cannot be “valid” if the parent is “in development.”   See the Registry Technical Overview.
ApproximateLengthAn amount of time (xs:duration): e.g., PT2H13M   <xs:element name=”ApproximateLength” type=”xs:duration”/>1 Conditionally RequiredThe approximate duration of the work.   For Abstraction objects, this may be estimated, but it should be more precise for lower level records such as Edits and Manifestations.   For Collection records (Series, Season, and Compilation), this may be 0.   For Episodes, non-zero values may be inherited from the parent Series or Season.
AlternateIDA text string with no whitespace characters, constrained according to the idType (free text for “Proprietary”): e.g., tt0052618 <xs:element maxOccurs=”unbounded” minOccurs=”0″ name=”AlternateID” type=”eidr:alternateIDType”/>0-∞ OptionalNon-EIDR identifiers associated with the work. There is no defined limit on the number of Alternate IDs.   See “Alternate ID Details” below.
 @relationEnumeration:  IsSameAs, IsEntirelyContainedBy, ContainsAllOf, IsPartiallyContainedBy, ContainsPartOf, IsDerivedFrom, IsSourceOf, HasCueSheet, HasSoundRecording, DepictsEvent, Duplicate, Other <xs:attribute name=”relation” type=”eidr:alternateIDRelationType”/>0-1 OptionalThe relationship between the work identified by the EIDR ID and the work identified by the Alternate ID. In most cases, this is isSameAs (when not provided, isSameAs is assumed), but if, for example, the EIDR ID content is the source from which the Alternate ID content is derived, then the Relation would be IsSourceOf.
 @xsi:typeEnumeration:  Ad-ID, AFI, AMG, Baseline, BFI, cIDF, CRID, DOI, EAN, GRid, GTIN, IMDB, ISAN, ISRC, ISTC, IVA, Lumiere, MUZE, Proprietary, SMPTE-UMID, TRIB, TVG, UPC, URI, UUID, URN1 RequiredThe Alternate ID type. Generally, the organization that issues the IDs.   NOTE: “Proprietary” is a term of art from the Standards Community. It does not mean that the ID is not freely available or publicly resolvable. All that it means is that the ID is not defined in a published standard.
 @domainA text string with no whitespace characters, following the general pattern of a dot-separated list of sub-domains ending in a top-level domain followed by an optional slash-separated list of ID types: e.g.: spe.sony.com/MPM <xs:attribute name=”domain” type=”eidr:constrainedURIType” use=”required”/>0-1 Conditionally RequiredIdentifies the organization that issued the ID with the option to specify a type of ID if the organization maintains more than one. Required if Type is Proprietary. Not valid otherwise.
Administrators<xs:element name=”Administrators” type=”eidr:administratorsInfoType”/>1 RequiredThe record’s Registrant and Metadata Authorities.   Administrators is a complex type where all data are recorded in child elements.   See “Administrators Details” below.
 /RegistrantThe EIDR Party ID of an entity authorized as a Registrant: e.g., 10.5237/F012-89FD <xs:element name=”Registrant” type=”eidr:registrantType”/>1 RequiredIn most cases, this must match the Party ID of the user registering the record. For subsequent modifications, any user on the record’s ACL (Access Control List) can update the record, even if not a member of the Registrant’s Party.
 /MetadataAuthorityThe EIDR Party ID of an entity authorized as a Metadata Authority: e.g.: 10.5237/AD45-F060 <xs:element maxOccurs=”4″ minOccurs=”0″ name=”MetadataAuthority” type=”eidr:metadataAuthorityType”/>0-4 OptionalEIDR Parties must be authorized to act as Metadata Authorities. When added to a record, a Metadata Authority asserts that it possess complete and accurate metadata and commits to maintaining the record going forward.
Credits<xs:element minOccurs=”0″ name=”Credits” type=”eidr:creditsType”/>0-1 Conditionally RequiredContains the works’ Director(s) and Actor(s).   Required if at least 1 Associated Org is not present. May be inherited in child records.   This section can only appear once, but it can contain up to 2 Directors and 4 Actors.   Credits is a complex type where all data are recorded in child elements and attributes.   See section “Credits Details” below.
 /Director<xs:element maxOccurs=”2″ minOccurs=”0″ name=”Director” type=”md:PersonName-type”/>0-2 Conditionally RequiredA Director, including someone who performed the role of Director but was not credited as such.   Credits/Director is a complex type where all data are recorded in child elements.
  /md:DisplayNameUnicode 128 character string: e.g., 黒澤 明 <xs:element name=”DisplayName”>   <xs:complexType>     <xs:simpleContent>       <xs:extension base=”md:eidr-PersonName-DisplayName-type”> …       </xs:extension>     </xs:simpleContent>   </xs:complexType> </xs:element>1 RequiredThe Director’s name presented in natural name order (i.e., NOT Last, First).   In most cases, this is represented in Latin-1 script, Romanized for non-Latin-1 alphabets, to aid in discovery and de-duplication (e.g., Akira Kurosawa instead of 黒澤 明).
 /Actor<xs:element maxOccurs=”4″ minOccurs=”0″ name=”Actor” type=”md:PersonName-type”/>0-4 Conditionally RequiredAn Actor, including any individual who is seen or heard within the work even if not acting.   Credits/Actor is a complex type where all data are recorded in child elements.
  /md:DisplayNameUnicode 128 character string: e.g., Харрисону Форду <xs:element name=”DisplayName”>   <xs:complexType>     <xs:simpleContent>       <xs:extension base=”md:eidr-PersonName-DisplayName-type”> …       </xs:extension>     </xs:simpleContent>   </xs:complexType> </xs:element>1 RequiredThe Actor’s name presented in natural name order (i.e., NOT Last, First). In most cases, this is represented in Latin-1 script, Romanized for non-Latin-1 alphabets, to aid in discovery and de-duplication (e.g., Harrison Ford instead of Харрисону Форду).
RegistrantExtraUnicode 128 character string: e.g., COO:BG;   <xs:element minOccurs=”0″ name=”RegistrantExtra” type=”eidr:registrantExtraDataType”/>0-1 OptionalAdditional information provided by the Registrant.   Often used to encode forward compatible values (data valid in a later version of the EIDR schema than the one being used).   Visible to all EIDR users, including the general public.
DescriptionUnicode 128 character string: e.g., Theatrical serial. <xs:element minOccurs=”0″ name=”Description” type=”eidr:descriptionType”/>0-1 OptionalAdditional information regarding the nature of the work to assist discovery and manual de-duplication. Not a plot synopsis.
 @langRFC 5646 written language code: e.g., en <xs:attribute name=”lang” type=”md:language-redefine” use=”required”/>1 RequiredThe language of the Description. See “Language Code Details,” below, and Using EIDR Language Codes.

Below is a sample XML Base Object Data record for an Abstraction Movie as may be retrieved from the Registry via the API, SDKs, or command line tools.[3] You can also view Registry records in XML form using the “View XML” option on the EIDR Web UI.[4] For details on generating XML records see the Registry Technical Overview and the EIDR 2.6 REST API Reference.

<BaseObjectData>
  <ID>10.5240/4DDF-A111-8543-E67B-58F6-2</ID>
  <StructuralType>Abstraction</StructuralType>
  <Mode>AudioVisual</Mode>
  <ReferentType>Movie</ReferentType>
  <ResourceName lang="en" titleClass="release">Ben-Hur</ResourceName>
  <AlternateResourceName lang="en" titleClass="AKA">Ben-Hur: A Tale of the Christ</AlternateResourceName>
  <AlternateResourceName lang="el" titleClass="regional">Μπεν Χουρ</AlternateResourceName>
  <AlternateResourceName lang="ru" titleClass="regional">Бен-Гур</AlternateResourceName>
  <OriginalLanguage mode="Audio" type="primary">en</OriginalLanguage>
  <AssociatedOrg idType="EIDRPartyID" organizationID="10.5237/169B-EDEB" role="producer">
    <md:DisplayName>Metro-Goldwyn-Mayer</md:DisplayName>
    <md:AlternateName>MGM</md:AlternateName>
  </AssociatedOrg>
  <ReleaseDate>1959-11-18</ReleaseDate>
  <CountryOfOrigin>US</CountryOfOrigin>
  <Status>valid</Status>
  <ApproximateLength>PT3H32M</ApproximateLength>
  <AlternateID relation="IsSameAs" xsi:type="ISAN">0000-0002-E823-0000-0-0000-0000-3</AlternateID>
  <AlternateID domain="warnerbros.com/MPM" xsi:type="Proprietary">2009218</AlternateID>
  <AlternateID domain="veronicamagazine.nl" xsi:type="Proprietary">388496</AlternateID>
  <AlternateID relation="IsSameAs" xsi:type="IMDB">tt0052618</AlternateID>
  <AlternateID relation="IsSameAs" domain="flixster.com" xsi:type="Proprietary">9402</AlternateID>
  <AlternateID domain="comcast.com" xsi:type="Proprietary">7773232513073535112</AlternateID>
  <AlternateID domain="itv.com" xsi:type="Proprietary">2/4139/0001</AlternateID>
  <Administrators>
    <Registrant>10.5237/superparty</Registrant>
  </Administrators>
  <Credits>
    <Director>
      <md:DisplayName>William Wyler</md:DisplayName>
    </Director>
    <Actor>
      <md:DisplayName>Charlton Heston</md:DisplayName>
    </Actor>
    <Actor>
      <md:DisplayName>Jack Hawkins</md:DisplayName>
    </Actor>
  </Credits>
</BaseObjectData>

When submitting this same record for registration or modification, the ID element is excluded and a Creation Type tag is wrapped around the core metadata. Each distinct record type has its own Creation Type. In this case, use the CreateBasic type and a Basic metadata tag, since only BaseObjectData is necessary for an Abstraction Movie record:

<Create type=”CreateBasic”>
  <Basic xmlns="http://www.eidr.org/schema" xmlns:md="http://www.movielabs.com/schema/md/v2.8/md">
    <BaseObjectData>
      <StructuralType>Abstraction</StructuralType>
      <Mode>AudioVisual</Mode>
      <ReferentType>Movie</ReferentType>
      <ResourceName lang="en" titleClass="release">Ben-Hur</ResourceName>
      <AlternateResourceName lang="en" titleClass="AKA">Ben-Hur: A Tale of the Christ</AlternateResourceName>
      <AlternateResourceName lang="el" titleClass="regional">Μπεν Χουρ</AlternateResourceName>
      <AlternateResourceName lang="ru" titleClass="regional">Бен-Гур</AlternateResourceName>
      <OriginalLanguage mode="Audio" type="primary">en</OriginalLanguage>
      <AssociatedOrg idType="EIDRPartyID" organizationID="10.5237/169B-EDEB" role="producer">
        <md:DisplayName>Metro-Goldwyn-Mayer</md:DisplayName>
        <md:AlternateName>MGM</md:AlternateName>
      </AssociatedOrg>
      <ReleaseDate>1959-11-18</ReleaseDate>
      <CountryOfOrigin>US</CountryOfOrigin>
      <Status>valid</Status>
      <ApproximateLength>PT3H32M</ApproximateLength>
      <AlternateID relation="IsSameAs" xsi:type="ISAN">0000-0002-E823-0000-0-0000-0000-3</AlternateID>
      <AlternateID domain="warnerbros.com/MPM" xsi:type="Proprietary">2009218</AlternateID>
      <AlternateID domain="veronicamagazine.nl" xsi:type="Proprietary">388496</AlternateID>
      <AlternateID relation="IsSameAs" xsi:type="IMDB">tt0052618</AlternateID>
      <AlternateID relation="IsSameAs" domain="flixster.com" xsi:type="Proprietary">9402</AlternateID>
      <AlternateID domain="comcast.com" xsi:type="Proprietary">7773232513073535112</AlternateID>
      <AlternateID domain="itv.com" xsi:type="Proprietary">2/4139/0001</AlternateID>
      <Administrators>
        <Registrant>10.5237/superparty</Registrant>
      </Administrators>
      <Credits>
        <Director>
          <md:DisplayName>William Wyler</md:DisplayName>
        </Director>
        <Actor>
          <md:DisplayName>Charlton Heston</md:DisplayName>
        </Actor>
        <Actor>
          <md:DisplayName>Jack Hawkins</md:DisplayName>
        </Actor>
      </Credits>
    </BaseObjectData>
  </Basic>
</Create>

NOTE: The Registry prohibits the use of empty XML tags. If a particular entry does not have any values (attributes, data payload, or nested elements), do not include the entry. For example, if a record does not have an Associated Org, do not include:

    <AssociatedOrg></AssociatedOrg>

OR

    <AssociatedOrg />

Simply skip the entry entirely.

Referent Type Details

In DOI terms, the referent is the item to which the DOI refers independent of any particular instantiation or meaning. The DOI handbook says, “ReferentType typically describes the abstract nature of the content of a referent irrespective of its structuralType.” For example, an object created as a movie is a movie whether it is being shown in a cinema, broadcast as an edited version over terrestrial TV, streamed over the Internet, or played from a DVD. A fundamental object can have multiple children through relationships such as a Clip, Edit, or Manifestation.

The EIDR ReferentType can have one of following values, set based on the original intent of a production or where the content was first made available for public viewing:

ValueExplanatory Notes
SeriesA Collection that includes ordered or unordered child items (Seasons and Episodes). Its child Episode records can have a Referent Type of TV, Movie, Web, Short, or Supplemental.
SeasonA second Collection below a Series that includes ordered or unordered child Episode items. Its child Episode records can have a Referent Type of TV, Movie, Web, Short, or Supplemental.
TVContent that first appeared via broadcast (terrestrial, satellite, cable, etc.). This includes telefilms, other one-off programs, and Episodes of television series.
MovieA feature film or other long-from motion picture that first appeared in theatrical exhibition or was released directly to video (home entertainment). If the duration is ≤ 40 minutes, then the record is a Short.
WebContent that first appeared on the Internet. (Increasingly, Web-original content is considered “TV” content: e.g., Netflix’s Stranger Things.)
ShortA short program (≤ 40 minutes ) that first appeared in theatrical exhibition or was released directly to video (home entertainment). If the duration is > 40 minutes, then the record is a Movie. Do not use for a Clip or Edit unless inherited from the parent.
CompilationA collection of multiple whole works, such as an electronic sell-through movie bundle, DVD with multiple works, a franchise, etc.
SupplementalMaterial created to support some other work, such as a trailer, featurette, deleted scenes, gag reel, interviews, behind-the-scenes, etc.

Title Details

Titles in EIDR are stored in Resource Name fields: Resource Name for a work’s primary (original or full) title and Alternate Resource Name for all other titles or nicknames by which the work is known. For more information on how to structure an EIDR title string, see “Titles and Alternate Titles” in Best Practices and Use Cases for Abstraction Records.

NOTE: EIDR supports Unicode for user-defined text strings, so titles are not limited to the Latin-1 character set.

NOTE: Registry de-duplication ignores diacritical marks and ligatures. That means that accented and un-accented characters are equivalent. Given the choice, always use the accented version when registering or modifying a record since that tends to be the more correct representation of local language use. You can always use the un-accented version later when conducting a search.

NOTE: EIDR Resource Names are automatically whitespace normalized[5] by the Registry. This has no effect on searching or de-duplication, but makes display values more consistent.

Each title must have a language (lang) attribute that identifies the language of the title string. (See “Language Code Details,” below, and Using EIDR Language Codes.) EIDR also optionally allows a titleClass attribute that can have one of the following values:

ValueExplanatory Notes
releaseThe original release title for the work. This is the name that appears in the credits for the home territory release or that is used as a worldwide foreign territory title for modern commercial works. The same work may have more than one release title: e.g., Cantonese and Mandarin versions of the same title for a domestic Chinese release, or a non-English home territory release title and an English worldwide release title.
abbreviatedShortened version of a longer title: e.g., “Prince Caspian” for “The Chronicles of Narnia: Prince Caspian”.
workingWorking title: e.g., “Eight Arms to Hold You” for “Help!”
acronymCommonly used initialism of a longer title: e.g., “SATC” for “Sex and the City”.
fan-basedA commonly used title coined by the public.
internalAn internal title or code name, not used in commercial release.
series numericA Registry-generated Season or Episode title, based on a sequence number.
series dateA Registry-generated Season or Episode title, based on a release date.
regionalA title unique to a particular territory or otherwise used outside the work’s original home territory, such as local titles given to foreign imports. May be in the same language as the Release title(s).
broadcastA broadcast-specific title that differs from the original Release title.
AKAAlso Known As for works known by multiple names in their home territory in addition to the original Release title(s).
FKAFormerly Known As for works that are no longer known by a particular name, but may be found under that title in historical records: e.g.: “Revenge of the Jedi” for “Return of the Jedi.”
transliteratedA title that originally appeared in one script but is now presented in a different script based on a phonetic transcription, not a translation. Most commonly used for Romanized versions of titles originally in non-Latin-1 scripts, such as a Japanese title presented in romaji.
otherUsed when no other type fits. Might be used for a descriptive title given by an archive for an actuality.

Language Code Details

In EIDR, language codes are used in fields such as Original and Version Language and as attributes for fields such as Resource Name and Description. Language codes are type xs:language, which is specified according to IETF BCP 47, following the guidelines of the SMPTE/MESA LMT (Language Metadata Table). See Using EIDR Language Codes for detailed instructions and EIDR-specific guidelines.

  • fr for French. Three-letter codes are required for some languages such as sgn for sign language (subtype not known) and zxx for no language content (which can apply to some of the earliest actuality films).
  • es-419 for Latin American Spanish.
  • mn-Cyrl (Cyrillic) and mn-Latn (Latin-1).
  • sr-Latn-HU represents the Serbian language (sr) written using Latin script (Latn) as used in Hungary (HU).

AssociatedOrg Details

In EIDR, Associated Orgs are organizations[6] that performed an identified function[7] in relation to the content identified by a particular EIDR record. While it is not common, the most appropriate list of Associated Orgs could differ from Abstraction to Edit to Manifestation levels or from Series to Season to Episode. The same organization could be listed more than once so long as the role differs each time.

Associated Org is a complex data type with attributes and nested elements. The simplest form of an Associated Org includes a role attribute (in the AssociatedOrg element) and a DisplayName (as a nested element):

<AssociatedOrg role="producer">
  <md:DisplayName>Metro-Goldwyn-Mayer</md:DisplayName>
</AssociatedOrg>

You can also include Alternate Names:

<AssociatedOrg role="producer">
  <md:DisplayName>Metro-Goldwyn-Mayer</md:DisplayName>
  <md:AlternateName>Metro-Goldwyn-Mayer Pictures</md:DisplayName>
  <md:AlternateName>MGM</md:AlternateName>
  <md:AlternateName>M-G-M</md:AlternateName>
</AssociatedOrg>

If an EIDR Party ID is provided with the Associated Org, then the Registry will automatically look up the DisplayName and any AlternateName elements for that Party (replacing any that were provided by the user[8]). This both ensures consistency across registry records (eliminating the impact of spelling variations, typos, etc.) and allows for very efficient entry of common Associated Orgs. The Party ID is included in an organizationID attribute of the AssociatedOrg element. When this is included, then an idType attribute must also be included. If you submit the following to the Registry:

<AssociatedOrg idType="EIDRPartyID" organizationID="10.5237/169B-EDEB" role="producer" />

It will return:

<AssociatedOrg idType="EIDRPartyID" organizationID="10.5237/169B-EDEB" role="producer">
  <md:DisplayName>Metro-Goldwyn-Mayer</md:DisplayName>
  <md:AlternateName>MGM</md:AlternateName>
</AssociatedOrg>

NOTE: Associated Org is part of the conditionally required rule that applies to EIDR record “Participants,” along with Director and Actor. Each of these fields is individually optional, but at least one of them must be included to provide a minimum level descriptive metadata to distinguish the content identified by the EIDR ID. In other words, each EIDR record must contain:

  • At least one Associated Org (preferably a producer at the Abstraction level)

OR

  • At least one Director

OR

  • Four Actors

NOTE: All of the “Participant” fields can be inherited, so once the Participant requirement is satisfied for a parent record, it is also satisfied for all child records. In most cases, the child records should not specify these values and allow them to inherit from the parent. The exception is when the child record has values that are distinct from the parent such as when a Clip features an Actor not present in the Edit’s Actor list or when identifying the original distributor for an Edit when the parent Abstraction record only identified its producers.

1.1.1     Associatedorg Role details

ValueExplanatory Notes
producerThe AssociatedOrg is a production company involved in the creation of the work.
distributorThe AssociatedOrg is a distributor. Not useful in Abstraction records (other than Compilations). May be useful in Edit records, if the version is unique to the distributor. Certainly useful in Manifestation records to identify the source of the viewable asset.
broadcasterThe AssociatedOrg is the commissioning broadcaster or the original broadcaster of an Abstraction record. Otherwise, use only if the broadcaster played a unique role in the creation of the identified object.
editorThe AssociatedOrg is the company that produced a particular Edit.
encoderThe AssociatedOrg is the company that produced a particular Manifestation.
otherThe AssociatedOrg has a durable relationship to the identified object (it will not change over time) that is not otherwise identified above.

Time and Date Details

Full dates are based on XML xs:date, which is inspired by ISO 8601 and take the form yyyy-mm-dd with a four-digit year, two-digit months and days, and hyphen separators. This is a neutral representation that works equally well in all regions of the world and has the added benefit of sorting chronologically when using a simple text sort (no other simple date representations do this).

To record August 9, 2002 (or 9 August, 2002, if you prefer) in an EIDR date field, use 2002-08-09.

Full dates are always preferred, but when they are not available, a four-digit year may be used instead. This is based on XML xs:gYear with the format yyyy, or 2002.

All times (both length and position) in the EIDR system are represented as a duration, based on XML xs:duration, which is the ISO 8601 extended format PnYnMnDTnHnMnS:

  • The duration begins with P
  • nY is the number of years followed by Y
  • nM is the number of months followed by M
  • nD is the number of days followed by D
  • The date information is separated from the time information with T
  • nH is the number of hours followed by H
  • nM is the number of minutes followed by M
  • nS the number of seconds followed by S

All of the numbers, other than Seconds, are integers with optional leading zeros. Seconds can include a decimal number to represent fractions of a second (i.e., frames).

For example, to indicate a duration of 2 hours, 30 minutes use PT2H30M.

Only provide significant values. That is, PT2H rather than PT2H00M00S, unless the value is known to be accurate to the second, and PT22M rather than PT0H22M. A value of 0 is typically represented as either PT0H or PT0M.

NOTE: Durations are automatically normalized by the Registry so that PT90M becomes PT1H30M and PT1H5S becomes PT1H0M5S. This has no effect on searching or de-duplication, but makes display values more consistent.

Alternate ID Details

Alternate ID includes a number of attributes in addition to the ID data payload. The simplest form of an Alternate ID a type attribute and the ID value:

<AlternateID xsi:type="IMDB">tt0052618</AlternateID>

The required Alternate ID type attribute is taken from the following list:

ValueExplanatory Notes
Ad-ID4 alphanumeric chars (company code), 7 alphanumeric (generated code), optional ‘H’ (for HD version).
AFIAmerican Film Institute: unrestricted integer.
AMGAll Movie Guide (part of All Media Guide), now owned by NetAktion LLC.
BaselineBaseline ID: 7-digit integer.
BFIBritish Film Institute: 9-character numeric string (integer with leading zeroes).
cIDFContent ID Forum Content ID.
CRIDTV-Anytime Content Reference Identifier (RFC 4078): crid://<DNS name>/<data>.
DOIA non-EIDR doi:name (i.e., a DOI with a non-EIDR prefix).
EANInternational Article Number (née European Article Number): 8- or 13-character numeric string.
GRidGlobal Release Identifier: 2 character (identifier scheme), 5 character (issuer code), 10 character (release number), 1 check character. Letters must be upper case. Either all sections are separated with dashes or none are.
GTINGlobal Trade Item Number: 8-, 13-, or 14-character numeric string.
IMDBIMDb Title ID: tt followed by a 7- or 8-digit integer.
ISANInternational Standard Audiovisual Number: Standard ISAN: 4-4-4-4, 4-4-4-4-C; V-ISAN: 4-4-4-4-C-4-4-C, or 4-4-4-4-4-4, where 4 is 4 uppercase hexadecimal digits, C is a single uppercase check character, and all occurrences of “-“ must be a dash, a space, or nothing. The 24-digit V-ISAN must have both check characters or none.
ISRCInternational Standard Recording Code: a 2-character (non-digit) country code, 3-character (alphanumeric or digit) registrant code, 2-digit year of reference, 5-digit designation code, with optional separating dashes. Letters are upper case. Either all dashes are present, or none are.
ISTCInternational Standard Text Code: 3 hex digits, 4 digits, 8 hex digits, ISO 7064 MOD16-3 check digit. (The groups can be separated by nothing, a space, or a hyphen. The same separator must be used for the whole ID.)
IVAInternet Video Achive ID. The form is a 7-digit integer (that cannot have 0 as the first digit).
LumiereEuropean Audiovisual Observatory: unrestricted integer.
MUZEA TiVo video or disc ID.
ProprietaryFor numbering systems that are not otherwise identified. A distinguishing domain attribute must be provided. No formatting restrictions are applied to the ID itself.
SMPTE-UMIDSMPTE Unique Material Identifier.
TRIBTribune Media TMS number (now Gracenote).
TVGTV Guide ID.
UPCUniversal Product Code – twelve decimal digits.
URIUniform Resource Identifier: scheme://domain name/data [# query] [#fragment]. Note that an IP address is not permitted.
UUIDUniversal Unique Identifier: 128-bit number presented as 8-4-4-4-12. Both upper and lowercase hexadecimal digits allowed.
URNUniform Resource Name (RFC 2141): urn: <NID> : <NSS>.

Alternate IDs that do not have an explicit type value must be presented using the Proprietary form, which includes a required domain to identify the source (and ID type, when one source has more than one ID type) of the ID. An ID from a source with only one ID type:

<AlternateID domain="veronicamagazine.nl" xsi:type="Proprietary">388496</AlternateID>

An ID from a source with more than one ID type, with the ID type presented after the domain, separated with a slash:

<AlternateID domain="warnerbros.com/MPM" xsi:type="Proprietary">2009218</AlternateID>

Alternate IDs can also include an optional relation attribute that indicates how the EIDR ID relates to the Alternate ID, taken from the following list:

ValueExplanatory Notes
IsSameAsThe object referred to by the EIDR ID is equivalent to the object referred to by the Alternate ID: e.g., this would apply to an IMDb ID for a root Movie record.
IsEntirelyContainedByThe object referred to by the EIDR ID is entirely contained by the object referred to by the Alternate ID: e.g., the Alternate ID might apply to a DVD that contains the Movie identified by the EIDR ID along with other material. (The Alternate ID did not reference additional material, then the relationship would be IsSameAs.) This is the inverse of ContainsAllOf.
ContainsAllOfThe object referred to by the EIDR ID includes the entire object referred to by the AlternateID plus additional material. (If the EIDR ID did not reference additional material, then the relationship would be IsSameAs.) This is the inverse of IsEntirelyContainedBy.
IsPartiallyContainedBySome portion of, but not all of, the object referred to by the EIDR ID is included within the object referred to by the Alternate ID. (The Alternate ID may or may not reference additional content.) This is the inverse of ContainsPartOf.
ContainsPartOfThe object referred to by the EIDR ID includes some portion of, but not all of, the object referred to by the AlternateID. (The EIDR ID may or may not reference additional content.) This is the inverse of IsPartiallyContainedBy.
IsDerivedFromThe object referred to by the EIDR ID is derived from the object referred to by the Alternate ID, e.g., the EIDR ID is an Edit or Manifestation of the Alternate ID. This is the inverse of IsSourceOf.
IsSourceOfThe object referred to by the EIDR ID is the master from which the object referred to by the Alternate ID is derrived, e.g., the EIDR ID is an Abstraction while the Alternate ID a derived Edit or Manifestation. This is the inverse of IsDerivedFrom.
DepictsEventThe object referred to by the EIDR ID is a recording of a live event identified by the indicated Event Identifier.
HasCueSheetThe Alternate ID refers to a music cue sheet (in whatever format is implied by the particular Alternate ID issuing organization) listing the music cues that appear within the object referred to by the EIDR ID. NOTE: It is theoretically possible to construct a cue sheet equivalent using Alternate IDs for each piece of music associated to the EIDR record with ContainsAllOf and ContainsPartOf relationships, but this would not indicate their order, number of uses, position, and duration and is not recommended except for music and concert videos where the music is fixed to the performance. Use external music cue sheets and an Alternate ID liked with a HasCueSheet relationship instead.
HasSoundRecordingThe Alternate ID refers to sound recording used within an audiovisual work, generally a piece of recorded music.   NOTE: It is theoretically possible to construct a cue sheet equivalent using Alternate IDs for each piece of music associated to the EIDR record with HasSoundRecording relationships, but this would not indicate their order, number of uses, position, and duration and is not recommended except for music and concert videos where the music is fixed to the performance. Use external music cue sheets and an Alternate ID liked with a HasCueSheet relationship instead.
DuplicateThe Alternate ID issuing organization has two or more ID referencing the same thing. While the Alternate ID may no longer be active (it has been deleted from the source or it has been aliased to refer to a surviving ID) third-party data sources may still reference this ID, so it is important to keep it in the EIDR record as a cross reference. Flagging it as “Duplicate” will indicate that it is no longer the primary Alternate ID from that particular source.
OtherThe relationship between the EIDR ID and the Alternate ID is unknown or not one of those listed above.

For example:

  <AlternateID relation="IsSameAs" xsi:type="IMDB">tt0052618</AlternateID>

Administrators Details

Administrators is a complex data type with nested elements for Registrant (required) and MetadataAuthoritiy (optional).

Registrant is a simple type that includes the Party ID of the user who created the record. For example:

<Administrators>
  <Registrant>10.5237/AD45-F060</Registrant>
</Administrators>

The Registrant is a permanent feature of the record and cannot be changed (it is an historical artifact). It has no correlation to who created the referenced work or who currently holds which rights in the work. Any EIDR member who has a need to identify a piece of work may create an EIDR ID if one does not already exist.[9] To begin, the Registrant is on the record’s ACL (Access Control List) and can therefore modify the record after it is created, but the ACL can be changed thereafter to include any Parties authorized by EIDR administration.

MetadataAuthority is a simple type that includes the Party ID of organizations that assert they possess complete and accurate metadata that describes the object referred to by the EIDR ID and agree to maintain the record going forward. For example:

<Administrators>
  <Registrant>10.5237/superparty</Registrant>
  <MetadataAuthority>10.5237/2FE2-24F2</MetadataAuthority>
</Administrators>

The MetadataAuthority need not be the same as the Registrant.

NOTE: Both Registrant and Metadata Authority are assigned Roles and only those Parties authorized to perform these roles may be identified in these fields.

NOTE: All non-administrative EIDR Parties IDs are automatically normalized to uppercase by the Registry. This has no effect on searching or de-duplication, but makes display values more consistent.

Credits Details

Credits is a complex data type with nested elements for Director and Actor, each of which contains a nested DisplayName. Directors (if any) are always listed first, followed by any Actors.

A Credits block with only a Director:

<Credits>
  <Director>
    <md:DisplayName>Nicholas Webster</md:DisplayName>
  </Director>
</Credits>

A Credits block with only Actors:

<Credits>
  <Actor>
    <md:DisplayName>Leonard Hicks</md:DisplayName>
  </Actor>
  <Actor>
    <md:DisplayName>John Call</md:DisplayName>
  </Actor>
</Credits>

A Credits block with a Director and Actors:

<Credits>
  <Director>
    <md:DisplayName>Nicholas Webster</md:DisplayName>
  </Director>
  <Actor>
    <md:DisplayName>Leonard Hicks</md:DisplayName>
  </Actor>
  <Actor>
    <md:DisplayName>John Call</md:DisplayName>
  </Actor>
  <Actor>
    <md:DisplayName>Vincent Beck</md:DisplayName>
  </Actor>
  <Actor>
    <md:DisplayName>Pia Zadora</md:DisplayName>
  </Actor>
</Credits>

NOTE: See the NOTES section under:

  • “Title Details” for further information on the treatment of Unicode characters, diacritics and ligatures, and whitespace in EIDR registry text strings.
  • “AssociatedOrg Details” for a summary of the “Participant” rule that governs the requirement for AssociatedOrg, Director, and Actor entries.
  • “AssociatedOrg Details” for the rules governing “Participant” data inheritance in child records.

Composite Details

Abstraction records (Movie, TV, Short, Supplemental, and Web) can optionally include Composite information (as described in “Composite” below) within an Extra Object Metadata block following the Base Object Data. For example:

<BaseObjectData>
  <ID>10.5240/12C3-9CB2-24BA-03C6-03DB-O</ID>
  <StructuralType>Abstraction</StructuralType>
  <Mode>AudioVisual</Mode>
  <ReferentType>Movie</ReferentType>
  <ResourceName lang="en" titleClass="release">That's Entertainment</ResourceName>
  <OriginalLanguage mode="Audio" type="primary">en</OriginalLanguage>
…
</BaseObjectData>
<ExtraObjectMetadata>
  <CompositeInfo>
    <CompositeClass>Excerpt</CompositeClass>
    <Element>
      <ID>10.5240/1DF4-A55B-62FE-F2BF-B447-V</ID>
      <Description>Fred Astaire in “The Band Wagon”</Description>
    </Element>
    <Element>
      <ID>10.5240/CE08-A846-EB2B-C220-1B14-M</ID>
      <Description>Bing Crosby in “Going Hollywood”</Description>
    </Element>
…
  </CompositeInfo>
</ExtraObjectMetadata>

[1] EIDR is an implementation of the DOI (Digital Object Identifier) system, defined as ISO 26324: DOI System.

[2] If a soundtrack is later added to what was originally a silent work, this is captured at the Edit level.

[3] When submitting a record to the Registry, do not include the ID field – that is assigned by the Registry, not the user.

[4] Available at https://ui.eidr.org/.

[5] Tabs, carriage returns, non-breaking spaces, etc. are replaced with spaces, multiple spaces in a row are replaced with a single space, and leading and trailing spaces are removed.

[6] Never people, though some organizations are named after people. Such organizations should be – but do not have to be – identified by EDIR Party IDs.

[7] As per the Associated Org Role controlled vocabulary: producer, distributor, broadcaster, editor, encoder, and other.

[8] Contact the EIDR Help Desk if an EIDR Party record needs to be added or updated.

[9] If such an ID already exists, then all subsequent registration attempts will return the existing EIDR ID as a duplicate record rather than issuing a new ID.

Updated on April 10, 2021

Was this article helpful?

Related Articles