Foundry API

<back to all web services

GetWarningRequest

Requires Authentication
The following routes are available for this service:
GET/warnings/{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 Warning implements IIdentifiableResource, IConvertible
{
    String? id;
    String? machineId;
    String? type;
    DateTime? startedAt;
    DateTime? resolvedAt;
    String? description;

    Warning({this.id,this.machineId,this.type,this.startedAt,this.resolvedAt,this.description});
    Warning.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        machineId = json['machineId'];
        type = json['type'];
        startedAt = JsonConverters.fromJson(json['startedAt'],'DateTime',context!);
        resolvedAt = JsonConverters.fromJson(json['resolvedAt'],'DateTime',context!);
        description = json['description'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'machineId': machineId,
        'type': type,
        'startedAt': JsonConverters.toJson(startedAt,'DateTime',context!),
        'resolvedAt': JsonConverters.toJson(resolvedAt,'DateTime',context!),
        'description': description
    };

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

class GetWarningResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Warning? warning;

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

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

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

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

class GetWarningRequest extends GetOperationTenanted<GetWarningResponse> implements IConvertible
{
    String? id;

    GetWarningRequest({this.id});
    GetWarningRequest.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() => "GetWarningRequest";
    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),
    'Warning': TypeInfo(TypeOf.Class, create:() => Warning()),
    'GetWarningResponse': TypeInfo(TypeOf.Class, create:() => GetWarningResponse()),
    'GetWarningRequest': TypeInfo(TypeOf.Class, create:() => GetWarningRequest()),
});

Dart GetWarningRequest 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 /warnings/{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
		}
	},
	warning: 
	{
		id: String,
		machineId: String,
		type: String,
		description: String
	}
}