Foundry API

CreateMachineRequest

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

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 Machine implements IIdentifiableResource, IConvertible
{
    String? name;
    String? type;
    DateTime? manufacturedOn;
    String? location;
    String? configuration;
    String? id;

    Machine({this.name,this.type,this.manufacturedOn,this.location,this.configuration,this.id});
    Machine.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'];
        configuration = json['configuration'];
        id = json['id'];
        return this;
    }

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

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

class CreateMachineResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Machine? machine;
    String? apiKey;

    CreateMachineResponse({this.responseStatus,this.machine,this.apiKey});
    CreateMachineResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        machine = JsonConverters.fromJson(json['machine'],'Machine',context!);
        apiKey = json['apiKey'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'machine': JsonConverters.toJson(machine,'Machine',context!),
        'apiKey': apiKey
    };

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

class CreateMachineRequest extends PostOperationTenanted<CreateMachineResponse> implements IConvertible
{
    String? name;
    String? type;
    DateTime? manufacturedOn;
    String? location;
    String? timezone;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'PostOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'Machine': TypeInfo(TypeOf.Class, create:() => Machine()),
    'CreateMachineResponse': TypeInfo(TypeOf.Class, create:() => CreateMachineResponse()),
    'CreateMachineRequest': TypeInfo(TypeOf.Class, create:() => CreateMachineRequest()),
});

Dart CreateMachineRequest 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.

POST /machines HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"name":"String","type":"String","manufacturedOn":"0001-01-01","location":"String","timezone":"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"}},"machine":{"name":"String","type":"String","manufacturedOn":"0001-01-01","location":"String","configuration":"String","id":"String"},"apiKey":"String"}