Foundry API

SearchMachinesRequest

The following routes are available for this service:
GET	/machines

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;

    SearchOperationUnTenanted({this.distinct,this.limit,this.offset,this.sort,this.filter});
    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'];
        return this;
    }

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

    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;
}

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;

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

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

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

    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;
}

abstract class SearchOperationResponse
{
    SearchMetadata? metadata;

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

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

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

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

class SearchMachine implements IIdentifiableResource, IConvertible
{
    String? name;
    String? type;
    DateTime? manufacturedOn;
    String? location;
    String? id;

    SearchMachine({this.name,this.type,this.manufacturedOn,this.location,this.id});
    SearchMachine.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        name = json['name'];
        type = json['type'];
        manufacturedOn = JsonConverters.fromJson(json['manufacturedOn'],'DateTime',context!);
        location = json['location'];
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'name': name,
        'type': type,
        'manufacturedOn': JsonConverters.toJson(manufacturedOn,'DateTime',context!),
        'location': location,
        'id': id
    };

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

class SearchMachinesResponse extends SearchOperationResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    List<SearchMachine>? machines;

    SearchMachinesResponse({this.responseStatus,this.machines});
    SearchMachinesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        machines = JsonConverters.fromJson(json['machines'],'List<SearchMachine>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'machines': JsonConverters.toJson(machines,'List<SearchMachine>',context!)
    });

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

class SearchMachinesRequest extends SearchOperationTenanted<SearchMachinesResponse> implements IConvertible
{
    SearchMachinesRequest();
    SearchMachinesRequest.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() => "SearchMachinesRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'GetOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'SearchOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'SearchOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    '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()),
    'SearchOperationResponse': TypeInfo(TypeOf.AbstractClass),
    'SearchMachine': TypeInfo(TypeOf.Class, create:() => SearchMachine()),
    'SearchMachinesResponse': TypeInfo(TypeOf.Class, create:() => SearchMachinesResponse()),
    'List<SearchMachine>': TypeInfo(TypeOf.Class, create:() => <SearchMachine>[]),
    'SearchMachinesRequest': TypeInfo(TypeOf.Class, create:() => SearchMachinesRequest()),
});

Dart SearchMachinesRequest DTOs

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

HTTP + CSV

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

GET /machines HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
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"}},"machines":[{"name":"String","type":"String","manufacturedOn":"0001-01-01","location":"String","id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"]}}}