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

Returns the participant budget snapshot based on the selected period and budget category.

Request Information

URI Parameters

Name	Description	Type	Additional information
programid	Program Id	string	Required

Body Parameters

Request

GetParticipantBudgetSnapshotRequest

Name	Type	Additional information
ParticipantId	string	None.
PeriodStartDate	date	None.
PeriodEndDate	date	None.
CategoryCode	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ParticipantId": "sample string 1",
  "PeriodStartDate": "2024-11-16T09:29:11.7167845+00:00",
  "PeriodEndDate": "2024-11-16T09:29:11.7167845+00:00",
  "CategoryCode": "sample string 4"
}

application/xml, text/xml

Sample:

<GetParticipantBudgetSnapshotRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.Budget">
  <CategoryCode>sample string 4</CategoryCode>
  <ParticipantId>sample string 1</ParticipantId>
  <PeriodEndDate>2024-11-16T09:29:11.7167845+00:00</PeriodEndDate>
  <PeriodStartDate>2024-11-16T09:29:11.7167845+00:00</PeriodStartDate>
</GetParticipantBudgetSnapshotRequest>

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

Response Information

Resource Description

GetParticipantBudgetSnapshotResponse

Name	Description	Type	Additional information
BudgetSnapshots		Collection of ParticipantBudgetSnapshot	None.

Response Formats

application/json, text/json

Sample:

{
  "BudgetSnapshots": [
    {
      "Label": "sample string 1",
      "Description": "sample string 2",
      "Amount": 3.0,
      "Units": "sample string 4"
    },
    {
      "Label": "sample string 1",
      "Description": "sample string 2",
      "Amount": 3.0,
      "Units": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<GetParticipantBudgetSnapshotResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.Budget">
  <BudgetSnapshots xmlns:d2p1="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Budget">
    <d2p1:ParticipantBudgetSnapshot>
      <d2p1:Amount>3</d2p1:Amount>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:Label>sample string 1</d2p1:Label>
      <d2p1:Units>sample string 4</d2p1:Units>
    </d2p1:ParticipantBudgetSnapshot>
    <d2p1:ParticipantBudgetSnapshot>
      <d2p1:Amount>3</d2p1:Amount>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:Label>sample string 1</d2p1:Label>
      <d2p1:Units>sample string 4</d2p1:Units>
    </d2p1:ParticipantBudgetSnapshot>
  </BudgetSnapshots>
</GetParticipantBudgetSnapshotResponse>