Foundry API

<back to all web services

UpdateMachineRequest

import Foundation
import ServiceStack

public class UpdateMachineRequest : PutPatchOperationTenanted<UpdateMachineResponse>
{
    public var id:String?
    public var name:String?
    public var type:String?
    public var manufacturedOn:Date?
    public var location:String?
    public var configuration:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case name
        case type
        case manufacturedOn
        case location
        case configuration
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(String.self, forKey: .id)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        type = try container.decodeIfPresent(String.self, forKey: .type)
        manufacturedOn = try container.decodeIfPresent(Date.self, forKey: .manufacturedOn)
        location = try container.decodeIfPresent(String.self, forKey: .location)
        configuration = try container.decodeIfPresent(String.self, forKey: .configuration)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if name != nil { try container.encode(name, forKey: .name) }
        if type != nil { try container.encode(type, forKey: .type) }
        if manufacturedOn != nil { try container.encode(manufacturedOn, forKey: .manufacturedOn) }
        if location != nil { try container.encode(location, forKey: .location) }
        if configuration != nil { try container.encode(configuration, forKey: .configuration) }
    }
}

public class PutPatchOperationTenanted<TResponse : Codable> : PutPatchOperationUnTenanted<TResponse>, ITenantedRequest
{
    public var organisationId:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case organisationId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        organisationId = try container.decodeIfPresent(String.self, forKey: .organisationId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if organisationId != nil { try container.encode(organisationId, forKey: .organisationId) }
    }
}

public class PutPatchOperationUnTenanted<TResponse : Codable> : IPatch, IPut, Codable
{
    required public init(){}
}

public class UpdateMachineResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var machine:Machine?

    required public init(){}
}

public class Machine : IIdentifiableResource, Codable
{
    public var name:String?
    public var type:String?
    public var manufacturedOn:Date?
    public var location:String?
    public var configuration:String?
    public var id:String?

    required public init(){}
}

Swift UpdateMachineRequest DTOs

PUT /machines/{Id} HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
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>