Institution

The institution model represents educational institutions registered on the Batchmates platform. Institutions can create campaigns, manage scholars, and receive donations to support their students. Below, we outline the different properties associated with an institution.

Properties

  • Name
    id
    Type
    integer
    Description

    Unique identifier for the institution

  • Name
    name
    Type
    string
    Description

    Full name of the institution

  • Name
    slug
    Type
    string
    Description

    URL-friendly unique identifier

  • Name
    logo
    Type
    string | null
    Description

    URL to institution's logo image

  • Name
    email
    Type
    string
    Description

    Unique contact email address

  • Name
    phone
    Type
    string | null
    Description

    Contact phone number

  • Name
    address
    Type
    text | null
    Description

    Full physical address

  • Name
    city
    Type
    string | null
    Description

    City name

  • Name
    country
    Type
    string
    Description

    Country name (default: "Philippines")

  • Name
    status
    Type
    enum
    Description

    Institution status: active, suspended, pending

  • Name
    settings
    Type
    json | null
    Description

    Institution-specific configuration settings

  • Name
    created_at
    Type
    timestamp
    Description

    Record creation timestamp

  • Name
    updated_at
    Type
    timestamp
    Description

    Record last update timestamp

  • Name
    deleted_at
    Type
    timestamp | null
    Description

    Soft delete timestamp


Relationships

  • Name
    users
    Type
    User[]
    Description

    All users affiliated with this institution. See Users

  • Name
    campaigns
    Type
    Campaign[]
    Description

    All campaigns created for this institution. See Campaigns

  • Name
    donations
    Type
    Donation[]
    Description

    All donations received by this institution's campaigns. See Donations

  • Name
    scholars
    Type
    Scholar[]
    Description

    All scholars enrolled in this institution. See Scholars

Was this page helpful?