Interfolio API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class representing packet evaluator section api calls

Hierarchy

  • EvaluatorSectionApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

updateSection

  • updateSection(__namedParameters: { description: string; name: string; packetId: number; sectionId: number }): Promise<boolean>

  • Update descripiton/name for Packet section for holding attachments

    example
    const updated = await api.Tenure.EvaulatorSections.updateSection({
  packetId: 9999,
  sectionId: 9999,
  name: "Section Name",
  description: "Section Description"
});

    Parameters

    • __namedParameters: { description: string; name: string; packetId: number; sectionId: number }
      • description: string

        Description of the section

      • name: string

        Name of the section

      • packetId: number

        ID of the packet

      • sectionId: number

        ID of the section

    Returns Promise<boolean>

Static findPacketSectionFromName

  • Find the packet section from the packet detail by section name

    example
    import EvaluatorSectionApi from "@sas-irad/interfolio-api/lib/tenure/packets/evaluator-section-api";
const detail = await api.Tenure.Packets.getDetail(9999);
const section = EvaluatorSectionApi.findPacketSectionFromName({
  packetDetail: detail,
  sectionName: "Section Name"
};

    Parameters

    • __namedParameters: { packetDetail: PacketDetail; sectionName: string }
      • packetDetail: PacketDetail

        detail for the entire packet

      • sectionName: string

        section name to search for

    Returns null | EvaluatorSection

Legend

  • Class
  • Constructor
  • Property
  • Method
  • Variable
  • Function
  • Type alias
  • Static method

Generated using TypeDoc