API - Announcements

Announcements

No description given.

Endpoints

get/api/v3/notification/announcements

Return a paginated list of notification/announcements

Input Schema

object
page?:
object
The page number, default to 1
number?: integer
The number of items per page, default to 1000
size?: integer
The sort order, comma separated list of fields. See sorting section for more details
sort?: string
Set to true to return the total number of items in the collection
count?: boolean
filter?:
object
id?: unknown
title?: unknown
content_md?: unknown
organizational_units?: unknown
author_name?: unknown
created_by?: unknown
view_count?: unknown
starts_at?: unknown
ends_at?: unknown
created_at?: unknown
title__match?: unknown
starts_at__gte?: unknown
starts_at__lte?: unknown
ends_at__gte?: unknown
ends_at__lte?: unknown
created_by__eq?: unknown
author_name__match?: unknown
organizational_units__contains?: unknown
The fields to include in the response.
The key is the resource type and the value is an array of fields.
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  page?: {
    // The page number, default to 1
    number?: number;
    // The number of items per page, default to 1000
    size?: number;
  };
  // The sort order, comma separated list of fields. See sorting section for more details
  sort?: string;
  // Set to true to return the total number of items in the collection
  count?: boolean;
  filter?: {
    id?: any;
    title?: any;
    content_md?: any;
    organizational_units?: any;
    author_name?: any;
    created_by?: any;
    view_count?: any;
    starts_at?: any;
    ends_at?: any;
    created_at?: any;
    title__match?: any;
    starts_at__gte?: any;
    starts_at__lte?: any;
    ends_at__gte?: any;
    ends_at__lte?: any;
    created_by__eq?: any;
    author_name__match?: any;
    organizational_units__contains?: any;
  };
  // The fields to include in the response.
  // The key is the resource type and the value is an array of fields.
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
array
Elements:
object
type: string
id?: string
attributes?:
object
id?: integer
title?: string
content_md?: string
organizational_units?: array
author_name?: string
created_by?: integer
view_count?: integer
starts_at?: datetime
ends_at?: datetime
created_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      title?: string;
      content_md?: string;
      organizational_units?: Array<any>;
      author_name?: string;
      created_by?: number;
      view_count?: number;
      starts_at?: Date;
      ends_at?: Date;
      created_at?: Date;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/notification/announcements

Create a new notification/announcements

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
title?: string
content_md?: string
organizational_units?: array
author_name?: string
created_by?: integer
view_count?: integer
starts_at?: datetime
ends_at?: datetime
created_at?: datetime

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      title?: string;
      content_md?: string;
      organizational_units?: Array<any>;
      author_name?: string;
      created_by?: number;
      view_count?: number;
      starts_at?: Date;
      ends_at?: Date;
      created_at?: Date;
    };
  };
};

patch/api/v3/notification/announcements/:id

Update an announcement.

Input Schema

object
id: integer
data:
object
attributes:
object
title?: string
content_md?: string
starts_at?: string
ends_at?: string
List of organizational unit for this announcement
organizational_units?: array

Typescript

type InputSchema = {
  id: number;
  data: {
    attributes: {
      title?: string;
      content_md?: string;
      starts_at?: string;
      ends_at?: string;
      // List of organizational unit for this announcement
      organizational_units?: Array<any>;
    };
  };
};

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: integer
title?: string
content_md?: string
organizational_units?: array
author_name?: string
created_by?: integer
view_count?: integer
starts_at?: datetime
ends_at?: datetime
created_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      title?: string;
      content_md?: string;
      organizational_units?: Array<any>;
      author_name?: string;
      created_by?: number;
      view_count?: number;
      starts_at?: Date;
      ends_at?: Date;
      created_at?: Date;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/notification/announcements/:id/read

Mark an announcement as read.

Input Schema

object
id: integer

Typescript

type InputSchema = { id: number };

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: integer
title?: string
content_md?: string
organizational_units?: array
author_name?: string
created_by?: integer
view_count?: integer
starts_at?: datetime
ends_at?: datetime
created_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      title?: string;
      content_md?: string;
      organizational_units?: Array<any>;
      author_name?: string;
      created_by?: number;
      view_count?: number;
      starts_at?: Date;
      ends_at?: Date;
      created_at?: Date;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

get/api/v3/notification/announcements/:id/views_summary

Show statistics summary of an announcement, such as the recipient count and view count.

Input Schema

object
id: integer

Typescript

type InputSchema = { id: number };

Output Schema

object
recipient_count: integer
view_count: integer

Typescript

type OutputSchema = { recipient_count: number; view_count: number };

delete/api/v3/notification/announcements/:resource_id

Delete the notification/announcements

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/notification/announcements/:resource_id

Show a specific notification/announcements

Input Schema

object
resource_id: integer
included?:
array
Elements: string
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  resource_id: number;
  included?: Array<string>;
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: integer
title?: string
content_md?: string
organizational_units?: array
author_name?: string
created_by?: integer
view_count?: integer
starts_at?: datetime
ends_at?: datetime
created_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      title?: string;
      content_md?: string;
      organizational_units?: Array<any>;
      author_name?: string;
      created_by?: number;
      view_count?: number;
      starts_at?: Date;
      ends_at?: Date;
      created_at?: Date;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};