| Requires the role: | manager |
| POST | /employers |
|---|
import 'package:servicestack/servicestack.dart';
abstract class PostOperationUnTenanted<TResponse> implements IPost
{
PostOperationUnTenanted();
PostOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
fromMap(Map<String, dynamic> json) {
return this;
}
Map<String, dynamic> toJson() => {};
getTypeName() => "PostOperationUnTenanted<$TResponse>";
TypeContext? context = _ctx;
}
abstract class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
{
String? organisationId;
PostOperationTenanted({this.organisationId});
PostOperationTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
organisationId = json['organisationId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'organisationId': organisationId
});
getTypeName() => "PostOperationTenanted<$TResponse>";
TypeContext? context = _ctx;
}
class BusinessDetails implements IConvertible
{
String? tradingName;
String? australianBusinessNumber;
String? australianCompanyNumber;
BusinessDetails({this.tradingName,this.australianBusinessNumber,this.australianCompanyNumber});
BusinessDetails.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
tradingName = json['tradingName'];
australianBusinessNumber = json['australianBusinessNumber'];
australianCompanyNumber = json['australianCompanyNumber'];
return this;
}
Map<String, dynamic> toJson() => {
'tradingName': tradingName,
'australianBusinessNumber': australianBusinessNumber,
'australianCompanyNumber': australianCompanyNumber
};
getTypeName() => "BusinessDetails";
TypeContext? context = _ctx;
}
class Contact implements IConvertible
{
String? contactName;
String? email;
String? phoneNumber;
String? preferredContactMethod;
Contact({this.contactName,this.email,this.phoneNumber,this.preferredContactMethod});
Contact.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
contactName = json['contactName'];
email = json['email'];
phoneNumber = json['phoneNumber'];
preferredContactMethod = json['preferredContactMethod'];
return this;
}
Map<String, dynamic> toJson() => {
'contactName': contactName,
'email': email,
'phoneNumber': phoneNumber,
'preferredContactMethod': preferredContactMethod
};
getTypeName() => "Contact";
TypeContext? context = _ctx;
}
class Address implements IConvertible
{
String? addressLine1;
String? addressLine2;
String? suburb;
String? stateTerritory;
String? postcode;
Address({this.addressLine1,this.addressLine2,this.suburb,this.stateTerritory,this.postcode});
Address.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
addressLine1 = json['addressLine1'];
addressLine2 = json['addressLine2'];
suburb = json['suburb'];
stateTerritory = json['stateTerritory'];
postcode = json['postcode'];
return this;
}
Map<String, dynamic> toJson() => {
'addressLine1': addressLine1,
'addressLine2': addressLine2,
'suburb': suburb,
'stateTerritory': stateTerritory,
'postcode': postcode
};
getTypeName() => "Address";
TypeContext? context = _ctx;
}
class Employer implements IIdentifiableResource, IConvertible
{
String? name;
BusinessDetails? businessDetails;
Contact? contact;
Address? postalAddress;
Address? physicalAddress;
String? id;
Employer({this.name,this.businessDetails,this.contact,this.postalAddress,this.physicalAddress,this.id});
Employer.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
name = json['name'];
businessDetails = JsonConverters.fromJson(json['businessDetails'],'BusinessDetails',context!);
contact = JsonConverters.fromJson(json['contact'],'Contact',context!);
postalAddress = JsonConverters.fromJson(json['postalAddress'],'Address',context!);
physicalAddress = JsonConverters.fromJson(json['physicalAddress'],'Address',context!);
id = json['id'];
return this;
}
Map<String, dynamic> toJson() => {
'name': name,
'businessDetails': JsonConverters.toJson(businessDetails,'BusinessDetails',context!),
'contact': JsonConverters.toJson(contact,'Contact',context!),
'postalAddress': JsonConverters.toJson(postalAddress,'Address',context!),
'physicalAddress': JsonConverters.toJson(physicalAddress,'Address',context!),
'id': id
};
getTypeName() => "Employer";
TypeContext? context = _ctx;
}
class CreateEmployerResponse implements IConvertible
{
ResponseStatus? responseStatus;
Employer? employer;
CreateEmployerResponse({this.responseStatus,this.employer});
CreateEmployerResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
employer = JsonConverters.fromJson(json['employer'],'Employer',context!);
return this;
}
Map<String, dynamic> toJson() => {
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'employer': JsonConverters.toJson(employer,'Employer',context!)
};
getTypeName() => "CreateEmployerResponse";
TypeContext? context = _ctx;
}
class CreateEmployerRequest extends PostOperationTenanted<CreateEmployerResponse> implements IConvertible
{
String? name;
CreateEmployerRequest({this.name});
CreateEmployerRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
name = json['name'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'name': name
});
getTypeName() => "CreateEmployerRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'PostOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'BusinessDetails': TypeInfo(TypeOf.Class, create:() => BusinessDetails()),
'Contact': TypeInfo(TypeOf.Class, create:() => Contact()),
'Address': TypeInfo(TypeOf.Class, create:() => Address()),
'Employer': TypeInfo(TypeOf.Class, create:() => Employer()),
'CreateEmployerResponse': TypeInfo(TypeOf.Class, create:() => CreateEmployerResponse()),
'CreateEmployerRequest': TypeInfo(TypeOf.Class, create:() => CreateEmployerRequest()),
});
Dart CreateEmployerRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<CreateEmployerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Employers">
<OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
<Name>String</Name>
</CreateEmployerRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CreateEmployerResponse 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>
</CreateEmployerResponse>