Billiecart API

SetPhysicalAddressRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
PUT	/employers/{Id}/physical-address

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 SetPhysicalAddressResponse:
    response_status: Optional[ResponseStatus] = None
    employer: Optional[Employer] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SetPhysicalAddressRequest(GetOperationTenanted[SetPhysicalAddressResponse]):
    id: Optional[str] = None
    address_line1: Optional[str] = None
    address_line2: Optional[str] = None
    suburb: Optional[str] = None
    state_territory: Optional[str] = None
    postcode: Optional[str] = None

Python SetPhysicalAddressRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /employers/{Id}/physical-address HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	addressLine1: String,
	addressLine2: String,
	suburb: String,
	stateTerritory: String,
	postcode: String,
	organisationId: String,
	embed: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	employer: 
	{
		name: String,
		businessDetails: 
		{
			tradingName: String,
			australianBusinessNumber: String,
			australianCompanyNumber: String
		},
		contact: 
		{
			contactName: String,
			email: String,
			phoneNumber: String,
			preferredContactMethod: String
		},
		postalAddress: 
		{
			addressLine1: String,
			addressLine2: String,
			suburb: String,
			stateTerritory: String,
			postcode: String
		},
		physicalAddress: 
		{
			addressLine1: String,
			addressLine2: String,
			suburb: String,
			stateTerritory: String,
			postcode: String
		},
		id: String
	}
}