Foundry API

UpdateMachineRequest

The following routes are available for this service:
PUT,PATCH	/machines/{Id}

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 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 UpdateMachineResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Machine? machine;

    UpdateMachineResponse({this.responseStatus,this.machine});
    UpdateMachineResponse.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() => "UpdateMachineResponse";
    TypeContext? context = _ctx;
}

class UpdateMachineRequest extends PutPatchOperationTenanted<UpdateMachineResponse> implements IConvertible
{
    String? id;
    String? name;
    String? type;
    DateTime? manufacturedOn;
    String? location;
    String? configuration;

    UpdateMachineRequest({this.id,this.name,this.type,this.manufacturedOn,this.location,this.configuration});
    UpdateMachineRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        id = json['id'];
        name = json['name'];
        type = json['type'];
        manufacturedOn = JsonConverters.fromJson(json['manufacturedOn'],'DateTime',context!);
        location = json['location'];
        configuration = json['configuration'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'id': id,
        'name': name,
        'type': type,
        'manufacturedOn': JsonConverters.toJson(manufacturedOn,'DateTime',context!),
        'location': location,
        'configuration': configuration
    });

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

TypeContext _ctx = TypeContext(library: 'staging_api.foundrylab.com', types: <String, TypeInfo> {
    'PutPatchOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'PutPatchOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'Machine': TypeInfo(TypeOf.Class, create:() => Machine()),
    'UpdateMachineResponse': TypeInfo(TypeOf.Class, create:() => UpdateMachineResponse()),
    'UpdateMachineRequest': TypeInfo(TypeOf.Class, create:() => UpdateMachineRequest()),
});

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

PUT /machines/{Id} HTTP/1.1 
Host: staging-api.foundrylab.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateMachineRequest 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>
  <Configuration>String</Configuration>
  <Id>String</Id>
  <Location>String</Location>
  <ManufacturedOn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System" />
  <Name>String</Name>
  <Type>String</Type>
</UpdateMachineRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateMachineResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Machines">
  <Machine xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Configuration>String</d2p1:Configuration>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:Location>String</d2p1:Location>
    <d2p1:ManufacturedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System" />
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Type>String</d2p1:Type>
  </Machine>
  <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>
</UpdateMachineResponse>