| Requires the role: | holder |
| GET | /packages/held |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
TResponse = TypeVar('TResponse')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IHasGetOptions, IGet):
embed: Optional[str] = None
@staticmethod
def response_type(): return TResponse
TResponse = TypeVar('TResponse')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOperationUnTenanted(Generic[TResponse], GetOperationUnTenanted[TResponse], IHasSearchOptions):
distinct: Optional[str] = None
limit: Optional[int] = None
offset: Optional[int] = None
sort: Optional[str] = None
filter: Optional[str] = None
search: Optional[str] = None
TResponse = TypeVar('TResponse')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOperationTenanted(Generic[TResponse], SearchOperationUnTenanted[TResponse], ITenantedRequest):
organisation_id: Optional[str] = None
class SortDirection(str, Enum):
ASCENDING = 'Ascending'
DESCENDING = 'Descending'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Sorting:
by: Optional[str] = None
direction: Optional[SortDirection] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Filtering:
fields: Optional[List[str]] = None
search: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchMetadata:
total: Optional[int] = None
limit: Optional[int] = None
offset: Optional[int] = None
sort: Optional[Sorting] = None
filter: Optional[Filtering] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOperationResponse:
metadata: Optional[SearchMetadata] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalaryPackageSummary(IIdentifiableResource):
customer_id: Optional[str] = None
customer_first_name: Optional[str] = None
customer_last_name: Optional[str] = None
employer_name: Optional[str] = None
vehicle_license_plate: Optional[str] = None
salary_sacrifice_amount: Optional[Decimal] = None
current_balance: Optional[Decimal] = None
pre_tax_deduction: Optional[Decimal] = None
post_tax_deduction: Optional[Decimal] = None
lease_term: Optional[int] = None
employer_id: Optional[str] = None
status: Optional[str] = None
id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchHeldSalaryPackagesResponse(SearchOperationResponse):
response_status: Optional[ResponseStatus] = None
salary_packages: Optional[List[SalaryPackageSummary]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchHeldSalaryPackagesRequest(SearchOperationTenanted[SearchHeldSalaryPackagesResponse]):
pass
Python SearchHeldSalaryPackagesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /packages/held HTTP/1.1 Host: staging-api.billiecart.com.au Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SearchHeldSalaryPackagesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.SalaryPackages">
<Metadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">
<d2p1:Filter>
<d2p1:Fields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:Fields>
<d2p1:Search>String</d2p1:Search>
</d2p1:Filter>
<d2p1:Limit>0</d2p1:Limit>
<d2p1:Offset>0</d2p1:Offset>
<d2p1:Sort>
<d2p1:By>String</d2p1:By>
<d2p1:Direction>Ascending</d2p1:Direction>
</d2p1:Sort>
<d2p1:Total>0</d2p1:Total>
</Metadata>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<SalaryPackages xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
<d2p1:SalaryPackageSummary>
<d2p1:CurrentBalance>0</d2p1:CurrentBalance>
<d2p1:CustomerFirstName>String</d2p1:CustomerFirstName>
<d2p1:CustomerId>String</d2p1:CustomerId>
<d2p1:CustomerLastName>String</d2p1:CustomerLastName>
<d2p1:EmployerId>String</d2p1:EmployerId>
<d2p1:EmployerName>String</d2p1:EmployerName>
<d2p1:Id>String</d2p1:Id>
<d2p1:LeaseTerm>0</d2p1:LeaseTerm>
<d2p1:PostTaxDeduction>0</d2p1:PostTaxDeduction>
<d2p1:PreTaxDeduction>0</d2p1:PreTaxDeduction>
<d2p1:SalarySacrificeAmount>0</d2p1:SalarySacrificeAmount>
<d2p1:Status>String</d2p1:Status>
<d2p1:VehicleLicensePlate>String</d2p1:VehicleLicensePlate>
</d2p1:SalaryPackageSummary>
</SalaryPackages>
</SearchHeldSalaryPackagesResponse>