GET api/clients/{clientId}/fundingPrograms?tripDate={tripDate}

Gets funding programs for client

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Client Id to fetch funding programs against.	integer	Required
tripDate	Expected trip date.	date	None.

Body Parameters

None.

Response Information

Resource Description

Returns

Collection of ClientFundingProgram

Name	Description	Type	Additional information
Sequence	Gets or sets the sequence of funding source in sources list	integer	None.
IsDefault	Gets or sets whether this funding program is applied to the client's trips by default.	boolean	None.
IsDedicated	Gets or sets dedicated status for Novus server	boolean	None.
IsPrepaid	Gets or sets if funding program is used for Prepaid faring	boolean	None.
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:

[
  {
    "sequence": 1,
    "isDefault": true,
    "isDedicated": true,
    "isPrepaid": true,
    "id": 4,
    "name": "sample string 5",
    "fundingSourceId": 6,
    "description": "sample string 7",
    "validDates": [
      {
        "fromDate": "2024-12-23T12:16:35.7736808-07:00",
        "toDate": "2024-12-23T12:16:35.7736808-07:00"
      },
      {
        "fromDate": "2024-12-23T12:16:35.7736808-07:00",
        "toDate": "2024-12-23T12:16:35.7736808-07:00"
      }
    ]
  },
  {
    "sequence": 1,
    "isDefault": true,
    "isDedicated": true,
    "isPrepaid": true,
    "id": 4,
    "name": "sample string 5",
    "fundingSourceId": 6,
    "description": "sample string 7",
    "validDates": [
      {
        "fromDate": "2024-12-23T12:16:35.7736808-07:00",
        "toDate": "2024-12-23T12:16:35.7736808-07:00"
      },
      {
        "fromDate": "2024-12-23T12:16:35.7736808-07:00",
        "toDate": "2024-12-23T12:16:35.7736808-07:00"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientFundingProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <ClientFundingProgram>
    <Description>sample string 7</Description>
    <FundingSourceId>6</FundingSourceId>
    <ID>4</ID>
    <Name>sample string 5</Name>
    <ValidDates>
      <FundingProgramDateWindow>
        <FromDate>2024-12-23T12:16:35.7736808-07:00</FromDate>
        <ToDate>2024-12-23T12:16:35.7736808-07:00</ToDate>
      </FundingProgramDateWindow>
      <FundingProgramDateWindow>
        <FromDate>2024-12-23T12:16:35.7736808-07:00</FromDate>
        <ToDate>2024-12-23T12:16:35.7736808-07:00</ToDate>
      </FundingProgramDateWindow>
    </ValidDates>
    <IsDedicated>true</IsDedicated>
    <IsDefault>true</IsDefault>
    <IsPrepaid>true</IsPrepaid>
    <Sequence>1</Sequence>
  </ClientFundingProgram>
  <ClientFundingProgram>
    <Description>sample string 7</Description>
    <FundingSourceId>6</FundingSourceId>
    <ID>4</ID>
    <Name>sample string 5</Name>
    <ValidDates>
      <FundingProgramDateWindow>
        <FromDate>2024-12-23T12:16:35.7736808-07:00</FromDate>
        <ToDate>2024-12-23T12:16:35.7736808-07:00</ToDate>
      </FundingProgramDateWindow>
      <FundingProgramDateWindow>
        <FromDate>2024-12-23T12:16:35.7736808-07:00</FromDate>
        <ToDate>2024-12-23T12:16:35.7736808-07:00</ToDate>
      </FundingProgramDateWindow>
    </ValidDates>
    <IsDedicated>true</IsDedicated>
    <IsDefault>true</IsDefault>
    <IsPrepaid>true</IsPrepaid>
    <Sequence>1</Sequence>
  </ClientFundingProgram>
</ArrayOfClientFundingProgram>