BME:API/create

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken

Het aanvragen van een ticket resulteert in een sessie of het verzoek om het bewerken van een mogelijke dubbeling te bevestigen. Hierbij wordt een ticket id aangemaakt door de BME, welke in verdere verzoeken gebruikt wordt. Indien een sessie gereed is, wordt een URL bijgevoegd waar de metadateerder de metadata kan bewerken in de BME. De opbouw van deze URL kan in de toekomst nog veranderen, dus hanteer daarom altijd de edit-url die bij het antwoord wordt meegegeven.

Argumenten

Een overzicht van de argumenten die meegegeven kunnen worden:

Info.gif De argumenten voor create moeten in POST meegegeven worden.
naam # type omschrijving
application_id 1 tekst applicatie identifier
application_password 1 tekst applicatie wachtwoord
callback_uri 1 url URL waarnaar de gebruiker wordt verwezen na voltooien bewerken metadata.
repository_id 1 tekst Edurep repository waar record wordt opgeslagen.
lom_record 0-1 xml XML LOM record
allowed_licenses 0-1 tekst Een kommagescheiden lijst met nul of meer van de volgende waarden (andere waarden worden genegeerd):
  • cc-by
  • cc-by-sa
  • cc-by-nc-sa
  • cc-by-nd
  • cc-by-nc-nd

De waarden worden als opties in het metadateerformulier getoond bij het toekennen van een licentie. Naast deze opties heeft de gebruiker altijd de mogelijkheid voor een eigen tekst.

lockPublishers 1 integer Indien waarde "1", dan kunnen geen uitgevers worden toegevoegd, verwijderd/gewijzigd.
noValidation 1 integer Indien waarde "1", dan wordt de validatie van de verplichte velden overgeslagen. Hiermee kan je template lom records genereren.
Interface 0-1 tekst De identifier van de te tonen gebruikersinterface. Valide opties zijn 'pro' en 'basic'. Indien deze parameter ontbreekt zal 'lite' gebruikt worden.

Voorbeeld Verzoek

curl --data "application_id=demo&application_password=demo&callback_uri=http%3A%2F%2Fexample.com%2Frecord%2F43%2Fmetadatacompleted&repository_id=test" http://www.metaplus.kennisnet.nl/bme/

Voorbeeld Respons

<ticket-request>
    <status>ready</status>
    <ticket>5449ff3b90311</ticket>
    <edit-url>http://metaplus.kennisnet.nl/bme/index.php?r=metadata&amp;ticket=5449ff3b90311</edit-url>
</ticket-request>

Foutmeldingen

message omschrijving
Access denied ontbrekende of incorrecte authenticatie
Repository ID is verplicht ontbrekende parameters
Retour URI is verplicht ontbrekende parameters
Provided XML is not well-formed aangeleverd LOM XML record is niet leeg of well-formed XML
Internal server error fout aan de zijde van BME

Voorbeeld

<ticket-request>
  <status>error</status>
  <message>Provided XML is not well-formed</message>
</ticket-request>