POST api/allocations/select

Retrieves a list of allocations that match the given criteria.

Request Information

URI Parameters

None.

Body Parameters

The criteria model to filter allocations by.

AllocationFilterCriteria
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

BudgetId

globally unique identifier

None.

TenantId

globally unique identifier

None.

UserId

globally unique identifier

None.

BudgetFromDate

date

None.

BudgetToDate

date

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "c5ad4e28-09b0-4a42-afa2-3480f21431a8",
  "BudgetId": "bfc0aa7d-9659-4bfc-8b19-c7b18dfc5d90",
  "TenantId": "defb7b83-5dda-42aa-b1bb-37a97d21a36f",
  "UserId": "61efd25f-4302-4a2c-8b30-7f830e28b675",
  "BudgetFromDate": "2025-12-06T02:24:53.8228128+00:00",
  "BudgetToDate": "2025-12-06T02:24:53.8228128+00:00"
}

application/xml, text/xml

Sample:
<AllocationFilterCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Pay.Models.FilterCriteria">
  <BudgetFromDate>2025-12-06T02:24:53.8228128+00:00</BudgetFromDate>
  <BudgetId>bfc0aa7d-9659-4bfc-8b19-c7b18dfc5d90</BudgetId>
  <BudgetToDate>2025-12-06T02:24:53.8228128+00:00</BudgetToDate>
  <Id>c5ad4e28-09b0-4a42-afa2-3480f21431a8</Id>
  <TenantId>defb7b83-5dda-42aa-b1bb-37a97d21a36f</TenantId>
  <UserId>61efd25f-4302-4a2c-8b30-7f830e28b675</UserId>
</AllocationFilterCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.