Billiecart API

<back to all web services

SearchAllEmployersRequest

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 SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
{
    String? distinct;
    int? limit;
    int? offset;
    String? sort;
    String? filter;
    String? search;

    SearchOperationUnTenanted({this.distinct,this.limit,this.offset,this.sort,this.filter,this.search});
    SearchOperationUnTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        distinct = json['distinct'];
        limit = json['limit'];
        offset = json['offset'];
        sort = json['sort'];
        filter = json['filter'];
        search = json['search'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'distinct': distinct,
        'limit': limit,
        'offset': offset,
        'sort': sort,
        'filter': filter,
        'search': search
    });

    getTypeName() => "SearchOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

abstract class SearchOperationTenanted<TResponse> extends SearchOperationUnTenanted<TResponse> implements ITenantedRequest
{
    String? organisationId;

    SearchOperationTenanted({this.organisationId});
    SearchOperationTenanted.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() => "SearchOperationTenanted<$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;
}

enum SortDirection
{
    Ascending,
    Descending,
}

class Sorting implements IConvertible
{
    String? by;
    SortDirection? direction;

    Sorting({this.by,this.direction});
    Sorting.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        by = json['by'];
        direction = JsonConverters.fromJson(json['direction'],'SortDirection',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'by': by,
        'direction': JsonConverters.toJson(direction,'SortDirection',context!)
    };

    getTypeName() => "Sorting";
    TypeContext? context = _ctx;
}

class Filtering implements IConvertible
{
    List<String>? fields;
    String? search;

    Filtering({this.fields,this.search});
    Filtering.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        fields = JsonConverters.fromJson(json['fields'],'List<String>',context!);
        search = json['search'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'fields': JsonConverters.toJson(fields,'List<String>',context!),
        'search': search
    };

    getTypeName() => "Filtering";
    TypeContext? context = _ctx;
}

class SearchMetadata implements IConvertible
{
    int? total;
    int? limit;
    int? offset;
    Sorting? sort;
    Filtering? filter;

    SearchMetadata({this.total,this.limit,this.offset,this.sort,this.filter});
    SearchMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        total = json['total'];
        limit = json['limit'];
        offset = json['offset'];
        sort = JsonConverters.fromJson(json['sort'],'Sorting',context!);
        filter = JsonConverters.fromJson(json['filter'],'Filtering',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'total': total,
        'limit': limit,
        'offset': offset,
        'sort': JsonConverters.toJson(sort,'Sorting',context!),
        'filter': JsonConverters.toJson(filter,'Filtering',context!)
    };

    getTypeName() => "SearchMetadata";
    TypeContext? context = _ctx;
}

class SearchAllEmployersResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    List<Employer>? employers;
    SearchMetadata? metadata;

    SearchAllEmployersResponse({this.responseStatus,this.employers,this.metadata});
    SearchAllEmployersResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        employers = JsonConverters.fromJson(json['employers'],'List<Employer>',context!);
        metadata = JsonConverters.fromJson(json['metadata'],'SearchMetadata',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'employers': JsonConverters.toJson(employers,'List<Employer>',context!),
        'metadata': JsonConverters.toJson(metadata,'SearchMetadata',context!)
    };

    getTypeName() => "SearchAllEmployersResponse";
    TypeContext? context = _ctx;
}

class SearchAllEmployersRequest extends SearchOperationTenanted<SearchAllEmployersResponse> implements IConvertible
{
    SearchAllEmployersRequest();
    SearchAllEmployersRequest.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "SearchAllEmployersRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
    'GetOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'SearchOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'SearchOperationTenanted<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()),
    'SortDirection': TypeInfo(TypeOf.Enum, enumValues:SortDirection.values),
    'Sorting': TypeInfo(TypeOf.Class, create:() => Sorting()),
    'Filtering': TypeInfo(TypeOf.Class, create:() => Filtering()),
    'SearchMetadata': TypeInfo(TypeOf.Class, create:() => SearchMetadata()),
    'SearchAllEmployersResponse': TypeInfo(TypeOf.Class, create:() => SearchAllEmployersResponse()),
    'List<Employer>': TypeInfo(TypeOf.Class, create:() => <Employer>[]),
    'SearchAllEmployersRequest': TypeInfo(TypeOf.Class, create:() => SearchAllEmployersRequest()),
});

Dart SearchAllEmployersRequest DTOs

GET /employers HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchAllEmployersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Employers">
  <Employers xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Employer>
      <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>
    </d2p1:Employer>
  </Employers>
  <Metadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces">
    <d2p1:Filter>
      <d2p1:Fields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Fields>
      <d2p1:Search>String</d2p1:Search>
    </d2p1:Filter>
    <d2p1:Limit>0</d2p1:Limit>
    <d2p1:Offset>0</d2p1:Offset>
    <d2p1:Sort>
      <d2p1:By>String</d2p1:By>
      <d2p1:Direction>Ascending</d2p1:Direction>
    </d2p1:Sort>
    <d2p1:Total>0</d2p1:Total>
  </Metadata>
  <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>
</SearchAllEmployersResponse>