Get Report Parameters

This API retrieves a list of report parameters that are used for generating various reports. This information is essential for dynamically constructing report filters and ensuring accurate data retrieval based on user selections.

Response Body

The response is a JSON array of report parameter objects. Each object includes the following fields:

Field Name	Data Type	Description
`id`	integer	Unique identifier for the report parameter.
`name`	string	The name of the parameter (e.g., "START DATE", "TRANSACTION TYPE").
`parameterType`	string	The type of parameter (e.g., `DATE`, `ARRAY`).
`order`	integer	The display order of the parameter.
`required`	boolean	Indicates whether the parameter is mandatory.
`options`	array	An array of available options for selection, if applicable. For some parameters, this may be a list of strings or objects.

Responses

🟢200Get Report Parameters

application/json

Body

Example

[
    {
        "id": 1,
        "name": "START DATE",
        "parameterType": "DATE",
        "order": 1,
        "required": true,
        "options": []
    },
    {
        "id": 2,
        "name": "END DATE",
        "parameterType": "DATE",
        "order": 2,
        "required": true,
        "options": []
    },
    {
        "id": 3,
        "name": "TRANSACTION TYPE",
        "parameterType": "ARRAY",
        "order": 3,
        "required": true,
        "options": [
            "INWARD",
            "OUTWARD",
            "ALL"
        ]
    },
    {
        "id": 4,
        "name": "TRANSACTION STATUS",
        "parameterType": "ARRAY",
        "order": 4,
        "required": true,
        "options": [
            "PENDING",
            "SUCCESS",
            "FAILED",
            "ALL"
        ]
    },
    {
        "id": 5,
        "name": "MERCHANTS",
        "parameterType": "ARRAY",
        "order": 5,
        "required": true,
        "options": [
            {
                "id": 17,
                "displayName": "Test Adept For Education",
                "isStaff": false
            },
            {
                "id": 18,
                "displayName": "Adept For Education",
                "isStaff": false
            },
            {
                "id": 24,
                "displayName": "iRecharge",
                "isStaff": false
            },
            {
                "id": 26,
                "displayName": "samuel oketola",
                "isStaff": false
            },
            {
                "id": 27,
                "displayName": "Mohammed Olateju",
                "isStaff": false
            },
            {
                "id": 37,
                "displayName": "Dami Test",
                "isStaff": false
            },
            {
                "id": 39,
                "displayName": "Ben Stokes",
                "isStaff": false
            }
        ]
    }
]

Response Body

Request

Request samples

Responses

Get Report Parameters

Response Body#

Request

Request samples

Responses

Response Body