Ich bin eine E-PAT Beispielinstanz. Alle meine APIs sind unter /api

Erhaltene Buchungen bis jetzt: bookings.txt

Erhaltene Formulare bis jetzt: formdata.txt

API

Response-Type if none specified: application/json

Auth is provided via a AUTH-TOKEN header. The requesting application has to send the following header with every request to the API: EPAT-AUTH-TOKEN: [epattoken]
Where [epattoken] is the API token issued by the EPAT instance.

For this mock, also EPAT-AUTH-TOKENs provided via GET are accepted for easier development and testing. They are implicitly included in the following example calls (for dev, it is now simpy the string epat hashed as MD5, 41b25014ca8536b93e3034a692119742).

Forms

Forms-app API

• GET /api/?appcode=forms&action=forms

  Returns a list of available forms with their public attributes

  Response object (JSON)

  List of forms with only public attributes, keyed by formid

  [ formid: { "name": formname, "language": formlanguage }, ... ]

  Examples

  • api/?appcode=forms&action=forms (all available forms with public attributes) {"1":{"name":"Patientenanmeldung Deutsch","language":"de"},"2":{"name":"Patientenanmeldung Englisch","language":"en"}}

• GET /api/?appcode=forms&action=forms&secret=[formsecret]&entity=[formid]

  Returns metadata the form with id formid

  Response object (JSON)

  Form object with all privates attributes if formsecret is correct

  { "name": formname, "language": formlanguage, "signature": { "required": formrequired, "city": formsignaturecity } }

  Response HTTP 403

  No response with HTTP error code 403 if formsecret is incorrect

  Response HTTP 404

  No response with HTTP error code 404 if no form with the specified formid exists

  Examples

  • api/?appcode=forms&action=forms&secret=i74os9&entity=1 (form with formid 1 with correct secret) {"name":"Patientenanmeldung Deutsch","language":"de","signature":{"required":true,"city":"Kilchberg"}}
  • api/?appcode=forms&action=forms&secret=wrong-secret&entity=1 (403, form with formid 1 with incorrect secret)
  • api/?appcode=forms&action=forms&secret=i74os9&entity=5000 (404, form with non existing formid 5000)

• GET /api/?appcode=forms&action=forms&secret=[formsecret]&entity=[formid]&field=[formfield]

  Returns the content of the field formfield. Usually formfield is html to get the form's HTML-code

  Response object (mixed)

  Content of field formfield if formsecret is correct

  Response HTTP 403

  No response with HTTP error code 403 if formsecret is incorrect

  Response HTTP 404

  No response with HTTP error code 404 if no form with the specified formid exists

  Examples

  • api/?appcode=forms&action=forms&secret=i74os9&entity=1&field=html (field html of form with formid 1 with correct secret. Note Contains no body/head parts) <div style="font-size:80%; margin-top:50px;"> <div style="width:30%; float:left;"> <img style="width:100%;" ...
  • api/?appcode=forms&action=forms&secret=wrong-secret&entity=1&field=html (403, field html of form with formid 1 with incorrect secret)
  • api/?appcode=forms&action=forms&secret=i74os9&entity=5000&field=html (404, field html of form with non existing formid 5000)

• POST /api/?appcode=forms&action=submit&secret=[formsecret]&entity=[formid]

  Transmits form data for form specified by formid

  Body

  body

  JSON encoded string of all form data (use json_decode on it) with the following fields:
  

  formId

  the id of the form (formid)

  formData

  a JSON object containing all form field values with name as key and value as value

  signature

  b64 encoded png image of the signature

  html

  html code of the signed form (with values)

  checksum

  SHA-1 checksum of the signed html form combined with its signature

  Response object (JSON)

  A object with a field success indicating the success of the submission

  { "success": true }

  Response HTTP 403

  No response with HTTP error code 403 if formsecret is incorrect

  Response HTTP 404

  No response with HTTP error code 404 if no form with the specified formid exists

Booking