Mobile API Documentation

Price Report PDF Download API

Overview: Get the IDEX Online Price Report in the requested format.

Input Parameters

Parameter Description
session_code String, as received from login API.
shape_type String, can be "Round" or "Fancy"
format String, option is only "pdf".

Sample Request Extended

HTTP JSON
Endpoint: https://mobapi.idexonline.com/pricereport/api/v2.0/pricereportdownload
{
  "session_code": "MOB_20240523065727_1u1FnnB6vyD5MI6adfUa8b",
  "shape_type_id": 2,
  "format": "pdf"
}

Sample Response

File or JSON Data
If all goes well, the HTTP code will be 200. You will get the file
In case of an exception, the error message will be displayed in this format, and the HTTP code will be 500.
If there is no price report available, the response code will be 404.
{
  "result_info": {
	"response_code": 61309,
	"response_description": "invalid or expired session"
  }
}
		

Alternative Direct Link

HTTP GET Direct Download

You can also construct a direct download link, if you want to open this for example in the browser. The disadvantage for this approach is that this will not give any error handling. You will need to pass the same parameters in the query string part of the URL:

Endpoint: https://mobapi.idexonline.com/pricereport/api/v2.0/pricereportdownloadfile
Sample URL:
https://mobapi.idexonline.com/pricereport/api/v2.0/pricereportdownloadfile?session_code=MOB_20240523065727_1u1FnnB6vyD5MI6adfUa8b&shape_type_id=1&format=pdf


Test the API


Generate JSON Request



POST






© IDEX Online 2024   -   www.idexonline.com