Billiecart API

SetPostalAddressRequest

**Requires Authentication**
Requires the role:	manager

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


export class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
    public embed?: string;

    public constructor(init?: Partial<GetOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}

export class GetOperationTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

    public constructor(init?: Partial<GetOperationTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}

export class BusinessDetails
{
    public tradingName?: string;
    public australianBusinessNumber?: string;
    public australianCompanyNumber?: string;

    public constructor(init?: Partial<BusinessDetails>) { (Object as any).assign(this, init); }
}

export class Contact
{
    public contactName?: string;
    public email?: string;
    public phoneNumber?: string;
    public preferredContactMethod?: string;

    public constructor(init?: Partial<Contact>) { (Object as any).assign(this, init); }
}

export class Address
{
    public addressLine1?: string;
    public addressLine2?: string;
    public suburb?: string;
    public stateTerritory?: string;
    public postcode?: string;

    public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}

export class Employer implements IIdentifiableResource
{
    public name?: string;
    public businessDetails?: BusinessDetails;
    public contact?: Contact;
    public postalAddress?: Address;
    public physicalAddress?: Address;
    public id?: string;

    public constructor(init?: Partial<Employer>) { (Object as any).assign(this, init); }
}

export class SetPostalAddressResponse
{
    public responseStatus?: ResponseStatus;
    public employer?: Employer;

    public constructor(init?: Partial<SetPostalAddressResponse>) { (Object as any).assign(this, init); }
}

export class SetPostalAddressRequest extends GetOperationTenanted<SetPostalAddressResponse>
{
    public id?: string;
    public addressLine1?: string;
    public addressLine2?: string;
    public suburb?: string;
    public stateTerritory?: string;
    public postcode?: string;

    public constructor(init?: Partial<SetPostalAddressRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript SetPostalAddressRequest DTOs

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

HTTP + XML

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

PUT /employers/{Id}/postal-address HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SetPostalAddressRequest 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>
  <AddressLine1>String</AddressLine1>
  <AddressLine2>String</AddressLine2>
  <Id>String</Id>
  <Postcode>String</Postcode>
  <StateTerritory>String</StateTerritory>
  <Suburb>String</Suburb>
</SetPostalAddressRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SetPostalAddressResponse 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>
</SetPostalAddressResponse>