POST api/trips/fundingprograms

Get funding programs available for booking based on Itinerary data.

Request Information

URI Parameters

None.

Body Parameters

Object containing request data

BookingFundingProgramsRequest
NameDescriptionTypeAdditional information
TripItinerary

Gets or sets Trip Itinerary data for casual itinerary

TripItinerary

None.

Trips

Gets or sets Trip data for subscription itinerary

Collection of Trip

None.

TripDays

Gets or sets the days for which subscription is to be enabled

TripDays

None.

ClientID

Gets or sets ClientID for Trip Data

integer

None.

FailOnWarnings

Gets or sets flag to fail request on warnings

boolean

None.

IsRecurring

Gets or sets flag to identify itienrary as subscription

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "tripItinerary": null,
  "trips": null,
  "tripDays": {
    "startDate": "2021-06-24T03:32:02.1034581-06:00",
    "endDate": "2021-06-24T03:32:02.1034581-06:00",
    "dateRuleType": 0,
    "days": 0
  },
  "clientID": 1,
  "failOnWarnings": true,
  "isRecurring": true
}

application/xml, text/xml

Sample:
<BookingFundingProgramsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <ClientID>1</ClientID>
  <FailOnWarnings>true</FailOnWarnings>
  <IsRecurring>true</IsRecurring>
  <TripDays>
    <DateRuleType>WeekTemplate</DateRuleType>
    <Days>None</Days>
    <EndDate>2021-06-24T03:32:02.1034581-06:00</EndDate>
    <StartDate>2021-06-24T03:32:02.1034581-06:00</StartDate>
  </TripDays>
  <TripItinerary i:nil="true" />
  <Trips i:nil="true" />
</BookingFundingProgramsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of Pair of Passenger [key] and Collection of FundingProgram [value]

Response Formats

application/json, text/json

Sample:
[
  {
    "key": {
      "passengerTypeCode": "sample string 1",
      "spaceTypeCode": "sample string 2",
      "fareTypeID": 1,
      "fundingProgramIds": [
        1,
        2
      ]
    },
    "value": [
      {
        "id": 1,
        "name": "sample string 2",
        "fundingSourceId": 3,
        "description": "sample string 4",
        "validDates": [
          {
            "fromDate": "2021-06-24T03:32:02.1154593-06:00",
            "toDate": "2021-06-24T03:32:02.1154593-06:00"
          },
          {
            "fromDate": "2021-06-24T03:32:02.1154593-06:00",
            "toDate": "2021-06-24T03:32:02.1154593-06:00"
          }
        ]
      },
      {
        "id": 1,
        "name": "sample string 2",
        "fundingSourceId": 3,
        "description": "sample string 4",
        "validDates": [
          {
            "fromDate": "2021-06-24T03:32:02.1154593-06:00",
            "toDate": "2021-06-24T03:32:02.1154593-06:00"
          },
          {
            "fromDate": "2021-06-24T03:32:02.1154593-06:00",
            "toDate": "2021-06-24T03:32:02.1154593-06:00"
          }
        ]
      }
    ]
  },
  {
    "key": {
      "passengerTypeCode": "sample string 1",
      "spaceTypeCode": "sample string 2",
      "fareTypeID": 1,
      "fundingProgramIds": [
        1,
        2
      ]
    },
    "value": [
      {
        "id": 1,
        "name": "sample string 2",
        "fundingSourceId": 3,
        "description": "sample string 4",
        "validDates": [
          {
            "fromDate": "2021-06-24T03:32:02.1154593-06:00",
            "toDate": "2021-06-24T03:32:02.1154593-06:00"
          },
          {
            "fromDate": "2021-06-24T03:32:02.1154593-06:00",
            "toDate": "2021-06-24T03:32:02.1154593-06:00"
          }
        ]
      },
      {
        "id": 1,
        "name": "sample string 2",
        "fundingSourceId": 3,
        "description": "sample string 4",
        "validDates": [
          {
            "fromDate": "2021-06-24T03:32:02.1154593-06:00",
            "toDate": "2021-06-24T03:32:02.1154593-06:00"
          },
          {
            "fromDate": "2021-06-24T03:32:02.1154593-06:00",
            "toDate": "2021-06-24T03:32:02.1154593-06:00"
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfKeyValuePairOfPassengerArrayOfFundingProgramtBLQkrsa xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
  <KeyValuePairOfPassengerArrayOfFundingProgramtBLQkrsa>
    <key xmlns:d3p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
      <d3p1:FareTypeID>1</d3p1:FareTypeID>
      <d3p1:FundingProgramIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d3p1:FundingProgramIds>
      <d3p1:PassengerTypeCode>sample string 1</d3p1:PassengerTypeCode>
      <d3p1:SpaceTypeCode>sample string 2</d3p1:SpaceTypeCode>
    </key>
    <value xmlns:d3p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
      <d3p1:FundingProgram>
        <d3p1:Description>sample string 4</d3p1:Description>
        <d3p1:FundingSourceId>3</d3p1:FundingSourceId>
        <d3p1:ID>1</d3p1:ID>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:ValidDates>
          <d3p1:FundingProgramDateWindow>
            <d3p1:FromDate>2021-06-24T03:32:02.1154593-06:00</d3p1:FromDate>
            <d3p1:ToDate>2021-06-24T03:32:02.1154593-06:00</d3p1:ToDate>
          </d3p1:FundingProgramDateWindow>
          <d3p1:FundingProgramDateWindow>
            <d3p1:FromDate>2021-06-24T03:32:02.1154593-06:00</d3p1:FromDate>
            <d3p1:ToDate>2021-06-24T03:32:02.1154593-06:00</d3p1:ToDate>
          </d3p1:FundingProgramDateWindow>
        </d3p1:ValidDates>
      </d3p1:FundingProgram>
      <d3p1:FundingProgram>
        <d3p1:Description>sample string 4</d3p1:Description>
        <d3p1:FundingSourceId>3</d3p1:FundingSourceId>
        <d3p1:ID>1</d3p1:ID>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:ValidDates>
          <d3p1:FundingProgramDateWindow>
            <d3p1:FromDate>2021-06-24T03:32:02.1154593-06:00</d3p1:FromDate>
            <d3p1:ToDate>2021-06-24T03:32:02.1154593-06:00</d3p1:ToDate>
          </d3p1:FundingProgramDateWindow>
          <d3p1:FundingProgramDateWindow>
            <d3p1:FromDate>2021-06-24T03:32:02.1154593-06:00</d3p1:FromDate>
            <d3p1:ToDate>2021-06-24T03:32:02.1154593-06:00</d3p1:ToDate>
          </d3p1:FundingProgramDateWindow>
        </d3p1:ValidDates>
      </d3p1:FundingProgram>
    </value>
  </KeyValuePairOfPassengerArrayOfFundingProgramtBLQkrsa>
  <KeyValuePairOfPassengerArrayOfFundingProgramtBLQkrsa>
    <key xmlns:d3p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
      <d3p1:FareTypeID>1</d3p1:FareTypeID>
      <d3p1:FundingProgramIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d3p1:FundingProgramIds>
      <d3p1:PassengerTypeCode>sample string 1</d3p1:PassengerTypeCode>
      <d3p1:SpaceTypeCode>sample string 2</d3p1:SpaceTypeCode>
    </key>
    <value xmlns:d3p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
      <d3p1:FundingProgram>
        <d3p1:Description>sample string 4</d3p1:Description>
        <d3p1:FundingSourceId>3</d3p1:FundingSourceId>
        <d3p1:ID>1</d3p1:ID>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:ValidDates>
          <d3p1:FundingProgramDateWindow>
            <d3p1:FromDate>2021-06-24T03:32:02.1154593-06:00</d3p1:FromDate>
            <d3p1:ToDate>2021-06-24T03:32:02.1154593-06:00</d3p1:ToDate>
          </d3p1:FundingProgramDateWindow>
          <d3p1:FundingProgramDateWindow>
            <d3p1:FromDate>2021-06-24T03:32:02.1154593-06:00</d3p1:FromDate>
            <d3p1:ToDate>2021-06-24T03:32:02.1154593-06:00</d3p1:ToDate>
          </d3p1:FundingProgramDateWindow>
        </d3p1:ValidDates>
      </d3p1:FundingProgram>
      <d3p1:FundingProgram>
        <d3p1:Description>sample string 4</d3p1:Description>
        <d3p1:FundingSourceId>3</d3p1:FundingSourceId>
        <d3p1:ID>1</d3p1:ID>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:ValidDates>
          <d3p1:FundingProgramDateWindow>
            <d3p1:FromDate>2021-06-24T03:32:02.1154593-06:00</d3p1:FromDate>
            <d3p1:ToDate>2021-06-24T03:32:02.1154593-06:00</d3p1:ToDate>
          </d3p1:FundingProgramDateWindow>
          <d3p1:FundingProgramDateWindow>
            <d3p1:FromDate>2021-06-24T03:32:02.1154593-06:00</d3p1:FromDate>
            <d3p1:ToDate>2021-06-24T03:32:02.1154593-06:00</d3p1:ToDate>
          </d3p1:FundingProgramDateWindow>
        </d3p1:ValidDates>
      </d3p1:FundingProgram>
    </value>
  </KeyValuePairOfPassengerArrayOfFundingProgramtBLQkrsa>
</ArrayOfKeyValuePairOfPassengerArrayOfFundingProgramtBLQkrsa>