Skip to main content

How to Get Started with the Flexi API (4/6)

HTTP Operations

Written by Petr Pech

In general, there are four basic supported HTTP operations that allow you to work with Flexi:

1) GET (reading a record, retrieving data)

  • the output format (specified as a URL extension) is taken into account

2) POST, PUT (creating, updating a record)

  • POST/PUT are not distinguished; the behavior depends on the target URL

  • when saving a record to a given register, the record is either added or updated (depending on whether the identifier already exists or not)

  • it is also possible to define behavior based on whether the record already exists, see: Create/Update Mode

  • when performing an operation on a record detail (i.e., when the URL contains an identifier), the identifier does not need to be included in the request body

3) DELETE (deleting a record)

  • records can be deleted using their detail URL (a URL containing an identifier)

  • we recommend using action="delete" instead

  • 200 – OK; 404 – record does not exist

  • works only on a specific record, for example https://localhost:5434/c/testovaci/faktura-vydana/480.xml

  • can only be used within the current period

The expected data format always matches the response format.

The format is specified either in the header using the Content-Type element or via the URL extension:

For more detailed information about HTTP operations, please refer to our documentation: Supported HTTP Operations

Did this answer your question?