POST api/{programid}/ProgramInformation

Description: Fetching the program information from client program and budget information

Request Information

URI Parameters

Name	Description	Type	Additional information
programid		string	Required

Body Parameters

ClientProgram

Name	Type	Additional information
Code	string	None.
TimesheetBeginDay	string	None.
TimesheetEndDay	string	None.
DaysonTimesheet	string	None.
ConsumerSpendingLimit	string	None.
ConsumerSpendingTimeframe	string	None.
ConsumerSpendingDateRange	string	None.
IndividualBudgetAllowed	string	None.
ExpenseAccountEndDate	string	None.
SweepBudget	string	None.
MonthlyBudgetSweepTo	string	None.
UseExemptFunction	string	None.
SweepToBudgetLable1	string	None.
SweepToBudgetLable2	string	None.
SweepToBudgetLable3	string	None.
NonProgramConsumerNo_	string	None.
ProgramBudget	Collection of ProgramBudget	None.

Request Formats

application/json, text/json

Sample:

{
  "Code": "sample string 1",
  "TimesheetBeginDay": "sample string 2",
  "TimesheetEndDay": "sample string 3",
  "DaysonTimesheet": "sample string 4",
  "ConsumerSpendingLimit": "sample string 5",
  "ConsumerSpendingTimeframe": "sample string 6",
  "ConsumerSpendingDateRange": "sample string 7",
  "IndividualBudgetAllowed": "sample string 8",
  "ExpenseAccountEndDate": "sample string 9",
  "SweepBudget": "sample string 10",
  "MonthlyBudgetSweepTo": "sample string 11",
  "UseExemptFunction": "sample string 12",
  "SweepToBudgetLable1": "sample string 13",
  "SweepToBudgetLable2": "sample string 14",
  "SweepToBudgetLable3": "sample string 15",
  "NonProgramConsumerNo_": "sample string 16",
  "ProgramBudget": [
    {
      "LineNo": "sample string 1",
      "ProgramCode": "sample string 2",
      "BudgetAmount": "sample string 3",
      "StartDate": "sample string 4",
      "EndDate": "sample string 5",
      "CurrentBudget": "sample string 6",
      "BudgetDateType": "sample string 7"
    },
    {
      "LineNo": "sample string 1",
      "ProgramCode": "sample string 2",
      "BudgetAmount": "sample string 3",
      "StartDate": "sample string 4",
      "EndDate": "sample string 5",
      "CurrentBudget": "sample string 6",
      "BudgetDateType": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:

<ClientProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.NavisionData.CommonClasses.ProgInformation">
  <Code>sample string 1</Code>
  <ConsumerSpendingDateRange>sample string 7</ConsumerSpendingDateRange>
  <ConsumerSpendingLimit>sample string 5</ConsumerSpendingLimit>
  <ConsumerSpendingTimeframe>sample string 6</ConsumerSpendingTimeframe>
  <DaysonTimesheet>sample string 4</DaysonTimesheet>
  <ExpenseAccountEndDate>sample string 9</ExpenseAccountEndDate>
  <IndividualBudgetAllowed>sample string 8</IndividualBudgetAllowed>
  <MonthlyBudgetSweepTo>sample string 11</MonthlyBudgetSweepTo>
  <NonProgramConsumerNo_>sample string 16</NonProgramConsumerNo_>
  <ProgramBudget>
    <ProgramBudget>
      <BudgetAmount>sample string 3</BudgetAmount>
      <BudgetDateType>sample string 7</BudgetDateType>
      <CurrentBudget>sample string 6</CurrentBudget>
      <EndDate>sample string 5</EndDate>
      <LineNo>sample string 1</LineNo>
      <ProgramCode>sample string 2</ProgramCode>
      <StartDate>sample string 4</StartDate>
    </ProgramBudget>
    <ProgramBudget>
      <BudgetAmount>sample string 3</BudgetAmount>
      <BudgetDateType>sample string 7</BudgetDateType>
      <CurrentBudget>sample string 6</CurrentBudget>
      <EndDate>sample string 5</EndDate>
      <LineNo>sample string 1</LineNo>
      <ProgramCode>sample string 2</ProgramCode>
      <StartDate>sample string 4</StartDate>
    </ProgramBudget>
  </ProgramBudget>
  <SweepBudget>sample string 10</SweepBudget>
  <SweepToBudgetLable1>sample string 13</SweepToBudgetLable1>
  <SweepToBudgetLable2>sample string 14</SweepToBudgetLable2>
  <SweepToBudgetLable3>sample string 15</SweepToBudgetLable3>
  <TimesheetBeginDay>sample string 2</TimesheetBeginDay>
  <TimesheetEndDay>sample string 3</TimesheetEndDay>
  <UseExemptFunction>sample string 12</UseExemptFunction>
</ClientProgram>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClientProgram'.

Response Information

Resource Description

ClientProgram

Name	Type	Additional information
Code	string	None.
TimesheetBeginDay	string	None.
TimesheetEndDay	string	None.
DaysonTimesheet	string	None.
ConsumerSpendingLimit	string	None.
ConsumerSpendingTimeframe	string	None.
ConsumerSpendingDateRange	string	None.
IndividualBudgetAllowed	string	None.
ExpenseAccountEndDate	string	None.
SweepBudget	string	None.
MonthlyBudgetSweepTo	string	None.
UseExemptFunction	string	None.
SweepToBudgetLable1	string	None.
SweepToBudgetLable2	string	None.
SweepToBudgetLable3	string	None.
NonProgramConsumerNo_	string	None.
ProgramBudget	Collection of ProgramBudget	None.

Response Formats

application/json, text/json

Sample:

{
  "Code": "sample string 1",
  "TimesheetBeginDay": "sample string 2",
  "TimesheetEndDay": "sample string 3",
  "DaysonTimesheet": "sample string 4",
  "ConsumerSpendingLimit": "sample string 5",
  "ConsumerSpendingTimeframe": "sample string 6",
  "ConsumerSpendingDateRange": "sample string 7",
  "IndividualBudgetAllowed": "sample string 8",
  "ExpenseAccountEndDate": "sample string 9",
  "SweepBudget": "sample string 10",
  "MonthlyBudgetSweepTo": "sample string 11",
  "UseExemptFunction": "sample string 12",
  "SweepToBudgetLable1": "sample string 13",
  "SweepToBudgetLable2": "sample string 14",
  "SweepToBudgetLable3": "sample string 15",
  "NonProgramConsumerNo_": "sample string 16",
  "ProgramBudget": [
    {
      "LineNo": "sample string 1",
      "ProgramCode": "sample string 2",
      "BudgetAmount": "sample string 3",
      "StartDate": "sample string 4",
      "EndDate": "sample string 5",
      "CurrentBudget": "sample string 6",
      "BudgetDateType": "sample string 7"
    },
    {
      "LineNo": "sample string 1",
      "ProgramCode": "sample string 2",
      "BudgetAmount": "sample string 3",
      "StartDate": "sample string 4",
      "EndDate": "sample string 5",
      "CurrentBudget": "sample string 6",
      "BudgetDateType": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:

<ClientProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.NavisionData.CommonClasses.ProgInformation">
  <Code>sample string 1</Code>
  <ConsumerSpendingDateRange>sample string 7</ConsumerSpendingDateRange>
  <ConsumerSpendingLimit>sample string 5</ConsumerSpendingLimit>
  <ConsumerSpendingTimeframe>sample string 6</ConsumerSpendingTimeframe>
  <DaysonTimesheet>sample string 4</DaysonTimesheet>
  <ExpenseAccountEndDate>sample string 9</ExpenseAccountEndDate>
  <IndividualBudgetAllowed>sample string 8</IndividualBudgetAllowed>
  <MonthlyBudgetSweepTo>sample string 11</MonthlyBudgetSweepTo>
  <NonProgramConsumerNo_>sample string 16</NonProgramConsumerNo_>
  <ProgramBudget>
    <ProgramBudget>
      <BudgetAmount>sample string 3</BudgetAmount>
      <BudgetDateType>sample string 7</BudgetDateType>
      <CurrentBudget>sample string 6</CurrentBudget>
      <EndDate>sample string 5</EndDate>
      <LineNo>sample string 1</LineNo>
      <ProgramCode>sample string 2</ProgramCode>
      <StartDate>sample string 4</StartDate>
    </ProgramBudget>
    <ProgramBudget>
      <BudgetAmount>sample string 3</BudgetAmount>
      <BudgetDateType>sample string 7</BudgetDateType>
      <CurrentBudget>sample string 6</CurrentBudget>
      <EndDate>sample string 5</EndDate>
      <LineNo>sample string 1</LineNo>
      <ProgramCode>sample string 2</ProgramCode>
      <StartDate>sample string 4</StartDate>
    </ProgramBudget>
  </ProgramBudget>
  <SweepBudget>sample string 10</SweepBudget>
  <SweepToBudgetLable1>sample string 13</SweepToBudgetLable1>
  <SweepToBudgetLable2>sample string 14</SweepToBudgetLable2>
  <SweepToBudgetLable3>sample string 15</SweepToBudgetLable3>
  <TimesheetBeginDay>sample string 2</TimesheetBeginDay>
  <TimesheetEndDay>sample string 3</TimesheetEndDay>
  <UseExemptFunction>sample string 12</UseExemptFunction>
</ClientProgram>