XML

SourceDescription (JSON)

Represents a description of a source.

Namespace:http://gedcomx.org/v1/
URI:http://gedcomx.org/v1/SourceDescription
Extends:HypermediaEnabledData

Properties

Name Type Description
about anyURI The URI (if applicable) of the actual source.
mediaType string Hint about the media (MIME) type of the resource being described.
resourceType resourceType The type of the resource being described.
citations array of SourceCitation The bibliographic citations for this source.
mediator ResourceReference A reference to the entity that mediates access to the described source.
sources array of SourceReference References to any sources to which this source is related (usually applicable to sources that are derived from or contained in another source).
analysis ResourceReference A reference to the analysis document explaining the analysis that went into this description of the source.
componentOf SourceReference A reference to the source that contains this source.
titles array of TextValue A list of titles for this source.
titleLabel TextValue A label for the title of this description. FTU
notes array of Note Notes about a source.
attribution Attribution The attribution metadata for this source description.
sortKey string A sort key to be used in determining the position of this source relative to other sources in the same collection. FTU
description array of TextValue Human-readable descriptions of the source. FTU
identifiers array of Identifier The list of identifiers for the source.
created dateTime The date the source was created. FTU
modified dateTime The date the source was last modified. FTU
coverage array of Coverage Declarations of the coverage of the source. FTU
rights array of string The rights for this source.
fields array of Field The fields that are applicable to the resource being described. FTU
repository ResourceReference Reference to an agent describing the repository in which the source is found. FTU
descriptor ResourceReference Reference to a descriptor of fields and type of data that can be expected to be extracted from the source. FTU
Properties inherited from HypermediaEnabledData
links array of Link The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.
Properties inherited from ExtensibleData
id ID A local, context-specific id for the data.

Example

{
  "about" : ...,
  "mediaType" : "...",
  "resourceType" : "...",
  "citations" : [ {
    "lang" : "...",
    "citationTemplate" : {
    },
    "fields" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "value" : "...",
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "mediator" : {
    "resourceId" : "...",
    "resource" : ...
  },
  "sources" : [ {
    "description" : "...",
    "attribution" : {
    },
    "qualifiers" : [ {
    }, ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "analysis" : {
    "resourceId" : "...",
    "resource" : ...
  },
  "componentOf" : {
    "description" : "...",
    "attribution" : {
    },
    "qualifiers" : [ {
    }, ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  },
  "titles" : [ {
    "lang" : "...",
    "value" : "..."
  }, ... ],
  "titleLabel" : {
    "lang" : "...",
    "value" : "..."
  },
  "notes" : [ {
    "lang" : "...",
    "subject" : "...",
    "text" : "...",
    "attribution" : {
    },
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "attribution" : {
    "contributor" : {
    },
    "modified" : "...",
    "changeMessage" : "...",
    "id" : "..."
  },
  "sortKey" : "...",
  "description" : [ {
    "lang" : "...",
    "value" : "..."
  }, ... ],
  "identifiers" : {
    "type1" : [ {
      "type" : "...",
      "value" : "..."
    }, ... ],
    "type2" : [ {
      "type" : "...",
      "value" : "..."
    }, ... ],
    "..." : ...
  },
  "created" : "...",
  "modified" : "...",
  "coverage" : [ {
    "recordType" : "...",
    "spatial" : {
    },
    "temporal" : {
    },
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "rights" : [ "...", ... ],
  "fields" : [ {
    "type" : "...",
    "values" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "repository" : {
    "resourceId" : "...",
    "resource" : ...
  },
  "descriptor" : {
    "resourceId" : "...",
    "resource" : ...
  },
  "links" : {
    "type1" : [ {
      "hreflang" : "...",
      "template" : "...",
      "title" : "...",
      "allow" : "...",
      "accept" : "...",
      "rel" : "...",
      "type" : "...",
      "href" : ...
    }, ... ],
    "type2" : [ {
      "hreflang" : "...",
      "template" : "...",
      "title" : "...",
      "allow" : "...",
      "accept" : "...",
      "rel" : "...",
      "type" : "...",
      "href" : ...
    }, ... ],
    "..." : ...
  },
  "id" : "..."
}