pool-definitions
Operations addressed under /pool-definitions — 2 operations.
aurax-bff-redirect-get-pool-definition-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-pool-definition-list; this entry declares none of its own.
Response body, read from the service source
The route declares its response as List<PoolDefinitionDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
PoolType | int | no |
Code | string | no |
Name | string | no |
IsActive | bool | no |
StartDate | DateOnly | no |
EndDate | DateOnly? | yes |
Rates | IEnumerable<PoolDefinitionRateDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeaurax-bff-redirect-get-pool-definition-list › Responses
Success. Returns a page of records: the collection under data, with total carrying the unpaged count.
Response records carried by this page.
totalTotal matching records, ignoring paging.
aurax-bff-redirect-get-pool-definition-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-pool-definition-by-id; this entry declares none of its own.
Response body, read from the service source
The route declares its response as PoolDefinitionDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
PoolType | int | no |
Code | string | no |
Name | string | no |
IsActive | bool | no |
StartDate | DateOnly | no |
EndDate | DateOnly? | yes |
Rates | IEnumerable<PoolDefinitionRateDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRFTSHR_1 | 400 | POOL_DEFINITION_NOT_FOUND |
path Parameters
idaurax-bff-redirect-get-pool-definition-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
codeendDateidisActivenamepoolTypestartDate