Foundry API

<back to all web services

ReportMachineStatusRequest

Requires Authentication
The following routes are available for this service:
All Verbs/machines/{Id}/statuses
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 MachineStatus implements IConvertible
{
    String? component;
    DateTime? observedAt;
    String? code;
    String? errorCode;
    String? errorDetails;

    MachineStatus({this.component,this.observedAt,this.code,this.errorCode,this.errorDetails});
    MachineStatus.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        component = json['component'];
        observedAt = JsonConverters.fromJson(json['observedAt'],'DateTime',context!);
        code = json['code'];
        errorCode = json['errorCode'];
        errorDetails = json['errorDetails'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'component': component,
        'observedAt': JsonConverters.toJson(observedAt,'DateTime',context!),
        'code': code,
        'errorCode': errorCode,
        'errorDetails': errorDetails
    };

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

class ReportMachineStatusResponse implements IConvertible
{
    MachineStatus? status;
    ResponseStatus? responseStatus;

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

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

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

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

class ReportMachineStatusRequest extends PostOperationTenanted<ReportMachineStatusResponse> implements IConvertible
{
    String? id;
    String? component;
    DateTime? observedAt;
    String? code;
    String? errorCode;
    String? errorDetails;

    ReportMachineStatusRequest({this.id,this.component,this.observedAt,this.code,this.errorCode,this.errorDetails});
    ReportMachineStatusRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        id = json['id'];
        component = json['component'];
        observedAt = JsonConverters.fromJson(json['observedAt'],'DateTime',context!);
        code = json['code'];
        errorCode = json['errorCode'];
        errorDetails = json['errorDetails'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'id': id,
        'component': component,
        'observedAt': JsonConverters.toJson(observedAt,'DateTime',context!),
        'code': code,
        'errorCode': errorCode,
        'errorDetails': errorDetails
    });

    getTypeName() => "ReportMachineStatusRequest";
    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),
    'MachineStatus': TypeInfo(TypeOf.Class, create:() => MachineStatus()),
    'ReportMachineStatusResponse': TypeInfo(TypeOf.Class, create:() => ReportMachineStatusResponse()),
    'ReportMachineStatusRequest': TypeInfo(TypeOf.Class, create:() => ReportMachineStatusRequest()),
});

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

POST /machines/{Id}/statuses HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	component: String,
	code: String,
	errorCode: String,
	errorDetails: String,
	organisationId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	status: 
	{
		component: String,
		code: String,
		errorCode: String,
		errorDetails: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}