RecordInfo Response Element

RecordInfo is an /edsapi/rest/retrieve endpoint response element. It is a repackaging of a subset of the ControlInfo element.

Anatomy of a RecordInfo Element

The elements contained in the RecordInfo element are described below. All elements described below are optional.

RecordInfo is a container for a BibRecord.

"RecordInfo":{
  "BibRecord":{}
}

BibRecord

BibRecord is a container for a BibEntity and BibRelationships.

"BibRecord":{
  "BibEntity":{},
  "BibRelationships":{}
}

BibEntity

BibEntity is a container for elements that define the bibliographic entity. All elements are optional. A BibEntity may define only a subset of the possible properties.

 "BibEntity": {
    "Identifiers": [{}],
    "Languages": [{}],
    "PhysicalDescription": {},
    "Subjects": [{}],
    "Titles": [{}]
  }

BibEntity elements are detailed below.

Titles

"Titles": [
  {
    "TitleFull":title,
    "Type": one of these:main
  }

Identifiers

"Identifiers": [
  { 
    "Type": one of these: issn-print, issn-electronic, issn-locals, issn-other, isbn-print, isbn-electronic, isbn-amazon, isbn-other, doi,
    "Value": value 
  }
]

Numbering

"Numbering": [
  {
    "Type": one of these: issue, volume,
    "Value": value
  },
  ...
]

Physical Description

"PhysicalDescription": {
  "Pagination": { 
    "PageCount": page count, 
    "StartPage": start page
  }
}

Languages

"Languages": [
  { 
    "Code": ISO 639-2 language code, 
    "Text": "English" 
  }
]

Subjects

"Subjects": [
  { 
    "SubjectFull": subjectfull, 
    "Type": one of these: general
  },
  ...
]

Dates

"Dates": [
  {
    "D": DD,
    "M": MM,
    "Text": a formatted date,
    "Type":one of these: published, created,
    "Y": YYYY
  }
]

Within the Dates element, YYYY follows the ISO-8601 standard. It represents years from 0000 to 9999. Year 0000 is equal to 1 BCE and all others are CE. To represent years in BCE, an expanded year representation is used: +-YYYY.

Additional Dates conventions:

  • The number of year digits must be >= 4.
  • If neither '+' nor '-' is present, the value is assumed to be '+'.
  • By convention, year zero is labeled positive: +0000.
  • The addition of a year zero causes earlier years to be different by one when converted; for example, the year 3 BCE would be denoted by -00002.

BibRelationships

BibRelationships defines relationships of BibEntity to other entities. There are two types of relationships:

  • IsPartOfRelationships
  • HasContributorRelationships
"BibRelationships": {
  "HasContributorRelationships": [],
  "IsPartOfRelationships":[]
}

IsPartOfRelationships

The IsPartOfRelationships element is a container for IsPartOf elements. Each IsPartOf element defines the relationship between the "main" BibEntity (the one that's a direct child of the BibRecord) and the BibEntity that's contained within the IsPartOf element. For example, an article is part of a journal or a chapter is part of a book. Currently, the IsPartOfRelationships element will contain only one IsPartOf element.

"IsPartOfRelationships": [
  "BibEntity": {}
]

HasContributorRelationships

The HasContributorRelationships element is a container for HasContributor elements. An HasContributor element contains a PersonEntity that defines a contributor to the main BibEntity. HasContributorRelationships may contain many HasContributor child elements.

"HasContributorRelationships": [
  { "PersonEntity": {}},
  { "PersonEntity": {}},
  ...
]

A PersonEntity currently contains only a Name element.

"PersonEntity": { 
  "Name": { 
    "NameFull": namefull
  } 
}