| Requires the role: | manager |
| PUT | /employers/{Id}/business-details |
|---|
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 GetOperationTenanted(Generic[TResponse], GetOperationUnTenanted[TResponse], ITenantedRequest):
organisation_id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BusinessDetails:
trading_name: Optional[str] = None
australian_business_number: Optional[str] = None
australian_company_number: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Contact:
contact_name: Optional[str] = None
email: Optional[str] = None
phone_number: Optional[str] = None
preferred_contact_method: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Address:
address_line1: Optional[str] = None
address_line2: Optional[str] = None
suburb: Optional[str] = None
state_territory: Optional[str] = None
postcode: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Employer(IIdentifiableResource):
name: Optional[str] = None
business_details: Optional[BusinessDetails] = None
contact: Optional[Contact] = None
postal_address: Optional[Address] = None
physical_address: Optional[Address] = None
id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SetBusinessDetailsResponse:
response_status: Optional[ResponseStatus] = None
employer: Optional[Employer] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SetBusinessDetailsRequest(GetOperationTenanted[SetBusinessDetailsResponse]):
id: Optional[str] = None
trading_name: Optional[str] = None
australian_business_number: Optional[str] = None
australian_company_number: Optional[str] = None
contact_name: Optional[str] = None
email: Optional[str] = None
phone_number: Optional[str] = None
preferred_contact_method: Optional[str] = None
Python SetBusinessDetailsRequest 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.
PUT /employers/{Id}/business-details HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SetBusinessDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Employers">
<Embed xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</Embed>
<OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
<AustralianBusinessNumber>String</AustralianBusinessNumber>
<AustralianCompanyNumber>String</AustralianCompanyNumber>
<ContactName>String</ContactName>
<Email>String</Email>
<Id>String</Id>
<PhoneNumber>String</PhoneNumber>
<PreferredContactMethod>String</PreferredContactMethod>
<TradingName>String</TradingName>
</SetBusinessDetailsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SetBusinessDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Employers">
<Employer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
<d2p1:BusinessDetails>
<d2p1:AustralianBusinessNumber>String</d2p1:AustralianBusinessNumber>
<d2p1:AustralianCompanyNumber>String</d2p1:AustralianCompanyNumber>
<d2p1:TradingName>String</d2p1:TradingName>
</d2p1:BusinessDetails>
<d2p1:Contact>
<d2p1:ContactName>String</d2p1:ContactName>
<d2p1:Email>String</d2p1:Email>
<d2p1:PhoneNumber>String</d2p1:PhoneNumber>
<d2p1:PreferredContactMethod>String</d2p1:PreferredContactMethod>
</d2p1:Contact>
<d2p1:Id>String</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
<d2p1:PhysicalAddress>
<d2p1:AddressLine1>String</d2p1:AddressLine1>
<d2p1:AddressLine2>String</d2p1:AddressLine2>
<d2p1:Postcode>String</d2p1:Postcode>
<d2p1:StateTerritory>String</d2p1:StateTerritory>
<d2p1:Suburb>String</d2p1:Suburb>
</d2p1:PhysicalAddress>
<d2p1:PostalAddress>
<d2p1:AddressLine1>String</d2p1:AddressLine1>
<d2p1:AddressLine2>String</d2p1:AddressLine2>
<d2p1:Postcode>String</d2p1:Postcode>
<d2p1:StateTerritory>String</d2p1:StateTerritory>
<d2p1:Suburb>String</d2p1:Suburb>
</d2p1:PostalAddress>
</Employer>
<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>
</SetBusinessDetailsResponse>