eHealth SSL Catalogue Excel service

eHealth SSL Catalogue Excel service
More information: https://systematic.com/
Contact Info: support.ehealth.servicedesk@systematic.com
Version: 1.0.0
BasePath:/v1
Proprietary
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Catalogue

Catalogue

Up 
get /catalogue/{id}
Download existing Catalogue in excel sheet. (exportCatalogue)

Path parameters

id (required)
Path Parameter — The id of the Catalogue to get.

Return type

File

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK File

400

The request could not be understood Error

404

Catalogue not found Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

Unexpected error Error
Up 
get /catalogue
Download Catalogue excel template. (getTemplate)

Return type

File

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK File

400

The request could not be understood Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

Unexpected error Error
Up 
post /catalogue
Upload an excel sheet with catalogue items, annotations etc. (importCatalogue)

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

file (required)
Form Parameter — An Excel sheet with all the catalogue and annotation items to upload in a catalogue. If no catalogue exists with a matching identifier, a new catalogue will be created, and all catalogue items and annotations will be added. If a catalogue exists with a matching identifier, the catalogue and details will be updated. To see the format of the excel, please download a template and se the description of it here.

Responses

201

Excel file was successfully uploaded and entities were successfully created or updated.

400

The request could not be understood Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

Unexpected error Error

Models

[ Jump to Methods ]

Table of Contents

  1. Error -
  2. Excelfile -

Error - Up

An business process error reported by the server.
id
UUID Unique ID of this error. format: uuid
time
Date Date and time this error occurred. format: date-time
code (optional)
String A protocol defined code allowing the client to understand the error and act appropriately format: string
message
String An English text describing the error in end-user terms. format: string
parameters (optional)
array[String] Error parameters for substituting placeholders in error message.
technicalDetails (optional)
String An detailed technical description of an internal, non-business error format: string

Excelfile - Up

excel file with defined values for catalogue items, annotations, etc.
fileName (optional)
byte[] format: binary