GET api/fundingprograms

Gets all the available funding programs that are accessible for the current tenant.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Returns the available funding programs.

Collection of FundingProgram
NameDescriptionTypeAdditional information
ID

Gets or sets the ID of the funding source.

integer

None.

Name

Gets or sets the name of the funding source.

string

None.

FundingSourceId

The ID of the funding source that this program belongs to

integer

None.

Description

Gets or sets funding program description

string

None.

ValidDates

Gets or sets the list of date ranges during which this funding program is valid in the system. If this list is empty, the funding program is always eligible.

Collection of FundingProgramDateWindow

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "name": "sample string 2",
    "fundingSourceId": 3,
    "description": "sample string 4",
    "validDates": [
      {
        "fromDate": "2021-06-24T04:07:15.690994-06:00",
        "toDate": "2021-06-24T04:07:15.690994-06:00"
      },
      {
        "fromDate": "2021-06-24T04:07:15.690994-06:00",
        "toDate": "2021-06-24T04:07:15.690994-06:00"
      }
    ]
  },
  {
    "id": 1,
    "name": "sample string 2",
    "fundingSourceId": 3,
    "description": "sample string 4",
    "validDates": [
      {
        "fromDate": "2021-06-24T04:07:15.690994-06:00",
        "toDate": "2021-06-24T04:07:15.690994-06:00"
      },
      {
        "fromDate": "2021-06-24T04:07:15.690994-06:00",
        "toDate": "2021-06-24T04:07:15.690994-06:00"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfFundingProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <FundingProgram>
    <Description>sample string 4</Description>
    <FundingSourceId>3</FundingSourceId>
    <ID>1</ID>
    <Name>sample string 2</Name>
    <ValidDates>
      <FundingProgramDateWindow>
        <FromDate>2021-06-24T04:07:15.690994-06:00</FromDate>
        <ToDate>2021-06-24T04:07:15.690994-06:00</ToDate>
      </FundingProgramDateWindow>
      <FundingProgramDateWindow>
        <FromDate>2021-06-24T04:07:15.690994-06:00</FromDate>
        <ToDate>2021-06-24T04:07:15.690994-06:00</ToDate>
      </FundingProgramDateWindow>
    </ValidDates>
  </FundingProgram>
  <FundingProgram>
    <Description>sample string 4</Description>
    <FundingSourceId>3</FundingSourceId>
    <ID>1</ID>
    <Name>sample string 2</Name>
    <ValidDates>
      <FundingProgramDateWindow>
        <FromDate>2021-06-24T04:07:15.690994-06:00</FromDate>
        <ToDate>2021-06-24T04:07:15.690994-06:00</ToDate>
      </FundingProgramDateWindow>
      <FundingProgramDateWindow>
        <FromDate>2021-06-24T04:07:15.690994-06:00</FromDate>
        <ToDate>2021-06-24T04:07:15.690994-06:00</ToDate>
      </FundingProgramDateWindow>
    </ValidDates>
  </FundingProgram>
</ArrayOfFundingProgram>