Page History
...
| Asetus | Muoto | Pakollinen | Kuvaus | Esimerkki |
|---|---|---|---|---|
| url | string | Kyllä | Rajapinnan osoite. Ainoastaan https-protokolla on tuettu, ja kohdejärjestelmällä pitää olla https:ää varten validi sertifikaatti. Osoitteeksi voi laittaa myös pelkän "test", jolloin kutsun sisältö tulostetaan vain näytölle testaamista varten. | url: '"https://jira.kansalliskirjasto.fi/omahienorajapinta'" |
| username | string | Ei | Käyttäjätunnus HTTP-autentikointia varten | username: '"tunnus'" |
| password | string | Ei | Salasana HTTP-autentikointia varten | password: '"huippusalainen'" |
| authMethod | string | Ei | 'basic' (oletus) tai 'digest' | authMethod: '"digest'" |
| headers | array | Ei | Mahdolliset HTTP-otsikkotiedot, jotka pyynnössä halutaan lähettää normaalien lisäksi | headers: |
| successCodes | array | Ei | HTTP-paluukoodit, joiden perusteella voidaan päätellä, että palaute on kirjattu järjestelmään. Oletuksena kelvolliset paluukoodit ovat 200-299. | successCodes: |
Esimerkki
| Code Block |
|---|
forms:
RepositoryLibraryRequest:
title: repository_library_request
enabled: true
useCaptcha: false
sendMethod: api
apiSettings:
url: https://somewhere
successCodes:
- 200
- 204
includeBarcode: true
includePatronId: true
onlyForLoggedUsers: true
emailSubject: "Varastokirjastotilaus (%%pickup%%): %%record_id%% - %%record%%"
response: repository_library_request_response
senderInfoRequired: true
hideSenderInfo: true
hideRecipientInfo: false
help:
pre: repository_library_request_info_html
fields:
- name: pickup
type: select
options:
- 2/Vaski/1/1/
- 2/Vaski/5/100/
- 2/Vaski/6/110/
label: preferred_pickup_location
- name: lastdate
type: date
label: Mihin mennessä aineisto tarvitaan
minValue: now
format: Y-m-d
required: false
- name: name
type: text
label: feedback_name
required: true
- name: email
type: email
label: feedback_email
required: true
- name: message
type: textarea
label: feedback_message
settings:
- [placeholder, repository_library_request_message]
- [rows, 3]
|
...
