Requires the role: | manager |
GET | /employers/{Id} |
---|
import 'package:servicestack/servicestack.dart';
abstract class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
String? embed;
GetOperationUnTenanted({this.embed});
GetOperationUnTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
embed = json['embed'];
return this;
}
Map<String, dynamic> toJson() => {
'embed': embed
};
getTypeName() => "GetOperationUnTenanted<$TResponse>";
TypeContext? context = _ctx;
}
abstract class GetOperationTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements ITenantedRequest
{
String? organisationId;
GetOperationTenanted({this.organisationId});
GetOperationTenanted.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() => "GetOperationTenanted<$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 GetEmployerResponse implements IConvertible
{
ResponseStatus? responseStatus;
Employer? employer;
GetEmployerResponse({this.responseStatus,this.employer});
GetEmployerResponse.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() => "GetEmployerResponse";
TypeContext? context = _ctx;
}
class GetEmployerRequest extends GetOperationTenanted<GetEmployerResponse> implements IConvertible
{
String? id;
GetEmployerRequest({this.id});
GetEmployerRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
id = json['id'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'id': id
});
getTypeName() => "GetEmployerRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
'GetOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'GetOperationTenanted<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()),
'GetEmployerResponse': TypeInfo(TypeOf.Class, create:() => GetEmployerResponse()),
'GetEmployerRequest': TypeInfo(TypeOf.Class, create:() => GetEmployerRequest()),
});
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.
GET /employers/{Id} HTTP/1.1 Host: staging-api.billiecart.com.au Accept: text/csv
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"}}