contentEadArchdesc

From Archives Portal Europe Wiki
Revision as of 13:22, 10 January 2018 by Admin (Talk | contribs) (Basic Response example)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Request url: https://api.archivesportaleurope.net/services/content/ead/archdesc/{id}. This service is a GET-request.

This content-service delivers all information available of the description of an archive as a whole identified with {id}. A web-developer can use this service to create a detailed presentation of a search result.



Request parameters

id

Internal APE identifier of a finding aid (id is starting with "F"), a holdings guide (id is starting with "H"), a source guide (id is starting with "S"). Descriptive units result in other information, so a separate request is developed, called /content/ead/clevel/{id}. In this service, if the identifier does not start with a "F", "H" or "S" you will get an error message. This parameter is required.

N.B.: you can find the (internal APE) identifier of a finding aid, a holdings guide or a source guide which is necessary for using this service via the /search/ead service

Response parameters

Empty Response example

{
  "id": "string",
  "findingAidNo": "string",
  "unitTitle": "string",
  "findingAidTitle": "string",
  "repositoryId": 0,
  "repository": "string",
  "content": {
    "eadheader": {
      "eadid": {
        "content": "string",
        "publicid": "string",
        "urn": "string",
        "url": "string",
        "mainagencycode": "string",
        "identifier": "string",
        "encodinganalog": "string",
        "countrycode": "string"
      },
      "filedesc": {
        "titlestmt": {
          "titleproper": [
            {
              "content": [
                {}
              ],
              "render": "ALTRENDER",
              "type": "string",
              "encodinganalog": "string",
              "id": "string",
              "altrender": "string",
              "audience": "string"
            }
          ],
          "subtitle": [
            {
              "content": [
                {}
              ],
              "encodinganalog": "string",
              "id": "string",
              "altrender": "string",
              "audience": "string"
            }
          ],
          "author": {
            "content": [
              {}
            ],
            "encodinganalog": "string",
            "id": "string",
            "altrender": "string",
            "audience": "string"
          },
          "sponsor": {
            "content": [
              {}
            ],
            "encodinganalog": "string",
            "id": "string",
            "altrender": "string",
            "audience": "string"
          },
          "encodinganalog": "string",
          "id": "string",
          "altrender": "string",
          "audience": "string"
        },
        "editionstmt": {
          "editionOrP": [
            {}
          ],
          "encodinganalog": "string",
          "id": "string",
          "altrender": "string",
          "audience": "string"
        },
        "publicationstmt": {
          "publisherOrDateOrAddress": [
            {}
          ],
          "encodinganalog": "string",
          "id": "string",
          "altrender": "string",
          "audience": "string"
        },
        "seriesstmt": {
          "titleproperOrNumOrP": [
            {}
          ],
          "encodinganalog": "string",
          "id": "string",
          "altrender": "string",
          "audience": "string"
        },
        "notestmt": {
          "note": [
            {
              "type": "string",
              "label": "string",
              "show": "string",
              "actuate": "string",
              "encodinganalog": "string",
              "id": "string",
              "altrender": "string",
              "audience": "string",
              "mblocks": [
                {}
              ]
            }
          ],
          "encodinganalog": "string",
          "id": "string",
          "altrender": "string",
          "audience": "string"
        },
        "encodinganalog": "string",
        "id": "string",
        "altrender": "string",
        "audience": "string"
      },
      "profiledesc": {
        "creation": {
          "content": [
            {}
          ],
          "encodinganalog": "string",
          "id": "string",
          "altrender": "string",
          "audience": "string"
        },
        "langusage": {
          "content": [
            {}
          ],
          "encodinganalog": "string",
          "id": "string",
          "altrender": "string",
          "audience": "string"
        },
        "descrules": {
          "content": [
            {}
          ],
          "encodinganalog": "string",
          "id": "string",
          "altrender": "string",
          "audience": "string"
        },
        "encodinganalog": "string",
        "id": "string",
        "altrender": "string",
        "audience": "string"
      },
      "revisiondesc": {
        "list": {
          "head": {
            "content": [
              {}
            ],
            "althead": "string",
            "id": "string",
            "altrender": "string",
            "audience": "string"
          },
          "item": [
            {
              "content": [
                {}
              ],
              "id": "string",
              "altrender": "string",
              "audience": "string"
            }
          ],
          "listhead": {
            "head01": {
              "content": [
                {}
              ],
              "id": "string",
              "altrender": "string",
              "audience": "string"
            },
            "head02": {
              "content": [
                {}
              ],
              "id": "string",
              "altrender": "string",
              "audience": "string"
            },
            "id": "string",
            "altrender": "string",
            "audience": "string"
          },
          "defitem": [
            {
              "label": {
                "content": [
                  {}
                ],
                "id": "string",
                "altrender": "string",
                "audience": "string"
              },
              "item": {
                "content": [
                  {}
                ],
                "id": "string",
                "altrender": "string",
                "audience": "string"
              },
              "id": "string",
              "altrender": "string",
              "audience": "string"
            }
          ],
          "type": "string",
          "mark": "string",
          "numeration": "string",
          "continuation": "string",
          "id": "string",
          "altrender": "string",
          "audience": "string"
        },
        "change": [
          {
            "date": {
              "content": "string",
              "id": "string",
              "lang": "string",
              "localType": "string",
              "standardDate": "string",
              "notBefore": "string",
              "notAfter": "string"
            },
            "item": [
              {
                "content": [
                  {}
                ],
                "id": "string",
                "altrender": "string",
                "audience": "string"
              }
            ],
            "encodinganalog": "string",
            "id": "string",
            "altrender": "string",
            "audience": "string"
          }
        ],
        "encodinganalog": "string",
        "id": "string",
        "altrender": "string",
        "audience": "string"
      },
      "langencoding": "string",
      "scriptencoding": "string",
      "dateencoding": "string",
      "countryencoding": "string",
      "repositoryencoding": "string",
      "relatedencoding": "string",
      "findaidstatus": "string",
      "encodinganalog": "string",
      "id": "string",
      "altrender": "string",
      "audience": "string"
    },
    "frontmatter": {
      "titlepage": {
        "addressOrChronlistOrList": [
          {}
        ],
        "id": "string",
        "altrender": "string",
        "audience": "string"
      },
      "div": [
        {
          "head": {
            "content": [
              {}
            ],
            "althead": "string",
            "id": "string",
            "altrender": "string",
            "audience": "string"
          },
          "div": [
            {}
          ],
          "id": "string",
          "altrender": "string",
          "audience": "string",
          "mblocks": [
            {}
          ]
        }
      ],
      "id": "string",
      "altrender": "string",
      "audience": "string"
    },
    "archdesc": {
      "runner": [
        {
          "content": [
            {}
          ],
          "placement": "string",
          "role": "string",
          "id": "string",
          "altrender": "string",
          "audience": "string"
        }
      ],
      "did": {
        "head": {
          "content": [
            {}
          ],
          "althead": "string",
          "id": "string",
          "altrender": "string",
          "audience": "string"
        },
        "encodinganalog": "string",
        "id": "string",
        "altrender": "string",
        "audience": "string",
        "mdid": [
          {}
        ]
      },
      "level": "CLASS",
      "type": "string",
      "relatedencoding": "string",
      "id": "string",
      "altrender": "string",
      "audience": "string",
      "otherlevel": "string",
      "encodinganalog": "string",
      "mdescFull": [
        {}
      ]
    },
    "relatedencoding": "string",
    "id": "string",
    "altrender": "string",
    "audience": "string"
  }
}

Basic Response example

For the identifier F1225191:

{
  "id": "F1225191",
  "findingAidNo": "2.13.80",
  "unitTitle": "Ministerie van Defensie: Commissie voor het Model van de Veldjas",
  "findingAidTitle": "Inventaris van het archief van de Commissie voor het model van de veldjas, 1937-1940",
  "repositoryId": 2437,
  "repository": "Nationaal Archief",
  "content": {
    "eadheader": {
      "eadid": {
        "content": "2.13.80",
        "url": "http://hdl.handle.net/10648/7e4c7f91-c497-48ef-acb2-72eabad6806d",
        "mainagencycode": "NL-HaNA",
        "identifier": "NL-HaNA_2.13.80",
        "countrycode": "NL"
      },
      "filedesc": {
        "titlestmt": {
          "titleproper": [
            {
              "content": [
                "Inventaris van het archief van de Commissie voor het model van de veldjas, 1937-1940"
              ],
              "encodinganalog": "245"
            }
          ],
          "author": {
            "content": [
              "H.E.M. Mettes"
            ],
            "encodinganalog": "245$c"
          }
        },
        "publicationstmt": {
          "publisherOrDateOrAddress": [
            {
              "content": [
                "Nationaal Archief, Den Haag"
              ]
            },
            {
              "content": [
                "2000"
              ],
              "encodinganalog": "260$c",
              "calendar": "gregorian",
              "era": "ce",
              "normal": "2000"
            }
          ]
        }
      },
      "profiledesc": {
        "langusage": {
          "content": [
            "This finding aid is written in ",
            {
              "name": "{urn:isbn:1-931666-22-9}language",
              "declaredType": "gov.loc.ead.Language",
              "scope": "gov.loc.ead.Langusage",
              "value": {
                "content": [
                  "Dutch"
                ],
                "scriptcode": "Latn",
                "encodinganalog": "041",
                "langcode": "dut"
              },
              "nil": false,
              "globalScope": false,
              "typeSubstituted": false
            },
            "."
          ]
        }
      },
      "revisiondesc": {
        "change": [
          {
            "date": {
              "calendar": "gregorian",
              "era": "ce"
            },
            "item": [
              {
                "content": [
                  "Converted_apeEAD_version_2.6.0"
                ]
              }
            ]
          }
        ]
      },
      "langencoding": "iso639-2b",
      "scriptencoding": "iso15924",
      "dateencoding": "iso8601",
      "countryencoding": "iso3166-1",
      "repositoryencoding": "iso15511",
      "relatedencoding": "MARC21"
    },
    "archdesc": {
      "did": {
        "head": {
          "content": [
            "Beschrijving van het archief"
          ]
        },
        "mdid": [
          {
            "content": [
              "Ministerie van Defensie: Commissie voor het Model van de Veldjas"
            ],
            "encodinganalog": "3.1.2"
          },
          {
            "content": [
              "Cie. Veldjas"
            ],
            "encodinganalog": "3.1.2",
            "type": "short"
          },
          {
            "content": [
              "1937-1940"
            ],
            "encodinganalog": "3.1.3",
            "normal": "1937/1940",
            "calendar": "gregorian",
            "era": "ce"
          },
          {
            "encodinganalog": "3.1.3",
            "calendar": "gregorian",
            "era": "ce"
          },
          {
            "content": [
              "2.13.80"
            ],
            "type": "call number",
            "encodinganalog": "3.1.1"
          },
          {
            "content": [
              {
                "name": "{urn:isbn:1-931666-22-9}extent",
                "declaredType": "gov.loc.ead.Extent",
                "scope": "gov.loc.ead.Physdesc",
                "value": {
                  "content": [
                    "0.10 meter; "
                  ],
                  "unit": "meter"
                },
                "nil": false,
                "globalScope": false,
                "typeSubstituted": false
              },
              {
                "name": "{urn:isbn:1-931666-22-9}extent",
                "declaredType": "gov.loc.ead.Extent",
                "scope": "gov.loc.ead.Physdesc",
                "value": {
                  "content": [
                    "7 inventarisnummers."
                  ],
                  "unit": "files"
                },
                "nil": false,
                "globalScope": false,
                "typeSubstituted": false
              }
            ],
            "encodinganalog": "3.1.5"
          },
          {
            "content": [
              "Het merendeel der stukken is in het ",
              {
                "name": "{urn:isbn:1-931666-22-9}language",
                "declaredType": "gov.loc.ead.Language",
                "scope": "gov.loc.ead.Langmaterial",
                "value": {
                  "content": [
                    "Nederlands"
                  ],
                  "scriptcode": "Latn",
                  "langcode": "dut"
                },
                "nil": false,
                "globalScope": false,
                "typeSubstituted": false
              },
              " . "
            ],
            "encodinganalog": "3.4.3"
          },
          {
            "content": [
              "Normale geschreven, getypte en gedrukte documenten, geen bijzondere handschriften."
            ]
          },
          {
            "content": [
              "Nationaal Archief, Den Haag"
            ]
          },
          {},
          {
            "content": [
              " "
            ],
            "label": "Archiefvormers: ",
            "encodinganalog": "3.2.1"
          },
          {
            "content": [
              {
                "name": "{urn:isbn:1-931666-22-9}corpname",
                "declaredType": "gov.loc.ead.Corpname",
                "scope": "gov.loc.ead.Origination",
                "value": {
                  "content": [
                    "Commissie voor het model van de veldjas"
                  ]
                },
                "nil": false,
                "globalScope": false,
                "typeSubstituted": false
              },
              ", 1937-1940"
            ],
            "encodinganalog": "3.2.1"
          }
        ]
      },
      "level": "FONDS",
      "type": "inventory",
      "relatedencoding": "ISAD(G)v2",
      "encodinganalog": "3.1.4",
      "mdescFull": [
        {
          "addressOrChronlistOrList": [
            {
              "content": [
                "Het archief van de commissie voor het model van de veldjas bevat stukken betreffen het onderzoek en ontwikkeling van een nieuwe veldjas voor de Nederlandse strijdkrachten."
              ]
            }
          ],
          "encodinganalog": "summary"
        },
        {
          "head": {
            "content": [
              "Geschiedenis van de archiefvormer"
            ]
          },
          "addressOrChronlistOrList": [
            {
              "content": [
                "Deze commissie werd bij beschikking van de minister van Defensie d.d. 2 september 1937, nr. 32 ingesteld met als opdracht proeven op kleine schaal te doen met drie nieuwe modellen veldjas."
              ]
            },
            {
              "content": [
                "De commissie stond onder voorzitterschap van luitenant-kolonel J. van Voorthuysen, commandant van het Regiment Grenadiers. De eerste vergadering van de commissie werd op 20 oktober 1937 in het Centraal Magazijn van Militaire Kleding en Uitrusting te Amsterdam gehouden."
              ]
            }
          ],
          "encodinganalog": "3.2.2"
        },
        {
          "head": {
            "content": [
              "Geschiedenis van het archiefbeheer"
            ]
          },
          "addressOrChronlistOrList": [
            {}
          ],
          "encodinganalog": "3.2.3"
        },
        {
          "head": {
            "content": [
              "De verwerving van het archief"
            ]
          },
          "addressOrChronlistOrList": [
            {
              "content": [
                "Het archief is krachtens bepalingen van de Archiefwet overgebracht."
              ]
            }
          ],
          "encodinganalog": "3.2.4"
        },
        {
          "head": {
            "content": [
              "Openbaarheidsbeperkingen"
            ]
          },
          "addressOrChronlistOrList": [
            {
              "content": [
                "Volledig openbaar."
              ]
            }
          ],
          "encodinganalog": "3.4.1"
        },
        {
          "head": {
            "content": [
              "Beperkingen aan het gebruik"
            ]
          },
          "addressOrChronlistOrList": [
            {
              "content": [
                "Reproductie van originele bescheiden uit dit archief is, behoudens de algemene regels die gelden voor het kopiëren van stukken, niet aan beperkingen onderhevig. Er zijn geen beperkingen krachtens het auteursrecht."
              ]
            }
          ],
          "encodinganalog": "3.4.5"
        },
        {
          "head": {
            "content": [
              "Materiële beperkingen"
            ]
          },
          "addressOrChronlistOrList": [
            {}
          ],
          "encodinganalog": "3.4.4"
        },
        {
          "addressOrChronlistOrList": [
            {
              "content": [
                "Het archief kent geen materiële beperkingen."
              ]
            }
          ],
          "encodinganalog": "3.4.4"
        },
        {
          "head": {
            "content": [
              "Aanvraaginstructie"
            ]
          },
          "addressOrChronlistOrList": [
            {
              "content": [
                "Openbare archiefstukken kunnen online worden aangevraagd en gereserveerd. U kunt dit ook via de terminals in de studiezaal van het Nationaal Archief doen. Om te kunnen reserveren dient u de volgende stappen te volgen:"
              ]
            },
            {
              "item": [
                {
                  "content": [
                    "U maakt een profiel aan op ",
                    {
                      "name": "{urn:isbn:1-931666-22-9}extref",
                      "declaredType": "gov.loc.ead.Extref",
                      "scope": "gov.loc.ead.Item",
                      "value": {
                        "content": [
                          "www.gahetna.nl"
                        ],
                        "type": "simple",
                        "href": "https://www.gahetna.nl/user/register"
                      },
                      "nil": false,
                      "globalScope": false,
                      "typeSubstituted": false
                    },
                    ", en logt vervolgens in;"
                  ]
                },
                {
                  "content": [
                    "Via de archiefinventaris (alleen de beschrijvingen met rode nummers) selecteert u het gewenste archiefstuk door op de knop 'Reserveren' te klikken;"
                  ]
                },
                {
                  "content": [
                    "In het volgende scherm geeft u aan op welke dag u het archiefstuk wilt inzien;"
                  ]
                },
                {
                  "content": [
                    "Indien u zich bevindt in de studiezaal en een tafelnummer heeft ontvangen kunt u dit nummer vermelden. Als u geen tafelnummer heeft kunt u tafelnummer 777 laten staan;"
                  ]
                },
                {
                  "content": [
                    "Vervolgens bevestigt u uw reservering door deze te versturen."
                  ]
                }
              ],
              "type": "ordered",
              "numeration": "arabic"
            }
          ],
          "encodinganalog": "3.6.1"
        },
        {
          "head": {
            "content": [
              "Citeerinstructie"
            ]
          },
          "addressOrChronlistOrList": [
            {
              "content": [
                "Bij het citeren in annotatie en verantwoording dient het archief tenminste éénmaal volledig en zonder afkortingen te worden vermeld. Daarna kan worden volstaan met verkorte aanhaling."
              ]
            },
            {
              "content": [
                "VOLLEDIG:  ",
                {
                  "name": "{urn:isbn:1-931666-22-9}lb",
                  "declaredType": "gov.loc.ead.Lb",
                  "scope": "gov.loc.ead.P",
                  "value": {},
                  "nil": false,
                  "globalScope": false,
                  "typeSubstituted": false
                },
                "Nationaal Archief, Den Haag, Ministerie van Defensie: Commissie voor het Model van de Veldjas, nummer toegang 2.13.80, inventarisnummer ... "
              ]
            },
            {
              "content": [
                "VERKORT:  ",
                {
                  "name": "{urn:isbn:1-931666-22-9}lb",
                  "declaredType": "gov.loc.ead.Lb",
                  "scope": "gov.loc.ead.P",
                  "value": {},
                  "nil": false,
                  "globalScope": false,
                  "typeSubstituted": false
                },
                "NL-HaNA, Cie. Veldjas, 2.13.80, inv.nr. ... "
              ]
            }
          ]
        },
        {
          "head": {
            "content": [
              "Beschikbaarheid van kopieën"
            ]
          },
          "addressOrChronlistOrList": [
            {}
          ],
          "encodinganalog": "3.5.2"
        },
        {
          "head": {
            "content": [
              "Beschrijving van de series en archiefbestanddelen"
            ]
          },
          "type": "othertype"
        }
      ]
    }
  }
}

id

Internal APE identifier of the finding aid, holdings guide or source guide. The same as your request parameter "id".

unitId

Original identifier of the information provided by the repository.

unitTitle

Title of the information provided by the repository.

repositoryId

Internal APE identifier of the repository.

repository

Name of the repository.

content

Information in EAD-format, serialized as JSON. This part could potentially contain all the elements that can be part of an EAD/XML-document.