Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

NameValue(s)RequiredRepeatableDefault valueDescription
Acceptapplication/json
*/*
yesnoapplication/jsonSpecifies the format of the accepted data. Every request needs to be sent with a valid Accept Header defining the requested response format. Otherwise the response to the request will be a 406 - Not acceptable status code. If the request accepts every kind of data (Accept: */*) JSON will be returned.
AuthorizationOAuth oauth_consumer_key="<API key>"yesnoAn API key is mandatory for data access. You may enclose it by either sending it as Query Parameter or (as mentioned here) in the Request Header.
Hostapi.deutsche-digitale-bibliothek.deyesnoThe host is mandatory.
Noprint
Section

Back To Top

Parameters

Query

ParameterValue(s)RequiredRepeatableDefault valueDescription
oauth_consumer_key<API key>yesnoAn API key is mandatory for data access. You may enclose it by either sending it as Query Parameter or (as mentioned here) in the Request Header.
sector<sector element>noyesThe sector the institutions should belong to. If more than one sector should be retrieved this parameter can be repeated (see sectors)
Noprint
Section

Back To Top

Authorization

This method needs an API key for authentication (Who are you?) and authorization (What you are authorized to do?). For more information please read the Authorization How-To.

This method is offered over HTTP and HTTP Secure.

Noprint
Section

Back To Top

Errors

CodeTextDescription
404Not FoundEither the item does not exist or has no data.
406Not AcceptableThe Request Header is not acceptable. Please see section Request Header.
500Server ErrorSomething went terribly wrong. An error message will provide a meaningful description.
Noprint
Section

Back To Top

Samples

Request 1

Request all institutions using authentication via Query Parameters.

...

Noprint
Code Block
titleJSON
linenumberstrue
languagejs
collapsetrue
[
    {
        "name": "Abenteuermuseum Saarbrücken",
        "id": "2GJUO7RSKB56546VZZIK5GN7GZUYU5L3",
        "latitude": "49.2401572",
        "longitude": "6.9969327",
        "sector": "sec_06"
    },
    {
        "name": "Alpines Museum des DAV",
        "id": "5TUIDBWGTQL4C2V6USI4L3HLLBHF7KXY",
        "latitude": "48.1352079",
        "longitude": "11.5889841",
        "sector": "sec_06"
    },
    {
        "name": "Alt-Arnstorf-Haus",
        "id": "JQADKD72P4O67OG7KERDZB4OQY4P5FRP",
        "children":
        [
            {
                "name": "Gollwitzer-Photoglasplattensammlung",
                "id": "UP63QLFLIUQHB2KXMOHBLHGVXBBLICRZ",
                "latitude": "48.56073",
                "longitude": "12.81708",
                "sector": "sec_01"
            }
        ],
        "latitude": "48.5601145",
        "longitude": "12.8193494",
        "sector": "sec_06"
    },
    ...
]
Noprint
Section

Back To Top