tenure/committee-api | Interfolio API

Index

References

default

Classes

CommitteeApi

Type aliases

Variables

References

default

Renames and exports CommitteeApi

Type aliases

Committee

Committee: { administrators: any[]; can_edit_membership: boolean; can_recuse: boolean; committee_members: CommitteeMember[]; id: number; individual_committee: boolean; name: string; packet_id: number; recused_committee_members: CommitteeMember[]; standing: boolean; temporary_committee_members: CommitteeMember[]; type: string; unit_id: number }

An Interfolio committee definition

Type declaration

administrators: any[]

Administrators of the committee
can_edit_membership: boolean

Flag indicating if the current user can edit the committee and membership
can_recuse: boolean

Flag inidicating if the current user can recuse committee members
committee_members: CommitteeMember[]

The committee members assigned to this committee
id: number

ID of the commitee
individual_committee: boolean

Flag indicating if this is an individual committee
name: string

Name of the committee
packet_id: number

Packet ID of the committee for ad hoc committees assigned to a particular case
recused_committee_members: CommitteeMember[]

Committee members reqcuesd for the given packet
standing: boolean

Flag indicating if this is a standing committee
temporary_committee_members: CommitteeMember[]

Committee members temporarily added
type: string

Type of the committee (standing etc)
unit_id: number

Unit id of the committee

CommitteeListSummary

CommitteeListSummary: { committee_member_count: number; id: number; in_use: boolean; name: string; unit_name: string }

Data returned when searching for committees

Type declaration

committee_member_count: number

Current number of committee members assigned to this committee
id: number

ID of the committee
in_use: boolean

flag inidicating if this committee has current assignments
name: string

Name of the committee
unit_name: string

Name of the unit to which this committee belongs

Variables

Const COMMITTEE_BASE_URL

COMMITTEE_BASE_URL: string = ...

const: Base url for committee api calls

Const COMMITTEE_URL

COMMITTEE_URL: string = ...

Const STANDING_COMMITTEES_URL

STANDING_COMMITTEES_URL: string = ...

Const STANDING_COMMITTEE_CREATE_URL

STANDING_COMMITTEE_CREATE_URL: string = ...

Generated using TypeDoc