POST api/{programid}/Participant/Budget/GetPeriods

Returns the list of periods, auth. or budget start and end dates, for a participant. Filtered to only return from a year ago to date.

Request Information

URI Parameters

Name	Description	Type	Additional information
programid		string	Required

Body Parameters

GetParticipantBudgetPeriodsRequest

Name	Type	Additional information
ParticipantId	string	None.
FromDate	date	None.
ToDate	date	None.
UseBudgets	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ParticipantId": "sample string 1",
  "FromDate": "2024-11-16T04:55:34.0511908-05:00",
  "ToDate": "2024-11-16T04:55:34.0511908-05:00",
  "UseBudgets": true
}

application/xml, text/xml

Sample:

<GetParticipantBudgetPeriodsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.Budget">
  <FromDate>2024-11-16T04:55:34.0511908-05:00</FromDate>
  <ParticipantId>sample string 1</ParticipantId>
  <ToDate>2024-11-16T04:55:34.0511908-05:00</ToDate>
  <UseBudgets>true</UseBudgets>
</GetParticipantBudgetPeriodsRequest>

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 'GetParticipantBudgetPeriodsRequest'.

Response Information

Resource Description

GetParticipantBudgetPeriodsResponse

Name	Description	Type	Additional information
BudgetPeriods		Collection of ParticipantBudgetPeriod	None.

Response Formats

application/json, text/json

Sample:

{
  "BudgetPeriods": [
    {
      "StartDate": "2024-11-16T04:55:34.0511908-05:00",
      "EndDate": "2024-11-16T04:55:34.0511908-05:00"
    },
    {
      "StartDate": "2024-11-16T04:55:34.0511908-05:00",
      "EndDate": "2024-11-16T04:55:34.0511908-05:00"
    }
  ]
}

application/xml, text/xml

Sample:

<GetParticipantBudgetPeriodsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.Budget">
  <BudgetPeriods xmlns:d2p1="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Budget">
    <d2p1:ParticipantBudgetPeriod>
      <d2p1:EndDate>2024-11-16T04:55:34.0511908-05:00</d2p1:EndDate>
      <d2p1:StartDate>2024-11-16T04:55:34.0511908-05:00</d2p1:StartDate>
    </d2p1:ParticipantBudgetPeriod>
    <d2p1:ParticipantBudgetPeriod>
      <d2p1:EndDate>2024-11-16T04:55:34.0511908-05:00</d2p1:EndDate>
      <d2p1:StartDate>2024-11-16T04:55:34.0511908-05:00</d2p1:StartDate>
    </d2p1:ParticipantBudgetPeriod>
  </BudgetPeriods>
</GetParticipantBudgetPeriodsResponse>