Platform API: Dashboard

get

Authorizations

BearerCookie

BearerstringRequired

Responses

200

OK

application/jsontext/json

get

/api/platform/dashboard

HTTPcURLJavaScriptPython

GET /v2/e01/api/platform/dashboard HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "ActiveNotifications": [
    {
      "NotificationId": "123e4567-e89b-12d3-a456-426614174000",
      "Type": "None",
      "Title": "text",
      "Details": "text",
      "LinkText": "text",
      "LinkUrl": "text",
      "Modified": "2026-05-07T21:22:21.083Z"
    }
  ],
  "Counts": {
    "BankCount": 1,
    "ActiveBankCount": 1,
    "FormCount": 1,
    "PublishedFormCount": 1,
    "PersonCount": 1,
    "ActivePersonCount": 1,
    "ApprovedPersonCount": 1,
    "CourseCount": 1,
    "PublishedCourseCount": 1,
    "StartedEnrollmentCount": 1,
    "CompletedEnrollmentCount": 1
  }
}

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Titlestring · nullableOptional

OnlyVisibleOnDashboardbooleanOptional

Responses

200

OK

application/jsontext/json

post

/api/platform/dashboard/notifications/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/platform/dashboard/notifications/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 46

{
  "Title": "text",
  "OnlyVisibleOnDashboard": true
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "Notifications": [
    {
      "NotificationId": "123e4567-e89b-12d3-a456-426614174000",
      "Type": "None",
      "Title": "text",
      "Details": "text",
      "LinkText": "text",
      "LinkUrl": "text",
      "StartDate": "2026-05-07T21:22:21.083Z",
      "EndDate": "2026-05-07T21:22:21.083Z",
      "IsActive": true,
      "Created": "2026-05-07T21:22:21.083Z",
      "CreatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "Modified": "2026-05-07T21:22:21.083Z",
      "ModifiedBy": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "Users": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "VisibleOnDashboard": {
    "ANY_ADDITIONAL_PROPERTY": true
  }
}

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

notificationIdstring · uuidRequired

Responses

200

OK

application/jsontext/json

NotificationIdstring · uuidOptional

Typestring · enumOptionalPossible values:

Titlestring · nullableOptional

Detailsstring · nullableOptional

LinkTextstring · nullableOptional

LinkUrlstring · nullableOptional

StartDatestring · date-time · nullableOptional

EndDatestring · date-time · nullableOptional

IsActivebooleanOptional

Createdstring · date-timeOptional

CreatedBystring · uuidOptional

Modifiedstring · date-timeOptional

ModifiedBystring · uuidOptional

get

/api/platform/dashboard/notifications/{notificationId}

HTTPcURLJavaScriptPython

GET /v2/e01/api/platform/dashboard/notifications/{notificationId} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "NotificationId": "123e4567-e89b-12d3-a456-426614174000",
  "Type": "None",
  "Title": "text",
  "Details": "text",
  "LinkText": "text",
  "LinkUrl": "text",
  "StartDate": "2026-05-07T21:22:21.083Z",
  "EndDate": "2026-05-07T21:22:21.083Z",
  "IsActive": true,
  "Created": "2026-05-07T21:22:21.083Z",
  "CreatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "Modified": "2026-05-07T21:22:21.083Z",
  "ModifiedBy": "123e4567-e89b-12d3-a456-426614174000"
}

delete

Authorizations

BearerCookie

BearerstringRequired

Path parameters

notificationIdstring · uuidRequired

Responses

200

OK

No content

delete

/api/platform/dashboard/notifications/{notificationId}

HTTPcURLJavaScriptPython

DELETE /v2/e01/api/platform/dashboard/notifications/{notificationId} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

No content

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

NotificationIdstring · uuidOptional

Typestring · enumOptionalPossible values:

Titlestring · nullableOptional

Detailsstring · nullableOptional

LinkTextstring · nullableOptional

LinkUrlstring · nullableOptional

StartDatestring · date-time · nullableOptional

EndDatestring · date-time · nullableOptional

IsActivebooleanOptional

Createdstring · date-timeOptional

CreatedBystring · uuidOptional

Modifiedstring · date-timeOptional

ModifiedBystring · uuidOptional

Responses

200

OK

application/jsontext/json

NotificationIdstring · uuidOptional

Typestring · enumOptionalPossible values:

Titlestring · nullableOptional

Detailsstring · nullableOptional

LinkTextstring · nullableOptional

LinkUrlstring · nullableOptional

StartDatestring · date-time · nullableOptional

EndDatestring · date-time · nullableOptional

IsActivebooleanOptional

Createdstring · date-timeOptional

CreatedBystring · uuidOptional

Modifiedstring · date-timeOptional

ModifiedBystring · uuidOptional

post

/api/platform/dashboard/notifications

HTTPcURLJavaScriptPython

POST /v2/e01/api/platform/dashboard/notifications HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 408

{
  "NotificationId": "123e4567-e89b-12d3-a456-426614174000",
  "Type": "None",
  "Title": "text",
  "Details": "text",
  "LinkText": "text",
  "LinkUrl": "text",
  "StartDate": "2026-05-07T21:22:21.083Z",
  "EndDate": "2026-05-07T21:22:21.083Z",
  "IsActive": true,
  "Created": "2026-05-07T21:22:21.083Z",
  "CreatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "Modified": "2026-05-07T21:22:21.083Z",
  "ModifiedBy": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "NotificationId": "123e4567-e89b-12d3-a456-426614174000",
  "Type": "None",
  "Title": "text",
  "Details": "text",
  "LinkText": "text",
  "LinkUrl": "text",
  "StartDate": "2026-05-07T21:22:21.083Z",
  "EndDate": "2026-05-07T21:22:21.083Z",
  "IsActive": true,
  "Created": "2026-05-07T21:22:21.083Z",
  "CreatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "Modified": "2026-05-07T21:22:21.083Z",
  "ModifiedBy": "123e4567-e89b-12d3-a456-426614174000"
}