Docs home

Public Event Module Details Learner Side

Tells you whether the Events module is turned on for the institute. Use it to decide whether to show an Events section on your website or app.

GET/public/event/module/settings
Public Event Module Details Learner Side
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/public/event/module/settings' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Success",
  "module_setting_details": {
    "event_module_settings_id": 1,
    "module_name": "events",
    "module_description": "1",
    "is_active": 1,
    "organization_id": 2
  }
}

Access: Public, no API key.

Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
Show child attributesHide child attributes
events
Example: events
1 on, 0 off
Example: 1

Notes: The institute is taken from the host name you call. On a branch domain, the branch's setting is returned; otherwise the setting of the institute's online organization. If the module was never set up, the call fails with "Module setting for online org is not set !".

Updated yesterday

Ask AI