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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ReportMachineStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Machines">
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <Code>String</Code>
  <Component>String</Component>
  <ErrorCode>String</ErrorCode>
  <ErrorDetails>String</ErrorDetails>
  <Id>String</Id>
  <ObservedAt>0001-01-01T00:00:00</ObservedAt>
</ReportMachineStatusRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReportMachineStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Machines">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Status xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Code>String</d2p1:Code>
    <d2p1:Component>String</d2p1:Component>
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:ErrorDetails>String</d2p1:ErrorDetails>
    <d2p1:ObservedAt>0001-01-01T00:00:00</d2p1:ObservedAt>
  </Status>
</ReportMachineStatusResponse>