Requires the role: | manager |
PUT | /employers/{Id} |
---|
export class PutOperationUnTenanted<TResponse> implements IPut
{
public constructor(init?: Partial<PutOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}
export class PutOperationTenanted<TResponse> extends PutOperationUnTenanted<TResponse> implements ITenantedRequest
{
public organisationId?: string;
public constructor(init?: Partial<PutOperationTenanted<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 UpdateEmployerResponse
{
public responseStatus?: ResponseStatus;
public employer?: Employer;
public constructor(init?: Partial<UpdateEmployerResponse>) { (Object as any).assign(this, init); }
}
export class UpdateEmployerRequest extends PutOperationTenanted<UpdateEmployerResponse>
{
public id?: string;
public name?: string;
public constructor(init?: Partial<UpdateEmployerRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript UpdateEmployerRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /employers/{Id} HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"id":"String","name":"String","organisationId":"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"}}