Class Qualifications

Constructors

constructor

Methods

getAnimalQualification getAnimalQualifications getHandlerQualification getHandlerQualifications getMemberAwards getMemberQualification getMemberQualifications

Constructors

constructor

Methods

getAnimalQualification

  • getAnimalQualification(
        context: "team" | "organisation" | "admin",
        contextId: number,
        qualificationId: number,
        options?: { exclude_org_data?: boolean; exclude_teams_data?: boolean },
    ): Promise<Qualification>

  • Parameters

    • context: "team" | "organisation" | "admin"

      The point of view from where the request takes place

    • contextId: number

      Either a team, organisation or admin's id

    • qualificationId: number

      The qualification's id

    • Optionaloptions: { exclude_org_data?: boolean; exclude_teams_data?: boolean }
      • Optionalexclude_org_data?: boolean

        Team context: Exclude entities inherited from the team's org

      • Optionalexclude_teams_data?: boolean

        Organisation context: Exclude entities belonging to accessible teams

    Returns Promise<Qualification>

    • An animal qualification

getAnimalQualifications

  • getAnimalQualifications(
        context: "team" | "organisation" | "admin",
        contextId: number,
        options?: {
            exclude_org_data?: boolean;
            exclude_teams_data?: boolean;
            order?: "asc" | "desc";
            page?: number;
            size?: number;
            sort?: "createdAt" | "id" | "updatedAt";
            title?: string;
        },
    ): Promise<Qualification[]>

  • Parameters

    • context: "team" | "organisation" | "admin"

      The point of view from where the request takes place

    • contextId: number

      Either a team, organisation or admin's id

    • Optionaloptions: {
          exclude_org_data?: boolean;
          exclude_teams_data?: boolean;
          order?: "asc" | "desc";
          page?: number;
          size?: number;
          sort?: "createdAt" | "id" | "updatedAt";
          title?: string;
      }
      • Optionalexclude_org_data?: boolean

        Team context: Exclude entities inherited from the team's org

      • Optionalexclude_teams_data?: boolean

        Organisation context: Exclude entities belonging to accessible teams

      • Optionalorder?: "asc" | "desc"

        Default: "asc"

      • Optionalpage?: number

        Page number

      • Optionalsize?: number

        Items per page

      • Optionalsort?: "createdAt" | "id" | "updatedAt"

        Default: "id"

      • Optionaltitle?: string

        The title of a resource

    Returns Promise<Qualification[]>

    • A list of animal qualifications

getHandlerQualification

  • getHandlerQualification(
        context: "team" | "organisation" | "admin",
        contextId: number,
        qualificationId: number,
        options?: { exclude_org_data?: boolean; exclude_teams_data?: boolean },
    ): Promise<Qualification>

  • Parameters

    • context: "team" | "organisation" | "admin"

      The point of view from where the request takes place

    • contextId: number

      Either a team, organisation or admin's id

    • qualificationId: number

      The qualification's id

    • Optionaloptions: { exclude_org_data?: boolean; exclude_teams_data?: boolean }
      • Optionalexclude_org_data?: boolean

        Team context: Exclude entities inherited from the team's org

      • Optionalexclude_teams_data?: boolean

        Organisation context: Exclude entities belonging to accessible teams

    Returns Promise<Qualification>

    • An animal qualification

getHandlerQualifications

  • getHandlerQualifications(
        context: "team" | "organisation" | "admin",
        contextId: number,
        options?: {
            exclude_org_data?: boolean;
            exclude_teams_data?: boolean;
            order?: "asc" | "desc";
            page?: number;
            size?: number;
            sort?: "createdAt" | "id" | "updatedAt";
            title?: string;
        },
    ): Promise<Qualification[]>

  • Parameters

    • context: "team" | "organisation" | "admin"

      The point of view from where the request takes place

    • contextId: number

      Either a team, organisation or admin's id

    • Optionaloptions: {
          exclude_org_data?: boolean;
          exclude_teams_data?: boolean;
          order?: "asc" | "desc";
          page?: number;
          size?: number;
          sort?: "createdAt" | "id" | "updatedAt";
          title?: string;
      }
      • Optionalexclude_org_data?: boolean

        Team context: Exclude entities inherited from the team's org

      • Optionalexclude_teams_data?: boolean

        Organisation context: Exclude entities belonging to accessible teams

      • Optionalorder?: "asc" | "desc"

        Default: "asc"

      • Optionalpage?: number

        Page number

      • Optionalsize?: number

        Items per page

      • Optionalsort?: "createdAt" | "id" | "updatedAt"

        Default: "id"

      • Optionaltitle?: string

        The title of a resource

    Returns Promise<Qualification[]>

    • A list of animal qualifications

getMemberAwards

  • getMemberAwards(
        context: "team" | "organisation" | "admin",
        contextId: number,
        options?: {
            exclude_org_data?: boolean;
            exclude_teams_data?: boolean;
            member_id?: number | "me";
            order?: "asc" | "desc";
            page?: number;
            qualification_id?: number;
            size?: number;
            sort?: "createdAt" | "id" | "updatedAt";
        },
    ): Promise<MemberAwards[]>

  • Parameters

    • context: "team" | "organisation" | "admin"

      The point of view from where the request takes place

    • contextId: number

      Either a team, organisation or admin's id

    • Optionaloptions: {
          exclude_org_data?: boolean;
          exclude_teams_data?: boolean;
          member_id?: number | "me";
          order?: "asc" | "desc";
          page?: number;
          qualification_id?: number;
          size?: number;
          sort?: "createdAt" | "id" | "updatedAt";
      }
      • Optionalexclude_org_data?: boolean

        Team context: Exclude entities inherited from the team's org

      • Optionalexclude_teams_data?: boolean

        Organisation context: Exclude entities belonging to accessible teams

      • Optionalmember_id?: number | "me"

        Qualified member. Either an id or "me"

      • Optionalorder?: "asc" | "desc"

        Default: "asc"

      • Optionalpage?: number

        Page number

      • Optionalqualification_id?: number

        The qualification's id

      • Optionalsize?: number

        Items per page

      • Optionalsort?: "createdAt" | "id" | "updatedAt"

        Default: "id"

    Returns Promise<MemberAwards[]>

    • A list of member qualification awards

getMemberQualification

  • getMemberQualification(
        context: "team" | "organisation" | "admin",
        contextId: number,
        qualificationId: number | "me",
        options?: { exclude_org_data?: boolean; exclude_teams_data?: boolean },
    ): Promise<Qualification>

  • Parameters

    • context: "team" | "organisation" | "admin"

      The point of view from where the request takes place

    • contextId: number

      Either a team, organisation or admin's id

    • qualificationId: number | "me"

      The qualification's id

    • Optionaloptions: { exclude_org_data?: boolean; exclude_teams_data?: boolean }
      • Optionalexclude_org_data?: boolean

        Team context: Exclude entities inherited from the team's org

      • Optionalexclude_teams_data?: boolean

        Organisation context: Exclude entities belonging to accessible teams

    Returns Promise<Qualification>

    • A member qualification

getMemberQualifications

  • getMemberQualifications(
        context: "team" | "organisation" | "admin",
        contextId: number,
        options?: {
            exclude_org_data?: boolean;
            exclude_teams_data?: boolean;
            order?: "asc" | "desc";
            page?: number;
            size?: number;
            sort?: "createdAt" | "id" | "updatedAt";
            title?: string;
        },
    ): Promise<Qualification[]>

  • Parameters

    • context: "team" | "organisation" | "admin"

      The point of view from where the request takes place

    • contextId: number

      Either a team, organisation or admin's id

    • Optionaloptions: {
          exclude_org_data?: boolean;
          exclude_teams_data?: boolean;
          order?: "asc" | "desc";
          page?: number;
          size?: number;
          sort?: "createdAt" | "id" | "updatedAt";
          title?: string;
      }
      • Optionalexclude_org_data?: boolean

        Team context: Exclude entities inherited from the team's org

      • Optionalexclude_teams_data?: boolean

        Organisation context: Exclude entities belonging to accessible teams

      • Optionalorder?: "asc" | "desc"

        Default: "asc"

      • Optionalpage?: number

        Page number

      • Optionalsize?: number

        Items per page

      • Optionalsort?: "createdAt" | "id" | "updatedAt"

        Default: "id"

      • Optionaltitle?: string

        The title of a resource

    Returns Promise<Qualification[]>

    • A list of member qualifications

Settings

Member Visibility

On This Page

Constructors
Methods