Versions Compared

Key

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

...

  1. This section provides informations about api call. First is type of api call. All api calls in Odds&More documentation are POST. Behind slash sign is the name of api call. Each api is properly named regarding its function. Behind name is short description of api call.

  2. This line points to parameters. All parameters are stored in body request below so here will always be “No parameters”.

  3. Request body is always application/json.

  4. Here you can chose if you want to test api for single or multiple items if needed.

  5. Here you can switch between “Example value” which shows example of api call, and “Schema” which reveals parameters and their descriptions.

  6. “Try it out” button gives you ability to test api call. When clicked, buton “Execute” will appear on the bottom

  7. This is the body of api call. “Format_2” = “1” and “params” are constant in any api call and are needed for execution. Inside brackets are values of parameters. Informations about parameters are located on section called “Schema” which is mentioned above. Here you can enter desired values for parameters.

  8. This sections displays possible responses.

When clicked on “Try it out button” you can change api parameters and then test api by click “Execute” button.

...

After execution of api call response body will appear on the bottom:

...

  • In response body you get data and output parameters are located after “Result”:

...

  • Below response body is example of response body which shows which parameters it should have

You may notice “Download” button in bottom right corner in response body. By clicking it will download output result as json file.

For details about output parameters you can click “Schema” and it will appear informations like on picture below:

...