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

Returns the budget categories available for a participant.

Request Information

URI Parameters

Name	Description	Type	Additional information
programid		string	Required

Body Parameters

GetParticipantBudgetCategoriesRequest

Name	Type	Additional information
ParticipantId	string	None.
DateOfService	date	None.
UseBudgets	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ParticipantId": "sample string 1",
  "DateOfService": "2024-11-16T05:00:16.2443096-05:00",
  "UseBudgets": true
}

application/xml, text/xml

Sample:

<GetParticipantBudgetCategoriesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.Budget">
  <DateOfService>2024-11-16T05:00:16.2443096-05:00</DateOfService>
  <ParticipantId>sample string 1</ParticipantId>
  <UseBudgets>true</UseBudgets>
</GetParticipantBudgetCategoriesRequest>

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

Response Information

Resource Description

GetParticipantBudgetCategoriesResponse

Name	Description	Type	Additional information
BudgetCategories		Collection of ParticipantBudgetCategory	None.

Response Formats

application/json, text/json

Sample:

{
  "BudgetCategories": [
    {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    {
      "Code": "sample string 1",
      "Description": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<GetParticipantBudgetCategoriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.Budget">
  <BudgetCategories xmlns:d2p1="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Budget">
    <d2p1:ParticipantBudgetCategory>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:Description>sample string 2</d2p1:Description>
    </d2p1:ParticipantBudgetCategory>
    <d2p1:ParticipantBudgetCategory>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:Description>sample string 2</d2p1:Description>
    </d2p1:ParticipantBudgetCategory>
  </BudgetCategories>
</GetParticipantBudgetCategoriesResponse>