Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

What is REST API?

A RESTful API is an application program interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data.

...

A RESTful API breaks down a transaction to create a series of small modules. Each module addresses a particular underlying part of the transaction. This modularity provides developers with a lot of flexibility. 

How to set up Burti REST API?

Setup is rather complicated, so we do it for the costumer. However, there are some prerequisites that needs to be done, in order to set it up:

...

Response file response.get2.json

Insert a new item

 sample.post.data.txt - made to the WRITE interface Web_JSON_UpdatingComposer.hal:

...

  1. name - the name of the update interface. The principle is similar to the read interfaces.
  2. company - the company number to use for inserting data
  3. data - the data block
  4. action - insert/update/delete
  5. matrix - to be used with matrix rows - array of rows in the same format as the following
  6. Code, Name - database fields to update with values

Response file response.post.json It contains no warnings or errors, but the format in which such errors would be received, can be seen in the file.

...