Foundry API

GetMachineRequest

The following routes are available for this service:
GET	/machines/{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 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 GetMachineResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Machine? machine;

    GetMachineResponse({this.responseStatus,this.machine});
    GetMachineResponse.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!);
        return this;
    }

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

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

class GetMachineRequest extends GetOperationTenanted<GetMachineResponse> implements IConvertible
{
    String? id;

    GetMachineRequest({this.id});
    GetMachineRequest.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() => "GetMachineRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'GetOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'GetOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'Machine': TypeInfo(TypeOf.Class, create:() => Machine()),
    'GetMachineResponse': TypeInfo(TypeOf.Class, create:() => GetMachineResponse()),
    'GetMachineRequest': TypeInfo(TypeOf.Class, create:() => GetMachineRequest()),
});

Dart GetMachineRequest DTOs

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

HTTP + JSV

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

GET /machines/{Id} HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
	}
}