Foundry API

<back to all web services

AddTelemetryRequest

Requires Authentication
The following routes are available for this service:
POST/machines/{MachineId}/telemetries
import 'package:servicestack/servicestack.dart';

abstract class PutPatchOperationUnTenanted<TResponse> implements IPatch, IPut
{
    PutPatchOperationUnTenanted();
    PutPatchOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PutPatchOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

abstract class PutPatchOperationTenanted<TResponse> extends PutPatchOperationUnTenanted<TResponse> implements ITenantedRequest
{
    String? organisationId;

    PutPatchOperationTenanted({this.organisationId});
    PutPatchOperationTenanted.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() => "PutPatchOperationTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class AddTelemetryResponse implements IConvertible
{
    ResponseStatus? responseStatus;

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

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

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

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

class Telemetry implements IIdentifiableResource, IConvertible
{
    String? type;
    String? value;
    DateTime? observedAt;
    String? id;

    Telemetry({this.type,this.value,this.observedAt,this.id});
    Telemetry.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class AddTelemetryRequest extends PutPatchOperationTenanted<AddTelemetryResponse> implements IConvertible
{
    String? machineId;
    List<Telemetry>? telemetries;

    AddTelemetryRequest({this.machineId,this.telemetries});
    AddTelemetryRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'machineId': machineId,
        'telemetries': JsonConverters.toJson(telemetries,'List<Telemetry>',context!)
    });

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

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'PutPatchOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'PutPatchOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'AddTelemetryResponse': TypeInfo(TypeOf.Class, create:() => AddTelemetryResponse()),
    'Telemetry': TypeInfo(TypeOf.Class, create:() => Telemetry()),
    'AddTelemetryRequest': TypeInfo(TypeOf.Class, create:() => AddTelemetryRequest()),
    'List<Telemetry>': TypeInfo(TypeOf.Class, create:() => <Telemetry>[]),
});

Dart AddTelemetryRequest 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/{MachineId}/telemetries HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	machineId: String,
	telemetries: 
	[
		{
			type: String,
			value: String,
			id: String
		}
	],
	organisationId: String
}
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
		}
	}
}