CommitteeApi | Interfolio API

Class representing an Interfolio Committee

Hierarchy

CommitteeApi

Index

Constructors

constructor

Properties

CommitteeMembers

Methods

Constructors

constructor

new CommitteeApi(config: ApiRequest | ApiConfig): CommitteeApi

- Defined in tenure/committee-api.ts:75
Constructor for the object

Parameters
- config: ApiRequest | ApiConfig
  
  Configuration for API calls
Returns CommitteeApi

Properties

Readonly CommitteeMembers

CommitteeMembers: CommitteeMemberApi

Methods

createStandingCommittee

createStandingCommittee(__namedParameters: { name: string; unitId: number }): Promise<Committee>

- Defined in tenure/committee-api.ts:100
Create a new standing committee
example
```
let committee = await api.Tenure.Committees.createStandingCommittee({name: "Committee Name", unitId: 9999});
```
Parameters
- __namedParameters: { name: string; unitId: number }
  - name: string
    
    Name of the standing committee
  - unitId: number
    
    Unit Id of the standing committee
Returns Promise<Committee>

delete

delete(__namedParameters: { id: number }): Promise<boolean>

- Defined in tenure/committee-api.ts:126
Delete the committee
example
```
await api.Tenure.Committees.delete({id: 9999});
```
Parameters
- __namedParameters: { id: number }
  - id: number
    
    ID of the Committee
Returns Promise<boolean>

findUnitStandingCommittee

findUnitStandingCommittee(__namedParameters: { committeeName: string; unitId: number }): Promise<Committee>

- Defined in tenure/committee-api.ts:149
Find a committee belonging to a particular unit
throws

Throws error if no committee is found within the unit

example
```
let committee = await api.Tenure.Committees.findUnitCommittee({name: "Committee Name", unitId: 9999});
```
Parameters
- __namedParameters: { committeeName: string; unitId: number }
  - committeeName: string
    
    Name of the committee to search for
  - unitId: number
Returns Promise<Committee>

getCommittee

getCommittee(__namedParameters: { id: number }): Promise<Committee>

- Defined in tenure/committee-api.ts:194
Get a committee from the committeeId
example
```
let committee = await api.Tenure.Committees.getCommittee({id: 9999});
```
Parameters
- __namedParameters: { id: number }
  - id: number
    
    ID of the committee
Returns Promise<Committee>

Generated using TypeDoc