GetActiveRunningNotifications

Read Complete Release Notes

Use the following API to get all the active notifications running/published at bulletin board and information ticker with details such as location, tenant, tenant code, number of days, and so on.

To authenticate the below API, see API Authentication and Authorization.

Service Name	HTTP Method
GetActiveRunningNotifications	POST

Sample Request

{
    "ServiceName": "GetActiveRunningNotifications",
    "objCommonParameters": {
        "_ProxyDetails": {
            "SAASOrgID": "0",
            "LoginUID": 0,
            "RequestType": "mobile",
            "MobileVersion": "5.10.3",
            "Password": "test@123",
            "AuthType": "FORM",
            "ProxyID": 0,
            "OrgID": "1",
            "TokenID": "",
            "ReturnType": "JSON",
            "UserName": "abc@xyz.com"
        },
        "AlertCommonParameters": {
            "Instance": "Info",
            "Include_inactive": 0,
            "No_of_days":10,
            "FromDate":"23-04-2023 00:00:00",
            "ToDate":"30-04-30 00:00:00",
            "Location":0,
            "Customer":0
        }
    }
}

Request Parameters

Parameter Name	Type	Description	Mandatory
Location	INTEGER	This parameter is the location of the user.	FALSE
Tenant	STRING	Mention name of the tenant.	FALSE
Tenant Code	STRING	This is a mandatory parameter. Mention the Tenant Code.	TRUE
From Date	STRING	Mention the Start of the date with time stamp (HH:MM)	FALSE
To Date	STRING	End of the date with time stamp (HH:MM)	FALSE
No_of_days	INTEGER	Mention the number of days. (Last X days)	TRUE
Include_inactive	BIT	This parameter is optional, but by default this is 0 which only displays active information.	FALSE
Customer	INTEGER	This parameter is the Customer ID.	FALSE

Sample Response

{
    "Errors": "",
    "Message": "",
    "Output": "",
    "TokenID": "46886472944B0A41762D4A43B4C5D3D3D322E1475FE64D33E4FE6F2057014E2D42DEB4941553FC13677EC73E6F6BEB2D7FE197B44A6A0673B6BA2AE25F9FD6F6E84D8F153CAE18F3AD569F0A386E86989F5DA1E037B223073A2A1B0D376229A20A1B9D4D567EB4FD7057C3877AE580E24BD3F27AA4F61A50EDC303397BAA3D59CE2C80812E5EE2A18AEA17C971663122",
    "OrgID": 0,
    "OutputObject": {
        "AlertsCount": 2,
        "AlertsList": [
            {
                "AlertID": 54,
                "Source": "Information Ticker",
                "Subject": "Test IM information Ticker",
                "Description": "testt",
                "Module": "IM",
                "Sup_Function_Name": "Information Technology",
                "Sup_Function": "Info",
                "Locations": "ALL",
                "Customers": "872"
            },
            {
                "AlertID": 55,
                "Source": "Bulletin Board",
                "Subject": null,
                "Description": "fsdvzdsfszb",
                "Module": "ADM",
                "Sup_Function_Name": "Information Technology",
                "Sup_Function": "Info",
                "Locations": "ALL",
                "Customers": "872"
            }
        ]
    },
    "OutputID": 0,
    "Input": null
}