GET api/fundingprograms/{programId}

Gets a funding program by id.

Request Information

URI Parameters

Name	Description	Type	Additional information
programId	The program's id	integer	Required

Body Parameters

None.

Response Information

Resource Description

Returns the available funding programs.

FundingProgram

Name	Description	Type	Additional 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": "2024-12-23T12:19:35.5361597-07:00",
      "toDate": "2024-12-23T12:19:35.5361597-07:00"
    },
    {
      "fromDate": "2024-12-23T12:19:35.5361597-07:00",
      "toDate": "2024-12-23T12:19:35.5361597-07:00"
    }
  ]
}

application/xml, text/xml

Sample:

<FundingProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <Description>sample string 4</Description>
  <FundingSourceId>3</FundingSourceId>
  <ID>1</ID>
  <Name>sample string 2</Name>
  <ValidDates>
    <FundingProgramDateWindow>
      <FromDate>2024-12-23T12:19:35.5361597-07:00</FromDate>
      <ToDate>2024-12-23T12:19:35.5361597-07:00</ToDate>
    </FundingProgramDateWindow>
    <FundingProgramDateWindow>
      <FromDate>2024-12-23T12:19:35.5361597-07:00</FromDate>
      <ToDate>2024-12-23T12:19:35.5361597-07:00</ToDate>
    </FundingProgramDateWindow>
  </ValidDates>
</FundingProgram>