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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Employers;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public partial class Address
    {
        public virtual string AddressLine1 { get; set; }
        public virtual string AddressLine2 { get; set; }
        public virtual string Suburb { get; set; }
        public virtual string StateTerritory { get; set; }
        public virtual string Postcode { get; set; }
    }

    public partial class BusinessDetails
    {
        public virtual string TradingName { get; set; }
        public virtual string AustralianBusinessNumber { get; set; }
        public virtual string AustralianCompanyNumber { get; set; }
    }

    public partial class Contact
    {
        public virtual string ContactName { get; set; }
        public virtual string Email { get; set; }
        public virtual string PhoneNumber { get; set; }
        public virtual string PreferredContactMethod { get; set; }
    }

    public partial class Employer
        : IIdentifiableResource
    {
        public virtual string Name { get; set; }
        public virtual BusinessDetails BusinessDetails { get; set; }
        public virtual Contact Contact { get; set; }
        public virtual Address PostalAddress { get; set; }
        public virtual Address PhysicalAddress { get; set; }
        public virtual string Id { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class GetOperationTenanted<TResponse>
        : GetOperationUnTenanted<TResponse>, ITenantedRequest
    {
        public virtual string OrganisationId { get; set; }
    }

    public partial class GetOperationUnTenanted<TResponse>
        : IHasGetOptions, IGet
    {
        public virtual string Embed { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Employers
{
    public partial class SetBusinessDetailsRequest
        : GetOperationTenanted<SetBusinessDetailsResponse>
    {
        public virtual string Id { get; set; }
        public virtual string TradingName { get; set; }
        public virtual string AustralianBusinessNumber { get; set; }
        public virtual string AustralianCompanyNumber { get; set; }
        public virtual string ContactName { get; set; }
        public virtual string Email { get; set; }
        public virtual string PhoneNumber { get; set; }
        public virtual string PreferredContactMethod { get; set; }
    }

    public partial class SetBusinessDetailsResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual Employer Employer { get; set; }
    }

}

C# SetBusinessDetailsRequest DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"String","tradingName":"String","australianBusinessNumber":"String","australianCompanyNumber":"String","contactName":"String","email":"String","phoneNumber":"String","preferredContactMethod":"String","organisationId":"String","embed":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}