API - Career Events

Career Events

Those endpoints allow you to manage the career events.

Career events are events that are related to the career of an employee, during his employment in the company. This can be a promotion, a demotion, a transfer, a new hire, a termination, etc.

Endpoints

get/api/v3/office/career_events

Return a paginated list of office/career/events

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
employee_id?: unknown
event_type?: unknown
details?: unknown
date?: unknown
created_by_id?: unknown
deleted_at?: unknown
deleted_by_id?: unknown
The related resources to include in the response. Allowed resources are:
- `employee`
- `deleted_by`
- `created_by`
included?:
array
Elements: string
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;
    employee_id?: any;
    event_type?: any;
    details?: any;
    date?: any;
    created_by_id?: any;
    deleted_at?: any;
    deleted_by_id?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `employee`
  // - `deleted_by`
  // - `created_by`
  included?: Array<string>;
  // 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
employee_id?: integer
event_type?: string
details?: string
date?: date
created_by_id?: integer
deleted_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      employee_id?: number;
      event_type?: string;
      details?: string;
      date?: Date;
      created_by_id?: number;
      deleted_at?: Date;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/office/career_events

Create a new office/career/events

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
employee_id?: integer
event_type?: string
details?: string
date?: date
created_by_id?: integer
deleted_at?: datetime

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      employee_id?: number;
      event_type?: string;
      details?: string;
      date?: Date;
      created_by_id?: number;
      deleted_at?: Date;
    };
  };
};

patch/api/v3/office/career_events/:id/delete

Mark a career event as deleted. The event is stored in the database for audit purpose, but it is not displayed in the application anymore.

Input Schema

object
id: unknown

Typescript

type InputSchema = { id: any };

get/api/v3/office/career_events/:resource_id

Show a specific office/career/events

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
employee_id?: integer
event_type?: string
details?: string
date?: date
created_by_id?: integer
deleted_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      employee_id?: number;
      event_type?: string;
      details?: string;
      date?: Date;
      created_by_id?: number;
      deleted_at?: Date;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/office/career_events/:resource_id

Update a office/career/events

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
employee_id?: integer
event_type?: string
details?: string
date?: date
created_by_id?: integer
deleted_at?: datetime

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      employee_id?: number;
      event_type?: string;
      details?: string;
      date?: Date;
      created_by_id?: number;
      deleted_at?: Date;
    };
  };
};