Billiecart API

<back to all web services

CreateEmployerRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/employers

export class PostOperationUnTenanted<TResponse> implements IPost
{

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

export class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

    public constructor(init?: Partial<PostOperationTenanted<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 CreateEmployerResponse
{
    public responseStatus?: ResponseStatus;
    public employer?: Employer;

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

export class CreateEmployerRequest extends PostOperationTenanted<CreateEmployerResponse>
{
    public name?: string;

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

TypeScript CreateEmployerRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /employers HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"name":"String","organisationId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}