Billiecart API

<back to all web services

SetBusinessDetailsRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
PUT/employers/{Id}/business-details
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class SetBusinessDetailsRequest extends GetOperationTenanted<SetBusinessDetailsResponse>
    {
        public String id = null;
        public String tradingName = null;
        public String australianBusinessNumber = null;
        public String australianCompanyNumber = null;
        public String contactName = null;
        public String email = null;
        public String phoneNumber = null;
        public String preferredContactMethod = null;
        
        public String getId() { return id; }
        public SetBusinessDetailsRequest setId(String value) { this.id = value; return this; }
        public String getTradingName() { return tradingName; }
        public SetBusinessDetailsRequest setTradingName(String value) { this.tradingName = value; return this; }
        public String getAustralianBusinessNumber() { return australianBusinessNumber; }
        public SetBusinessDetailsRequest setAustralianBusinessNumber(String value) { this.australianBusinessNumber = value; return this; }
        public String getAustralianCompanyNumber() { return australianCompanyNumber; }
        public SetBusinessDetailsRequest setAustralianCompanyNumber(String value) { this.australianCompanyNumber = value; return this; }
        public String getContactName() { return contactName; }
        public SetBusinessDetailsRequest setContactName(String value) { this.contactName = value; return this; }
        public String getEmail() { return email; }
        public SetBusinessDetailsRequest setEmail(String value) { this.email = value; return this; }
        public String getPhoneNumber() { return phoneNumber; }
        public SetBusinessDetailsRequest setPhoneNumber(String value) { this.phoneNumber = value; return this; }
        public String getPreferredContactMethod() { return preferredContactMethod; }
        public SetBusinessDetailsRequest setPreferredContactMethod(String value) { this.preferredContactMethod = value; return this; }
    }

    public static class GetOperationTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements ITenantedRequest
    {
        public String organisationId = null;
        
        public String getOrganisationId() { return organisationId; }
        public GetOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
    }

    public static class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
    {
        public String embed = null;
        
        public String getEmbed() { return embed; }
        public GetOperationUnTenanted<TResponse> setEmbed(String value) { this.embed = value; return this; }
    }

    public static class SetBusinessDetailsResponse
    {
        public ResponseStatus responseStatus = null;
        public Employer employer = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public SetBusinessDetailsResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Employer getEmployer() { return employer; }
        public SetBusinessDetailsResponse setEmployer(Employer value) { this.employer = value; return this; }
    }

    public static class Employer implements IIdentifiableResource
    {
        public String name = null;
        public BusinessDetails businessDetails = null;
        public Contact contact = null;
        public Address postalAddress = null;
        public Address physicalAddress = null;
        public String id = null;
        
        public String getName() { return name; }
        public Employer setName(String value) { this.name = value; return this; }
        public BusinessDetails getBusinessDetails() { return businessDetails; }
        public Employer setBusinessDetails(BusinessDetails value) { this.businessDetails = value; return this; }
        public Contact getContact() { return contact; }
        public Employer setContact(Contact value) { this.contact = value; return this; }
        public Address getPostalAddress() { return postalAddress; }
        public Employer setPostalAddress(Address value) { this.postalAddress = value; return this; }
        public Address getPhysicalAddress() { return physicalAddress; }
        public Employer setPhysicalAddress(Address value) { this.physicalAddress = value; return this; }
        public String getId() { return id; }
        public Employer setId(String value) { this.id = value; return this; }
    }

    public static class BusinessDetails
    {
        public String tradingName = null;
        public String australianBusinessNumber = null;
        public String australianCompanyNumber = null;
        
        public String getTradingName() { return tradingName; }
        public BusinessDetails setTradingName(String value) { this.tradingName = value; return this; }
        public String getAustralianBusinessNumber() { return australianBusinessNumber; }
        public BusinessDetails setAustralianBusinessNumber(String value) { this.australianBusinessNumber = value; return this; }
        public String getAustralianCompanyNumber() { return australianCompanyNumber; }
        public BusinessDetails setAustralianCompanyNumber(String value) { this.australianCompanyNumber = value; return this; }
    }

    public static class Contact
    {
        public String contactName = null;
        public String email = null;
        public String phoneNumber = null;
        public String preferredContactMethod = null;
        
        public String getContactName() { return contactName; }
        public Contact setContactName(String value) { this.contactName = value; return this; }
        public String getEmail() { return email; }
        public Contact setEmail(String value) { this.email = value; return this; }
        public String getPhoneNumber() { return phoneNumber; }
        public Contact setPhoneNumber(String value) { this.phoneNumber = value; return this; }
        public String getPreferredContactMethod() { return preferredContactMethod; }
        public Contact setPreferredContactMethod(String value) { this.preferredContactMethod = value; return this; }
    }

    public static class Address
    {
        public String addressLine1 = null;
        public String addressLine2 = null;
        public String suburb = null;
        public String stateTerritory = null;
        public String postcode = null;
        
        public String getAddressLine1() { return addressLine1; }
        public Address setAddressLine1(String value) { this.addressLine1 = value; return this; }
        public String getAddressLine2() { return addressLine2; }
        public Address setAddressLine2(String value) { this.addressLine2 = value; return this; }
        public String getSuburb() { return suburb; }
        public Address setSuburb(String value) { this.suburb = value; return this; }
        public String getStateTerritory() { return stateTerritory; }
        public Address setStateTerritory(String value) { this.stateTerritory = value; return this; }
        public String getPostcode() { return postcode; }
        public Address setPostcode(String value) { this.postcode = value; return this; }
    }

}

Java SetBusinessDetailsRequest 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}/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>