Class Animals

Constructors

constructor

Methods

getAnimal getAnimals

Constructors

constructor

Methods

getAnimal

  • getAnimal(
        context: "team" | "organisation" | "admin",
        contextId: number,
        animalId: number | "me",
    ): Promise<Animal>

  • 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

    • animalId: number | "me"

      An animal id

    Returns Promise<Animal>

    • An animal item

getAnimals

  • getAnimals(
        context: "team" | "organisation" | "admin",
        contextId: number,
        options?: {
            handler_member_id?: number | number[];
            id?: number | number[];
            order?: "asc" | "desc";
            page?: number;
            size?: number;
            sort?: "createdAt" | "id" | "updatedAt";
            status?: "NON_OPERATIONAL" | "OPERATIONAL";
            team_id?: number;
        },
    ): Promise<Animal[]>

  • 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: {
          handler_member_id?: number | number[];
          id?: number | number[];
          order?: "asc" | "desc";
          page?: number;
          size?: number;
          sort?: "createdAt" | "id" | "updatedAt";
          status?: "NON_OPERATIONAL" | "OPERATIONAL";
          team_id?: number;
      }
      • Optionalhandler_member_id?: number | number[]

        The member id or ids of the animal's handler(s)

      • Optionalid?: number | number[]

        A list of ids

      • Optionalorder?: "asc" | "desc"

        Default: "asc"

      • Optionalpage?: number

        Page number

      • Optionalsize?: number

        Items per page

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

        Default: "id"

      • Optionalstatus?: "NON_OPERATIONAL" | "OPERATIONAL"

        The status of the animal

      • Optionalteam_id?: number

        The numeric identifier for a resource

    Returns Promise<Animal[]>

    • A list of animals

Settings

Member Visibility

On This Page

Constructors
Methods