Gebruik service

Via deze service is het mogelijk om de repository te benaderen. Via verschillende manieren is het mogelijk om items op te vragen/in te zien. De mogelijkheden worden hieronder beschreven per niveau. In het algemeen gelden de volgende mogelijkheden.

• Bij bepaalde area’s wordt gebruik gemaakt van sub-area’s. In die gevallen is het geen verplichting om die op te geven bij het request. De service zal de juiste area bepalen inclusief eventuele subarea’s. Een voorbeeld “/officielepublicaties/stcrt-2015-123” redirect naar “/officielepublicaties/stcrt/2015/stcrt-2015-123”.
• De mogelijkheid bestaat om de response in een bepaald formaat geretourneerd te krijgen. Achter het request wordt dan de toevoeging ?output=…. gedaan, voorbeeld https://repository.officiele-overheidspublicaties.nl/officielepublicaties/stcrt-2015-123?output=html.

Per niveau is beschreven welke output mogelijkheden er zijn..

Area niveau

• uitleg: Geef de naam van de area op om een uitleg te krijgen van het gebruik van de service.
• request: https://repository.officiele-overheidspublicaties.nl/[area]
• voorbeeld: https://repository.officiele-overheidspublicaties.nl/OfficielePublicaties.

Work niveau

• uitleg: geef de naam van de area en een work op om als toevoeging achter de Url.
• request: https://repository.officiele-overheidspublicaties.nl/[area]/[work]
• voorbeeld: .../officielepublicaties/stcrt-2015-123 redirect naar …/officielepublicaties/stcrt/2015/stcrt-2015-123.
• response: het gehele manifestbestand.
• output mogelijkheden:
• xml: manifestbestand xml formaat.
• html: manifestbestand in html formaat.
• zip: zip-bestand van de gevraagde [work] inclusief alle subdirectories en bestanden.

Expression niveau

• uitleg: geef de naam van de area, een work en een expression op om als toevoeging achter de url.
• request: https://repository.officiele-overheidspublicaties.nl/[area]/[work]/[expression]
• voorbeeld: …/officielepublicaties/stcrt-2015-123/1 redirect naar /officielepublicaties/stcrt/2015/stcrt-2015-123/1.
• response: het gevraagde [expression] element uit het manifestbestand.
• output mogelijkheden:
• xml: het gevraagde [expression] element uit het manifestbestand xml formaat.
• html: het gevraagde [expression] element uit het manifestbestand in html formaat.
• zip: zip-bestand van de gevraagde [expression] inclusief alle subdirectories en bestanden.

Manifestation niveau

• uitleg: geef de naam van de area, een work, een expression en een manifestation op om als toevoeging achter de url.
• request: https://repository.officiele-overheidspublicaties.nl/[area]/[work]/[expression]/[manifestation]
• voorbeeld: …/officielepublicaties/stcrt-2015-123/1/pdf redirect naar /officielepublicaties/stcrt/2015/stcrt-2015-123/1/pdf.
• response: het gevraagde [manifestation] element uit het manifestbestand.
• output mogelijkheden:
• xml: het gevraagde [manifestation] element uit het manifestbestand xml formaat.
• html: het gevraagde [manifestation] element uit het manifestbestand in html formaat.
• zip: zip-bestand van de gevraagde [manifestation] inclusief alle subdirectories en bestanden.

Item niveau

• uitleg: geef de naam van een specifiek item.
• request: https://repository.officiele-overheidspublicaties.nl/[area]/[work]/[expression]/[manifestation]/[item]
• voorbeeld: …/officielepublicaties/stcrt-2015-123/1/pdf redirect naar /officielepublicaties/stcrt/2015/stcrt-2015-123/1/pdf.
• response: het gevraagde [item]
• output mogelijkheden: het output format van het gevraagde item. Er is geen mogelijkheid om een format op te geven.

Speciale labels

• uitleg: De speciale labels “currentItem” en “latestItem” kunnen gebruikt worden om respectievelijk het momenteel actuele item en het laatst toegevoegde item van een work op te vragen. In de praktijk is dit vaak hetzelfde item. De speciale labels "currentExpression" en "latestExpression" kunnen gebruikt worden om respectievelijk de momenteel actuele expression en de laatst toegevoegde expression van een work.
• request: https://repository.officiele-overheidspublicaties.nl/[area]/[work]/[currentitem]
• voorbeeld: …/officielepublicaties/stcrt-2015-123/currentitem. In het manifest is de waarde van het CurrentItem bijvoorbeeld 1/pdf/stcrt-2015-123.pdf. het originele request redirect naar /officielepublicaties/stcrt/2015/stcrt-2015-123/1/pdf/stcrt-2015-123.pdf.
• response: het gevraagde item.
• output mogelijkheden: het output format van het gevraagde item. Er is geen mogelijkheid om een format op te geven.