API - Educations

Educations

No description given.

Endpoints

get/api/v3/talent/educations

Return a paginated list of talent/educations

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
talent_id?: unknown
name?: unknown
institution?: unknown
degree?: unknown
start_date?: unknown
end_date?: unknown
The related resources to include in the response. Allowed resources are:
- `talent`
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;
    talent_id?: any;
    name?: any;
    institution?: any;
    degree?: any;
    start_date?: any;
    end_date?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `talent`
  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
name?: string
institution?: string
degree?: string
start_date?: date
end_date?: date or null
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      name?: string;
      institution?: string;
      degree?: string;
      start_date?: Date;
      end_date?: Date | null;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/talent/educations

Create a new talent/educations

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
name?: string
institution?: string
degree?: string
start_date?: date
end_date?: date or null
relationships?:
object
talent:
object
data:
object
type: string
id?: string

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      name?: string;
      institution?: string;
      degree?: string;
      start_date?: Date;
      end_date?: Date | null;
    };
    relationships?: { talent: { data: { type: string; id?: string } } };
  };
};

delete/api/v3/talent/educations/:resource_id

Delete the talent/educations

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/talent/educations/:resource_id

Show a specific talent/educations

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
name?: string
institution?: string
degree?: string
start_date?: date
end_date?: date or null
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      name?: string;
      institution?: string;
      degree?: string;
      start_date?: Date;
      end_date?: Date | null;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/talent/educations/:resource_id

Update a talent/educations

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
name?: string
institution?: string
degree?: string
start_date?: date
end_date?: date or null

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      name?: string;
      institution?: string;
      degree?: string;
      start_date?: Date;
      end_date?: Date | null;
    };
  };
};